Include2GED1.1

Short:        ARexx macro for developers using GoldED
Author:       one@risc.upol.cz (Jan Skypala)
Uploader:     one risc upol cz
Type:         dev/misc
Architecture: m68k-amigaos

VERSION
    $VER: Include2GEDDict.readme 1.1 06.03.95

COPYRIGHT
    ©1995 Jan Skypala, Better Software

DISTRIBUTION
    This file is freeware, but also copyrighted to its author.
    You can distribute it in unchaged form for no or nominal fee, upload it to
    BBS, include on public domain CD-ROMs (like Aminet or Fred Fish), in
    magazines.
    It is permitted to include this macro within GoldED archive.
    It is permitted to include this macro in GoldED macro collections (like
    ESEE).
    I would not mind if you send a copy of magazine or free CD if you decided to
    publish it in the magazine or on the CD-ROM.
    It is permitted to include this macro in language packages (I would not mind
    if you send me a copy of package)
    I would not mind if you send at least postcard.

DESCRIPTION
    This is Arexx macro to make life more comfortable. If you like using GoldED
    dictionary for autocompletition and autocasing you maybe hate manual
    inserting every word you want. That's why this Arexx script comes. Running
    it on standard files it will grab the words for them and insert them into
    dictionary automaticaly. Currently recognized files:

    .fd    files with list of libraries functions
    .h     C include files
    .i     assembler include files
    .m     AmigaE include files

USAGE
    rx Include2GEDDict.rexx FILES/M

    FILES - list of files (including paths). If not specified and rexxreqtools
            library available then file requester opens and lets you select
            files.

REQUIREMENTS
    GoldED running
    rexxreqtools.library for file requester if no files specified
    ec:ShowModule for AmigaE modules processing

BUGS
    The program doesn't process two level nested C structures. It's built in,
    but GoldED crashes sometimes when I insert the words into dictionary (maybe
    they are too long), so I made the program to ignore them i.e. it will not
    produce any mischmasch in dictionary. If you want to see the place it is
    lines 381-384 in the program. It is the case of following include files and
    structures:
    devices/inputevent.h
        InputEvent.ie_position.ie_xy.ie_x
        InputEvent.ie_position.ie_xy.ie_y
        InputEvent.ie_position.ie_dead.ie_prev1DownCode
        InputEvent.ie_position.ie_dead.ie_prev1DownQual
        InputEvent.ie_position.ie_dead.ie_prev2DownCode
        InputEvent.ie_position.ie_dead.ie_prev2DownQual
    dos/dosextens.h
        DosList.dol_misc.dol_handler.dol_Handler
        DosList.dol_misc.dol_handler.dol_StackSize
        DosList.dol_misc.dol_handler.dol_Priority
        DosList.dol_misc.dol_handler.dol_Startup
        DosList.dol_misc.dol_handler.dol_SegList
        DosList.dol_misc.dol_handler.dol_GlobVec
        DosList.dol_misc.dol_volume.dol_VolumeDate
        DosList.dol_misc.dol_volume.dol_LockList
        DosList.dol_misc.dol_volume.dol_DiskType
        DosList.dol_misc.dol_assign.dol_AssignName
        DosList.dol_misc.dol_assign.dol_List
    dos/notify.h
        NotifyRequest.nr_stuff.nr_Msg.nr_Port
        NotifyRequest.nr_stuff.nr_Signal.nr_Task
        NotifyRequest.nr_stuff.nr_Signal.nr_SignalNum
        NotifyRequest.nr_stuff.nr_Signal.nr_pad
    You can insert them manually, of course.
    There are no three level nested structures in include files so I didn't care
    about them at all.

HISTORY
    1.0 - first public release
    1.1 - error messages showing in shell eliminated
        - now also understands macro definitions in AmigaE .m modules
        - one level nested C structures are now processed alright
        - typedef struct { ... } name (used in intuition/classusr.h) corrected
        - two level nested C structures processed, just because of GoldED
          crashing the words are not inserted into dictionary yet.
        - arrays in C structures now processed alright

FUTURE
    If you send me files e.g. for pascal I can do the work for them too. Just in
    the case they are pre-compiled (like AmigaE modules) I need some utility to
    convert them into text files.

AUTHOR'S ADDRESSES
    e-mail:     one@risc.upol.cz
    snail mail: Jan Skypala
                Zasovska 730
                Valasske Mezirici
                757 01
                Czech Republic