structluwra_1_1StateWrapper.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414
  1. <!-- HTML header for doxygen 1.8.10-->
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  6. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  7. <meta name="generator" content="Doxygen 1.8.11"/>
  8. <title>Luwra: luwra::StateWrapper Struct Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13. <link href="stylesheet.css" rel="stylesheet" type="text/css"/>
  14. </head>
  15. <body>
  16. <div id="top">
  17. <!-- Generated by Doxygen 1.8.11 -->
  18. <div id="navrow1" class="tabs">
  19. <ul class="tablist">
  20. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  21. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  22. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  23. </ul>
  24. </div>
  25. <div id="navrow2" class="tabs2">
  26. <ul class="tablist">
  27. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  28. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  29. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  30. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  31. </ul>
  32. </div>
  33. <div id="nav-path" class="navpath">
  34. <ul>
  35. <li class="navelem"><a class="el" href="namespaceluwra.html">luwra</a></li><li class="navelem"><a class="el" href="structluwra_1_1StateWrapper.html">StateWrapper</a></li> </ul>
  36. </div>
  37. </div><!-- top -->
  38. <div class="header">
  39. <div class="summary">
  40. <a href="#pub-methods">Public Member Functions</a> &#124;
  41. <a href="#pub-attribs">Public Attributes</a> &#124;
  42. <a href="structluwra_1_1StateWrapper-members.html">List of all members</a> </div>
  43. <div class="headertitle">
  44. <div class="title">luwra::StateWrapper Struct Reference</div> </div>
  45. </div><!--header-->
  46. <div class="contents">
  47. <table class="memberdecls">
  48. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  49. Public Member Functions</h2></td></tr>
  50. <tr class="memitem:a2edf40dff6189f6a62f16d41439e6fa6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structluwra_1_1StateWrapper.html#a2edf40dff6189f6a62f16d41439e6fa6">StateWrapper</a> (<a class="el" href="namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d">State</a> *<a class="el" href="structluwra_1_1StateWrapper.html#ab5c6fb20675aec5710857c6962c598ff">state</a>)</td></tr>
  51. <tr class="separator:a2edf40dff6189f6a62f16d41439e6fa6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  52. <tr class="memitem:aa759d636fc1779af97b53383164d1ede"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structluwra_1_1StateWrapper.html#aa759d636fc1779af97b53383164d1ede">StateWrapper</a> ()</td></tr>
  53. <tr class="separator:aa759d636fc1779af97b53383164d1ede"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. <tr class="memitem:a9022ffd5a9777088b9be4e03f43287c9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structluwra_1_1StateWrapper.html#a9022ffd5a9777088b9be4e03f43287c9">~StateWrapper</a> ()</td></tr>
  55. <tr class="separator:a9022ffd5a9777088b9be4e03f43287c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:ab91a945d5071f5ba2f99336fba2fe85e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structluwra_1_1StateWrapper.html#ab91a945d5071f5ba2f99336fba2fe85e">operator State *</a> ()</td></tr>
  57. <tr class="separator:ab91a945d5071f5ba2f99336fba2fe85e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. <tr class="memitem:ae525c83eea1240690e8837c736dbdd8b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structluwra_1_1StateWrapper.html#ae525c83eea1240690e8837c736dbdd8b">loadStandardLibrary</a> ()</td></tr>
  59. <tr class="separator:ae525c83eea1240690e8837c736dbdd8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:adf43eedc990499465558aae162718feb"><td class="memTemplParams" colspan="2">template&lt;typename V &gt; </td></tr>
  61. <tr class="memitem:adf43eedc990499465558aae162718feb"><td class="memTemplItemLeft" align="right" valign="top">V&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structluwra_1_1StateWrapper.html#adf43eedc990499465558aae162718feb">getGlobal</a> (const std::string &amp;key) const </td></tr>
  62. <tr class="separator:adf43eedc990499465558aae162718feb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:ac8be165c08327f3a2cccd42ce114147a"><td class="memTemplParams" colspan="2">template&lt;typename V &gt; </td></tr>
  64. <tr class="memitem:ac8be165c08327f3a2cccd42ce114147a"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structluwra_1_1StateWrapper.html#ac8be165c08327f3a2cccd42ce114147a">setGlobal</a> (const std::string &amp;key, V value) const </td></tr>
  65. <tr class="separator:ac8be165c08327f3a2cccd42ce114147a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a2bf875af9f8734f3aaed3f3c69e7e98a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structluwra_1_1GlobalAccessor.html">GlobalAccessor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structluwra_1_1StateWrapper.html#a2bf875af9f8734f3aaed3f3c69e7e98a">operator[]</a> (const std::string &amp;key) const </td></tr>
  67. <tr class="separator:a2bf875af9f8734f3aaed3f3c69e7e98a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a841ea3be576b323feb0e0c4e73659d17"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  69. <tr class="memitem:a841ea3be576b323feb0e0c4e73659d17"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structluwra_1_1StateWrapper.html#a841ea3be576b323feb0e0c4e73659d17">registerUserType</a> (const std::string &amp;ctor_name, const <a class="el" href="namespaceluwra.html#a6dc0acb148bf26f49b0b27d6cad9bfe1">MemberMap</a> &amp;methods=<a class="el" href="namespaceluwra.html#a6dc0acb148bf26f49b0b27d6cad9bfe1">MemberMap</a>(), const <a class="el" href="namespaceluwra.html#a6dc0acb148bf26f49b0b27d6cad9bfe1">MemberMap</a> &amp;meta_methods=<a class="el" href="namespaceluwra.html#a6dc0acb148bf26f49b0b27d6cad9bfe1">MemberMap</a>())</td></tr>
  70. <tr class="separator:a841ea3be576b323feb0e0c4e73659d17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a1d73b27017627f90b7c5e7984c4f0c52"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structluwra_1_1StateWrapper.html#a1d73b27017627f90b7c5e7984c4f0c52">runString</a> (const std::string &amp;code)</td></tr>
  72. <tr class="separator:a1d73b27017627f90b7c5e7984c4f0c52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:a2247fc5292f6784e4cd3f55a68ba6f15"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structluwra_1_1StateWrapper.html#a2247fc5292f6784e4cd3f55a68ba6f15">runFile</a> (const std::string &amp;filepath)</td></tr>
  74. <tr class="separator:a2247fc5292f6784e4cd3f55a68ba6f15"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. </table><table class="memberdecls">
  76. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  77. Public Attributes</h2></td></tr>
  78. <tr class="memitem:ab5c6fb20675aec5710857c6962c598ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d">State</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structluwra_1_1StateWrapper.html#ab5c6fb20675aec5710857c6962c598ff">state</a></td></tr>
  79. <tr class="separator:ab5c6fb20675aec5710857c6962c598ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a55f83661f04e7c7ad21456207feeef01"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structluwra_1_1StateWrapper.html#a55f83661f04e7c7ad21456207feeef01">close_state</a></td></tr>
  81. <tr class="separator:a55f83661f04e7c7ad21456207feeef01"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. </table>
  83. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  84. <div class="textblock"><p>Wrapper for a Lua state </p>
  85. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  86. <a class="anchor" id="a2edf40dff6189f6a62f16d41439e6fa6"></a>
  87. <div class="memitem">
  88. <div class="memproto">
  89. <table class="mlabels">
  90. <tr>
  91. <td class="mlabels-left">
  92. <table class="memname">
  93. <tr>
  94. <td class="memname">luwra::StateWrapper::StateWrapper </td>
  95. <td>(</td>
  96. <td class="paramtype"><a class="el" href="namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d">State</a> *&#160;</td>
  97. <td class="paramname"><em>state</em></td><td>)</td>
  98. <td></td>
  99. </tr>
  100. </table>
  101. </td>
  102. <td class="mlabels-right">
  103. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  104. </tr>
  105. </table>
  106. </div><div class="memdoc">
  107. <p>Operate on a foreign state instance. </p>
  108. </div>
  109. </div>
  110. <a class="anchor" id="aa759d636fc1779af97b53383164d1ede"></a>
  111. <div class="memitem">
  112. <div class="memproto">
  113. <table class="mlabels">
  114. <tr>
  115. <td class="mlabels-left">
  116. <table class="memname">
  117. <tr>
  118. <td class="memname">luwra::StateWrapper::StateWrapper </td>
  119. <td>(</td>
  120. <td class="paramname"></td><td>)</td>
  121. <td></td>
  122. </tr>
  123. </table>
  124. </td>
  125. <td class="mlabels-right">
  126. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. <p>Create a new Lua state. </p>
  131. </div>
  132. </div>
  133. <a class="anchor" id="a9022ffd5a9777088b9be4e03f43287c9"></a>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="mlabels">
  137. <tr>
  138. <td class="mlabels-left">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">luwra::StateWrapper::~StateWrapper </td>
  142. <td>(</td>
  143. <td class="paramname"></td><td>)</td>
  144. <td></td>
  145. </tr>
  146. </table>
  147. </td>
  148. <td class="mlabels-right">
  149. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  150. </tr>
  151. </table>
  152. </div><div class="memdoc">
  153. </div>
  154. </div>
  155. <h2 class="groupheader">Member Function Documentation</h2>
  156. <a class="anchor" id="adf43eedc990499465558aae162718feb"></a>
  157. <div class="memitem">
  158. <div class="memproto">
  159. <div class="memtemplate">
  160. template&lt;typename V &gt; </div>
  161. <table class="mlabels">
  162. <tr>
  163. <td class="mlabels-left">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname">V luwra::StateWrapper::getGlobal </td>
  167. <td>(</td>
  168. <td class="paramtype">const std::string &amp;&#160;</td>
  169. <td class="paramname"><em>key</em></td><td>)</td>
  170. <td> const</td>
  171. </tr>
  172. </table>
  173. </td>
  174. <td class="mlabels-right">
  175. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>Retrieve a global value. </p>
  180. </div>
  181. </div>
  182. <a class="anchor" id="ae525c83eea1240690e8837c736dbdd8b"></a>
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="mlabels">
  186. <tr>
  187. <td class="mlabels-left">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">void luwra::StateWrapper::loadStandardLibrary </td>
  191. <td>(</td>
  192. <td class="paramname"></td><td>)</td>
  193. <td></td>
  194. </tr>
  195. </table>
  196. </td>
  197. <td class="mlabels-right">
  198. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. </div>
  203. </div>
  204. <a class="anchor" id="ab91a945d5071f5ba2f99336fba2fe85e"></a>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="mlabels">
  208. <tr>
  209. <td class="mlabels-left">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname">luwra::StateWrapper::operator <a class="el" href="namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d">State</a> * </td>
  213. <td>(</td>
  214. <td class="paramname"></td><td>)</td>
  215. <td></td>
  216. </tr>
  217. </table>
  218. </td>
  219. <td class="mlabels-right">
  220. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  221. </tr>
  222. </table>
  223. </div><div class="memdoc">
  224. </div>
  225. </div>
  226. <a class="anchor" id="a2bf875af9f8734f3aaed3f3c69e7e98a"></a>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="mlabels">
  230. <tr>
  231. <td class="mlabels-left">
  232. <table class="memname">
  233. <tr>
  234. <td class="memname"><a class="el" href="structluwra_1_1GlobalAccessor.html">GlobalAccessor</a> luwra::StateWrapper::operator[] </td>
  235. <td>(</td>
  236. <td class="paramtype">const std::string &amp;&#160;</td>
  237. <td class="paramname"><em>key</em></td><td>)</td>
  238. <td> const</td>
  239. </tr>
  240. </table>
  241. </td>
  242. <td class="mlabels-right">
  243. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  244. </tr>
  245. </table>
  246. </div><div class="memdoc">
  247. <p>Create an accessor to a global value. </p>
  248. </div>
  249. </div>
  250. <a class="anchor" id="a841ea3be576b323feb0e0c4e73659d17"></a>
  251. <div class="memitem">
  252. <div class="memproto">
  253. <div class="memtemplate">
  254. template&lt;typename T &gt; </div>
  255. <table class="mlabels">
  256. <tr>
  257. <td class="mlabels-left">
  258. <table class="memname">
  259. <tr>
  260. <td class="memname">void luwra::StateWrapper::registerUserType </td>
  261. <td>(</td>
  262. <td class="paramtype">const std::string &amp;&#160;</td>
  263. <td class="paramname"><em>ctor_name</em>, </td>
  264. </tr>
  265. <tr>
  266. <td class="paramkey"></td>
  267. <td></td>
  268. <td class="paramtype">const <a class="el" href="namespaceluwra.html#a6dc0acb148bf26f49b0b27d6cad9bfe1">MemberMap</a> &amp;&#160;</td>
  269. <td class="paramname"><em>methods</em> = <code><a class="el" href="namespaceluwra.html#a6dc0acb148bf26f49b0b27d6cad9bfe1">MemberMap</a>()</code>, </td>
  270. </tr>
  271. <tr>
  272. <td class="paramkey"></td>
  273. <td></td>
  274. <td class="paramtype">const <a class="el" href="namespaceluwra.html#a6dc0acb148bf26f49b0b27d6cad9bfe1">MemberMap</a> &amp;&#160;</td>
  275. <td class="paramname"><em>meta_methods</em> = <code><a class="el" href="namespaceluwra.html#a6dc0acb148bf26f49b0b27d6cad9bfe1">MemberMap</a>()</code>&#160;</td>
  276. </tr>
  277. <tr>
  278. <td></td>
  279. <td>)</td>
  280. <td></td><td></td>
  281. </tr>
  282. </table>
  283. </td>
  284. <td class="mlabels-right">
  285. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  286. </tr>
  287. </table>
  288. </div><div class="memdoc">
  289. <p>See <a class="el" href="namespaceluwra.html#a0a744cd63bf0d4f611a62b8a56df714e">luwra::registerUserType</a>. </p>
  290. </div>
  291. </div>
  292. <a class="anchor" id="a2247fc5292f6784e4cd3f55a68ba6f15"></a>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <table class="mlabels">
  296. <tr>
  297. <td class="mlabels-left">
  298. <table class="memname">
  299. <tr>
  300. <td class="memname">int luwra::StateWrapper::runFile </td>
  301. <td>(</td>
  302. <td class="paramtype">const std::string &amp;&#160;</td>
  303. <td class="paramname"><em>filepath</em></td><td>)</td>
  304. <td></td>
  305. </tr>
  306. </table>
  307. </td>
  308. <td class="mlabels-right">
  309. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  310. </tr>
  311. </table>
  312. </div><div class="memdoc">
  313. <p>Execute a file. </p>
  314. </div>
  315. </div>
  316. <a class="anchor" id="a1d73b27017627f90b7c5e7984c4f0c52"></a>
  317. <div class="memitem">
  318. <div class="memproto">
  319. <table class="mlabels">
  320. <tr>
  321. <td class="mlabels-left">
  322. <table class="memname">
  323. <tr>
  324. <td class="memname">int luwra::StateWrapper::runString </td>
  325. <td>(</td>
  326. <td class="paramtype">const std::string &amp;&#160;</td>
  327. <td class="paramname"><em>code</em></td><td>)</td>
  328. <td></td>
  329. </tr>
  330. </table>
  331. </td>
  332. <td class="mlabels-right">
  333. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  334. </tr>
  335. </table>
  336. </div><div class="memdoc">
  337. <p>Execute a piece of code. </p>
  338. </div>
  339. </div>
  340. <a class="anchor" id="ac8be165c08327f3a2cccd42ce114147a"></a>
  341. <div class="memitem">
  342. <div class="memproto">
  343. <div class="memtemplate">
  344. template&lt;typename V &gt; </div>
  345. <table class="mlabels">
  346. <tr>
  347. <td class="mlabels-left">
  348. <table class="memname">
  349. <tr>
  350. <td class="memname">void luwra::StateWrapper::setGlobal </td>
  351. <td>(</td>
  352. <td class="paramtype">const std::string &amp;&#160;</td>
  353. <td class="paramname"><em>key</em>, </td>
  354. </tr>
  355. <tr>
  356. <td class="paramkey"></td>
  357. <td></td>
  358. <td class="paramtype">V&#160;</td>
  359. <td class="paramname"><em>value</em>&#160;</td>
  360. </tr>
  361. <tr>
  362. <td></td>
  363. <td>)</td>
  364. <td></td><td> const</td>
  365. </tr>
  366. </table>
  367. </td>
  368. <td class="mlabels-right">
  369. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  370. </tr>
  371. </table>
  372. </div><div class="memdoc">
  373. <p>Assign a global value. </p>
  374. </div>
  375. </div>
  376. <h2 class="groupheader">Member Data Documentation</h2>
  377. <a class="anchor" id="a55f83661f04e7c7ad21456207feeef01"></a>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <table class="memname">
  381. <tr>
  382. <td class="memname">bool luwra::StateWrapper::close_state</td>
  383. </tr>
  384. </table>
  385. </div><div class="memdoc">
  386. </div>
  387. </div>
  388. <a class="anchor" id="ab5c6fb20675aec5710857c6962c598ff"></a>
  389. <div class="memitem">
  390. <div class="memproto">
  391. <table class="memname">
  392. <tr>
  393. <td class="memname"><a class="el" href="namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d">State</a>* luwra::StateWrapper::state</td>
  394. </tr>
  395. </table>
  396. </div><div class="memdoc">
  397. </div>
  398. </div>
  399. </div><!-- contents -->
  400. </body>
  401. </html>