Squirrel Standard Library 2.2

compiles a squirrel script or loads a precompiled one and executes it. returns the value returned by the script or null if no value is returned. if the optional parameter 'raiseerror' is true, the compiler error handler is invoked in case of a syntax error. If raiseerror is omitted or set to false, the compiler error handler is not ivoked. When squirrel is compiled in unicode mode the function can handle different character ecodings, UTF8 with and without prefix and UCS-2 prefixed(both big endian an little endian). If the source stream is not prefixed UTF8 ecoding is used as default.

compiles a squirrel script or loads a precompiled one an returns it as as function. if the optional parameter 'raiseerror' is true, the compiler error handler is invoked in case of a syntax error. If raiseerror is omitted or set to false, the compiler error handler is not ivoked. When squirrel is compiled in unicode mode the function can handle different character ecodings, UTF8 with and without prefix and UCS-2 prefixed(both big endian an little endian). If the source stream is not prefixed UTF8 ecoding is used as default.

serializes a closure to a bytecode file (destpath). The serialized file can be loaded using loadfile() and dofile().

stderr

File object bound on the os standard error stream

stdin

File object bound on the os standard input stream

stdout

File object bound on the os standard output stream

The file object implements a stream on a operating system file. It's contructor imitate the behaviour of the C runtime function fopen for eg.

          
local myfile = file("test.xxx","wb+");
					
        

creates a file with read/write access in the current directory.

returns a non null value if the read/write pointer is at the end of the stream.

flushes the stream.return a value != null if succeded, otherwise returns null

returns the lenght of the stream

read n bytes from the stream and retuns them as blob

reads a number from the stream according to the type parameter. type can have the following values:

Moves the read/write pointer to a specified location. offset indicates the number of bytes from origin. origin can be 'b' beginning of the stream,'c' current location or 'e' end of the stream. If origin is omitted the parameter is defaulted as 'b'(beginning of the stream).

returns read/write pointer absolute position

writes a blob in the stream

writes a number in the stream formatted according to the type parameter. type can have the following values:

initialize and register the io library in the given VM.

creates a file object bound to the SQFILE passed as parameter and pushes it in the stack

retrieve the pointer of a stream handle from an arbitrary position in the stack.

compiles a squirrel script or loads a precompiled one an pushes it as closure in the stack. When squirrel is compiled in unicode mode the function can handle different character ecodings, UTF8 with and without prefix and UCS-2 prefixed(both big endian an little endian). If the source stream is not prefixed UTF8 ecoding is used as default.

Compiles a squirrel script or loads a precompiled one and executes it. Optionally pushes the return value of the executed script in the stack. When squirrel is compiled in unicode mode the function can handle different character ecodings, UTF8 with and without prefix and UCS-2 prefixed(both big endian an little endian). If the source stream is not prefixed UTF8 ecoding is used as default.

serializes the closure at the top position in the stack as bytecode in the file specified by the paremeter filename. If a file with the same name already exists, it will be overwritten.

returns a new instance of a blob class of the specified size in bytes

casts a float to a int

casts a int to a float

swap the byte order of a number (like it would be a 16bits integer)

swap the byte order of an integer

swaps the byteorder of a float

The blob object is a buffer of arbitrary binary data. The object behaves like a file stream, it has a read/write pointer and it automatically grows if data is written out of his boundary.
A blob can also be accessed byte by byte through the [] operator.

returns a non null value if the read/write pointer is at the end of the stream.

flushes the stream.return a value != null if succeded, otherwise returns null

returns the lenght of the stream

read n bytes from the stream and retuns them as blob

reads a number from the stream according to the type pameter. type can have the following values:

resizes the blob to the specified size

Moves the read/write pointer to a specified location. offset indicates the number of bytes from origin. origin can be 'b' beginning of the stream,'c' current location or 'e' end of the stream. If origin is omitted the parameter is defaulted as 'b'(beginning of the stream).

swaps the byte order of the blob content as it would be an array of 16bits integers

swaps the byte order of the blob content as it would be an array of 32bits integers

returns read/write pointer absolute position

writes a blob in the stream

writes a number in the stream formatted according to the type pameter. type can have the following values:

initialize and register the blob library in the given VM.

retrieve the pointer of a blob's payload from an arbitrary position in the stack.

retrieve the size of a blob's payload from an arbitrary position in the stack.

creates a blob with the given payload size and pushes it in the stack.

returns the absolute value of x as integer

returns the arccosine of x

returns the arcsine of x

returns the arctangent of x

returns the arctangent of y/x.

returns a float value representing the smallest integer that is greater than or equal to x

returns the cosine of x

