Sophie

Sophie

distrib > Mandriva > 8.2 > i586 > media > contrib > by-pkgid > 070b5c05d42a76a25abd916d2fe11a39 > files > 60

ccscript-1.8.4-2mdk.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ScriptModule class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.5 on Tue Oct 9 20:52:05 2001 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ScriptModule  Class Reference</h1>This class is used for generic ccScript <a class="el" href="class_dso.html">DSO</a> plugins. ccScript loadable module. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="script_h-source.html">script.h</a>&gt;</code>
<p>
<a href="class_scriptmodule-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="class_scriptmodule.html#b0">moduleAttach</a> (<a class="el" href="class_scriptinterp.html">ScriptInterp</a> *interp)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Method to call for handling script attach events.</em> <a href="#b0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="class_scriptmodule.html#b1">moduleDetach</a> (<a class="el" href="class_scriptinterp.html">ScriptInterp</a> *interp)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Method to call for handling script detach events.</em> <a href="#b1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual char*&nbsp;</td><td valign=bottom><a class="el" href="class_scriptmodule.html#b2">getSession</a> (<a class="el" href="class_scriptinterp.html">ScriptInterp</a> *interp, <a class="el" href="script_h.html#a3">scriptline_t</a> *line, <a class="el" href="class_scriptsession.html">ScriptSession</a> **session)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Check for script handler.</em> <a href="#b2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual char*&nbsp;</td><td valign=bottom><a class="el" href="class_scriptmodule.html#b3">checkScript</a> (<a class="el" href="script_h.html#a3">scriptline_t</a> *line, <a class="el" href="class_scriptimage.html">ScriptImage</a> *img)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Validate script command for parser.</em> <a href="#b3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_scriptmodule.html#b4">ScriptModule</a> (const char *name)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Construct and link-in a command handler.</em> <a href="#b4">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>ScriptModule*&nbsp;</td><td valign=bottom><a class="el" href="class_scriptmodule.html#e0">find</a> (const char *name)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Find a given module.</em> <a href="#e0">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Friends</h2></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="#l0">ScriptInterp</a></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="#l1">ScriptCommand</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class is used for generic ccScript <a class="el" href="class_dso.html">DSO</a> plugins. ccScript loadable module.
<p>
This allows plugins to become part of the base ccScript engine.
<p>
<dl compact><dt>
<b>Author(s): </b><dd>
 David Sugar &lt;<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>&gt; </dl>
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="b4" doxytag="ScriptModule::ScriptModule"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
ScriptModule::ScriptModule (
          </b></td>
          <td valign="bottom"><b>
const char * <em>name</em>&nbsp;)<code> [protected]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Construct and link-in a command handler.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em>
&nbsp;</td><td>
 of command being created. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="b3" doxytag="ScriptModule::checkScript"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
char * ScriptModule::checkScript (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="script_h.html#a3">scriptline_t</a> * <em>line</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
<a class="el" href="class_scriptimage.html">ScriptImage</a> * <em>img</em>&nbsp;)<code> [inline, protected, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Validate script command for parser.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
 error string or NULL if ok. </dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>script</em>
&nbsp;</td><td>
 line evaluated. </td></tr>
<tr><td valign=top><em>image</em>
&nbsp;</td><td>
 set analyzed. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="e0" doxytag="ScriptModule::find"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
ScriptModule * ScriptModule::find (
          </b></td>
          <td valign="bottom"><b>
const char * <em>name</em>&nbsp;)<code> [static, protected]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Find a given module.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
 module found. </dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>module</em>
&nbsp;</td><td>
 name. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="b2" doxytag="ScriptModule::getSession"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
char * ScriptModule::getSession (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="class_scriptinterp.html">ScriptInterp</a> * <em>interp</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
<a class="el" href="script_h.html#a3">scriptline_t</a> * <em>line</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
<a class="el" href="class_scriptsession.html">ScriptSession</a> ** <em>session</em>&nbsp;)<code> [inline, protected, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Check for script handler.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
 error string. </dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>interpreter</em>
&nbsp;</td><td>
 image. </td></tr>
<tr><td valign=top><em>line</em>
&nbsp;</td><td>
 object parsed. </td></tr>
<tr><td valign=top><em>pointer</em>
&nbsp;</td><td>
 to session handler. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="b0" doxytag="ScriptModule::moduleAttach"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
void ScriptModule::moduleAttach (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="class_scriptinterp.html">ScriptInterp</a> * <em>interp</em>&nbsp;)<code> [inline, protected, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Method to call for handling script attach events.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>interpreter</em>
&nbsp;</td><td>
 being attached. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="b1" doxytag="ScriptModule::moduleDetach"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
void ScriptModule::moduleDetach (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="class_scriptinterp.html">ScriptInterp</a> * <em>interp</em>&nbsp;)<code> [inline, protected, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Method to call for handling script detach events.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>interpreter</em>
&nbsp;</td><td>
 being detached. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a name="l1" doxytag="ScriptModule::ScriptCommand"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
class ScriptCommand<code> [friend]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="l0" doxytag="ScriptModule::ScriptInterp"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
class ScriptInterp<code> [friend]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="script_h-source.html">script.h</a></ul>
<hr><address><small>Generated at Tue Oct 9 20:52:05 2001 for ccscript by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
 &copy;&nbsp;1997-2001</small></address>
</body>
</html>