/usr/share/doc/libucommon-dev/a00119.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 | <!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 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>
</div>
</div>
<div class="contents">
<h1>ucc::script Class Reference</h1><!-- doxytag: class="ucc::script" --><!-- doxytag: inherits="ucc::CountedObject,ucc::memalloc" -->
<p>Compiled script container.
<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:</div>
<div class="dynsection">
<div class="center"><img src="a00497.png" border="0" usemap="#ucc_1_1script_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1script_inherit__map" id="ucc_1_1script_inherit__map">
<area shape="rect" id="node2" href="a00043.html" title="A base class for reference counted objects." alt="" coords="5,83,152,112"/><area shape="rect" id="node4" href="a00093.html" title="A common base class for all managed objects." alt="" coords="32,5,125,35"/><area shape="rect" id="node6" href="a00080.html" title="An alternate memory pager private heap manager." alt="" coords="176,83,291,112"/></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:</div>
<div class="dynsection">
<div class="center"><img src="a00498.png" border="0" usemap="#ucc_1_1script_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1script_coll__map" id="ucc_1_1script_coll__map">
<area shape="rect" id="node2" href="a00043.html" title="A base class for reference counted objects." alt="" coords="347,12,493,42"/><area shape="rect" id="node4" href="a00093.html" title="A common base class for all managed objects." alt="" coords="5,64,99,94"/><area shape="rect" id="node10" href="a00029.html" title="A general purpose smart pointer helper class." alt="" coords="188,64,321,94"/><area shape="rect" id="node17" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="188,194,321,223"/><area shape="rect" id="node6" href="a00080.html" title="An alternate memory pager private heap manager." alt="" coords="887,402,1001,431"/><area shape="rect" id="node8" href="a00015.html" title="ucc::pointer\< script \>" alt="" coords="688,60,851,90"/><area shape="rect" id="node13" href="a00099.html" title="An index container for maintaining an ordered list of objects." alt="" coords="875,187,1013,216"/><area shape="rect" id="node15" href="a00100.html" title="A linked object base class for ordered objects." alt="" coords="519,195,663,224"/><area shape="rect" id="node24" href="a00123.html" title="Header describes a script section." alt="" coords="521,295,660,324"/><area shape="rect" id="node21" href="a00126.html" title="Basic compiled statement." alt="" coords="885,282,1003,311"/></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>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00120.html">checks</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A container class for compile-time check methods. <a href="a00120.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00121.html">error</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A class to collect compile-time errors. <a href="a00121.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html">event</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An event block for a script. <a href="a00122.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00123.html">header</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Header describes a script section. <a href="a00123.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00124.html">interp</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An instance of the runtime interpreter. <a href="a00124.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="a00125.html">keyword</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A structure to introduce new core commands to the runtime engine. <a href="a00125.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="a00126.html">line</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Basic compiled statement. <a href="a00126.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00127.html">methods</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Runtime methods collection class. <a href="a00127.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="a00128.html">stack_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Runtime stack for each interpreter instance. <a href="a00128.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00129.html">strict</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Contains defined variables found by scope when strict is used. <a href="a00129.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00130.html">symbol</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Contains instance of a runtime symbol. <a href="a00130.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab592452c0370eb81a9ec6eaabd33a5dc"></a><!-- doxytag: member="ucc::script::check_t" ref="ab592452c0370eb81a9ec6eaabd33a5dc" args=")(script *img, script::header *scr, script::line_t *line)" -->
typedef const char *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#ab592452c0370eb81a9ec6eaabd33a5dc">check_t</a> )(<a class="el" href="a00119.html">script</a> *img, <a class="el" href="a00123.html">script::header</a> *scr, <a class="el" href="a00126.html">script::line_t</a> *<a class="el" href="a00126.html">line</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A type for compile-time command verification method invokation. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a681d9989d4467befe3e37161f07e6b6d"></a><!-- doxytag: member="ucc::script::event_t" ref="a681d9989d4467befe3e37161f07e6b6d" args="" -->
typedef <a class="el" href="a00122.html">event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a681d9989d4467befe3e37161f07e6b6d">event_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience typedef to allow use of event name. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00125.html">ucc::script::keyword</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#ac09d764c0e5c4fc6f7466f13e21578a4">keyword_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A structure to introduce new core commands to the runtime engine. <a href="#ac09d764c0e5c4fc6f7466f13e21578a4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00126.html">ucc::script::line</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#ab2db08f1bc82044b678221e147e8bfea">line_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Basic compiled statement. <a href="#ab2db08f1bc82044b678221e147e8bfea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a4604f1296a11fb51b8a3a9471940ea"></a><!-- doxytag: member="ucc::script::method_t" ref="a7a4604f1296a11fb51b8a3a9471940ea" args=")(void)" -->
typedef bool(script::interp::* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a7a4604f1296a11fb51b8a3a9471940ea">method_t</a> )(void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A type for runtime script method invokation. <br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9c04e6a53b43cfc80cd61ab8542f5d9"></a><!-- doxytag: member="ucc::script::getErrors" ref="ab9c04e6a53b43cfc80cd61ab8542f5d9" args="(void)" -->
unsigned </td><td class="memItemRight" valign="bottom"><b>getErrors</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a932c61de7e56fed550fb36714059de5b"></a><!-- doxytag: member="ucc::script::getFilename" ref="a932c61de7e56fed550fb36714059de5b" args="(void)" -->
const char * </td><td class="memItemRight" valign="bottom"><b>getFilename</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57e13427d98ff412d918f1cfee64ab63"></a><!-- doxytag: member="ucc::script::getLines" ref="a57e13427d98ff412d918f1cfee64ab63" args="(void)" -->
unsigned </td><td class="memItemRight" valign="bottom"><b>getLines</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0c95b4abd011fe27576b12305669715"></a><!-- doxytag: member="ucc::script::getListing" ref="ae0c95b4abd011fe27576b12305669715" args="(void)" -->
<a class="el" href="a00069.html">LinkedObject</a> * </td><td class="memItemRight" valign="bottom"><b>getListing</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76671b8322f35158d0425e014d1a5dd6"></a><!-- doxytag: member="ucc::script::isStrict" ref="a76671b8322f35158d0425e014d1a5dd6" args="(void)" -->
bool </td><td class="memItemRight" valign="bottom"><b>isStrict</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7519594bf715fa16468d60fa3343aa9"></a><!-- doxytag: member="ucc::script::looping" ref="ad7519594bf715fa16468d60fa3343aa9" args="(void)" -->
<a class="el" href="a00119.html#a7a4604f1296a11fb51b8a3a9471940ea">method_t</a> </td><td class="memItemRight" valign="bottom"><b>looping</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1392b2503011a15950b2eca2d5274ca6"></a><!-- doxytag: member="ucc::script::pull" ref="a1392b2503011a15950b2eca2d5274ca6" args="(void)" -->
<a class="el" href="a00119.html#a7a4604f1296a11fb51b8a3a9471940ea">method_t</a> </td><td class="memItemRight" valign="bottom"><b>pull</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa56b094177437993017c99f757ffbbd"></a><!-- doxytag: member="ucc::script::push" ref="aaa56b094177437993017c99f757ffbbd" args="(line_t *line)" -->
bool </td><td class="memItemRight" valign="bottom"><b>push</b> (<a class="el" href="a00126.html">line_t</a> *<a class="el" href="a00126.html">line</a>)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00119.html">script</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a449b6891f9866d038b66556d3a309ebb">append</a> (<a class="el" href="a00119.html">script</a> *merge, const char *filename, <a class="el" href="a00119.html">script</a> *config=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a file into an existing image. <a href="#a449b6891f9866d038b66556d3a309ebb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a3a37c6372c0ee3acc87b961537a8211b">assign</a> (<a class="el" href="a00125.html">keyword_t</a> *list)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign new keywords from extensions and derived service. <a href="#a3a37c6372c0ee3acc87b961537a8211b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00119.html">script</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a70ccfb986a7fa22640f9acbc2f99679d">compile</a> (const char *filename, <a class="el" href="a00119.html">script</a> *config=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compile a script file into an image. <a href="#a70ccfb986a7fa22640f9acbc2f99679d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a556bf2880090752aec5ae1134e133966"></a><!-- doxytag: member="ucc::script::copy" ref="a556bf2880090752aec5ae1134e133966" args="(const char *list, char *item, unsigned size)" -->
static void </td><td class="memItemRight" valign="bottom"><b>copy</b> (const char *list, char *item, unsigned size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8ff4400a40f5a2b4de47038a8442c067"></a><!-- doxytag: member="ucc::script::count" ref="a8ff4400a40f5a2b4de47038a8442c067" args="(const char *list)" -->
static unsigned </td><td class="memItemRight" valign="bottom"><b>count</b> (const char *list)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1cc7809b2c0f987fc6c9b95c2e7fab6"></a><!-- doxytag: member="ucc::script::find" ref="ac1cc7809b2c0f987fc6c9b95c2e7fab6" args="(script *img, const char *id)" -->
static <a class="el" href="a00123.html">header</a> * </td><td class="memItemRight" valign="bottom"><b>find</b> (<a class="el" href="a00119.html">script</a> *img, const char *id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00125.html">keyword_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a8d8a09302cecc6b3e8c8b0fba1613d73">find</a> (const char *id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a keyword from internal command table. <a href="#a8d8a09302cecc6b3e8c8b0fba1613d73"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a392f459e47fdd5441d541760cfc580b1"></a><!-- doxytag: member="ucc::script::get" ref="a392f459e47fdd5441d541760cfc580b1" args="(char *list, unsigned offset)" -->
static char * </td><td class="memItemRight" valign="bottom"><b>get</b> (char *list, unsigned offset)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae382eda76a780ab8670039f811518528"></a><!-- doxytag: member="ucc::script::get" ref="ae382eda76a780ab8670039f811518528" args="(const char *list, unsigned offset)" -->
static const char * </td><td class="memItemRight" valign="bottom"><b>get</b> (const char *list, unsigned offset)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#ac393ef84f086a494cceec0b5ad43da7a">init</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize entire script engine. <a href="#ac393ef84f086a494cceec0b5ad43da7a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afd82034d491ed33aec43c238293fc134"></a><!-- doxytag: member="ucc::script::isEvent" ref="afd82034d491ed33aec43c238293fc134" args="(header *scr, const char *id)" -->
static bool </td><td class="memItemRight" valign="bottom"><b>isEvent</b> (<a class="el" href="a00123.html">header</a> *scr, const char *id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00119.html">script</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a0db5149347096e2a84760179d6a566b0">merge</a> (const char *filename, <a class="el" href="a00119.html">script</a> *root=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compile and merge a script into an existing shared image. <a href="#a0db5149347096e2a84760179d6a566b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e34ecce95ae9985f24843ff0678db42"></a><!-- doxytag: member="ucc::script::offset" ref="a4e34ecce95ae9985f24843ff0678db42" args="(const char *list, unsigned index)" -->
static unsigned </td><td class="memItemRight" valign="bottom"><b>offset</b> (const char *list, unsigned index)</td></tr>
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a347eaaae1abd67340b8c209f051ad3"></a><!-- doxytag: member="ucc::script::first" ref="a0a347eaaae1abd67340b8c209f051ad3" args="" -->
<a class="el" href="a00123.html">header</a> * </td><td class="memItemRight" valign="bottom"><b>first</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7ee2acca7ea36bd8a2e8fb38c0d678b"></a><!-- doxytag: member="ucc::script::scripts" ref="af7ee2acca7ea36bd8a2e8fb38c0d678b" args="" -->
<a class="el" href="a00069.html">LinkedObject</a> ** </td><td class="memItemRight" valign="bottom"><b>scripts</b></td></tr>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4654b18dd8b3ab4953b3c9458dc8eb12"></a><!-- doxytag: member="ucc::script::decimals" ref="a4654b18dd8b3ab4953b3c9458dc8eb12" args="" -->
static unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a4654b18dd8b3ab4953b3c9458dc8eb12">decimals</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">default decimal places <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a009cb4f2225810b3376a14cd699c68b0"></a><!-- doxytag: member="ucc::script::indexing" ref="a009cb4f2225810b3376a14cd699c68b0" args="" -->
static unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a009cb4f2225810b3376a14cd699c68b0">indexing</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">default symbol indexing <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad5418d3ec068bd3483402eb0bc8e4198"></a><!-- doxytag: member="ucc::script::paging" ref="ad5418d3ec068bd3483402eb0bc8e4198" args="" -->
static size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#ad5418d3ec068bd3483402eb0bc8e4198">paging</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">default heap paging <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b37632881cc83b8516a6cc2bb59be13"></a><!-- doxytag: member="ucc::script::sizing" ref="a1b37632881cc83b8516a6cc2bb59be13" args="" -->
static unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a1b37632881cc83b8516a6cc2bb59be13">sizing</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">default symbol size <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9af0ee3395cbe8db4867b12743c7a023"></a><!-- doxytag: member="ucc::script::stacking" ref="a9af0ee3395cbe8db4867b12743c7a023" args="" -->
static unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#a9af0ee3395cbe8db4867b12743c7a023">stacking</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">stack frames in script runtime <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6b81a273da048bcfafde61350effb54"></a><!-- doxytag: member="ucc::script::stepping" ref="af6b81a273da048bcfafde61350effb54" args="" -->
static unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00119.html#af6b81a273da048bcfafde61350effb54">stepping</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">default stepping increment <br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae37262ce5c9b4604321c56b0782df7c6"></a><!-- doxytag: member="ucc::script::checks" ref="ae37262ce5c9b4604321c56b0782df7c6" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>checks</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f18ba04a2e7670af0c2bbaae938d4d5"></a><!-- doxytag: member="ucc::script::error" ref="a2f18ba04a2e7670af0c2bbaae938d4d5" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>error</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1fbf7340d70b65e7faca05ab7c7e9235"></a><!-- doxytag: member="ucc::script::interp" ref="a1fbf7340d70b65e7faca05ab7c7e9235" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>interp</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aca9e297cb443a5389e174023ead2689c"></a><!-- doxytag: member="ucc::script::methods" ref="aca9e297cb443a5389e174023ead2689c" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>methods</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a87a875076cc8a917e3caa701d4359b22"></a><!-- doxytag: member="ucc::script::strict" ref="a87a875076cc8a917e3caa701d4359b22" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>strict</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Compiled script container. </p>
<p>This class holds the image of a reference counted instance of a compiled script. </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#l00050">50</a> of file <a class="el" href="a00202_source.html">script.h</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="ac09d764c0e5c4fc6f7466f13e21578a4"></a><!-- doxytag: member="ucc::script::keyword_t" ref="ac09d764c0e5c4fc6f7466f13e21578a4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="a00125.html">ucc::script::keyword</a> <a class="el" href="a00125.html">ucc::script::keyword_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A structure to introduce new core commands to the runtime engine. </p>
<p>This is typically passed to assign as an array. Entries with no runtime method (method = NULL) are only processed at compile-time. </p>
</div>
</div>
<a class="anchor" id="ab2db08f1bc82044b678221e147e8bfea"></a><!-- doxytag: member="ucc::script::line_t" ref="ab2db08f1bc82044b678221e147e8bfea" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="a00126.html">ucc::script::line</a> <a class="el" href="a00126.html">ucc::script::line_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Basic compiled statement. </p>
<p>This is a linked list of statement lines, with an array of parsed statement arguments. An optional dsp resource mask value can be assigned by a check method on a per-line basis as well as at closure time for a script. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a449b6891f9866d038b66556d3a309ebb"></a><!-- doxytag: member="ucc::script::append" ref="a449b6891f9866d038b66556d3a309ebb" args="(script *merge, const char *filename, script *config=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00119.html">script</a>* ucc::script::append </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00119.html">script</a> * </td>
<td class="paramname"> <em>merge</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00119.html">script</a> * </td>
<td class="paramname"> <em>config</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Append a file into an existing image. </p>
<p>A shared config script can be used that holds common definitions. Multiple script files can also be merged together into a final image. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>merge</em> </td><td>with prior compiled script. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>to compile. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>config</em> </td><td>image of script with common definitions. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>compiled script object if successful. </dd></dl>
</div>
</div>
<a class="anchor" id="a3a37c6372c0ee3acc87b961537a8211b"></a><!-- doxytag: member="ucc::script::assign" ref="a3a37c6372c0ee3acc87b961537a8211b" args="(keyword_t *list)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void ucc::script::assign </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00125.html">keyword_t</a> * </td>
<td class="paramname"> <em>list</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign new keywords from extensions and derived service. </p>
<p>Must be called before any use. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>of keywords to add to engine. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a70ccfb986a7fa22640f9acbc2f99679d"></a><!-- doxytag: member="ucc::script::compile" ref="a70ccfb986a7fa22640f9acbc2f99679d" args="(const char *filename, script *config=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00119.html">script</a>* ucc::script::compile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00119.html">script</a> * </td>
<td class="paramname"> <em>config</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compile a script file into an image. </p>
<p>Creates the new image that will be used. A shared config script can be compiled and used to hold common definitions. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>to compile. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>config</em> </td><td>image of script with common definitions. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>compiled script object if successful. </dd></dl>
</div>
</div>
<a class="anchor" id="a8d8a09302cecc6b3e8c8b0fba1613d73"></a><!-- doxytag: member="ucc::script::find" ref="a8d8a09302cecc6b3e8c8b0fba1613d73" args="(const char *id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00125.html">keyword_t</a>* ucc::script::find </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find a keyword from internal command table. </p>
<p>This includes the core runtime engine keywords set through <a class="el" href="a00119.html#ac393ef84f086a494cceec0b5ad43da7a" title="Initialize entire script engine.">init()</a> and any derived ones added through assign. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>of command to find. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>keyword object for the command or NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="ac393ef84f086a494cceec0b5ad43da7a"></a><!-- doxytag: member="ucc::script::init" ref="ac393ef84f086a494cceec0b5ad43da7a" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void ucc::script::init </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize entire script engine. </p>
<p>Must be called first and once. </p>
</div>
</div>
<a class="anchor" id="a0db5149347096e2a84760179d6a566b0"></a><!-- doxytag: member="ucc::script::merge" ref="a0db5149347096e2a84760179d6a566b0" args="(const char *filename, script *root=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00119.html">script</a>* ucc::script::merge </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00119.html">script</a> * </td>
<td class="paramname"> <em>root</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compile and merge a script into an existing shared image. </p>
<p>This is related to compile, but the target script's definitions are linked into the base config script. Use NULL if no base. This is often used to compose lint images. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>to merge. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>root</em> </td><td>script to merge definitions with. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>compiled script instance if successful. </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:42 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>
|