1.25Virtual Machine Informations

Generic informations on the Virtual Machine.

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

Functions

vmFalconPath

Returns default system path for Falcon load requests.

vmFalconPath()
ReturnThe 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()
ReturnTrue 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.

For 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

vmModuleLine

Returns the number of the line it has been called at.

vmModuleLine()
ReturnAn integer that represents a line number.

vmModuleName

Returns the logical name of this module.

vmModuleName()
ReturnLogical name of this module.

Every module has a logical name inside the application. There is a loose mapping between the underlying module providers and the logical name of the module, so knowing it may be helpful.

vmModuleVersionInfo

Returns an array containing current module version informations.

vmModuleVersionInfo()
ReturnMajor, minor and revision numbers of the curerntly being executed module, in a 3 elements array.

vmSearchPath

Returns the application specific load path.

vmSearchPath()
ReturnA module search path as set by the application when creating the virtual machine.

This string is at disposal of the embeddign application (or of the Falcon command line interpreter) to communicate to scripts and underlying users the search path set at applicaiton level. It is used by internal services, the include function, the compiler Feather module and similar facilities.

vmSystemType

Returns a descriptive name of the overall system architecture.

vmSystemType()
ReturnA 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()
ReturnMajor, minor and revision numbers of the running virtual machine in a 3 elements array.

vmVersionName

Returns the nickname for this VM version.

vmVersionName()
ReturnA string containing the symbolic name of this VM version.
Made with http://www.falconpl.org