<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Class _BaseCompiler - Class _BaseCompiler</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="./modules.html"><span>Modules</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="./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="./enum.html"><span>Enumerations</span></a></li>
</ul>
</div>
</div>
<hr/>
<h1 class="faldoc_title">Class _BaseCompiler<span class="faldoc_belong"><a href="./module_feather_compiler.html">[in Compiler]</a></p></h1>
<p class="faldoc_brief"> Abstract base class for the <a href="./class_Compiler.html">Compiler</a> and <a href="./class_ICompiler.html">ICompiler</a> classes. </p>
<p class="faldoc_funcdecl">
<b>class</b> _BaseCompiler
</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="#alwaysRecomp">alwaysRecomp</a></td><td>If true, a load method finding a valid .fam that may substitute a .fal will ignore it, and will try to compile and load the .fal instead.</td></tr>
<tr><td><a href="#compileInMemory">compileInMemory</a></td><td>If true (the default) intermediate compilation steps are performed in memory.</td></tr>
<tr><td><a href="#ignoreSources">ignoreSources</a></td><td>If true, sources are ignored, and only .fam or shared object/dynamic link libraries will be loaded.</td></tr>
<tr><td><a href="#language">language</a></td><td>Language code used to load language-specific string tables.</td></tr>
<tr><td><a href="#launchAtLink">launchAtLink</a></td><td>If true, the __main__ function (that is, the entry point) of the loaded modules is executed before returning it.</td></tr>
<tr><td><a href="#path">path</a></td><td>The search path for modules loaded by name.</td></tr>
<tr><td><a href="#saveMandatory">saveMandatory</a></td><td>If true, when saveModule option is true too and a module can't be serialized, the compiler raises an exception.</td></tr>
<tr><td><a href="#saveModules">saveModules</a></td><td>If true, once compiled a source that is located on a local file system, the compiler will also try to save the .fam pre-compiled module, that may be used if the same module is loaded a second time.</td></tr>
<tr><td><a href="#sourceEncoding">sourceEncoding</a></td><td>The encoding of the source file.</td></tr>
<tr><td><a href="#addFalconPath">addFalconPath()</a></td><td>Adds the default system paths to the path searched by this compiler. </td></tr>
<tr><td><a href="#setDirective">setDirective()</a></td><td>Compiles a script on the fly. </td></tr>
</table>
<a name="more"><h2 class="faldoc_title">Detailed description</h2></a>
<p class="faldoc_funcdecl">
<b>class</b> _BaseCompiler
</p>
<table class="faldoc_function">
</table>
<br/>
<p class="item_brief"> Abstract base class for the <a href="./class_Compiler.html">Compiler</a> and <a href="./class_ICompiler.html">ICompiler</a> classes. </p>
<p class="faldoc_text"> This base class is used to put some common properties at disposal of both the subclasses: the standard <a href="./class_Compiler.html">Compiler</a>, and the <a href="./class_ICompiler.html">ICompiler</a>(Incremental Compiler) that allows live evaluation in a protected children virtual machine. </p>
<h2 class="faldoc_title">Properties</h2>
<h3 class="faldoc_funcname"><a name="alwaysRecomp">alwaysRecomp</a></h3>
<p class="item_brief">If true, a load method finding a valid .fam that may substitute a .fal will ignore it, and will try to compile and load the .fal instead.</p>
<h3 class="faldoc_funcname"><a name="compileInMemory">compileInMemory</a></h3>
<p class="item_brief">If true (the default) intermediate compilation steps are performed in memory.</p>
<h3 class="faldoc_funcname"><a name="ignoreSources">ignoreSources</a></h3>
<p class="item_brief">If true, sources are ignored, and only .fam or shared object/dynamic link libraries will be loaded.</p>
<h3 class="faldoc_funcname"><a name="language">language</a></h3>
<p class="item_brief">Language code used to load language-specific string tables.</p>
<h3 class="faldoc_funcname"><a name="launchAtLink">launchAtLink</a></h3>
<p class="item_brief">If true, the __main__ function (that is, the entry point) of the loaded modules is executed before returning it.</p>
<h3 class="faldoc_funcname"><a name="path">path</a></h3>
<p class="item_brief">The search path for modules loaded by name.</p>
<h3 class="faldoc_funcname"><a name="saveMandatory">saveMandatory</a></h3>
<p class="item_brief">If true, when saveModule option is true too and a module can't be serialized, the compiler raises an exception.</p>
<h3 class="faldoc_funcname"><a name="saveModules">saveModules</a></h3>
<p class="item_brief">If true, once compiled a source that is located on a local file system, the compiler will also try to save the .fam pre-compiled module, that may be used if the same module is loaded a second time.</p>
<h3 class="faldoc_funcname"><a name="sourceEncoding">sourceEncoding</a></h3>
<p class="item_brief">The encoding of the source file.</p>
<h2 class="faldoc_title">Methods</h2>
<h3 class="faldoc_funcname"><a name="addFalconPath">addFalconPath()</a></h3>
<p class="item_brief">Adds the default system paths to the path searched by this compiler. </p>
<p class="faldoc_funcdecl">_BaseCompiler.addFalconPath( )</p>
<p class="faldoc_text"><p class="faldoc_text">This method instructs the compiler that the default search path used by Falcon engine should be also searched when loading modules. This means that the directory in which official Falcon modules are stored, or those set in the FALCON_LOAD_PATH environment variables, or compiled in for a particular installation of Falcon, will be searched whenever loading a module. </p>
<p class="faldoc_text"> The paths are inserted at the beginning; so, they will be the first searched. It is possible then to alter the search path by changing the <b><i>Compiler.path</i></b> property and i.e. prepending a desired local search path to it. </p>
</p>
<h3 class="faldoc_funcname"><a name="setDirective">setDirective()</a></h3>
<p class="item_brief">Compiles a script on the fly. </p>
<p class="faldoc_funcdecl">_BaseCompiler.setDirective( dt, value )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">dt</td><td class="faldoc_paramdesc">Directive to be set. </td></tr><tr><td class="faldoc_param">value</td><td class="faldoc_paramdesc">Value to be given to the directive. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc"> On success, a <a href="./class_Module.html">Module</a> instance that contains the loaded module. </td></tr>
<tr><td class="faldoc_raise">Raises:</td><td class="faldoc_raisedesc">
<table class="faldoc_raise">
<tr><td class="faldoc_raiseitem"><b><i>SyntaxError</i></b></td><td class="faldoc_raisedesc">if the module contains logical error. </td></tr><tr><td class="faldoc_raiseitem"><b><i>IoError</i></b></td><td class="faldoc_raisedesc">if the input data is a file stream and there have been a read failure. </td></tr>
</table>
</td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">Sets a directive as if the scripts that will be loaded by this compiler defined it through the directive statement. Scripts can always override a directive by setting it to a different value in their code; notice also that compilation directives are useful only if a compilation actually take places. In case a .fam or a binary module is loaded, they have no effect. </p>
</p>
<hr/>
<div class="navibottom">
<center>
<a href="./index.html">Main</a> - <a href="./modules.html">Modules</a> - <a href="./pages.html">Related pages</a> - <a href="./groups.html">Groups</a> - <a href="./classes.html">Classes</a> - <a href="./objects.html">Objects</a> - <a href="./functions.html">All functions</a> - <a href="./enum.html">Enumerations</a>
</center>
</div>
</div>
<div class="faldoc_signature">Made with <a href="http://www.falconpl.org">faldoc 2.2.0</div>
</body>
</html>
