[Plib-cvs] plib/doc/psl appl_guide.html,1.1,1.2 prog_guide.html,1.1,1.2

[Steve B. <sj...@us...>]

Update of /cvsroot/plib/plib/doc/psl
In directory usw-pr-cvs1:/tmp/cvs-serv31108/plib/doc/psl

Modified Files:
	appl_guide.html prog_guide.html 
Log Message:
Added documentation for PSL


Index: appl_guide.html
===================================================================
RCS file: /cvsroot/plib/plib/doc/psl/appl_guide.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- appl_guide.html	10 Sep 2002 04:37:38 -0000	1.1
+++ appl_guide.html	13 Sep 2002 17:37:25 -0000	1.2
@@ -24,6 +24,383 @@
 scripting abilities using the PSL interpreter.
 <p>
 
+To include PSL scripts into your application requires that you:
+<pre>
+
+   #include &lt;plib/psl.h&gt;
+
+</pre>
+...and link with '<code>-lplibpsl</code>'
+<p>
[...352 lines suppressed...]
+The 'pause' command indicates that this script has completed it's
+work for this frame.
+<p>
+Alternatively, some applications may wish to run the scripts for
+fixed amounts of time, fixed numbers of byte-codes - or until
+some other criterion is satisfied.
+<H3> Resetting a Script </H3>
+There is a <code>pslProgram::reset()</code> function that
+restarts the PSL program from the beginning having first
+reset all of its internal variables.
+<H3> Debugging PSL scripts </H3>
+For debugging PSL scripts, you may replace the 'step' call with
+'trace' - which causes the byte-code for each instruction to be
+printed to stderr as it's executed.
+<p>
+You can also call <code>pslProgram::dump()</code> to print out
+all of the byte-code and the PSL symbol table for the program.
 <hr>
 <address>
 <a href="http://www.sjbaker.org">Steve J. Baker.</a> &lt;<a href="mailto:sjb...@ai...">sjb...@ai...</a>&gt;</address>

Index: prog_guide.html
===================================================================
RCS file: /cvsroot/plib/plib/doc/psl/prog_guide.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- prog_guide.html	10 Sep 2002 04:37:38 -0000	1.1
+++ prog_guide.html	13 Sep 2002 17:37:25 -0000	1.2
@@ -13,21 +13,140 @@
 <tr>
 <td>
 <center>
-<h1>The PSL Programming Guide </h1></center>
+<h1>The PLIB Scripting Language Programming Guide </h1></center>
 <center>By Steve Baker</center>
 </td>
 </tr>
 </table>
 <H1>Introduction</H1>
+
[...113 lines suppressed...]
+  <li> Hex and octal constants.
+  <li> Arrays & Structs.
+  <li> Operations on "string" variables.
+  <li> String concatenation.
+  <li> '\' to escape the end-of-line character in strings and macro's.
+  <li> Array bounds checking.
+  <li> Parameter passing by name.
+  <li> Many of C's standard library functions are needed.
+</ul>
+
+Currently there are hard limits in many places - the number of
+variables, the size of the program, the depth of nesting, etc.
+These limits will gradually be removed as PSL is developed.
+
 <hr>
 <address>
 <a href="http://www.sjbaker.org">Steve J. Baker.</a> &lt;<a href="mailto:sjb...@ai...">sjb...@ai...</a>&gt;</address>
 </body>
 </html>
+