PageRenderTime 41ms CodeModel.GetById 13ms RepoModel.GetById 0ms app.codeStats 0ms

/lib/cpluff/doc/reference/c-api/group__cFuncsSymbols.html

https://gitlab.com/sloshedpuppie/LetsGoRetro
HTML | 186 lines | 176 code | 9 blank | 1 comment | 0 complexity | fe7230dcfaa02b289bd005952b6f9d2b MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
    3. 

  3. <title>C-Pluff C API: Dynamic symbols</title>
    4. 

  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
    5. 

  5. <link href="tabs.css" rel="stylesheet" type="text/css">
    6. 

  6. </head><body>
    7. 

  7. <!-- Generated by Doxygen 1.5.1 -->
    8. 

  8. <div class="tabs">
    9. 

  9.   <ul>
    10. 

  10.     <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    11. 

  11.     <li><a href="modules.html"><span>Modules</span></a></li>
    12. 

  12.     <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    13. 

  13.     <li><a href="files.html"><span>Files</span></a></li>
    14. 

  14.     <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
    15. 

  15.   </ul></div>
    16. 

  16. <h1>Dynamic symbols<br>
    17. 

  17. <small>
    18. 

  18. [<a class="el" href="group__cFuncs.html">Functions</a>]</small>
    19. 

  19. </h1><hr><a name="_details"></a><h2>Detailed Description</h2>
    20. 

  20. These functions can be used to dynamically access symbols exported by the plug-ins. 
    21. 

  21. <p>
    22. 

  22. They are intended to be used by a plug-in runtime or by the main program. 
    23. 

  23. <p>
    24. 

  24. <table border="0" cellpadding="0" cellspacing="0">
    25. 

  25. <tr><td></td></tr>
    26. 

  26. <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
    27. 

  27. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__cEnums.html#gd6a8106d281ffa4b1f43fe8e3effc7da">cp_status_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cFuncsSymbols.html#g9d128b52c0ffe2d4215026fe59f9abeb">cp_define_symbol</a> (<a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a> *ctx, const char *name, void *ptr)</td></tr>
    28. 

  28. 

  29. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Defines a context specific symbol.  <a href="#g9d128b52c0ffe2d4215026fe59f9abeb"></a><br></td></tr>
    30. 

  30. <tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cFuncsSymbols.html#g8bc3b7fcf4f4ed414837f5a3998d46b7">cp_resolve_symbol</a> (<a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a> *ctx, const char *id, const char *name, <a class="el" href="group__cEnums.html#gd6a8106d281ffa4b1f43fe8e3effc7da">cp_status_t</a> *status)</td></tr>
    31. 

  31. 

  32. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resolves a symbol provided by the specified plug-in.  <a href="#g8bc3b7fcf4f4ed414837f5a3998d46b7"></a><br></td></tr>
    33. 

  33. <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cFuncsSymbols.html#g150629125a61ac9fa4e2095b0d9c7e57">cp_release_symbol</a> (<a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a> *ctx, const void *ptr)</td></tr>
    34. 

  34. 

  35. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Releases a previously obtained symbol.  <a href="#g150629125a61ac9fa4e2095b0d9c7e57"></a><br></td></tr>
    36. 

  36. </table>
    37. 

  37. <hr><h2>Function Documentation</h2>
    38. 

  38. <a class="anchor" name="g9d128b52c0ffe2d4215026fe59f9abeb"></a><!-- doxytag: member="cpluff.h::cp_define_symbol" ref="g9d128b52c0ffe2d4215026fe59f9abeb" args="(cp_context_t *ctx, const char *name, void *ptr)" -->
    39. 

  39. <div class="memitem">
    40. 

  40. <div class="memproto">
    41. 

  41.       <table class="memname">
    42. 

  42.         <tr>
    43. 

  43.           <td class="memname"><a class="el" href="group__cEnums.html#gd6a8106d281ffa4b1f43fe8e3effc7da">cp_status_t</a> cp_define_symbol           </td>
    44. 

  44.           <td>(</td>
    45. 

  45.           <td class="paramtype"><a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a> *&nbsp;</td>
    46. 

  46.           <td class="paramname"> <em>ctx</em>, </td>
    47. 

  47.         </tr>
    48. 

  48.         <tr>
    49. 

  49.           <td class="paramkey"></td>
    50. 

  50.           <td></td>
    51. 

  51.           <td class="paramtype">const char *&nbsp;</td>
    52. 

  52.           <td class="paramname"> <em>name</em>, </td>
    53. 

  53.         </tr>
    54. 

  54.         <tr>
    55. 

  55.           <td class="paramkey"></td>
    56. 

  56.           <td></td>
    57. 

  57.           <td class="paramtype">void *&nbsp;</td>
    58. 

  58.           <td class="paramname"> <em>ptr</em></td><td>&nbsp;</td>
    59. 

  59.         </tr>
    60. 

  60.         <tr>
    61. 

  61.           <td></td>
    62. 

  62.           <td>)</td>
    63. 

  63.           <td></td><td></td><td width="100%"></td>
    64. 

  64.         </tr>
    65. 

  65.       </table>
    66. 

  66. </div>
    67. 

  67. <div class="memdoc">
    68. 

  68. 

  69. <p>
    70. 

  70. Defines a context specific symbol. 
    71. 

  71. <p>
    72. 

  72. If a plug-in has symbols which have a plug-in instance specific value then the plug-in should define those symbols when it is started. The defined symbols are cleared automatically when the plug-in instance is stopped. Symbols can not be redefined.<p>
    73. 

  73. <dl compact><dt><b>Parameters:</b></dt><dd>
    74. 

  74.   <table border="0" cellspacing="2" cellpadding="0">
    75. 

  75.     <tr><td valign="top"></td><td valign="top"><em>ctx</em>&nbsp;</td><td>the plug-in context </td></tr>
    76. 

  76.     <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>the name of the symbol </td></tr>
    77. 

  77.     <tr><td valign="top"></td><td valign="top"><em>ptr</em>&nbsp;</td><td>pointer value for the symbol </td></tr>
    78. 

  78.   </table>
    79. 

  79. </dl>
    80. 

  80. <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="group__cEnums.html#ggd6a8106d281ffa4b1f43fe8e3effc7da5ffbe0fe80af75e699e4b04909912f7a">CP_OK</a> (zero) on success or a status code on failure </dd></dl>
    81. 

  81. 

  82. </div>
    83. 

  83. </div><p>
    84. 

  84. <a class="anchor" name="g8bc3b7fcf4f4ed414837f5a3998d46b7"></a><!-- doxytag: member="cpluff.h::cp_resolve_symbol" ref="g8bc3b7fcf4f4ed414837f5a3998d46b7" args="(cp_context_t *ctx, const char *id, const char *name, cp_status_t *status)" -->
    85. 

  85. <div class="memitem">
    86. 

  86. <div class="memproto">
    87. 

  87.       <table class="memname">
    88. 

  88.         <tr>
    89. 

  89.           <td class="memname">void* cp_resolve_symbol           </td>
    90. 

  90.           <td>(</td>
    91. 

  91.           <td class="paramtype"><a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a> *&nbsp;</td>
    92. 

  92.           <td class="paramname"> <em>ctx</em>, </td>
    93. 

  93.         </tr>
    94. 

  94.         <tr>
    95. 

  95.           <td class="paramkey"></td>
    96. 

  96.           <td></td>
    97. 

  97.           <td class="paramtype">const char *&nbsp;</td>
    98. 

  98.           <td class="paramname"> <em>id</em>, </td>
    99. 

  99.         </tr>
    100. 

  100.         <tr>
    101. 

  101.           <td class="paramkey"></td>
    102. 

  102.           <td></td>
    103. 

  103.           <td class="paramtype">const char *&nbsp;</td>
    104. 

  104.           <td class="paramname"> <em>name</em>, </td>
    105. 

  105.         </tr>
    106. 

  106.         <tr>
    107. 

  107.           <td class="paramkey"></td>
    108. 

  108.           <td></td>
    109. 

  109.           <td class="paramtype"><a class="el" href="group__cEnums.html#gd6a8106d281ffa4b1f43fe8e3effc7da">cp_status_t</a> *&nbsp;</td>
    110. 

  110.           <td class="paramname"> <em>status</em></td><td>&nbsp;</td>
    111. 

  111.         </tr>
    112. 

  112.         <tr>
    113. 

  113.           <td></td>
    114. 

  114.           <td>)</td>
    115. 

  115.           <td></td><td></td><td width="100%"></td>
    116. 

  116.         </tr>
    117. 

  117.       </table>
    118. 

  118. </div>
    119. 

  119. <div class="memdoc">
    120. 

  120. 

  121. <p>
    122. 

  122. Resolves a symbol provided by the specified plug-in. 
    123. 

  123. <p>
    124. 

  124. The plug-in is started automatically if it is not already active. The symbol may be context specific or global. The framework first looks for a context specific symbol and then falls back to resolving a global symbol exported by the plug-in runtime library. The symbol can be released using <a class="el" href="group__cFuncsSymbols.html#g150629125a61ac9fa4e2095b0d9c7e57">cp_release_symbol</a> when it is not needed anymore. Pointers obtained from this function must not be passed on to other plug-ins or the main program.<p>
    125. 

  125. When a plug-in runtime calls this function the plug-in framework creates a dynamic dependency from the symbol using plug-in to the symbol defining plug-in. The symbol using plug-in is stopped automatically if the symbol defining plug-in is about to be stopped. If the symbol using plug-in does not explicitly release the symbol then it is automatically released after a call to the stop function. It is not safe to refer to a dynamically resolved symbol in the stop function except to release it using <a class="el" href="group__cFuncsSymbols.html#g150629125a61ac9fa4e2095b0d9c7e57">cp_release_symbol</a>.<p>
    126. 

  126. When the main program calls this function it is the responsibility of the main program to always release the symbol before the symbol defining plug-in is stopped. It is a fatal error if the symbol is not released before the symbol defining plug-in is stopped.<p>
    127. 

  127. <dl compact><dt><b>Parameters:</b></dt><dd>
    128. 

  128.   <table border="0" cellspacing="2" cellpadding="0">
    129. 

  129.     <tr><td valign="top"></td><td valign="top"><em>ctx</em>&nbsp;</td><td>the plug-in context </td></tr>
    130. 

  130.     <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>the identifier of the symbol defining plug-in </td></tr>
    131. 

  131.     <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>the name of the symbol </td></tr>
    132. 

  132.     <tr><td valign="top"></td><td valign="top"><em>status</em>&nbsp;</td><td>a pointer to the location where the status code is to be stored, or NULL </td></tr>
    133. 

  133.   </table>
    134. 

  134. </dl>
    135. 

  135. <dl class="return" compact><dt><b>Returns:</b></dt><dd>the pointer associated with the symbol or NULL on failure </dd></dl>
    136. 

  136. 

  137. </div>
    138. 

  138. </div><p>
    139. 

  139. <a class="anchor" name="g150629125a61ac9fa4e2095b0d9c7e57"></a><!-- doxytag: member="cpluff.h::cp_release_symbol" ref="g150629125a61ac9fa4e2095b0d9c7e57" args="(cp_context_t *ctx, const void *ptr)" -->
    140. 

  140. <div class="memitem">
    141. 

  141. <div class="memproto">
    142. 

  142.       <table class="memname">
    143. 

  143.         <tr>
    144. 

  144.           <td class="memname">void cp_release_symbol           </td>
    145. 

  145.           <td>(</td>
    146. 

  146.           <td class="paramtype"><a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a> *&nbsp;</td>
    147. 

  147.           <td class="paramname"> <em>ctx</em>, </td>
    148. 

  148.         </tr>
    149. 

  149.         <tr>
    150. 

  150.           <td class="paramkey"></td>
    151. 

  151.           <td></td>
    152. 

  152.           <td class="paramtype">const void *&nbsp;</td>
    153. 

  153.           <td class="paramname"> <em>ptr</em></td><td>&nbsp;</td>
    154. 

  154.         </tr>
    155. 

  155.         <tr>
    156. 

  156.           <td></td>
    157. 

  157.           <td>)</td>
    158. 

  158.           <td></td><td></td><td width="100%"></td>
    159. 

  159.         </tr>
    160. 

  160.       </table>
    161. 

  161. </div>
    162. 

  162. <div class="memdoc">
    163. 

  163. 

  164. <p>
    165. 

  165. Releases a previously obtained symbol. 
    166. 

  166. <p>
    167. 

  167. The pointer must not be used after the symbol has been released. The symbol is released only after as many calls to this function as there have been for <a class="el" href="group__cFuncsSymbols.html#g8bc3b7fcf4f4ed414837f5a3998d46b7">cp_resolve_symbol</a> for the same plug-in and symbol.<p>
    168. 

  168. <dl compact><dt><b>Parameters:</b></dt><dd>
    169. 

  169.   <table border="0" cellspacing="2" cellpadding="0">
    170. 

  170.     <tr><td valign="top"></td><td valign="top"><em>ctx</em>&nbsp;</td><td>the plug-in context </td></tr>
    171. 

  171.     <tr><td valign="top"></td><td valign="top"><em>ptr</em>&nbsp;</td><td>the pointer associated with the symbol </td></tr>
    172. 

  172.   </table>
    173. 

  173. </dl>
    174. 

  174. 

  175. </div>
    176. 

  176. </div><p>
    177. 

  177. <hr size="1">
    178. 

  178. <p class="footer">
    179. 

  179. <a href="http://www.c-pluff.org/">C-Pluff</a>, a plug-in framework for C<br>
    180. 

  180. Copyright 2007 <a href="http://www.jlehtinen.net/">Johannes Lehtinen</a>
    181. 

  181. </p>
    182. 

  182. <p class="generated-by">
    183. 

  183. Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1
    184. 

  184. </p>
    185. 

  185. </body>
    186. 

  186. </html>
    187. 

  187.