returns the exponential value of the float parameter x

returns the absolute value of x as float

returns a float value representing the largest integer that is less than or equal to x

returns the natural logarithm of x

returns the logarithm base-10 of x

returns x raised to the power of y.

returns a pseudorandom integer in the range 0 to RAND_MAX

returns the sine of x

returns the square root of x

sets the starting point for generating a series of pseudorandom integers

returns the tangent of x

PI

The numeric constant pi (3.141592) is the ratio of the circumference of a circle to its diameter

RAND_MAX

the maximum value that can be returned by the rand() function

initialize and register the math library in the given VM.

returns a float representing the number of seconds elapsed since the start of the process

returns a table containing a date/time splitted in the slots:

if time is omitted the current time is used.
if format can be 'l' local time or 'u' UTC time, if omitted is defaulted as 'l'(local time).

Returns a string containing the value of the environment variable varname

deletes the file specified by path

renames the file or directory specified by oldname to the name given by newname

executes the string cmd through the os command interpreter.

returns the number of seconds elapsed since midnight 00:00:00, January 1, 1970.

the result of this function can be formatted through the faunction date

initialize and register the system library in the given VM.

Returns a string formatted according formatstr and the optional parameters following it. The format string follows the same rules as the printf family of standard C functions( the "*" is not supported).

eg.
sq> print(format("%s %d 0x%02X\n","this is a test :",123,10));
this is a test : 123 0x0A

					

Strips white-space-only characters that might appear at the beginning of the given string and returns the new stripped string.

compiles a regular expression pattern and returns it as a new regexp class instance.

GREEDY CLOSURES. 

ESCAPE CHARACTERS. 

PREDEFINED CLASSES. 

Strips white-space-only characters that might appear at the end of the given string and returns the new stripped string.

returns an array of strings split at each point where a separator character occurs in str. The separator is not returned as part of any array element. the parameter separators is a string that specifies the characters as to be used for the splitting.

              
eg.
local a = split("1.2-3;4/5",".-/;");
// the result will be  [1,2,3,4,5]

					
            

Strips white-space-only characters that might appear at the beginning or end of the given string and returns the new stripped string.

The regexp object rapresent a precompiled regular experssion pattern. The object is created trough the function regexp().

returns an array of tables containing two indexs("begin" and "end")of the first match of the regular expression in the string str. An array entry is created for each captured sub expressions. If no match occurs returns null. The search starts from the index start of the string, if start is omitted the search starts from the beginning of the string.

the first element of the returned array(index 0) always contains the complete match.

 
local ex = regexp(@"(\d+) ([a-zA-Z]+)(\p)");
local string = "stuff 123 Test;";
local res = ex.capture(string);
foreach(i,val in res)
{
	print(format("match number[%02d] %s\n",
			i,string.slice(val.begin,val.end))); //prints "Test"
}

...
will print
match number[00] 123 Test;
match number[01] 123
match number[02] Test
match number[03] ;
				
				

returns a true if the regular expression matches the string str, otherwise returns false.

returns a table containing two indexs("begin" and "end") of the first match of the regular expression in the string str, otherwise if no match occurs returns null. The search starts from the index start of the string, if start is omitted the search starts from the beginning of the string.

 
local ex = regexp("[a-zA-Z]+");
local string = "123 Test;";
local res = ex.search(string);
print(string.slice(res.begin,res.end)); //prints "Test"
				
				

initialize and register the string library in the given VM.

creates a new string formatted according to the object at positionnformatstringidx and the optional parameters following it. The format string follows the same rules as the printf family of standard C functions( the "*" is not supported).

compiles an expression and returns a pointer to the compiled version. in case of failure returns NULL.The returned object has to be deleted through the function sqstd_rex_free().

deletes a expression structure created with sqstd_rex_compile()

returns SQTrue if the string specified in the parameter text is an exact match of the expression, otherwise returns SQFalse.

searches the first match of the expressin in the string specified in the parameter text. if the match is found returns SQTrue and the sets out_begin to the beginning of the match and out_end at the end of the match; otherwise returns SQFalse.

searches the first match of the expressin in the string delimited by the parameter text_begin and text_end. if the match is found returns SQTrue and the sets out_begin to the beginning of the match and out_end at the end of the match; otherwise returns SQFalse.

returns the number of sub expressions matched by the expression

retrieve the begin and and pointer to the length of the sub expression indexed by n. The result is passed trhough the struct SQRexMatch.

initialize compiler and runtime error handlers, the handlers use the print function set through(sq_setprintfunc) to output the error.

print the call stack and stack contents.the function uses the print function set through(sq_setprintfunc) to output the stack dump.