Index  |  Related pages  |  Classes  |  Functions  |  Entities  |  Function Sets  |  Groups

Function set vminfo

Generic informations on the Virtual Machine. more...


Function list

vmFalconPath Returns default system path for Falcon load requests.
vmIsMain Returns true if the calling module is the main module of the application.
vmModuleVersionInfo Returns an array containing current module version informations.
vmSystemType Returns a descriptive name of the overall system architecture.
vmVersionInfo Returns an array containing VM version informations.
vmVersionName Returns the nickname for this VM version.

Detailed description

This functions are meant to provide minimal informations about the virtual machine and its configuration. In example, they provide the VM version number and target architectures.


Functions

vmFalconPath()

Returns default system path for Falcon load requests.

vmFalconPath( )
Returns:

The default compiled-in load path, or the value of the environemnt variable FALCON_LOAD_PATH if defined.

vmIsMain()

Returns true if the calling module is the main module of the application.

vmIsMain( )
Returns:

True if the calling module is the main module.

This function checks if the current module has been added as the last one right before starting an explicit execution of the virtual machine from the outside.

This function is useful for those modules that have a main code which is meant to be executed at link time and a part that is menat to be executed only if the module is directly loaded and executed.

In example:

       // executes this at link time
       prtcode = printl
 
       // executes this from another module on request
       function testPrint()
          prtcode( "Success." )
       end
       export testPrint
 
       // performs a test if directly loaded
       if vmIsMain()
          > "Testing the testPrint function"
          testPrint()
       end

vmModuleVersionInfo()

Returns an array containing current module version informations.

vmModuleVersionInfo( )
Returns:

Major, minor and revision numbers of the curerntly being executed module, in a 3 elements array.

vmSystemType()

Returns a descriptive name of the overall system architecture.

vmSystemType( )
Returns:

A string containing a small descriptiuon of the system architecture.

Currently, it can be "WIN" on the various MS-Windows flavours and POSIX on Linux, BSD, Solaris, Mac-OSX and other *nix based systems.

vmVersionInfo()

Returns an array containing VM version informations.

vmVersionInfo( )
Returns:

Major, minor and revision numbers of the running virtual machine in a 3 elements array.

vmVersionName()

Returns the nickname for this VM version.

vmVersionName( )
Returns:

A string containing the symbolic name of this VM version.


Index  |  Related pages  |  Classes  |  Functions  |  Entities  |  Function Sets  |  Groups
Made with Faldoc 1.0.0