DEFAULT LIBRARY A Programming Language Manual

gs_error ( lib: Default, file: ../src/gs/gslib_default.cpp ) gs_error( info ) IN str info error info (optional) Generates an user error and stop the execution of the program. If info is specified, the text will be reported along with the error. It can be used to handle critical errors, that usually shouldn't happend, and to stop program in a "controlled" way.  C/C++ source code void gsError( gsVM* vm ) { guard(gsError); cchar* sz = NULL; if( gs_params(vm)==1 && gs_ckstr(vm,0) ) sz = gs_tostr(vm,0); gs_error( vm, GS_ERR_USER, sz ); // stop execution will be stopped unguard(); } gs_debug ( lib: Default, file: ../src/gs/gslib_default.cpp ) gs_debug( debuglevel ) IN int debuglevel binary debug flags This function is used for advanced debuging. It changes the processor level of debug, to receive more or less information when an error occures. The debug level is an integer value with various flag options stored on bits. bit 0: halt on errors, with a message box info bit 1: log error description and short call stack info bit 2: list current function machine code (used when bit 4 is set) bit 3: list data on the stack (used when bit 4 is set) bit 4: list extensive info about the current call stack (use bit 2 and 3) bit 5: dump global variables with names and values bit 6: dump all functions assemler code The default level of debug is 3 (halt and short description) and should be enough to track most common errors. gs_debug(255); // set all debug bits for the highest level of debug a = b+1; // this will produce an error, because b is not found  C/C++ source code void gsDebug( gsVM* vm ) { guard(gsDebug); if( !gs_ckint(vm,0) ) return; vm->m_debug = gs_toint(vm,0); unguard(); } new ( lib: Default, file: ../src/gs/gslib_default.cpp ) obj new( ) OUT obj new created object Creates a new empty object of base gsObj class.  C/C++ source code void gsNew( gsVM* vm ) { guard(gsNew); gsObj* obj = gs_new gsObj(); obj->Construct( vm ); gs_pushobj( vm, obj ); unguard(); } delete ( lib: Default, file: ../src/gs/gslib_default.cpp ) delete( obj ) IN obj obj object to be deleted Deletes a created object.  C/C++ source code void gsDelete( gsVM* vm ) { guard(gsDelete); if( !gs_ckobj(vm,0) ) return; gsObj* obj = gs_toobj(vm,0); if( obj ) { obj->Destruct( vm ); gs_delete( obj ); } unguard(); } gs_compilefile ( lib: Default, file: ../src/gs/gslib_default.cpp ) int gs_compilefile( programfile, gfname ) IN str programfile path to a valid program file str gfname global function name (optional) OUT int 1=success, 0=fail Compiles the program contained in the specified file and remember it's content. The content of the file must be a valid GS9 program (with functions). If an error occures or the file is not found, it will return false. Somehow similar to the #include instruction. Optional global function name to tell where to put the new global code.  C/C++ source code void gsCompileFile( gsVM* vm ) { guard(gsCompileFile); if( !gs_ckstr(vm,0) ) return; cchar* gfname = NULL; if( gs_params(vm)==2 && gs_ckstr(vm,1) ) gfname = gs_tostr(vm,1); int ret = gs_compilefile( vm, gs_tostr(vm,0), gfname ); gs_pushint( vm, ret ); unguard(); } gs_compilestring ( lib: Default, file: ../src/gs/gslib_default.cpp ) int gs_compilestring( programtext, gfname ) IN str programtext valid program text str gfname global function name (optional) OUT int 1=success, 0=fail Compiles the program contained in the specified string and remember it's content. The content of the string must be a valid GS9 program (with functions). Optional global function name to tell where to put the new global code.  C/C++ source code void gsCompileString( gsVM* vm ) { guard(gsCompileString); if( !gs_ckstr(vm,0) ) return; cchar* gfname = NULL; if( gs_params(vm)==2 && gs_ckstr(vm,1) ) gfname = gs_tostr(vm,1); int ret = gs_compilestring( vm, gs_tostr(vm,0), gfname ); gs_pushint( vm, ret ); unguard(); } gs_docommand ( lib: Default, file: ../src/gs/gslib_default.cpp ) int, val gs_docommand( codetext ) IN str codetext valid instrutions text OUT int 1=success, 0=fail val returned value Compiles and execute the instructions contained in the specified string, than forget it's content. The string must contain valid GS9 instructions, but no functions or other global declarations. The effect will be like if the code from the string would be in a temporary function and that function is called right there. println("one"); // will print one gs_docommand( "println(\"two\");" ); // will print two println("three"); // will print three  C/C++ source code void gsDoCommand( gsVM* vm ) { guard(gsDoCommand); if( !gs_ckstr(vm,0) ) return; int ret = gs_docommand( vm, gs_tostr(vm,0) ); gs_pushint( vm, ret ); unguard(); } gs_gid ( lib: Default, file: ../src/gs/gslib_default.cpp ) int gs_gid( varname ) IN str varname global variable's name OUT int variable's id or -1 if not found Returns the internal index of the varname global variable. If no global variable is found with the specified name, -1 will be returned. See the Advanced access chapter.  C/C++ source code void gsGid( gsVM* vm ) { guard(gsGid); if( !gs_ckstr(vm,0) ) return; gsVal& val = vm->Get(0); int gidx = vm->m_env->FindGlb( val.m_str ); gs_pushint( vm, gidx ); unguard(); } gs_gname ( lib: Default, file: ../src/gs/gslib_default.cpp ) str gs_gname( gid ) IN int gid global variable's id OUT str global variable's name Returns the name of a global variable specified by gid internal index. Use gs_gid to obtain the gid of a global variable.  C/C++ source code void gsGName( gsVM* vm ) { guard(gsGName); if( !gs_ckint(vm,0) ) return; int gidx = gs_toint(vm,0); gs_getglobalname( vm, gidx ); unguard(); } gs_gget ( lib: Default, file: ../src/gs/gslib_default.cpp ) val gs_gget( gid ) IN int gid global variable's id OUT val global variable's value Returns the value of a global variable specified by gid internal index. Use gs_gid to obtain the gid of a global variable.  C/C++ source code void gsGGet( gsVM* vm ) { guard(gsGGet); if( !gs_ckint(vm,0) ) return; int gidx = gs_toint(vm,0); gs_getglobal( vm, gidx ); unguard(); } gs_gset ( lib: Default, file: ../src/gs/gslib_default.cpp ) gs_gset( gid, value ) IN int gid global variable's id val value value to set Sets the value of a global variable specified by the gid internal index. Use gs_gid to obtain the gid of a global variable.  C/C++ source code void gsGSet( gsVM* vm ) { guard(gsGSet); if( !gs_ckparams(vm,2) ) return; if( !gs_ckint(vm,0) ) return; int gidx = gs_toint(vm,0); gs_push(vm,1); gs_setglobal( vm, gidx ); unguard(); } print ( lib: Default, file: ../src/gs/gslib_default.cpp ) print( ... ) IN ... ... any number of parameters of any type is accepted Can handle multiple parameters of any type, printing all their values in the console, one by one. There's an decent limit of length when printing, so huge texts will not be fully displayed. // will print "one" and "two" on the same line and "three" on the next one print("one ","two \n","three "); // will print "four" on the same line with previous "three" print("four ");  C/C++ source code void gsPrint( gsVM* vm ) { guard(gsPrint); for( int i=0; i<gs_params(vm); i++ ) gs_vallog( vm->Get(i) ); unguard(); } println ( lib: Default, file: ../src/gs/gslib_default.cpp ) println( ... ) IN ... ... any number of parameters of any type is accepted Can handle multiple parameters of any type, printing all their values in the console, one by one. It also adds a new line character (\n), so the next print call will write it's text on the next line. There's an decent limit of length when printing, so huge texts will not be fully displayed. // will print "one" and "two" on the same line and "three" on the next line. println("one ","two "); println("three ");  C/C++ source code void gsPrintln( gsVM* vm ) { guard(gsPrintln); for( int i=0; i<gs_params(vm); i++ ) gs_vallog( vm->Get(i) ); gs_log( "\n" ); unguard(); } ZERO ( lib: Default, file: ../src/gs/gslib_default.cpp ) 0.0 Define with the value of num type 0. NULL ( lib: Default, file: ../src/gs/gslib_default.cpp ) NULL Define with the value of ptr type NULL. TYPE_NUM ( lib: Default, file: ../src/gs/gslib_default.cpp ) GS_TYPE_NUM Define with the internal value of the type num (0). Usable with typeof. TYPE_PTR ( lib: Default, file: ../src/gs/gslib_default.cpp ) GS_TYPE_PTR Define with the internal value of the type ptr (1). Usable with typeof. TYPE_TAB ( lib: Default, file: ../src/gs/gslib_default.cpp ) GS_TYPE_TAB Define with the internal value of the type tab (2). Usable with typeof. TYPE_STR ( lib: Default, file: ../src/gs/gslib_default.cpp ) GS_TYPE_STR Define with the internal value of the type str (3). Usable with typeof. TYPE_OBJ ( lib: Default, file: ../src/gs/gslib_default.cpp ) GS_TYPE_OBJ Define with the internal value of the type obj (4). Usable with typeof. TYPE_FNC ( lib: Default, file: ../src/gs/gslib_default.cpp ) GS_TYPE_FNC Define with the internal value of the type fnc (5). Usable with typeof. TYPE_MAX ( lib: Default, file: ../src/gs/gslib_default.cpp ) GS_TYPE_MAX Define with the internal count of types (6).