home *** CD-ROM | disk | FTP | other *** search
/ Oakland CPM Archive / oakcpm.iso / sigm / vol114 / misc < prev    next >
Encoding:
Text File  |  1984-04-29  |  4.2 KB  |  158 lines
  1. MENU of MISCELLANEOUS UTILITIES:
  2. copyright (C) 1983 by E. E. Bergmann
  3. COREDUMP and RESTORE
  4. LISTFILE
  5. LOAD
  6. SHOWCODE and NOSHOWCODE
  7. % ="comments"
  8. TOP10 and NEXT10
  9. DIS ="the disassembler"
  10. to examine STACK and RSTACK
  11. TRACE of procedures
  12. HELP
  13. :
  14. ::
  15. *********************************************************
  16. *                            *
  17. * PISTOL-Portably Implemented Stack Oriented Language    *
  18. *            Version 2.0            *
  19. * (C) 1983 by    Ernest E. Bergmann            *
  20. *        Physics, Building #16            *
  21. *        Lehigh Univerisity            *
  22. *        Bethlehem, Pa. 18015            *
  23. *                            *
  24. * Permission is hereby granted for all reproduction and *
  25. * distribution of this material provided this notice is *
  26. * included.                        *
  27. *                            *
  28. *********************************************************
  29. :
  30. ::
  31. COREDUMP    saves an image of PISTOL's memory as a
  32.         file named with the string previously
  33.         placed on top of the stack.  (for an
  34.         example see "GETTING STARTED", near the
  35.         start of this documentation).
  36.  
  37. RESTORE        takes the file whose name is on the top
  38.         of stack and "restores" the memory image
  39.         that had been previously saved by a
  40.         COREDUMP command.  (for an example see
  41.         "GETTING STARTED", near the start of this
  42.         documentation).
  43.  
  44. :
  45. ::
  46. LISTFILE    opens a new file with the name that was
  47.         on the top of stack.  This new file can
  48.         be written into to keep a record of the
  49.         terminal session (using the boolean:
  50.         LIST).  For example, to record portions 
  51.         of the terminal session in a file named
  52.         "DIALOG":
  53.  
  54.         X> 'DIALOG LISTFILE
  55.         X> LIST ON
  56.             .
  57.             . (recorded)
  58.             .
  59.         X> LIST OFF
  60.             .
  61.             . (not recorded)
  62.             .
  63.         X> LIST ON
  64.             .
  65.             . (recorded)
  66.             .
  67.             etc.
  68.  
  69. :
  70. ::
  71. LOAD    is used to take a PISTOL source file whose name is
  72.         pointed to by the top of stack.  If given a line
  73.     number instead of a filename, it will access the
  74.     edit buffer instead.
  75.  
  76. :
  77. ::
  78. SHOWCODE    makes pistol display the contents of its
  79.                 compile buffer after every compilation.  It is
  80.                 most useful when you are trying to estimate
  81.                 where special patching needs to be done, such
  82.                 as done by ARGPATCH (see the definitions in
  83.                 PBASE for this one!).  To stop showing code you
  84.                 should use:
  85.  
  86. NOSHOWCODE    turns off the SHOWCODE, described immediately
  87.                 above.
  88.  
  89. :
  90. ::
  91.  
  92. %    is the comment delimiter; the compiler ignores
  93.         remaining text to the end of the current line.  Do not
  94.         shun its use in creating PISTOL source files;  PISTOL
  95.         is NOT self documenting!
  96. :
  97. ::
  98.     To name the ten most recent definitions one should
  99. type:  TOP10 .  It will display the information and leave on
  100. stack the address of the 11th most recent definition.  To name
  101. further definitions, one can type NEXT10 which takes the
  102. address off of the stack and names the next ten definitions.
  103. In turn, it leaves the address of the 21th most recent
  104. definition on stack.
  105.  
  106. :
  107. ::
  108.     One can dis-assemble a definition using the word, DIS .
  109. For example:
  110.  
  111. X> 'TOP10 DIS
  112.  
  113. produces the result:
  114.  
  115. 'TOP10 : CURRENT W@ NEXT10 ;
  116.  
  117. Not all definitions are disassembled so faithfully.
  118.  
  119. :
  120. ::
  121.     To examine the stack in a non-destructive manner, one
  122. can use the word, STACK.  It will display the number of items
  123. in the stack and their values.  For testing definitions it is
  124. useful to check the stack before and after the definition has
  125. been invoked.
  126.  
  127.     To examine the contents of the return stack in a
  128. non-destructive manner, one can use the word, RSTACK .
  129.  
  130. :
  131. ::
  132.     If the definition appears to be faulty, it is often
  133. useful to debug it by tracing the program flow through the
  134. definition and the state of the stack at intermediate steps.
  135. This can be accomplished automatically by the use of the word,
  136. TRACE.  For example, to trace the action of DDUP one can type:
  137.  
  138. X> 1 2 'DDUP TRACE
  139.  
  140. :
  141. ::
  142. HELP    If typed with no parameters placed on the stack
  143.     it accesses this file (PISTOL.HLP) and permits the
  144.     user to access various partitions in a menu driven
  145.     manner.  
  146.         It may also be used to access other files
  147.     by the user placing the name of the file on stack.
  148.     For example, the user can access the file named "io":
  149.  
  150.     X> 'IO HELP
  151.  
  152.     The files accessed in this manner should contain
  153.     partitioning information in the form of lines that
  154.     start with a variable number of ':'; examine the
  155.     PISTOL.HLP file for examples of partitioning and
  156.     subpartitioning.
  157. :
  158.