home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 164.lha / ARexx / McC_v1.3_ARexx / mcc1R3.docs < prev    next >
Text File  |  1988-04-28  |  7KB  |  155 lines
  1.                                       McC
  2.                            Integrated Editor/Compiler
  3.                                   Version 1.3
  4.                                by John McClennan
  5.                                  June 25, 1988
  6.  
  7.  
  8.  
  9. Introduction:
  10.  
  11.    McC is a set of six ARexx V1.06 macros that create and integrated
  12. edit/compile enviroment using TxEd Plus and Lattice C V4.0.  Programs can
  13. be edited using TxEd and then compiled without having to exit the editor. 
  14. If any errors are detected during the compilation, the cursor is positioned
  15. at the line in the source code corresponding to the first error.  A TxEd
  16. menu option allows the cursor to be moved to the lines where subsequent
  17. errors occurred.
  18.  
  19.  
  20. Installation:
  21.  
  22.    If you received McC in ARC'ed format, the first thing you must do is
  23. rename two of the files.  The file "McCstm.txed" should be renamed
  24. "McCstmain.txed" and the file "McCste.txed" should be renamed
  25. "McCsterr.txed".  The six macros should then be copied to the directory
  26. corresponding to the logical device name REXX:.  Also, the library
  27. "rexxsupport.library" must be in the LIBS: directory.  Once this has been
  28. accomplished, McC is ready for use.
  29.  
  30.  
  31. Operation:
  32.  
  33.    The McC enviroment is started by typing "rx mcc" at the command line
  34. prompt (Note:  WShell users can omit the "rx" command and just type "mcc").
  35. When the TxEd window appears the message "Can't Open File!" will appear. 
  36. This is normal and due to the fact that McC names the default file upon
  37. invocation as "noname.c"  (Note: if a file by that name does exist in your
  38. current directory, it will be loaded and the warning message will not
  39. appear).  If you wish to enter a new file and name it as something other
  40. than "noname.c", use the TxEd menu option "Save AS" in the Project menu to
  41. save the file for the first time.  If you wish to load and edit an already
  42. existing file use the "Open" command from the Project menu.
  43.  
  44.    To compile the program currently being edited, select the "Compile"
  45. option from the User menu or use the command key shortcut Right-Amiga-M. 
  46. This will save the file currently being edited and then call the compiler. 
  47. A window will appear in the middle of the screen informing you of the name
  48. of the file being compiled.  When the compilation is finished, the TxEd
  49. window will go blank for a second and then a second window will appear
  50. containing the output from the compiler.  If errors were detected during
  51. the compilation, then the cursor in the error message window will be
  52. positioned at the text describing the first error message and the cursor in
  53. the edit window will be positioned at the start of the line that caused the
  54. error.  If no errors were detected, the cursor in the error message window
  55. will be positioned at the bottom line of the compiler's output.  If more
  56. than one error occurred during the compilation, you can move forward to the
  57. next error by using the "Next Error" option in the User menu or the command
  58. key shortcut Right-Amiga-N.  The cursors in the two windows will be
  59. positioned as described above except at the positions corresponding to the
  60. second (or third etc.) error.  Note, each time the "Next Error" command is
  61. used (including finding the first error), the message "ARexx MACRO ERROR"
  62. will appear in the title bar of the error message window.  The cause of
  63. this is undetermined but it can be ignored since it does not affect the
  64. operation of McC.  One thing to remember about the "Next Error" command is
  65. that it determines the position to move the cursor to from the line number
  66. in the error message.  If you correct a previous error by adding or
  67. deleting lines, the line numbers corresponding to the errors will be out of
  68. synch.
  69.  
  70.    By default on startup, all files are compiled using the "-b0" switch for
  71. the LC command.  To change the compiler options use the "Set Options"
  72. command in the User menu.  A window will appear showing the options that
  73. were previously in effect and asking you to enter the new options.  Note,
  74. entering a blank line for the new options indicates that no options will be
  75. used for a compilation.
  76.  
  77.    To exit from McC, use the normal TxEd "Quit" command in the Project
  78. menu.
  79.  
  80.  
  81. Warnings:
  82.  
  83.    The error message window should never be closed once it is opened until
  84. you are ready to exit McC.  If you do so, an error may occur if you try to
  85. compile a file.  If you do close the window by accident, save the file you
  86. are currently working on, exit McC, and then re-enter it and load your file
  87. back in.  This is due to the fact that the port name corresponding to the
  88. error message window can't be determined until it is opened for the first
  89. time.  Closing and reopening it may cause the port to change without McC's
  90. knowledge.
  91.  
  92.    A second possible problem relates to the one above.  If you close the
  93. error message window and then use the "More TxEd" command to open a new
  94. window and edit a file, the contents of the second file may be lost if you
  95. try and compile the original file.  This is also due to the port name
  96. confusion.
  97.  
  98.    Finally, only one instance of the McC eviroment should be invoked at any
  99. time.  ARexx's clip list is used to store some important values (such as
  100. the port addresses for the windows) and will be corrupted if more than one
  101. case of McC is run at any time.
  102.  
  103.  
  104. Revisions from Version 1.2:
  105.  
  106. 1.  The limitation confining you to only editing files in the current
  107. directory upon invocation of McC no longer exists.  The standard TxEd
  108. "Open" command can be used to load files from any directory or device.
  109.  
  110. 2.  A file name can no longer be specified on the command line.  This is a
  111. direct result of changes needed to make the first revision above work. 
  112. Upon initial entry into McC V1.3 a default filename of "noname.c" is
  113. assumed.  This can be changed by using the "Load" or "Save AS" commands.
  114.  
  115. 3.  WShell is no longer required.  Changes made in V1.06 of ARexx now allow
  116. McC to be run as-is from the normal CLI.
  117.  
  118. 4.  The "Next Error" option has been added.
  119.  
  120. 5.  The problem of the compiler not finding quoted include files that are
  121. in the current directory as opposed to INCLUDE: has been fixed.
  122.  
  123.  
  124. Macro File Description:
  125.  
  126.    Version 1.3 consists of the six ARexx macro files described below.
  127.  
  128. McC.rexx - This macro sets up the McC enviroment and makes the initial call
  129.            to TxEd Plus.
  130.  
  131. McC1.txed - This macro handles the actual call to the compiler.  It opens
  132.             the error message window the first time it is called.
  133.  
  134. McCnext.txed - This macro finds the next error in the compilation and
  135.                positions the cursors in the two windows as described in
  136.                the Operation section above.
  137.  
  138. McCopts.txed - This macro opens up a CON: window to get the new compiler
  139.                options.
  140.  
  141. McCstmain.txed - This is a TxEd startup macro for the main edit window.  It
  142.                  also calls a startup.txed macro if you have one.
  143.  
  144. McCsterr.txed - This is a TxEd startup macro for the error message window.
  145.  
  146.  
  147. Bug Reports and Comments:
  148.  
  149.    The best way to get in touch with me is to send BIX mail to jmcclennan. 
  150. Failing that, send paper (yecch!) mail to:
  151.  
  152.                John McClennan
  153.                65 Bonney Dr.
  154.                Holliston, MA  01746
  155.