<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ost::ScriptModule class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.10 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> </center>
<hr><h1>ost::ScriptModule Class Reference</h1>This class is used for generic ccScript <a class="el" href="class_d_s_o.html">DSO</a> plugins. ccScript loadable module.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="script_8h-source.html">script.h</a>></code>
<p>
<a href="classost_1_1_script_module-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 </td><td valign=bottom><a class="el" href="classost_1_1_script_module.html#b0">moduleAttach</a> (<a class="el" href="classost_1_1_script_interp.html">ScriptInterp</a> *interp)</td></tr>
<tr><td> </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 </td><td valign=bottom><a class="el" href="classost_1_1_script_module.html#b1">moduleDetach</a> (<a class="el" href="classost_1_1_script_interp.html">ScriptInterp</a> *interp)</td></tr>
<tr><td> </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 * </td><td valign=bottom><a class="el" href="classost_1_1_script_module.html#b2">getSession</a> (<a class="el" href="classost_1_1_script_interp.html">ScriptInterp</a> *interp, <a class="el" href="namespaceost.html#a6">scriptline_t</a> *line, <a class="el" href="classost_1_1_script_session.html">ScriptSession</a> **session)</td></tr>
<tr><td> </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 * </td><td valign=bottom><a class="el" href="classost_1_1_script_module.html#b3">checkScript</a> (<a class="el" href="namespaceost.html#a6">scriptline_t</a> *line, <a class="el" href="classost_1_1_script_image.html">ScriptImage</a> *img)</td></tr>
<tr><td> </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> </td><td valign=bottom><a class="el" href="classost_1_1_script_module.html#b4">ScriptModule</a> (const char *name)</td></tr>
<tr><td> </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 * </td><td valign=bottom><a class="el" href="classost_1_1_script_module.html#e0">find</a> (const char *name)</td></tr>
<tr><td> </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 </td><td valign=bottom><a class="el" href="classost_1_1_script_module.html#l0">ScriptInterp</a></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classost_1_1_script_module.html#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_d_s_o.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: </b><dd>
David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="b4" doxytag="ost::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 class="md" nowrap valign="top"> ost::ScriptModule::ScriptModule </td>
<td class="md">( </td>
<td class="md">const char *</td>
<td class="mdname1"> <em>name</em> </td>
<td class="md">) </td>
<td class="md"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</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> </td><td>
of command being created. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="b3" doxytag="ost::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 class="md" nowrap valign="top"> virtual char* ost::ScriptModule::checkScript </td>
<td class="md">( </td>
<td class="md"><a class="el" href="namespaceost.html#a6">scriptline_t</a> *</td>
<td class="mdname"> <em>line</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md"><a class="el" href="classost_1_1_script_image.html">ScriptImage</a> *</td>
<td class="mdname"> <em>img</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</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> </td><td>
line evaluated. </td></tr>
<tr><td valign=top><em>image
</em> </td><td>
set analyzed. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="e0" doxytag="ost::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 class="md" nowrap valign="top"> ScriptModule* ost::ScriptModule::find </td>
<td class="md">( </td>
<td class="md">const char *</td>
<td class="mdname1"> <em>name</em> </td>
<td class="md">) </td>
<td class="md"><code> [static, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</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> </td><td>
name. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="b2" doxytag="ost::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 class="md" nowrap valign="top"> virtual char* ost::ScriptModule::getSession </td>
<td class="md">( </td>
<td class="md"><a class="el" href="classost_1_1_script_interp.html">ScriptInterp</a> *</td>
<td class="mdname"> <em>interp</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md"><a class="el" href="namespaceost.html#a6">scriptline_t</a> *</td>
<td class="mdname"> <em>line</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md"><a class="el" href="classost_1_1_script_session.html">ScriptSession</a> **</td>
<td class="mdname"> <em>session</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</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> </td><td>
image. </td></tr>
<tr><td valign=top><em>line
</em> </td><td>
object parsed. </td></tr>
<tr><td valign=top><em>pointer
</em> </td><td>
to session handler. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="b0" doxytag="ost::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 class="md" nowrap valign="top"> virtual void ost::ScriptModule::moduleAttach </td>
<td class="md">( </td>
<td class="md"><a class="el" href="classost_1_1_script_interp.html">ScriptInterp</a> *</td>
<td class="mdname1"> <em>interp</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</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> </td><td>
being attached. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="b1" doxytag="ost::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 class="md" nowrap valign="top"> virtual void ost::ScriptModule::moduleDetach </td>
<td class="md">( </td>
<td class="md"><a class="el" href="classost_1_1_script_interp.html">ScriptInterp</a> *</td>
<td class="mdname1"> <em>interp</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</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> </td><td>
being detached. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a name="l1" doxytag="ost::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 class="md" nowrap valign="top"> friend class ScriptCommand<code> [friend]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="l0" doxytag="ost::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 class="md" nowrap valign="top"> friend class ScriptInterp<code> [friend]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</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_8h-source.html">script.h</a></ul>
<hr><address><small>Generated at Fri Nov 2 09:22:25 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.10 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
8.2
>
i586
>
media
>
contrib
>
by-pkgid
>
070b5c05d42a76a25abd916d2fe11a39
>
files
>
89
