home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / dev / misc / Include2GED1_1.readme < prev    next >
Encoding:
Text File  |  1995-04-27  |  4.7 KB  |  117 lines
  1. Short:    ARexx macro for developers using GoldED
  2. Author:   one@risc.upol.cz (Jan Skypala)
  3. Uploader: one@risc.upol.cz
  4. Type:     dev/misc
  5.  
  6. VERSION
  7.     $VER: Include2GEDDict.readme 1.1 06.03.95
  8.  
  9. COPYRIGHT
  10.     ©1995 Jan Skypala, Better Software
  11.  
  12. DISTRIBUTION
  13.     This file is freeware, but also copyrighted to its author.
  14.     You can distribute it in unchaged form for no or nominal fee, upload it to
  15.     BBS, include on public domain CD-ROMs (like Aminet or Fred Fish), in
  16.     magazines.
  17.     It is permitted to include this macro within GoldED archive.
  18.     It is permitted to include this macro in GoldED macro collections (like
  19.     ESEE).
  20.     I would not mind if you send a copy of magazine or free CD if you decided to
  21.     publish it in the magazine or on the CD-ROM.
  22.     It is permitted to include this macro in language packages (I would not mind
  23.     if you send me a copy of package)
  24.     I would not mind if you send at least postcard.
  25.  
  26. DESCRIPTION
  27.     This is Arexx macro to make life more comfortable. If you like using GoldED
  28.     dictionary for autocompletition and autocasing you maybe hate manual
  29.     inserting every word you want. That's why this Arexx script comes. Running
  30.     it on standard files it will grab the words for them and insert them into
  31.     dictionary automaticaly. Currently recognized files:
  32.  
  33.     .fd    files with list of libraries functions
  34.     .h     C include files
  35.     .i     assembler include files
  36.     .m     AmigaE include files
  37.  
  38. USAGE
  39.     rx Include2GEDDict.rexx FILES/M
  40.  
  41.     FILES - list of files (including paths). If not specified and rexxreqtools
  42.             library available then file requester opens and lets you select
  43.             files.
  44.  
  45. REQUIREMENTS
  46.     GoldED running
  47.     rexxreqtools.library for file requester if no files specified
  48.     ec:ShowModule for AmigaE modules processing
  49.  
  50. BUGS
  51.     The program doesn't process two level nested C structures. It's built in,
  52.     but GoldED crashes sometimes when I insert the words into dictionary (maybe
  53.     they are too long), so I made the program to ignore them i.e. it will not
  54.     produce any mischmasch in dictionary. If you want to see the place it is
  55.     lines 381-384 in the program. It is the case of following include files and
  56.     structures:
  57.     devices/inputevent.h
  58.         InputEvent.ie_position.ie_xy.ie_x
  59.         InputEvent.ie_position.ie_xy.ie_y
  60.         InputEvent.ie_position.ie_dead.ie_prev1DownCode
  61.         InputEvent.ie_position.ie_dead.ie_prev1DownQual
  62.         InputEvent.ie_position.ie_dead.ie_prev2DownCode
  63.         InputEvent.ie_position.ie_dead.ie_prev2DownQual
  64.     dos/dosextens.h
  65.         DosList.dol_misc.dol_handler.dol_Handler
  66.         DosList.dol_misc.dol_handler.dol_StackSize
  67.         DosList.dol_misc.dol_handler.dol_Priority
  68.         DosList.dol_misc.dol_handler.dol_Startup
  69.         DosList.dol_misc.dol_handler.dol_SegList
  70.         DosList.dol_misc.dol_handler.dol_GlobVec
  71.         DosList.dol_misc.dol_volume.dol_VolumeDate
  72.         DosList.dol_misc.dol_volume.dol_LockList
  73.         DosList.dol_misc.dol_volume.dol_DiskType
  74.         DosList.dol_misc.dol_assign.dol_AssignName
  75.         DosList.dol_misc.dol_assign.dol_List
  76.     dos/notify.h
  77.         NotifyRequest.nr_stuff.nr_Msg.nr_Port
  78.         NotifyRequest.nr_stuff.nr_Signal.nr_Task
  79.         NotifyRequest.nr_stuff.nr_Signal.nr_SignalNum
  80.         NotifyRequest.nr_stuff.nr_Signal.nr_pad
  81.     You can insert them manually, of course.
  82.     There are no three level nested structures in include files so I didn't care
  83.     about them at all.
  84.  
  85. HISTORY
  86.     1.0 - first public release
  87.     1.1 - error messages showing in shell eliminated
  88.         - now also understands macro definitions in AmigaE .m modules
  89.         - one level nested C structures are now processed alright
  90.         - typedef struct { ... } name (used in intuition/classusr.h) corrected
  91.         - two level nested C structures processed, just because of GoldED
  92.           crashing the words are not inserted into dictionary yet.
  93.         - arrays in C structures now processed alright
  94.  
  95. FUTURE
  96.     If you send me files e.g. for pascal I can do the work for them too. Just in
  97.     the case they are pre-compiled (like AmigaE modules) I need some utility to
  98.     convert them into text files.
  99.  
  100. AUTHOR'S ADDRESSES
  101.     e-mail:     one@risc.upol.cz
  102.     snail mail: Jan Skypala
  103.                 Zasovska 730
  104.                 Valasske Mezirici
  105.                 757 01
  106.                 Czech Republic
  107.  
  108.  
  109. ============================= Archive contents =============================
  110.  
  111. Original  Packed Ratio    Date     Time    Name
  112. -------- ------- ----- --------- --------  -------------
  113.    24151    4435 81.6% 02-Sep-92 14:40:50  Include2GEDDict.rexx
  114.      691     195 71.7% 02-Sep-92 14:07:06  Include2GEDDict.rexx.info
  115. -------- ------- ----- --------- --------
  116.    24842    4630 81.3% 09-Mar-95 16:39:00   2 files
  117.