diff options
Diffstat (limited to 'zinclib.d/doc/html/ZincInternal_8hpp.html')
| -rw-r--r-- | zinclib.d/doc/html/ZincInternal_8hpp.html | 535 |
1 files changed, 535 insertions, 0 deletions
diff --git a/zinclib.d/doc/html/ZincInternal_8hpp.html b/zinclib.d/doc/html/ZincInternal_8hpp.html new file mode 100644 index 0000000..84befd3 --- /dev/null +++ b/zinclib.d/doc/html/ZincInternal_8hpp.html @@ -0,0 +1,535 @@ +<!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>IntuiKit: ZincInternal.hpp File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3.3 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</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="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div> +<h1>ZincInternal.hpp File Reference</h1> +<p> +<code>#include <string></code><br> +<code>#include "<a class="el" href="ZincObjects_8hpp-source.html">ZincObjects.hpp</a>"</code><br> + +<p> +<a href="ZincInternal_8hpp-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Defines</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="ZincInternal_8hpp.html#a0">MAX_NUM_LENGTH</a> 32</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="ZincInternal_8hpp.html#a1">Z_TCLCB</a> "zincTclCb"</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="ZincInternal_8hpp.html#a2">Z_BOO_POOL</a>(no, value) ( Tcl_SetBooleanObj (pool[no], value), pool[no] )</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="ZincInternal_8hpp.html#a3">Z_INT_POOL</a>(no, value) ( Tcl_SetIntObj (pool[no], value), pool[no] )</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="ZincInternal_8hpp.html#a4">Z_DBL_POOL</a>(no, value) ( Tcl_SetDoubleObj (pool[no], value), pool[no] )</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="ZincInternal_8hpp.html#a5">Z_STR_POOL</a>(no, value, length)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="ZincInternal_8hpp.html#a6">Z_LST_POOL</a>(no, value, size)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="ZincInternal_8hpp.html#a7">Z_CLEANLIST</a>(no) Tcl_SetIntObj (pool[no], 0)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="ZincInternal_8hpp.html#a8">Z_DEFINE_ZOPT</a>(string) Tcl_Obj* ZOPT_##string = Tcl_NewStringObj ("-" #string, -1);</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="ZincInternal_8hpp.html#a9">Z_DEFINE_ZFCT</a>(string) Tcl_Obj* ZFCT_##string = Tcl_NewStringObj (#string, -1);</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="ZincInternal_8hpp.html#a10">Z_DEFINE_ZITM</a>(string) Tcl_Obj* ZITM_##string = Tcl_NewStringObj (#string, -1);</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="ZincInternal_8hpp.html#a11">Z_PARENTGROUP</a>(parentGroup) ( (parentGroup != NULL) ? parentGroup->object : <a class="el" href="Zinc_8cpp.html#a4">DEFAULT_GROUP_OBJ</a> );</td></tr> + +<tr><td colspan=2><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="ZincInternal_8hpp.html#a12">itos</a> (int integer)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="ZincInternal_8hpp.html#a13">ltos</a> (long l)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="ZincInternal_8hpp.html#a14">dtos</a> (double d)</td></tr> + +</table> +<hr><h2>Define Documentation</h2> +<a name="a0" doxytag="ZincInternal.hpp::MAX_NUM_LENGTH"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> #define MAX_NUM_LENGTH 32 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<a class="el" href="ZincInternal_8hpp.html">ZincInternal.hpp</a> zinclib<p> +This software is the property of IntuiLab SA, France. See at the end of the file for the complete copyright notice<p> +Here we defines macros and constants that are only used within Zinclib code<p> +08/03/05<p> +Contributors: Benoit Peccatte <<a href="mailto:peccatte@intuilab.com">peccatte@intuilab.com</a>> David Thevenin <<a href="mailto:thevenin@intuilab.com">thevenin@intuilab.com</a>> </td> + </tr> +</table> +<a name="a2" doxytag="ZincInternal.hpp::Z_BOO_POOL"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> #define Z_BOO_POOL</td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">no, <tr> + <td></td> + <td></td> + <td class="md" nowrap>value </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> ( Tcl_SetBooleanObj (pool[no], value), pool[no] ) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +These are macro for shortness and readability of code. They take one Tcl_Obj from the pool and put one value into it. This object is returned. They all have the same signature.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign=top><em>no</em> </td><td>the id of the Tcl_Obj to take within the pool (max is ZINC_POOL_COUNT-1) </td></tr> + <tr><td valign=top><em>value</em> </td><td>the value to put in the extracted object </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the object from the pool </dd></dl> + </td> + </tr> +</table> +<a name="a7" doxytag="ZincInternal.hpp::Z_CLEANLIST"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> #define Z_CLEANLIST</td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">no </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> Tcl_SetIntObj (pool[no], 0) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Clear a list object. Tcl_Obj used in a list object have a refcount incremented and as such can't be reused for anything else. To free those object you need to clean the list object after use.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign=top><em>no</em> </td><td>the id of a Tcl_Obj within the pool which contains a list to clear </td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a name="a4" doxytag="ZincInternal.hpp::Z_DBL_POOL"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> #define Z_DBL_POOL</td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">no, <tr> + <td></td> + <td></td> + <td class="md" nowrap>value </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> ( Tcl_SetDoubleObj (pool[no], value), pool[no] ) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a name="a9" doxytag="ZincInternal.hpp::Z_DEFINE_ZFCT"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> #define Z_DEFINE_ZFCT</td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">string </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> Tcl_Obj* ZFCT_##string = Tcl_NewStringObj (#string, -1); + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a name="a10" doxytag="ZincInternal.hpp::Z_DEFINE_ZITM"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> #define Z_DEFINE_ZITM</td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">string </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> Tcl_Obj* ZITM_##string = Tcl_NewStringObj (#string, -1); + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a name="a8" doxytag="ZincInternal.hpp::Z_DEFINE_ZOPT"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> #define Z_DEFINE_ZOPT</td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">string </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> Tcl_Obj* ZOPT_##string = Tcl_NewStringObj ("-" #string, -1); + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Create a constant Tcl_Obj that can be reused as a parameter later<p> +string define the name and the value ov the object </td> + </tr> +</table> +<a name="a3" doxytag="ZincInternal.hpp::Z_INT_POOL"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> #define Z_INT_POOL</td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">no, <tr> + <td></td> + <td></td> + <td class="md" nowrap>value </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> ( Tcl_SetIntObj (pool[no], value), pool[no] ) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a name="a6" doxytag="ZincInternal.hpp::Z_LST_POOL"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> #define Z_LST_POOL</td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">no, <tr> + <td></td> + <td></td> + <td class="md" nowrap>value, <tr> + <td></td> + <td></td> + <td class="md" nowrap>size </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<b>Value:</b><div class="fragment"><pre>( Tcl_SetListObj (pool[no], size, value),\ + pool[no] ) +</pre></div>Make a list object<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign=top><em>no</em> </td><td>the id of the Tcl_Obj to take within the pool </td></tr> + <tr><td valign=top><em>value</em> </td><td>a table of pointer to Tcl_Obj to put in the list </td></tr> + <tr><td valign=top><em>size</em> </td><td>the number objects in the table </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>the list object from the pool </dd></dl> + </td> + </tr> +</table> +<a name="a11" doxytag="ZincInternal.hpp::Z_PARENTGROUP"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> #define Z_PARENTGROUP</td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">parentGroup </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> ( (parentGroup != NULL) ? parentGroup->object : <a class="el" href="Zinc_8cpp.html#a4">DEFAULT_GROUP_OBJ</a> ); + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Macro to return a parentGroup Tcl_Obj. If a NULL is group given, it returns the default one.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign=top><em>parentGroup</em> </td><td>the parent group to take </td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a name="a5" doxytag="ZincInternal.hpp::Z_STR_POOL"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> #define Z_STR_POOL</td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">no, <tr> + <td></td> + <td></td> + <td class="md" nowrap>value, <tr> + <td></td> + <td></td> + <td class="md" nowrap>length </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<b>Value:</b><div class="fragment"><pre>( Tcl_SetStringObj (pool[no], \ + value, length), \ + pool[no] ) +</pre></div> </td> + </tr> +</table> +<a name="a1" doxytag="ZincInternal.hpp::Z_TCLCB"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> #define Z_TCLCB "zincTclCb" + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<hr><h2>Function Documentation</h2> +<a name="a14" doxytag="ZincInternal.hpp::dtos"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string dtos </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">double </td> + <td class="mdname1" valign="top" nowrap> <em>d</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Convert a double to a string<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign=top><em>double</em> </td><td>the integer to convert </td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a name="a12" doxytag="ZincInternal.hpp::itos"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string itos </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">int </td> + <td class="mdname1" valign="top" nowrap> <em>integer</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Convert an integer to a string<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign=top><em>integer</em> </td><td>the integer to convert </td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a name="a13" doxytag="ZincInternal.hpp::ltos"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string ltos </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">long </td> + <td class="mdname1" valign="top" nowrap> <em>l</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Convert a long to a string<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign=top><em>l</em> </td><td>the long to convert </td></tr> + </table> +</dl> + </td> + </tr> +</table> +<hr size="1"><address style="align: right;"><small>Generated on Mon Apr 18 17:40:44 2005 for IntuiKit by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.3 </small></address> +</body> +</html> |