home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / eco12.zip / readme.txt < prev   
Text File  |  1999-06-29  |  8KB  |  249 lines
  1. ------------------------------------------------------------
  2.   ECO 1.2 - EPM menu for Java/C/IPF editing and compiling
  3. ------------------------------------------------------------
  4.         
  5.  
  6. Read this carefully, even when using a previous version
  7. already!  In case you are using ECO with the "Editor for
  8. Java", then, please, check the settings of the related
  9. program object; the installation instructions distributed
  10. with the previous ECO versions had a minor error as to this
  11. subject.  Many apologies for this mistake!
  12.  
  13.  
  14.  
  15. Contents
  16. --------
  17. What is ECO ?
  18. Installing ECO
  19. Using ECO
  20. Using ECO with jikes
  21. Syntax Highlighting
  22. ECO - the Pro(fessional) version
  23. History
  24. Credits
  25. Support
  26.  
  27.  
  28.  
  29. What is ECO ?
  30. -------------
  31. Using ECO, you can run a compiler or the "make" utility from
  32. an EPM menu, view the transcript of the compilation process
  33. within the editor, and link compiler error messages to the
  34. corresponding lines of the source file.  
  35. The latter facility requires the EPM to understand the
  36. format of the error messages; currently the Java compilers
  37. javac and jikes, GNU C, VisualAge C and ipfc are supported.
  38.  
  39. A menu item is provided for controlling the syntax
  40. highlighting of Java, C, HTML, IPF and "make" files.
  41.  
  42. ECO requires EPM version 6.03b which comes with Warp 4 (not
  43. with Warp 3) or can be downloaded freely from various sites.
  44.  
  45. ECO has been tested with the following compilers:
  46.  
  47. * javac from JDK 1.1.7
  48. * jikes v0.57
  49. * gcc 2.8.1
  50. * VAC++ V3.0
  51. * ipfc 4.00.
  52.  
  53.  
  54.  
  55. Installing ECO
  56. --------------
  57. 1) Copy the file eco.ex to the directory where your EPM 
  58. resides, usually \OS2\APPS on the boot drive.
  59.  
  60. 2a) Add the following line (including the quotes) to your
  61. EPM Rexx profile, i.e. the file PROFILE.ERX:
  62.  
  63.         'link eco'
  64.  
  65. What is ECO ?
  66. Make sure that "REXX profile" is enabled in the EPM
  67. settings!  In this case the eco module will _always_ be
  68. linked when the EPM starts up.
  69.  
  70. alternatively:
  71.  
  72. 2b) Open the settings notebook of the program object "Editor
  73. for Java" and enter the following line (incl. the quotes)
  74. into the "parameter" entry field:
  75.  
  76.         /m 'link eco'
  77.  
  78. Then the eco module will only be linked when the EPM is run
  79. via this program object.  (The program object "Editor for 
  80. Java" is part of the JDK.)
  81.  
  82. 3) (Re)start the editor.  There should be an additional
  83. submenu named "Compile" then.
  84.  
  85. 4) The source code files eco.e and ecostuff.add are NOT
  86. required to use the eco module.  You may, however, recompile
  87. the EPM editor with the ECO module included permanently, see
  88. the section "ECO - the Pro(fessional) version" near the end
  89. of this document!
  90.  
  91.  
  92.  
  93. Using ECO
  94. ---------
  95. 1) Edit your Java, C, C++, or ipf program source.
  96.  
  97. 2) Select the menu item "Compile/Compile".
  98.  
  99. 3) The command which is displayed here will be executed in
  100. the directory of the current file, when you click on "Run".
  101. The default is to run the current file through the Java
  102. compiler "javac"; edit this according to your needs.  
  103. Any occurrence of %**F will expand to the current filename
  104. including the extension; %**N will expand to the filename
  105. without extension.  
  106. Instead of invoking a compiler you may also run the "make"
  107. utility (or execute any other program).
  108. The command is memorized, so you need not enter it again
  109. when repeating compilation; it is saved when you leave the
  110. editor.
  111.  
  112. 4) Click on "Run"; the EPM will switch to a shell window,
  113. where the command is executed.  
  114. The current file is saved automagically before this step is
  115. performed, as well as all other files recognized as Java, C,
  116. or IPF.  The following file types are honored:  JAV JAVA C H
  117. SQC CPP HPP CXX HXX SQX IPF.  (Please, note that the current
  118. file is _always_ saved, regardless of its type.)
  119.  
  120. 5) Select the menu item "Compile/Locate next error".  The
  121. EPM will search for the first error message, switch to the
  122. corresponding line of the source code and show the error
  123. message in its message line.  
  124. ECO understands the format of the error messages generated
  125. by javac, jikes, gcc and VisualAge C as well as the format
  126. of the IPF compiler ipfc 4.00.  In case the exact column of
  127. the error is indicated in the transcript, the erroneous
  128. token will be marked by a red circle.
  129.  
  130. 6) Select "Locate next error" again (without returning to
  131. the transcript):  The cursor will jump to the location of
  132. the next error in the source code.  
  133.  
  134. 7) Select the menu item "Compile/View transcript" while
  135. editing the source code or any other file:  The EPM will
  136. switch to the shell window and move the cursor (if possible)
  137. to the latest error found before.
  138.  
  139. 8) Select "Locate next error" while editing the transcript:
  140. In this case the search for the next error starts in the
  141. current line of this file.
  142.  
  143. 9) Select the menu item "Compile/View transcript" while
  144. editing the transcript:  The cursor will jump to the first
  145. line of the latest compilation protocol, and the error
  146. searching facility is reset to that line.
  147.  
  148.  
  149.  
  150. Using ECO with jikes
  151. --------------------
  152. The jikes compiler must be called with the option +E, so as
  153. to generate suitable error messages for use with ECO.  
  154. ECO is known to work with jikes v0.57; earlier versions are
  155. _not_ supported, due to a different format of the error
  156. messages.
  157.  
  158.  
  159.  
  160. Syntax Highlighting
  161. -------------------
  162. Select the menu item "Compile/Highlighting" to toggle syntax
  163. highlighting of Java, C, IPF, HTML and "make" files".  This
  164. affects the current file only.  The setting is not saved
  165. when you quit the editor!
  166.  
  167. Syntax highlighting is controlled by the keyword files
  168. EPMKWDS.*, which are part of the OS/2 EPM package.  The
  169. colors defined in these files suit the default color scheme
  170. of the editor.
  171.  
  172.  
  173.  
  174. ECO - the Pro(fessional) version
  175. --------------------------------
  176. In case you have got the EPM source code and IBM's ETPM
  177. compiler, you can recompile the EPM so as to include the ECO
  178. module permanently:  
  179.  
  180. Put the source file eco.e in a directory where the ETPM can
  181. find it, and append the contents of the file ecostuff.add to
  182. an existing mystuff.e file (or rename ecostuff.add to
  183. mystuff.e, if the latter does not yet exist.)  Then compile
  184. the EPM, and -- voila -- there's the Compile menu!  Do NOT
  185. link the ready-made module eco.ex additionally then!
  186.  
  187. With the Pro version, the ECO menu and the particular items
  188. are enabled with suitable file types only.
  189.  
  190.  
  191.  
  192. History
  193. -------
  194. 1999-06-28: v1.2
  195.   * Support for VisualAge C and jikes added.
  196.   * Highlighting of "make" files added.
  197.   * Menu shortcuts.
  198.   * Optional "Pro" version.
  199.   * Small changes to the documentation.
  200.  
  201. 1999-01-13: v1.1
  202.   * sensible error message when "Highlighting" is requested
  203.     for a file type other than Java, HTML, C or IPF
  204.   
  205. 1998-10-17:  v1.0
  206.   * Support for ipfc and syntax highlighting added.
  207.   * The column of an error is marked by a red circle.
  208.   * Better documentation.
  209.   
  210. 1998-04-14:  v0.9
  211.   * The first public version.
  212.  
  213.  
  214.  
  215. Credits
  216. -------
  217. Special thanks to Dr. J.Hoffmann (Rechenzentrum der RWTH
  218. Aachen, Abteilung Numerik), who provided the suppport for
  219. Visual Age C++ and jikes, helped me with testing, and
  220. contributed many good ideas.
  221.  
  222.  
  223.  
  224. Support
  225. -------
  226. In case you encounter any problems with ECO, or if you have
  227. any suggestions for improving it, then write an e-mail
  228. message to the author:
  229.  
  230. Walter Schmidt  <walter.schmidt@arcormail.de>
  231.  
  232. Please, obtain my address from the latest version of this
  233. document!
  234.  
  235. The latest version of this software can usually be obtained
  236. from the "Hobbes" software archive.
  237.  
  238.  
  239.  
  240. Finally ...
  241. -----------
  242. ...  I would like to apologize for any mistakes in this
  243. document.  English is not my native language.  Suggestions
  244. for improving this document and the messages displayed by
  245. the program are welcome.
  246.  
  247. -- finis
  248.  
  249.