/usr/share/doc/libucommon-dev/a00124.html is in libucommon-doc 3.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>UCommon: ucc::script::interp Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00119.html">script</a>::<a class="el" href="a00124.html">interp</a>
</div>
</div>
<div class="contents">
<h1>ucc::script::interp Class Reference</h1><!-- doxytag: class="ucc::script::interp" --><!-- doxytag: inherits="ucc::memalloc" -->
<p>An instance of the runtime interpreter.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00202_source.html">script.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::script::interp:</div>
<div class="dynsection">
<div class="center"><img src="a00505.png" border="0" usemap="#ucc_1_1script_1_1interp_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1script_1_1interp_inherit__map" id="ucc_1_1script_1_1interp_inherit__map">
<area shape="rect" id="node5" href="a00127.html" title="Runtime methods collection class." alt="" coords="5,160,157,189"/><area shape="rect" id="node2" href="a00080.html" title="An alternate memory pager private heap manager." alt="" coords="24,5,139,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::script::interp:</div>
<div class="dynsection">
<div class="center"><img src="a00506.png" border="0" usemap="#ucc_1_1script_1_1interp_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1script_1_1interp_coll__map" id="ucc_1_1script_1_1interp_coll__map">
<area shape="rect" id="node2" href="a00080.html" title="An alternate memory pager private heap manager." alt="" coords="1291,5,1405,35"/><area shape="rect" id="node4" href="a00015.html" title="ucc::pointer\< script \>" alt="" coords="669,57,832,87"/><area shape="rect" id="node6" href="a00029.html" title="A general purpose smart pointer helper class." alt="" coords="347,61,480,91"/><area shape="rect" id="node8" href="a00093.html" title="A common base class for all managed objects." alt="" coords="5,105,99,135"/><area shape="rect" id="node10" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="188,191,321,220"/><area shape="rect" id="node19" href="a00123.html" title="Header describes a script section." alt="" coords="505,229,644,259"/><area shape="rect" id="node24" href="a00122.html" title="An event block for a script." alt="" coords="1061,301,1192,331"/><area shape="rect" id="node14" href="a00128.html" title="Runtime stack for each interpreter instance." alt="" coords="1277,211,1419,240"/><area shape="rect" id="node16" href="a00126.html" title="Basic compiled statement." alt="" coords="856,277,973,307"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a36a37af02314f0ede72ead6c8b2afb63"></a><!-- doxytag: member="ucc::script::interp::num_t" ref="a36a37af02314f0ede72ead6c8b2afb63" args="[16]" -->
typedef char </td><td class="memItemRight" valign="bottom"><b>num_t</b> [16]</td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#ac58bcdb1af8ce3ff399e0fe7b3fa0b2d">attach</a> (<a class="el" href="a00119.html">script</a> *image, const char *entry=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attach a compiled image to the interpreter and start. <a href="#ac58bcdb1af8ce3ff399e0fe7b3fa0b2d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#a18ee942b0428bbba675bd65445d07111">detach</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cleanup after interpreter run. <a href="#a18ee942b0428bbba675bd65445d07111"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#a9aecf0d447aec106aaf31d9578fa798e">error</a> (const char *text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Invoke runtime interpreter error handling. <a href="#a9aecf0d447aec106aaf31d9578fa798e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#ad1cd726bc1ca2dcfe705feec6056ebb4">getResource</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get current dsp resource mask. <a href="#ad1cd726bc1ca2dcfe705feec6056ebb4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#a94aa4d3784e895b2c75d15d566aeee34">initialize</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to initialize and purge the interpreter between runs. <a href="#a94aa4d3784e895b2c75d15d566aeee34"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#ad9cbd5f2321274bc28751fbdd8294d64">step</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Step through an instance of the interpreter. <a href="#ad9cbd5f2321274bc28751fbdd8294d64"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a544f6e0bf2e7748cdf6df6115d1f5da8"></a><!-- doxytag: member="ucc::script::interp::createSymbol" ref="a544f6e0bf2e7748cdf6df6115d1f5da8" args="(const char *id)" -->
<a class="el" href="a00130.html">symbol</a> * </td><td class="memItemRight" valign="bottom"><b>createSymbol</b> (const char *id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ccff9f2ae0ccbb1336ca1dcedca8715"></a><!-- doxytag: member="ucc::script::interp::find" ref="a4ccff9f2ae0ccbb1336ca1dcedca8715" args="(const char *id)" -->
<a class="el" href="a00130.html">symbol</a> * </td><td class="memItemRight" valign="bottom"><b>find</b> (const char *id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6db710a02da46b01fa42a095e0cb869e"></a><!-- doxytag: member="ucc::script::interp::getCondition" ref="a6db710a02da46b01fa42a095e0cb869e" args="(const char *test, const char *value)" -->
virtual bool </td><td class="memItemRight" valign="bottom"><b>getCondition</b> (const char *test, const char *value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20df64a15b38a060987dd7cb66905eb0"></a><!-- doxytag: member="ucc::script::interp::getContent" ref="a20df64a15b38a060987dd7cb66905eb0" args="(const char *text)" -->
const char * </td><td class="memItemRight" valign="bottom"><b>getContent</b> (const char *text)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3bcbce45d17cc0fd7f6737f2a579e242"></a><!-- doxytag: member="ucc::script::interp::getContent" ref="a3bcbce45d17cc0fd7f6737f2a579e242" args="(void)" -->
const char * </td><td class="memItemRight" valign="bottom"><b>getContent</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e9e49c8241048dad4909a04fc4ab955"></a><!-- doxytag: member="ucc::script::interp::getFormat" ref="a6e9e49c8241048dad4909a04fc4ab955" args="(symbol *sym, const char *id, char *temp)" -->
virtual const char * </td><td class="memItemRight" valign="bottom"><b>getFormat</b> (<a class="el" href="a00130.html">symbol</a> *sym, const char *id, char *temp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac00486dff7aec3d7428723aa9ee2b0b9"></a><!-- doxytag: member="ucc::script::interp::getIndex" ref="ac00486dff7aec3d7428723aa9ee2b0b9" args="(void)" -->
const char * </td><td class="memItemRight" valign="bottom"><b>getIndex</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb5347c78f3764a00b18376aba53f0f4"></a><!-- doxytag: member="ucc::script::interp::getKeyword" ref="adb5347c78f3764a00b18376aba53f0f4" args="(const char *id)" -->
const char * </td><td class="memItemRight" valign="bottom"><b>getKeyword</b> (const char *id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac383b5154b451cf6335dbbce23f887ff"></a><!-- doxytag: member="ucc::script::interp::getLooping" ref="ac383b5154b451cf6335dbbce23f887ff" args="(void)" -->
<a class="el" href="a00119.html#a7a4604f1296a11fb51b8a3a9471940ea">method_t</a> </td><td class="memItemRight" valign="bottom"><b>getLooping</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f2317efefd29fb832d4eb91506bd88f"></a><!-- doxytag: member="ucc::script::interp::getParams" ref="a7f2317efefd29fb832d4eb91506bd88f" args="(header *scope, line_t *line)" -->
void </td><td class="memItemRight" valign="bottom"><b>getParams</b> (<a class="el" href="a00123.html">header</a> *scope, <a class="el" href="a00126.html">line_t</a> *<a class="el" href="a00126.html">line</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a19fbe7468d5f10b3ff6bbfbc0970e029"></a><!-- doxytag: member="ucc::script::interp::getTemp" ref="a19fbe7468d5f10b3ff6bbfbc0970e029" args="(void)" -->
char * </td><td class="memItemRight" valign="bottom"><b>getTemp</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a894c52d18e1c7fc942bc0c8c8290143d"></a><!-- doxytag: member="ucc::script::interp::getTypeinit" ref="a894c52d18e1c7fc942bc0c8c8290143d" args="(const char *type_id)" -->
virtual const char * </td><td class="memItemRight" valign="bottom"><b>getTypeinit</b> (const char *type_id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75942379adab35bb347d3861b706a466"></a><!-- doxytag: member="ucc::script::interp::getTypesize" ref="a75942379adab35bb347d3861b706a466" args="(const char *type_id)" -->
virtual unsigned </td><td class="memItemRight" valign="bottom"><b>getTypesize</b> (const char *type_id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ce4a06a5cb4fe8df5374a95e9c32527"></a><!-- doxytag: member="ucc::script::interp::getValue" ref="a6ce4a06a5cb4fe8df5374a95e9c32527" args="(void)" -->
const char * </td><td class="memItemRight" valign="bottom"><b>getValue</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4725c917085c48908535981f22888bcc"></a><!-- doxytag: member="ucc::script::interp::getVar" ref="a4725c917085c48908535981f22888bcc" args="(const char *id, const char *value=NULL)" -->
<a class="el" href="a00130.html">symbol</a> * </td><td class="memItemRight" valign="bottom"><b>getVar</b> (const char *id, const char *value=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a346a4eec8fdd286d7803b8b2f787c1f2"></a><!-- doxytag: member="ucc::script::interp::isConditional" ref="a346a4eec8fdd286d7803b8b2f787c1f2" args="(unsigned index)" -->
bool </td><td class="memItemRight" valign="bottom"><b>isConditional</b> (unsigned index)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#ad87ecf2a2c7a63ecab123930afa94e73">isInherited</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to determine if an event handler should be treated as inherited/callable from the base script when requested from a defined block of code but not found there. <a href="#ad87ecf2a2c7a63ecab123930afa94e73"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#a18770ef080e57d0f82613ce8cd4cc4a9">match</a> (const char *pattern, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Define pattern match virtual. <a href="#a18770ef080e57d0f82613ce8cd4cc4a9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7349193d9831fbbdbc526f4ad70ae573"></a><!-- doxytag: member="ucc::script::interp::pop" ref="a7349193d9831fbbdbc526f4ad70ae573" args="(void)" -->
bool </td><td class="memItemRight" valign="bottom"><b>pop</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae50fb6ce9f1574e55b5a8bff9f6de7c9"></a><!-- doxytag: member="ucc::script::interp::pullBase" ref="ae50fb6ce9f1574e55b5a8bff9f6de7c9" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><b>pullBase</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a171ea1909d0d0f8ff26c86af0673c6"></a><!-- doxytag: member="ucc::script::interp::pullLoop" ref="a8a171ea1909d0d0f8ff26c86af0673c6" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><b>pullLoop</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14ad6df6454bb0761cdf780bcc2470ee"></a><!-- doxytag: member="ucc::script::interp::pullScope" ref="a14ad6df6454bb0761cdf780bcc2470ee" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><b>pullScope</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a753658d0625013711a13e9a2f0f44a5d"></a><!-- doxytag: member="ucc::script::interp::push" ref="a753658d0625013711a13e9a2f0f44a5d" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><b>push</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#a515fed6840f9507cee874a339521685c">scriptEvent</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Try to branch to a named event handler. <a href="#a515fed6840f9507cee874a339521685c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00122.html">event</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html#a3c01a37a09d6893f18f921729a0ff819">scriptMethod</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Search for an event object in the method table. <a href="#a3c01a37a09d6893f18f921729a0ff819"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a426bf2d1bb2d95f98fcec454f9a51794"></a><!-- doxytag: member="ucc::script::interp::setConst" ref="a426bf2d1bb2d95f98fcec454f9a51794" args="(const char *id, const char *value)" -->
bool </td><td class="memItemRight" valign="bottom"><b>setConst</b> (const char *id, const char *value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d4209200b64797337d63a4dec1c7137"></a><!-- doxytag: member="ucc::script::interp::setRef" ref="a8d4209200b64797337d63a4dec1c7137" args="(header *scope, const char *id, char *data, unsigned size)" -->
void </td><td class="memItemRight" valign="bottom"><b>setRef</b> (<a class="el" href="a00123.html">header</a> *scope, const char *id, char *data, unsigned size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a180a5719b1edab1c13ba2b068c812a0b"></a><!-- doxytag: member="ucc::script::interp::setStack" ref="a180a5719b1edab1c13ba2b068c812a0b" args="(header *scr, event *ev=NULL)" -->
void </td><td class="memItemRight" valign="bottom"><b>setStack</b> (<a class="el" href="a00123.html">header</a> *scr, <a class="el" href="a00122.html">event</a> *ev=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abcc38eba685bcdb41c0d1cee0b745909"></a><!-- doxytag: member="ucc::script::interp::skip" ref="abcc38eba685bcdb41c0d1cee0b745909" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><b>skip</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a933657d5ddbb5b9953a293ac066ea1f4"></a><!-- doxytag: member="ucc::script::interp::startScript" ref="a933657d5ddbb5b9953a293ac066ea1f4" args="(header *scr)" -->
void </td><td class="memItemRight" valign="bottom"><b>startScript</b> (<a class="el" href="a00123.html">header</a> *scr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7aaba8d3f887bed4c5561560b768a2c"></a><!-- doxytag: member="ucc::script::interp::tryexit" ref="ad7aaba8d3f887bed4c5561560b768a2c" args="(void)" -->
bool </td><td class="memItemRight" valign="bottom"><b>tryexit</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae26fd8ea7e05fc6dfc14a6ec38676bc8"></a><!-- doxytag: member="ucc::script::interp::trylabel" ref="ae26fd8ea7e05fc6dfc14a6ec38676bc8" args="(const char *id)" -->
bool </td><td class="memItemRight" valign="bottom"><b>trylabel</b> (const char *id)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e1258b2b55712155fcb4241f51dd4e6"></a><!-- doxytag: member="ucc::script::interp::frame" ref="a3e1258b2b55712155fcb4241f51dd4e6" args="" -->
unsigned </td><td class="memItemRight" valign="bottom"><b>frame</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d4b2ab47d10545de5b4fda097316b9c"></a><!-- doxytag: member="ucc::script::interp::image" ref="a3d4b2ab47d10545de5b4fda097316b9c" args="" -->
<a class="el" href="a00015.html">pointer</a>< <a class="el" href="a00119.html">script</a> > </td><td class="memItemRight" valign="bottom"><b>image</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9391e890a262f7a39efed6a275255b32"></a><!-- doxytag: member="ucc::script::interp::stack" ref="a9391e890a262f7a39efed6a275255b32" args="" -->
<a class="el" href="a00128.html">stack_t</a> * </td><td class="memItemRight" valign="bottom"><b>stack</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab63aec0e3bedb9a1db9b68e685acadfd"></a><!-- doxytag: member="ucc::script::interp::syms" ref="ab63aec0e3bedb9a1db9b68e685acadfd" args="" -->
<a class="el" href="a00069.html">LinkedObject</a> ** </td><td class="memItemRight" valign="bottom"><b>syms</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An instance of the runtime interpreter. </p>
<p>Some application servers, like GNU Bayonne, may create an interpreter instance for each telephone call session. All runtime execution happens through the interpreter class, which executes compiled script images. This is commonly used as a base class for runtime methods and application specific interpreters. All interpreter instance data and symbols are allocated off the interpreter instance private heap. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00202_source.html#l00256">256</a> of file <a class="el" href="a00202_source.html">script.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac58bcdb1af8ce3ff399e0fe7b3fa0b2d"></a><!-- doxytag: member="ucc::script::interp::attach" ref="ac58bcdb1af8ce3ff399e0fe7b3fa0b2d" args="(script *image, const char *entry=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::script::interp::attach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00119.html">script</a> * </td>
<td class="paramname"> <em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>entry</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Attach a compiled image to the interpreter and start. </p>
<p>Even when different entry points are called, the initialization block is always called. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>image</em> </td><td>to attach (ref count). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>entry</em> </td><td>point, NULL for "@main" </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true ifi successful, false if failed to find entry. </dd></dl>
</div>
</div>
<a class="anchor" id="a18ee942b0428bbba675bd65445d07111"></a><!-- doxytag: member="ucc::script::interp::detach" ref="a18ee942b0428bbba675bd65445d07111" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::script::interp::detach </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cleanup after interpreter run. </p>
<p>Releases reference to image. </p>
</div>
</div>
<a class="anchor" id="a9aecf0d447aec106aaf31d9578fa798e"></a><!-- doxytag: member="ucc::script::interp::error" ref="a9aecf0d447aec106aaf31d9578fa798e" args="(const char *text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::script::interp::error </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>text</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Invoke runtime interpreter error handling. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>to post into error symbol. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad1cd726bc1ca2dcfe705feec6056ebb4"></a><!-- doxytag: member="ucc::script::interp::getResource" ref="ad1cd726bc1ca2dcfe705feec6056ebb4" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ucc::script::interp::getResource </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get current dsp resource mask. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>resource mask. </dd></dl>
</div>
</div>
<a class="anchor" id="a94aa4d3784e895b2c75d15d566aeee34"></a><!-- doxytag: member="ucc::script::interp::initialize" ref="a94aa4d3784e895b2c75d15d566aeee34" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::script::interp::initialize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to initialize and purge the interpreter between runs. </p>
<p>This is used especially if the same interpreter object is kept in memory and directly re-used for multiple executions. </p>
</div>
</div>
<a class="anchor" id="ad87ecf2a2c7a63ecab123930afa94e73"></a><!-- doxytag: member="ucc::script::interp::isInherited" ref="ad87ecf2a2c7a63ecab123930afa94e73" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ucc::script::interp::isInherited </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to determine if an event handler should be treated as inherited/callable from the base script when requested from a defined block of code but not found there. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of event. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if is inherited. </dd></dl>
</div>
</div>
<a class="anchor" id="a18770ef080e57d0f82613ce8cd4cc4a9"></a><!-- doxytag: member="ucc::script::interp::match" ref="a18770ef080e57d0f82613ce8cd4cc4a9" args="(const char *pattern, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ucc::script::interp::match </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Define pattern match virtual. </p>
<p>This is used for the "$" conditional expression, for event dispatch, and for some searches. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>to match. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>we match with. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if pattern matches. </dd></dl>
</div>
</div>
<a class="anchor" id="a515fed6840f9507cee874a339521685c"></a><!-- doxytag: member="ucc::script::interp::scriptEvent" ref="a515fed6840f9507cee874a339521685c" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::script::interp::scriptEvent </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Try to branch to a named event handler. </p>
<p>If successful, the interpreter transfers control to the start of the handler for the next step. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of event to request. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if found. </dd></dl>
</div>
</div>
<a class="anchor" id="a3c01a37a09d6893f18f921729a0ff819"></a><!-- doxytag: member="ucc::script::interp::scriptMethod" ref="a3c01a37a09d6893f18f921729a0ff819" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00122.html">event</a>* ucc::script::interp::scriptMethod </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Search for an event object in the method table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>to search for. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>method if found. </dd></dl>
</div>
</div>
<a class="anchor" id="ad9cbd5f2321274bc28751fbdd8294d64"></a><!-- doxytag: member="ucc::script::interp::step" ref="ad9cbd5f2321274bc28751fbdd8294d64" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::script::interp::step </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Step through an instance of the interpreter. </p>
<p>This can step through multiple lines at once, depending on <a class="el" href="a00119.html#af6b81a273da048bcfafde61350effb54" title="default stepping increment">script::stepping</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if still running, false if exited. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00202_source.html">script.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:43 2010 for UCommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|