<!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::ScriptSymbol 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::ScriptSymbol Class Reference</h1>This class manages symbol tables for the scripting engine. Symbol table management for scripting engine.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="script_8h-source.html">script.h</a>></code>
<p>
<p>Inheritance diagram for ost::ScriptSymbol::
<p><center><img src="classost_1_1_script_symbol.gif" usemap="#ost::ScriptSymbol_map" border="0"></center>
<map name="ost::ScriptSymbol_map">
<area href="class_shared_mem_pager.html" alt="SharedMemPager" shape="rect" coords="0,0,114,24">
<area href="classost_1_1_script_interp.html" alt="ost::ScriptInterp" shape="rect" coords="0,112,114,136">
</map>
<a href="classost_1_1_script_symbol-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceost.html#a5">scriptsymbol_t</a> * </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#a0">getTrigger</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Fetch a pending trigger value and clear it.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#a1">getSymbolSize</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Fetch default symbol size.</em> <a href="#a1">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_symbol.html#a2">ScriptSymbol</a> (int size, int pgsize=1024)</td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#a3">getSymbol</a> (const char *symbol)</td></tr>
<tr><td> </td><td><font size=-1><em>Fetch the address of the value of a given symbol identifier.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#a4">setSymbol</a> (const char *symbol, const char *value="")</td></tr>
<tr><td> </td><td><font size=-1><em>Set a given symbol to a new value.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#a5">setConst</a> (const char *symbol, const char *value="")</td></tr>
<tr><td> </td><td><font size=-1><em>Set a constant value.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#a6">makeSequence</a> (const char *id, unsigned char count, unsigned char recsize)</td></tr>
<tr><td> </td><td><font size=-1><em>Create a sequence object (looping fifo).</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#a7">makeStack</a> (const char *id, unsigned char count, unsigned char recsize)</td></tr>
<tr><td> </td><td><font size=-1><em>Create a stack object.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#a8">makeFifo</a> (const char *id, unsigned char count, unsigned char recsize)</td></tr>
<tr><td> </td><td><font size=-1><em>Create a fifo object.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#a9">makeCounter</a> (const char *id)</td></tr>
<tr><td> </td><td><font size=-1><em>Create an automatic counter object.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#a10">postSymbol</a> (<a class="el" href="namespaceost.html#a5">scriptsymbol_t</a> *sym, const char *value)</td></tr>
<tr><td> </td><td><font size=-1><em>Post data into a fifo.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#a11">readSymbol</a> (<a class="el" href="namespaceost.html#a5">scriptsymbol_t</a> *sym)</td></tr>
<tr><td> </td><td><font size=-1><em>Read symbol handles special symbol types.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#a12">setAlias</a> (const char *symbol, const char *source)</td></tr>
<tr><td> </td><td><font size=-1><em>Set an alias.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceost.html#a5">scriptsymbol_t</a> * </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#a13">getAlias</a> (const char *symbol)</td></tr>
<tr><td> </td><td><font size=-1><em>Get an alias.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#a14">setSymbol</a> (const char *symbol, int size=0)</td></tr>
<tr><td> </td><td><font size=-1><em>Create a new symbol entry of a specified size.</em> <a href="#a14">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#a15">clrSymbol</a> (const char *id)</td></tr>
<tr><td> </td><td><font size=-1><em>Clear a symbol definition.</em> <a href="#a15">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#a16">Purge</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Purge user defined symbols and memory space.</em> <a href="#a16">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespaceost.html#a5">scriptsymbol_t</a> * </td><td valign=bottom><a class="el" href="classost_1_1_script_symbol.html#b0">getEntry</a> (const char *symbol, int size=0)</td></tr>
<tr><td> </td><td><font size=-1><em>Fetch a symbol entry.</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_symbol.html#b1">Commit</a> (<a class="el" href="namespaceost.html#a5">scriptsymbol_t</a> *sym)</td></tr>
<tr><td> </td><td><font size=-1><em>A virtual method used when "committing" symbol changes.</em> <a href="#b1">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_symbol.html#l0">ScriptInterp</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class manages symbol tables for the scripting engine. Symbol table management for scripting engine.
<p>
A symbol is a variable with a reserved memory space. Some derived systems, like Bayonne IVR, may make use of a channel specific and global symbol tables.
<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="a2" doxytag="ost::ScriptSymbol::ScriptSymbol"></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::ScriptSymbol::ScriptSymbol </td>
<td class="md">( </td>
<td class="md">int</td>
<td class="mdname"> <em>size</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">int</td>
<td class="mdname"> <em>pgsize</em> = 1024</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="b1" doxytag="ost::ScriptSymbol::Commit"></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::ScriptSymbol::Commit </td>
<td class="md">( </td>
<td class="md"><a class="el" href="namespaceost.html#a5">scriptsymbol_t</a> *</td>
<td class="mdname1"> <em>sym</em> </td>
<td class="md">) </td>
<td class="md"><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
A virtual method used when "committing" symbol changes.
<p>
Normally this is a non-operation, but when system specific dialects are created, special symbols that must be converted from strings into other kinds of internal data types, or that might perform operations can be represented with the commit.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>symbol
</em> </td><td>
to commit. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a16" doxytag="ost::ScriptSymbol::Purge"></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"> void ost::ScriptSymbol::Purge </td>
<td class="md">( </td>
<td class="md">void</td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Purge user defined symbols and memory space.
<p>
</td>
</tr>
</table>
<a name="a15" doxytag="ost::ScriptSymbol::clrSymbol"></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"> void ost::ScriptSymbol::clrSymbol </td>
<td class="md">( </td>
<td class="md">const char *</td>
<td class="mdname1"> <em>id</em> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Clear a symbol definition.
<p>
This does not remove the entry if it already exists. It mearly clears the initial flag so it still can appear undefined.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>symbol
</em> </td><td>
name to clear. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a13" doxytag="ost::ScriptSymbol::getAlias"></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"> <a class="el" href="namespaceost.html#a5">scriptsymbol_t</a>* ost::ScriptSymbol::getAlias </td>
<td class="md">( </td>
<td class="md">const char *</td>
<td class="mdname1"> <em>symbol</em> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get an alias.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>symbol
</em> </td><td>
name to find. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
script symbol object or NULL. </dl> </td>
</tr>
</table>
<a name="b0" doxytag="ost::ScriptSymbol::getEntry"></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 <a class="el" href="namespaceost.html#a5">scriptsymbol_t</a>* ost::ScriptSymbol::getEntry </td>
<td class="md">( </td>
<td class="md">const char *</td>
<td class="mdname"> <em>symbol</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">int</td>
<td class="mdname"> <em>size</em> = 0</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fetch a symbol entry.
<p>
Normally this is presumed to be from the native symbol table. However, the use of a virtual allows one to derive special "system" symbols as needed for Bayonne dialects, as well as specify special attributes and properties for system symbols. For example, in the Bayonne IVR, symbols might be used to retrieve the current DTMF digit buffer and count, but these are stored as and manipulated in a channel structure rather than in "symbol space".
<p>
<dl compact><dt><b>
Returns: </b><dd>
symbol entry or NULL if not found. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>symbol
</em> </td><td>
name to find or create. </td></tr>
<tr><td valign=top><em>size
</em> </td><td>
of symbol space to create if not found. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a3" doxytag="ost::ScriptSymbol::getSymbol"></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"> char* ost::ScriptSymbol::getSymbol </td>
<td class="md">( </td>
<td class="md">const char *</td>
<td class="mdname1"> <em>symbol</em> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fetch the address of the value of a given symbol identifier.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>symbol
</em> </td><td>
name. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
symbol buffer address, or NULL if not found. </dl> </td>
</tr>
</table>
<a name="a1" doxytag="ost::ScriptSymbol::getSymbolSize"></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"> int ost::ScriptSymbol::getSymbolSize </td>
<td class="md">( </td>
<td class="md">void</td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fetch default symbol size.
<p>
<dl compact><dt><b>
Returns: </b><dd>
default symbol size. </dl> </td>
</tr>
</table>
<a name="a0" doxytag="ost::ScriptSymbol::getTrigger"></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"> <a class="el" href="namespaceost.html#a5">scriptsymbol_t</a>* ost::ScriptSymbol::getTrigger </td>
<td class="md">( </td>
<td class="md">void</td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fetch a pending trigger value and clear it.
<p>
<dl compact><dt><b>
Returns: </b><dd>
symbol trigger that is active. </dl> </td>
</tr>
</table>
<a name="a9" doxytag="ost::ScriptSymbol::makeCounter"></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"> bool ost::ScriptSymbol::makeCounter </td>
<td class="md">( </td>
<td class="md">const char *</td>
<td class="mdname1"> <em>id</em> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Create an automatic counter object.
<p>
<dl compact><dt><b>
Returns: </b><dd>
false if fail. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name
</em> </td><td>
of counter. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a8" doxytag="ost::ScriptSymbol::makeFifo"></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"> bool ost::ScriptSymbol::makeFifo </td>
<td class="md">( </td>
<td class="md">const char *</td>
<td class="mdname"> <em>id</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">unsigned char</td>
<td class="mdname"> <em>count</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">unsigned char</td>
<td class="mdname"> <em>recsize</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Create a fifo object.
<p>
<dl compact><dt><b>
Returns: </b><dd>
false if fail. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name
</em> </td><td>
of fifo. </td></tr>
<tr><td valign=top><em>number
</em> </td><td>
of records. </td></tr>
<tr><td valign=top><em>size
</em> </td><td>
of record. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a6" doxytag="ost::ScriptSymbol::makeSequence"></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"> bool ost::ScriptSymbol::makeSequence </td>
<td class="md">( </td>
<td class="md">const char *</td>
<td class="mdname"> <em>id</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">unsigned char</td>
<td class="mdname"> <em>count</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">unsigned char</td>
<td class="mdname"> <em>recsize</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Create a sequence object (looping fifo).
<p>
<dl compact><dt><b>
Returns: </b><dd>
false if fail. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name
</em> </td><td>
of sequence. </td></tr>
<tr><td valign=top><em>max.
</em> </td><td>
number of sequences. </td></tr>
<tr><td valign=top><em>size
</em> </td><td>
of sequence data record. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a7" doxytag="ost::ScriptSymbol::makeStack"></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"> bool ost::ScriptSymbol::makeStack </td>
<td class="md">( </td>
<td class="md">const char *</td>
<td class="mdname"> <em>id</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">unsigned char</td>
<td class="mdname"> <em>count</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">unsigned char</td>
<td class="mdname"> <em>recsize</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Create a stack object.
<p>
<dl compact><dt><b>
Returns: </b><dd>
false if fail. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name
</em> </td><td>
of stack. </td></tr>
<tr><td valign=top><em>number
</em> </td><td>
of entries. </td></tr>
<tr><td valign=top><em>size
</em> </td><td>
of record. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a10" doxytag="ost::ScriptSymbol::postSymbol"></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"> bool ost::ScriptSymbol::postSymbol </td>
<td class="md">( </td>
<td class="md"><a class="el" href="namespaceost.html#a5">scriptsymbol_t</a> *</td>
<td class="mdname"> <em>sym</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">const char *</td>
<td class="mdname"> <em>value</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Post data into a fifo.
<p>
<dl compact><dt><b>
Returns: </b><dd>
false if full. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>symbol
</em> </td><td>
object to post. </td></tr>
<tr><td valign=top><em>data
</em> </td><td>
value to post. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a11" doxytag="ost::ScriptSymbol::readSymbol"></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"> char* ost::ScriptSymbol::readSymbol </td>
<td class="md">( </td>
<td class="md"><a class="el" href="namespaceost.html#a5">scriptsymbol_t</a> *</td>
<td class="mdname1"> <em>sym</em> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Read symbol handles special symbol types.
<p>
<dl compact><dt><b>
Returns: </b><dd>
data of symbol. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>symbol.
</em> </td><td>
</td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a12" doxytag="ost::ScriptSymbol::setAlias"></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"> bool ost::ScriptSymbol::setAlias </td>
<td class="md">( </td>
<td class="md">const char *</td>
<td class="mdname"> <em>symbol</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">const char *</td>
<td class="mdname"> <em>source</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set an alias.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>symbol
</em> </td><td>
name to alias. </td></tr>
<tr><td valign=top><em>value
</em> </td><td>
of alias to set. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
bool if not set, else value. </dl> </td>
</tr>
</table>
<a name="a5" doxytag="ost::ScriptSymbol::setConst"></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"> char* ost::ScriptSymbol::setConst </td>
<td class="md">( </td>
<td class="md">const char *</td>
<td class="mdname"> <em>symbol</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">const char *</td>
<td class="mdname"> <em>value</em> = ""</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set a constant value.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>symbol
</em> </td><td>
name to find. </td></tr>
<tr><td valign=top><em>value
</em> </td><td>
string to set. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
NULL if not found, else value. </dl> </td>
</tr>
</table>
<a name="a14" doxytag="ost::ScriptSymbol::setSymbol"></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"> char* ost::ScriptSymbol::setSymbol </td>
<td class="md">( </td>
<td class="md">const char *</td>
<td class="mdname"> <em>symbol</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">int</td>
<td class="mdname"> <em>size</em> = 0</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Create a new symbol entry of a specified size.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>symbol
</em> </td><td>
name to create. </td></tr>
<tr><td valign=top><em>size
</em> </td><td>
of symbol, otherwise default size used. </td></tr>
<tr><td valign=top><em>buffer
</em> </td><td>
or NULL if exists. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a4" doxytag="ost::ScriptSymbol::setSymbol"></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"> char* ost::ScriptSymbol::setSymbol </td>
<td class="md">( </td>
<td class="md">const char *</td>
<td class="mdname"> <em>symbol</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">const char *</td>
<td class="mdname"> <em>value</em> = ""</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set a given symbol to a new value.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>symbol
</em> </td><td>
name to find. </td></tr>
<tr><td valign=top><em>value
</em> </td><td>
string to set. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
NULL if not found, else value. </dl> </td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a name="l0" doxytag="ost::ScriptSymbol::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
>
99
