home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / prog / c / quik_fix.lzh / README < prev   
Lisp/Scheme  |  1992-12-08  |  3KB  |  116 lines
  1.          Using Aztec C QuikFix with GNU Emacs
  2.       ==================================================
  3. Contents:
  4.     README            - this file.
  5.  
  6.     quik-fix.el        - GNU Emacs code.
  7.  
  8.     quik-fix.rexx        - AREXX script to communicate with
  9.                   GNU Emacs.
  10.  
  11.     quik-fix-stop.rexx    - AREXX script to abort QuikFix from
  12.                   outside of GNU Emacs.
  13.  
  14.     menu_example        - example menu to use with QuikFix
  15.  
  16. Requirements:
  17.     o  GNU Emacs 18.58, Amiga port 1.25DG
  18.        Thanks to David Gay (dgay@di.epfl.ch) for a great port!
  19.  
  20.     o  runback - the quik-fix.rexx script starts emacs with the
  21.        runback command (that is, if emacs is not already running).
  22.        If necessary, you can edit the script to use something else.
  23.  
  24. Installing:
  25.     1. Place quik-fix.el in the GNUEmacs:lisp directory.
  26.  
  27.     2. Place the ARexx scripts in the GNUEmacs: directory.
  28.        (actually, it can go anywhere, but this is what I assume
  29.        for the following instructions)
  30.  
  31.     3. Edit the "Config" section of each quik-fix file.
  32.  
  33.     4. Create the CCEDIT environment variable.  Use the Aztec
  34.        "mset" command.  For example:
  35.         mset "CCEDIT=SYS:RexxC/rx GNUEmacs:quik-fix.rexx"
  36.  
  37.     5. Put the following line in your "s:.emacs" file:
  38.         (load "quik-fix")
  39.  
  40.        or, you can use the following line instead:
  41.         (autoload 'quik-fix-start "quik-fix" nil t)
  42.  
  43.        This makes emacs load the quick-fix code only when needed
  44.        (thus speeding up your startup when not using quick-fix)
  45.  
  46.     6. Use the "-qf" flag when you compile.     The compiler
  47.        automatically executes the CCEDIT command if there is an
  48.        error or a warning.
  49.  
  50. Using:
  51.     0. The compiler starts QuikFix automatically.  If emacs
  52.        is not already running, the quik-fix.rexx script starts
  53.        it.    After emacs is running, the script executes the
  54.        (quik-fix-start) command.
  55.  
  56.     1. Call the following commands to move from error to error:
  57.         quik-fix-next        - goto next error
  58.         quik-fix-previous    - goto previous error
  59.         quik-fix-current    - goto current error
  60.         quik-fix-first        - goto first error
  61.         quik-fix-last        - goto last error
  62.  
  63.     2. Call one of the following commands when you are done:
  64.         quik-fix-stop        - cancel the compile
  65.         quik-fix-recompile    - recompile the file
  66.  
  67.        These commands ask you to save your files, but do not
  68.        exit from emacs.
  69.  
  70.     3. If, for some reason, you cannot stop QuikFix from within
  71.        emacs, execute the quik-fix-stop.rexx ARexx script.
  72.  
  73.  
  74. Notes:
  75.     Format of the file "AztecC.Err" (as far as I can tell):
  76.  
  77.        str>int:int:char:int:str:
  78.         |    |   |    |  |  |
  79.         |    |   |    |  |  --- description
  80.         |    |   |    |  |
  81.         |    |   |    |  --- error code number
  82.         |    |   |    |
  83.         |    |   |    --- [EW] error or warning
  84.         |    |   |
  85.         |    |   --- column
  86.         |    |
  87.         |    --- line
  88.         |
  89.         --- filename
  90.  
  91.  
  92. Bugs:
  93.     o (quik-fix-start) displays the error message, but then emacs
  94.       erases it. As a workaround, select the (quik-fix-current)
  95.       command to redisplay the error message.
  96.  
  97. Todo:
  98.     o If the EMACS1 ARexx port is not open, check for EMACS2, etc.
  99.  
  100.     o Figure out how to load more than 25 errors (if possible)
  101.  
  102.     o Add an optional argument to the movement commands. If you
  103.       call the command with an argument, move to an error. If you
  104.       call the command without an argument move to an error or a
  105.       warning.  Send me your opinions, or modify the code
  106.       yourself.
  107.  
  108. Send comments to
  109.  
  110. Patrick Fitzgerald
  111. 203 Utica Place, Apt. 24
  112. Huntsville, AL 35806 (USA)
  113.  
  114. pat@fitz.b17d.ingr.com    <--- soon to change, see below
  115. pat@fitz.b30.ingr.com    <--- starting mid-July 1992
  116.