PageRenderTime 69ms CodeModel.GetById 27ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/lexecutor/lExecutor.html

http://luapack.googlecode.com/
HTML | 258 lines | 122 code | 133 blank | 3 comment | 0 complexity | 6ffc029f3c28bdec875b4c3ef20612dd MD5 | raw file
Possible License(s): LGPL-2.1, GPL-2.0, AGPL-3.0, LGPL-2.0, LGPL-3.0, BSD-3-Clause, ISC 
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"

    2. 

  2.    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

    3. 

  3. <html>

    4. 

  4. <head>

    5. 

  5.     <title>Reference</title>

    6. 

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

    7. 

  7. 	<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->

    8. 

  8. </head>

    9. 

  9. 

    10. 

  10. <body>

    11. 

  11. <div id="container">

    12. 

  12. 

    13. 

  13. <div id="product">

    14. 

  14. 	<div id="product_logo"></div>

    15. 

  15. 	<div id="product_name"><big><b></b></big></div>

    16. 

  16. 	<div id="product_description"></div>

    17. 

  17. </div> <!-- id="product" -->

    18. 

  18. 

    19. 

  19. <div id="main">

    20. 

  20. 

    21. 

  21. <div id="navigation">

    22. 

  22. 

    23. 

  23. 

    24. 

  24. <h1>LuaDoc</h1>

    25. 

  25. <ul>

    26. 

  26. 	

    27. 

  27. 	<li><strong>lExecutor</strong></li>

    28. 

  28. 	

    29. 

  29. </ul>

    30. 

  30. 

    31. 

  31. 

    32. 

  32. <!-- Module list -->

    33. 

  33. 

    34. 

  34. 

    35. 

  35. <!-- File list -->

    36. 

  36. 

    37. 

  37. 

    38. 

  38. 

    39. 

  39. 

    40. 

  40. 

    41. 

  41. 

    42. 

  42. </div><!-- id="navigation" -->

    43. 

  43. 

    44. 

  44. <div id="content">

    45. 

  45. 

    46. 

  46. <h1>Module <code>lExecutor</code></h1>

    47. 

  47. 

    48. 

  48. <p>lExecutor is a <a href="http://lua.org">Lua</a> application that allows users to run there console based scripts in a user interface. It is completely general purpose and uses 'print()' and 'Prompt()' to get messages to the GUI. It is very simple and exposes only a couple of variables and functions to aid in keeping your scripts simple and not written just to work in lExecutor.<br /> <br />  lExecutor has a very simple user interface that has a menu, an output log, an execute button, and a continuous run checkbox. You can open lExecutor just by launching it and then if no script was passed on its command line it will prompt for a file to run. After that the user just clicks the 'Execute' button each time they want to run the script, starting at the <code>main()</code> function. If the user wants to repeatedly run the script over and over, just clicking the 'Continuous' checkbox and then the 'Execute' button. The 'Continuous' checkbox is located next to the 'Execute' button. When you are done running it is continuous mode just click the 'Continuous' checkbox, to remove the check, and it will stop executing.<br /> <br />  lExecutor can also save the output to a text file so that you can review and have record of all that occured in that session. To save the output to a text file use <code>File->Save Output (Ctrl + S)</code> and choose the location to save the file to. When you save the log lExecutor will clear the output.<br /> <br />  lExecutor can also open new files and load them to execute without always having to restart the application. To do this you use <code>File->Open (Ctrl+O)</code> and select the file you want to open. </p>

    49. 

  49. 

    50. 

  50. 

    51. 

  51. <p><b>Author:</b>

    52. 

  52. <table class="authors_list">

    53. 

  53. 

    54. 

  54. 	<tr><td class="name"><a href="mailto:rpusztai@gmail.com">Ryan Pusztai</a></td></tr>

    55. 

  55. 

    56. 

  56. </table>

    57. 

  57. </p>

    58. 

  58. 

    59. 

  59. 

    60. 

  60. 

    61. 

  61. <p><b>Release:</b> 1.01 <04/07/2010>  <h2>Note:</h2> <ul>When a file is loaded <code>lExecutor</code> will set the current working directory to the loaded scripts directory. Make sure your paths in your scripts are relative to the top level script (the script you are running). </ul>  <h2>lExecutor:</h2> <ul> To use lExecutor you need to write scripts in Lua. You can find out more about Lua here:<br /><br /> <li><a href="http://lua.org/manual/">Lua manual</a></li> <li><a href="http://www.lua.org/pil/">Programming in Lua</a> &#x2013; First Edition (book)</li> </ul>  <h2>Usage:</h2> <ul> <code>lExecutor.wlua [script [args]]</code> <h4>Options:</h4> <ul> <li><code>script</code>  <ul>file path to a Lua script to load when started. It must exist.</ul></li> <li><code>args</code>    <ul>arguments to pass to the loaded script. Not to lexecutor</ul></li> </Ul> </ul>  <h2>General Information:</h2> <ul> <b>Script initialization and using a <code>main()</code>:</b> <ul> The general idea that lExecutor uses is the idea that any code that is not in a fuction is ran as initialization code for your script. Then lExecutor calls a global function named <code>main()</code>. This is simply done as a main entry point into your application. If the global function <code>main()</code> is missing lExecutor will just execute the entire script when 'Execute' is pressed.  <pre class="example"> -- Initialization code here<br /> APP_NAME = "Simple lExecutor Example"<br /> -- Code that is ran as soon as lExecutor has loaded this script.<br /> port = lExecutor.Prompt( "What COM port?" )<br /> <br />  -- Main entry point<br /> -- This is ran every press of 'Execute' in lExecutor.<br /> function main()<br /> &nbsp; &nbsp; print( "Hi from main()" )<br /> &nbsp; &nbsp; print( "Opening COM port", port )<br /> end<br /> <br />  -- Checking to see if lExecutor is running this script.<br /> -- If it is not then we still want the script to run completely,<br /> -- so call main()<br /> if not _LEXECUTOR then<br /> &nbsp; &nbsp; main()<br /> end </pre> </ul> </ul>  <ul> <b>Script parameters:</b> <ul> When running a script you can access the command line parameters passed to the script (see above in the 'Usage' section) in a table called <code>arg</code>. The zero index always has the full file name of the running script. It also contains the rest of the parameters passed in as a normal Lua table. <pre class="example"> print( "Script that is loaded: ", arg[0] )<br /> print( "Number of arguments sent to the script: ", #arg )<br /> print( "Unpacked arguments: ", unpack( arg ) ) </pre> </ul> </ul> 

    62. 

  62. </p>

    63. 

  63. 

    64. 

  64. 

    65. 

  65. 

    66. 

  66. <h2>Functions</h2>

    67. 

  67. <table class="function_list">

    68. 

  68. 

    69. 

  69. 	<tr>

    70. 

  70. 	<td class="name" nowrap><a href="#lExecutor.ClearLog">lExecutor.ClearLog</a>&nbsp;()</td>

    71. 

  71. 	<td class="summary">Clears the log </td>

    72. 

  72. 	</tr>

    73. 

  73. 

    74. 

  74. 	<tr>

    75. 

  75. 	<td class="name" nowrap><a href="#lExecutor.Prompt">lExecutor.Prompt</a>&nbsp;(message)</td>

    76. 

  76. 	<td class="summary">This function will allow you to take input from the user.</td>

    77. 

  77. 	</tr>

    78. 

  78. 

    79. 

  79. 	<tr>

    80. 

  80. 	<td class="name" nowrap><a href="#lExecutor.SetPassFailStatus">lExecutor.SetPassFailStatus</a>&nbsp;(isPassed, show)</td>

    81. 

  81. 	<td class="summary">Sets the pass/fail status indicator to the specified state.</td>

    82. 

  82. 	</tr>

    83. 

  83. 

    84. 

  84. 	<tr>

    85. 

  85. 	<td class="name" nowrap><a href="#print">print</a>&nbsp;(...)</td>

    86. 

  86. 	<td class="summary">This overrides the default <code>print()</code> and allows the loaded script to display feedback to the user in the GUI.</td>

    87. 

  87. 	</tr>

    88. 

  88. 

    89. 

  89. </table>

    90. 

  90. 

    91. 

  91. 

    92. 

  92. 

    93. 

  93. <h2>Tables</h2>

    94. 

  94. <table class="table_list">

    95. 

  95. 

    96. 

  96. 	<tr>

    97. 

  97. 	<td class="name" nowrap><a href="#APP_NAME">APP_NAME</a></td>

    98. 

  98. 	<td class="summary">Use this in the calling app to overwrite the windows title that is displayed.</td>

    99. 

  99. 	</tr>

    100. 

  100. 

    101. 

  101. 	<tr>

    102. 

  102. 	<td class="name" nowrap><a href="#_LEXECUTOR">_LEXECUTOR</a></td>

    103. 

  103. 	<td class="summary">This symbol is defined so that scripts can be written to know if lExecutor is running the script.</td>

    104. 

  104. 	</tr>

    105. 

  105. 

    106. 

  106. </table>

    107. 

  107. 

    108. 

  108. 

    109. 

  109. 

    110. 

  110. <br/>

    111. 

  111. <br/>

    112. 

  112. 

    113. 

  113. 

    114. 

  114. 

    115. 

  115. <h2><a name="functions"></a>Functions</h2>

    116. 

  116. <dl class="function">

    117. 

  117. 

    118. 

  118. 

    119. 

  119. 

    120. 

  120. <dt><a name="lExecutor.ClearLog"></a><strong>lExecutor.ClearLog</strong>&nbsp;()</dt>

    121. 

  121. <dd>

    122. 

  122. Clears the log

    123. 

  123. 

    124. 

  124. 

    125. 

  125. 

    126. 

  126. 

    127. 

  127. 

    128. 

  128. 

    129. 

  129. 

    130. 

  130. 

    131. 

  131. 

    132. 

  132. </dd>

    133. 

  133. 

    134. 

  134. 

    135. 

  135. 

    136. 

  136. 

    137. 

  137. <dt><a name="lExecutor.Prompt"></a><strong>lExecutor.Prompt</strong>&nbsp;(message)</dt>

    138. 

  138. <dd>

    139. 

  139. This function will allow you to take input from the user. This function will stop the execution of your script to let the user respond.

    140. 

  140. 

    141. 

  141. 

    142. 

  142. <h3>Parameters:</h3>

    143. 

  143. <ul>

    144. 

  144. 	

    145. 

  145. 	<li>

    146. 

  146. 	  <code><em>message</em></code>: {string} Message to display to the user.

    147. 

  147. 	</li>

    148. 

  148. 	

    149. 

  149. </ul>

    150. 

  150. 

    151. 

  151. 

    152. 

  152. 

    153. 

  153. 

    154. 

  154. 

    155. 

  155. 

    156. 

  156. <h3>Return value:</h3>

    157. 

  157. <ul>{string} The value entered by the user.</ul>

    158. 

  158. 

    159. 

  159. 

    160. 

  160. 

    161. 

  161. </dd>

    162. 

  162. 

    163. 

  163. 

    164. 

  164. 

    165. 

  165. 

    166. 

  166. <dt><a name="lExecutor.SetPassFailStatus"></a><strong>lExecutor.SetPassFailStatus</strong>&nbsp;(isPassed, show)</dt>

    167. 

  167. <dd>

    168. 

  168. Sets the pass/fail status indicator to the specified state. Use this to display a pass or fail status to the user running the script. This function will show the pass/fail status indicator the first time it is called.

    169. 

  169. 

    170. 

  170. 

    171. 

  171. <h3>Parameters:</h3>

    172. 

  172. <ul>

    173. 

  173. 	

    174. 

  174. 	<li>

    175. 

  175. 	  <code><em>isPassed</em></code>: {bool} [DEF] If true then the indicator will display "PASS" and the background will be green. If false, then it will display "FAIL" and the background will be red.

    176. 

  176. 	</li>

    177. 

  177. 	

    178. 

  178. 	<li>

    179. 

  179. 	  <code><em>show</em></code>: {bool} [DEF] If true then the indicator will display, else if false it will not show. This defaults to true.

    180. 

  180. 	</li>

    181. 

  181. 	

    182. 

  182. </ul>

    183. 

  183. 

    184. 

  184. 

    185. 

  185. 

    186. 

  186. 

    187. 

  187. 

    188. 

  188. 

    189. 

  189. 

    190. 

  190. 

    191. 

  191. </dd>

    192. 

  192. 

    193. 

  193. 

    194. 

  194. 

    195. 

  195. 

    196. 

  196. <dt><a name="print"></a><strong>print</strong>&nbsp;(...)</dt>

    197. 

  197. <dd>

    198. 

  198. This overrides the default <code>print()</code> and allows the loaded script to display feedback to the user in the GUI.

    199. 

  199. 

    200. 

  200. 

    201. 

  201. <h3>Parameters:</h3>

    202. 

  202. <ul>

    203. 

  203. 	

    204. 

  204. 	<li>

    205. 

  205. 	  <code><em>...</em></code>: {varies} Message to display to the user.

    206. 

  206. 	</li>

    207. 

  207. 	

    208. 

  208. </ul>

    209. 

  209. 

    210. 

  210. 

    211. 

  211. 

    212. 

  212. 

    213. 

  213. 

    214. 

  214. 

    215. 

  215. 

    216. 

  216. 

    217. 

  217. </dd>

    218. 

  218. 

    219. 

  219. 

    220. 

  220. </dl>

    221. 

  221. 

    222. 

  222. 

    223. 

  223. 

    224. 

  224. 

    225. 

  225. <h2><a name="tables"></a>Tables</h2>

    226. 

  226. <dl class="table">

    227. 

  227. 

    228. 

  228. <dt><a name="APP_NAME"></a><strong>APP_NAME</strong></dt>

    229. 

  229. <dd>Use this in the calling app to overwrite the windows title that is displayed. This just allows a bit more customization of the GUI. It must be a string and it must be a global declaration.  <h4>Example:</h4> <pre class="example"> APP_NAME = "My Cool App" </pre><br /><br />

    230. 

  230. 

    231. 

  231. 

    232. 

  232. 

    233. 

  233. </dd>

    234. 

  234. 

    235. 

  235. 

    236. 

  236. <dt><a name="_LEXECUTOR"></a><strong>_LEXECUTOR</strong></dt>

    237. 

  237. <dd>This symbol is defined so that scripts can be written to know if lExecutor is running the script. This can be helpful so that you can write your script once and have it work in the console as well as lExecutor.  A common use for this would be to not automatically call your Lua scripts <code>main()</code> function, so that lExecutor can be the only one to call it. Ex.  <h4>Example:</h4> <pre class="example"> function main()<br /> &nbsp; &nbsp; print( "Hello World" )<br /> end<br /> <br /> -- Now we need to automatically run the main() function when<br /> -- anywhere other then lExecutor.<br /> if not _LEXECUTOR then main() end </pre><br /><br />

    238. 

  238. 

    239. 

  239. 

    240. 

  240. 

    241. 

  241. </dd>

    242. 

  242. 

    243. 

  243. 

    244. 

  244. </dl>

    245. 

  245. 

    246. 

  246. 

    247. 

  247. 

    248. 

  248. </div> <!-- id="content" -->

    249. 

  249. 

    250. 

  250. </div> <!-- id="main" -->

    251. 

  251. 

    252. 

  252. <div id="about">

    253. 

  253. 	<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>

    254. 

  254. </div> <!-- id="about" -->

    255. 

  255. 

    256. 

  256. </div> <!-- id="container" -->	

    257. 

  257. </body>

    258. 

  258. </html>

    259. 

  259.