home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 10 / Fresh_Fish_10_2352.bin / useful / util / edit / mg / src.lzh / amiga / storage.h < prev    next >
C/C++ Source or Header  |  1990-05-23  |  18KB  |  373 lines
  1. /* === rexx/storage.h ==================================================
  2.  *
  3.  * Copyright (c) 1986, 1987 by William S. Hawes (All Rights Reserved)
  4.  *
  5.  * =====================================================================
  6.  * Header file to define ARexx data structures.
  7.  */
  8.  
  9. #ifndef REXX_STORAGE_H
  10. #define REXX_STORAGE_H
  11.  
  12. #ifndef EXEC_TYPES_H
  13. #include "exec/types.h"
  14. #endif
  15.  
  16. #ifndef EXEC_NODES_H
  17. #include "exec/nodes.h"
  18. #endif
  19.  
  20. #ifndef EXEC_LISTS_H
  21. #include "exec/lists.h"
  22. #endif
  23.  
  24. #ifndef EXEC_PORTS_H
  25. #include "exec/ports.h"
  26. #endif
  27.  
  28. #ifndef EXEC_LIBRARIES_H
  29. #include "exec/libraries.h"
  30. #endif
  31.  
  32. #ifndef LIBRARIES_DOS_H
  33. #include <libraries/dos.h>
  34. #endif
  35.  
  36. /* The NexxStr structure is used to maintain the internal strings in REXX.
  37.  * It includes the buffer area for the string and associated attributes.
  38.  * This is actually a variable-length structure; it is allocated for a
  39.  * specific length string, and the length is never modified thereafter
  40.  * (since it's used for recycling).
  41.  */
  42.  
  43. struct NexxStr {
  44.    LONG     ns_Ivalue;                 /* integer value                 */
  45.    UWORD    ns_Length;                 /* length in bytes (excl null)   */
  46.    UBYTE    ns_Flags;                  /* attribute flags               */
  47.    UBYTE    ns_Hash;                   /* hash code                     */
  48.    BYTE     ns_Buff[8];                /* buffer area for strings       */
  49.    };                                  /* size: 16 bytes (minimum)      */
  50.  
  51. #define NXADDLEN 9                     /* offset plus null byte         */
  52. #define IVALUE(nsPtr) (nsPtr->ns_Ivalue)
  53.  
  54. /* String attribute flag bit definitions                                */
  55. #define NSB_KEEP     0                 /* permanent string?             */
  56. #define NSB_STRING   1                 /* string form valid?            */
  57. #define NSB_NOTNUM   2                 /* non-numeric?                  */
  58. #define NSB_NUMBER   3                 /* a valid number?               */
  59. #define NSB_BINARY   4                 /* integer value saved?          */
  60. #define NSB_FLOAT    5                 /* floating point format?        */
  61. #define NSB_EXT      6                 /* an external string?           */
  62. #define NSB_SOURCE   7                 /* part of the program source?   */
  63.  
  64. /* The flag form of the string attributes                               */
  65. #define NSF_KEEP     (1 << NSB_KEEP  )
  66. #define NSF_STRING   (1 << NSB_STRING)
  67. #define NSF_NOTNUM   (1 << NSB_NOTNUM)
  68. #define NSF_NUMBER   (1 << NSB_NUMBER)
  69. #define NSF_BINARY   (1 << NSB_BINARY)
  70. #define NSF_FLOAT    (1 << NSB_FLOAT )
  71. #define NSF_EXT      (1 << NSB_EXT   )
  72. #define NSF_SOURCE   (1 << NSB_SOURCE)
  73.  
  74. /* Combinations of flags                                                */
  75. #define NSF_INTNUM   (NSF_NUMBER | NSF_BINARY | NSF_STRING)
  76. #define NSF_DPNUM    (NSF_NUMBER | NSF_FLOAT)
  77. #define NSF_ALPHA    (NSF_NOTNUM | NSF_STRING)
  78. #define NSF_OWNED    (NSF_SOURCE | NSF_EXT    | NSF_KEEP)
  79. #define KEEPSTR      (NSF_STRING | NSF_SOURCE | NSF_NOTNUM)
  80. #define KEEPNUM      (NSF_STRING | NSF_SOURCE | NSF_NUMBER | NSF_BINARY)
  81.  
  82. /* The RexxArg structure is identical to the NexxStr structure, but
  83.  * is allocated from system memory rather than from internal storage.
  84.  * This structure is used for passing arguments to external programs.
  85.  * It is usually passed as an "argstring", a pointer to the string buffer.
  86.  */
  87.  
  88. struct RexxArg {
  89.    LONG     ra_Size;                   /* total allocated length        */
  90.    UWORD    ra_Length;                 /* length of string              */
  91.    UBYTE    ra_Flags;                  /* attribute flags               */
  92.    UBYTE    ra_Hash;                   /* hash code                     */
  93.    BYTE     ra_Buff[8];                /* buffer area                   */
  94.    };                                  /* size: 16 bytes (minimum)      */
  95.  
  96. /* The RexxMsg structure is used for all communications with REXX
  97.  * programs.  It is an EXEC message with a parameter block appended.
  98.  */
  99.  
  100. struct RexxMsg {
  101.    struct Message rm_Node;             /* EXEC message structure        */
  102.    APTR     rm_TaskBlock;              /* global structure (private)    */
  103.    APTR     rm_LibBase;                /* library base (private)        */
  104.    LONG     rm_Action;                 /* command (action) code         */
  105.    LONG     rm_Result1;                /* primary result (return code)  */
  106.    LONG     rm_Result2;                /* secondary result              */
  107.    STRPTR   rm_Args[16];               /* argument block (ARG0-ARG15)   */
  108.  
  109.    struct MsgPort *rm_PassPort;        /* forwarding port               */
  110.    STRPTR   rm_CommAddr;               /* host address (port name)      */
  111.    STRPTR   rm_FileExt;                /* file extension                */
  112.    LONG     rm_Stdin;                  /* input stream (filehandle)     */
  113.    LONG     rm_Stdout;                 /* output stream (filehandle)    */
  114.    LONG     rm_avail;                  /* future expansion              */
  115.    };                                  /* size: 128 bytes               */
  116.  
  117. /* Field definitions                                                    */
  118. #define ARG0(rmp) (rmp->rm_Args[0])    /* start of argblock             */
  119. #define ARG1(rmp) (rmp->rm_Args[1])    /* first argument                */
  120. #define ARG2(rmp) (rmp->rm_Args[2])    /* second argument               */
  121.  
  122. #define MAXRMARG  15                   /* maximum arguments             */
  123.  
  124. /* Command (action) codes for message packets                           */
  125. #define RXCOMM    0x01000000           /* a command-level invocation    */
  126. #define RXFUNC    0x02000000           /* a function call               */
  127. #define RXCLOSE   0x03000000           /* close the REXX server         */
  128. #define RXQUERY   0x04000000           /* query for information         */
  129. #define RXADDFH   0x07000000           /* add a function host           */
  130. #define RXADDLIB  0x08000000           /* add a function library        */
  131. #define RXREMLIB  0x09000000           /* remove a function library     */
  132. #define RXADDCON  0x0A000000           /* add/update a ClipList string  */
  133. #define RXREMCON  0x0B000000           /* remove a ClipList string      */
  134. #define RXTCOPN   0x0C000000           /* open the trace console        */
  135. #define RXTCCLS   0x0D000000           /* close the trace console       */
  136.  
  137. /* Command modifier flag bits                                           */
  138. #define RXFB_NOIO    16                /* suppress I/O inheritance?     */
  139. #define RXFB_RESULT  17                /* result string expected?       */
  140. #define RXFB_STRING  18                /* program is a "string file"?   */
  141. #define RXFB_TOKEN   19                /* tokenize the command line?    */
  142. #define RXFB_NONRET  20                /* a "no-return" message?        */
  143.  
  144. /* The flag form of the command modifiers                               */
  145. #define RXFF_NOIO    (1L << RXFB_NOIO  )
  146. #define RXFF_RESULT  (1L << RXFB_RESULT)
  147. #define RXFF_STRING  (1L << RXFB_STRING)
  148. #define RXFF_TOKEN   (1L << RXFB_TOKEN )
  149. #define RXFF_NONRET  (1L << RXFB_NONRET)
  150.  
  151. #define RXCODEMASK   0xFF000000
  152. #define RXARGMASK    0x0000000F
  153.  
  154. /* The RexxRsrc structure is used to manage global resources.  Each node 
  155.  * has a name string created as a RexxArg structure, and the total size
  156.  * of the node is saved in the "rr_Size" field.  The REXX systems library
  157.  * provides functions to allocate and release resource nodes.  If special
  158.  * deletion operations are required, an offset and base can be provided in
  159.  * "rr_Func" and "rr_Base", respectively.  This "autodelete" function will
  160.  * be called with the base in register A6 and the node in A0.
  161.  */
  162.  
  163. struct RexxRsrc {
  164.    struct Node rr_Node;
  165.    WORD     rr_Func;                   /* "auto-delete" offset          */
  166.    APTR     rr_Base;                   /* "auto-delete" base            */
  167.    LONG     rr_Size;                   /* total size of node            */
  168.    LONG     rr_Arg1;                   /* available ...                 */
  169.    LONG     rr_Arg2;                   /* available ...                 */
  170.    };                                  /* size: 32 bytes                */
  171.  
  172. /* Resource node types                                                  */
  173. #define RRT_ANY