<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Function set "Virtual Machine Informations" - Function set "Virtual Machine Informations"</title>
<link href="faldoc.css" rel="stylesheet" type="text/css"/>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
</head>
<body class="faldoc_body">
<div class="navitop">
<div class="tabs">
<ul>
<li><a href="./index.html"><span>Main</span></a></li>
<li><a href="./pages.html"><span>Related pages</span></a></li>
<li><a href="./groups.html"><span>Groups</span></a></li>
<li><a href="./funset.html"><span>Function sets</span></a></li>
<li><a href="./classes.html"><span>Classes</span></a></li>
<li><a href="./objects.html"><span>Objects</span></a></li>
<li><a href="./functions.html"><span>All functions</span></a></li>
<li><a href="./globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<hr/>
<h1 class="faldoc_title">Function set "Virtual Machine Informations"</h1>
<p class="faldoc_brief">Generic informations on the Virtual Machine. </p>
<p class="faldoc_brief"><a href="#more">more...</a></p>
<h2 class="faldoc_title">Summary</h2>
<table class="faldoc_list">
<tr><td><a href="#vmFalconPath">vmFalconPath()</a></td><td>Returns default system path for Falcon load requests. </td></tr>
<tr><td><a href="#vmIsMain">vmIsMain()</a></td><td>Returns true if the calling module is the main module of the application. </td></tr>
<tr><td><a href="#vmModuleName">vmModuleName()</a></td><td>Returns the logical name of this module. </td></tr>
<tr><td><a href="#vmModuleVersionInfo">vmModuleVersionInfo()</a></td><td>Returns an array containing current module version informations. </td></tr>
<tr><td><a href="#vmSearchPath">vmSearchPath()</a></td><td>Returns the application specific load path. </td></tr>
<tr><td><a href="#vmSystemType">vmSystemType()</a></td><td>Returns a descriptive name of the overall system architecture. </td></tr>
<tr><td><a href="#vmVersionInfo">vmVersionInfo()</a></td><td>Returns an array containing VM version informations. </td></tr>
<tr><td><a href="#vmVersionName">vmVersionName()</a></td><td>Returns the nickname for this VM version. </td></tr>
</table>
<a name="more"><h2 class="faldoc_title">Detailed description</h2></a>
<table class="faldoc_function">
</table>
<br/>
<p class="item_brief">Generic informations on the Virtual Machine. </p>
<p class="faldoc_text">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. </p>
<h2 class="faldoc_title">Members</h2>
<h3 class="faldoc_funcname"><a name="vmFalconPath">vmFalconPath()</a></h3>
<p class="item_brief">Returns default system path for Falcon load requests. </p>
<p class="faldoc_funcdecl">vmFalconPath</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">The default compiled-in load path, or the value of the environemnt variable FALCON_LOAD_PATH if defined. </td></tr>
</table>
<h3 class="faldoc_funcname"><a name="vmIsMain">vmIsMain()</a></h3>
<p class="item_brief">Returns true if the calling module is the main module of the application. </p>
<p class="faldoc_funcdecl">vmIsMain</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">True if the calling module is the main module. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">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. </p>
<p class="faldoc_text">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. </p>
<p class="faldoc_text">For example: </p>
<pre class="faldoc_code">
// 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
</pre>
</p>
<h3 class="faldoc_funcname"><a name="vmModuleName">vmModuleName()</a></h3>
<p class="item_brief">Returns the logical name of this module. </p>
<p class="faldoc_funcdecl">vmModuleName</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">Logical name of this module. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">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. </p>
</p>
<h3 class="faldoc_funcname"><a name="vmModuleVersionInfo">vmModuleVersionInfo()</a></h3>
<p class="item_brief">Returns an array containing current module version informations. </p>
<p class="faldoc_funcdecl">vmModuleVersionInfo</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">Major, minor and revision numbers of the curerntly being executed module, in a 3 elements array. </td></tr>
</table>
<h3 class="faldoc_funcname"><a name="vmSearchPath">vmSearchPath()</a></h3>
<p class="item_brief">Returns the application specific load path. </p>
<p class="faldoc_funcdecl">vmSearchPath</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">A module search path as set by the application when creating the virtual machine. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text"> 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 <a href="./functions.html#include">include</a> function, the compiler Feather module and similar facilities. </p>
</p>
<h3 class="faldoc_funcname"><a name="vmSystemType">vmSystemType()</a></h3>
<p class="item_brief">Returns a descriptive name of the overall system architecture. </p>
<p class="faldoc_funcdecl">vmSystemType</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">A string containing a small descriptiuon of the system architecture. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">Currently, it can be "WIN" on the various MS-Windows flavours and POSIX on Linux, BSD, Solaris, Mac-OSX and other *nix based systems. </p>
</p>
<h3 class="faldoc_funcname"><a name="vmVersionInfo">vmVersionInfo()</a></h3>
<p class="item_brief">Returns an array containing VM version informations. </p>
<p class="faldoc_funcdecl">vmVersionInfo</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">Major, minor and revision numbers of the running virtual machine in a 3 elements array. </td></tr>
</table>
<h3 class="faldoc_funcname"><a name="vmVersionName">vmVersionName()</a></h3>
<p class="item_brief">Returns the nickname for this VM version. </p>
<p class="faldoc_funcdecl">vmVersionName</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">A string containing the symbolic name of this VM version. </td></tr>
</table>
<hr/>
<div class="navibottom">
<center>
<a href="./index.html">Main</a> - <a href="./pages.html">Related pages</a> - <a href="./groups.html">Groups</a> - <a href="./funset.html">Function sets</a> - <a href="./classes.html">Classes</a> - <a href="./objects.html">Objects</a> - <a href="./functions.html">All functions</a> - <a href="./globals.html">Globals</a>
</center>
</div>
</div>
<div class="faldoc_signature">Made with <a href="http://www.falconpl.org">faldoc 2.2.0</div>
</body>
</html>
