home *** CD-ROM | disk | FTP | other *** search
/ Power-Programmierung / CD1.mdf / forth / compiler / fpc / doc / zz.txt < prev   
Text File  |  1990-02-07  |  6KB  |  132 lines
  1. ZZ.TXT                  Mini Doc for ZZ.COM             by Tom Zimmer
  2.  
  3. ZZ NOTES
  4.  
  5.   ZZ is an integrator program that provides a simple connected
  6. environment for the TCOM compiler, and the SZ editor. ZZ's purpose is
  7. to reduce keystrokes while simplifying program development. It sends
  8. and accepts commands from the SZ editor while directing the operations
  9. of the TCOM compiler, and the BXDEBUG debugger.
  10.  
  11.   Specifically ZZ gets all of its commands from two places, the file
  12. ZZ.CFG. and ZZ.CMD. Both are ordinary text files. ZZ.CFG holds command
  13. lines for ZZ to perform. Here is an example of the contents of ZZ.CFG:
  14.  
  15.         Line 1     SZ %1 %2 %3 /cmd
  16.         Line 2     SZ %F.msg /b||
  17.         Line 3     CLS|%1 %P|PAUSE||
  18.                    echo Alt-3 is not defined, edit MS.CFG|pause
  19.                    echo Alt-4 is not defined, edit MS.CFG|pause
  20.         Line 6     tcom %1 /opt /sym /Q >%F.msg||
  21.                    echo Alt-6 is not defined, edit MS.CFG|pause
  22.         Line 8     bxdebug %F.com||
  23.                    echo Alt-8 is not defined, edit MS.CFG|pause
  24.                    echo Alt-9 & F9 are not defined, edit MS.CFG|pause
  25.         Line 11    echo Alt-0 is not defined, edit MS.CFG|pause
  26.  
  27.   When ZZ starts execution, it first reads in ZZ.CFG. ZZ then passes
  28. Line 1 to DOS as a command line. This starts the SZ editor on whatever
  29. file was specified after ZZ on the DOS commandline. When SZ returns, ZZ
  30. looks in the file ZZ.CMD for information on what to do next. The ZZ.CMD
  31. file contains a single line, and looks like this:
  32.  
  33.                 1 0004 0007 C:\FPC\TCOM\SAMPLE.SEQ
  34.  
  35.   The first three items are at fixed locations in the first line. The
  36. "1" signifies the command line to execute. The command is in the range
  37. 1 to 9 plus 0 corresponding to Lines 2 through 11 above. A command "Q"
  38. means we are Quitting ZZ. The second and third items in ZZ.CMD are the
  39. ROW and COLUMN of where we were editing in SZ. The fourth Item is
  40. variable length, and specifies the file we were editing. The filename
  41. is passed as "%1" on the commandline as a parameter to whatever
  42. commandline gets executed.
  43.  
  44. You may notice some peculiarities in the above commandlines,
  45. specifically the use of the "|" character. ZZ recognizes "|" as a
  46. command seperator, and actually passes each "|" delimited string
  47. sequence to DOS as a seperate commandline. Sort of a mini or shorthand
  48. batch file.
  49.  
  50.   The "%F" symbol above in lines 2,6, and 8, inserts the same filename
  51. as "%1", except the filename extension is removed. This is useful to
  52. allow making several file with the sname name but different extensions.
  53.  
  54.   The "%P" symbol in line 3 indicates command line parameters are
  55. needed for this command. ZZ will then prompt for user input of up to
  56. 40 characters on the last line of the display before executing the
  57. command.
  58.  
  59. SZ NOTES
  60.  
  61.   While we are discussing ZZ, I need to mention the changes to the SZ
  62. editor. SZ will generate the file ZZ.CMD only if it is started with a
  63. commandline including the "/CMD" option. This tells SZ we are in a
  64. compile environment, and that commands need to be passed back to ZZ for
  65. its use.  When SZ starts up with this option, it trys to read in a file
  66. with the same name as the file it is editing, but with a ".MSG"
  67. extension. If this file is found, then SZ scans it for error messages.
  68. This file is generated by the TCOM compiler using standard I/O
  69. redirection as shown in Line 6 above. In addition the "/Q" (Quiet)
  70. option suppresses exteranious compiler output. Error messages from
  71. the TCOM compiler are in a format compatible with the Microsoft C
  72. compiler as following example illustrates:
  73.  
  74.         SAMPLE.SEQ(23)  XYZZ Undefined symbol
  75.  
  76.   Here the filename starts the line, and the line where the error
  77. occured is placed in parenthesis. SZ looks for lines in the format, and
  78. when an error is detected, SZ switches into "ERRORING" mode, and
  79. displays the error message on the bottom line of the screen, with the
  80. faulty line displayed in reverse video. At this point only three
  81. keyboard keys are active, the up and down arrow keys, for moving
  82. through the errors, and the ESC key for leaving "ERRORING" mode. You
  83. can press ESC, to correct an error, then press Alt-F5 to re-enter and
  84. examine additional errors. When you are satisfied with your changes,
  85. you can press F5 again, and re-compile the program.
  86.  
  87.   While the actual interconnection process is quite complicated, you
  88. need only remember a few keys as follows:
  89.  
  90.         F5      Compile current source file.
  91.         F7      Debug current program.
  92.         Ctl-F1  View compiler .MSG file. use F10 to return to editing.
  93.         Ctl-F2  Execute the current program.
  94.         F10     Leave the environment.
  95.  
  96.   Alt-1 through Alt-0 can be used to directly execute lines 2 through
  97. 11 of the ZZ.CFG file. You can edit ZZ.CFG to add or change the
  98. commands listed there.
  99.  
  100.   ZZ can be used as an integrator for other compilers, that like TCOM
  101. or Microsoft C can be directed to build error files with the same
  102. format.
  103.  
  104.   As you have probably noticed, ZZ is very small, about 6k bytes. That
  105. along with 3k bytes for the COMMAND shell, is all that is consumed
  106. from your Transient Programming Area by ZZ's operation. ZZ can then be
  107. used with compilers that need all of memory to operate.
  108.  
  109.   I hope you find ZZ useful, it is Public Domain, and may be used as
  110. you wish. If you find ZZ, SZ, TCOM, or F-PC useful, you may want to
  111. send a check for $60.00 to the following address:
  112.  
  113.                                 Tom Zimmer
  114.                                 292 Falcato Drive
  115.                                 Milpitas, CA. 95035
  116.                                         Home (408) 263-8859
  117.                                         Work (408) 432-4643
  118.  
  119.   You will receive the latest copy of F-PC, TCOM, SZ, and ZZ. Please
  120. specify the disk format you need.
  121.  
  122.   My prefered format is 1.2Meg 5 1/4. If you need 360k, 720k or 1.4Meg
  123. disk formats please add $5.00 for additional handling.
  124.  
  125.   Out of US orders please add another $5.00 for additional postage and
  126. handling.
  127.  
  128.   Also include the version numbers of each program you have, and a day
  129. and evening phone number for questions.
  130.  
  131.  
  132.