home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / bbs / cbm / os-include.lha / os-include / dos / rdargs.h < prev    next >
C/C++ Source or Header  |  1993-10-15  |  4KB  |  125 lines
  1. #ifndef DOS_RDARGS_H
  2. #define DOS_RDARGS_H
  3. /*
  4. **
  5. **    $VER: rdargs.h 36.6 (12.7.90)
  6. **    Includes Release 40.15
  7. **
  8. **    ReadArgs() structure definitions
  9. **
  10. **    (C) Copyright 1989-1993 Commodore-Amiga, Inc.
  11. **        All Rights Reserved
  12. **
  13. */
  14.  
  15. #ifndef EXEC_TYPES_H
  16. #include "exec/types.h"
  17. #endif
  18.  
  19. #ifndef EXEC_NODES_H
  20. #include "exec/nodes.h"
  21. #endif
  22.  
  23. /**********************************************************************
  24.  *
  25.  * The CSource data structure defines the input source for "ReadItem()"
  26.  * as well as the ReadArgs call.  It is a publicly defined structure
  27.  * which may be used by applications which use code that follows the
  28.  * conventions defined for access.
  29.  *
  30.  * When passed to the dos.library functions, the value passed as
  31.  * struct *CSource is defined as follows:
  32.  *    if ( CSource == 0)    Use buffered IO "ReadChar()" as data source
  33.  *    else            Use CSource for input character stream
  34.  *
  35.  * The following two pseudo-code routines define how the CSource structure
  36.  * is used:
  37.  *
  38.  * long CS_ReadChar( struct CSource *CSource )
  39.  * {
  40.  *    if ( CSource == 0 )    return ReadChar();
  41.  *    if ( CSource->CurChr >= CSource->Length )    return ENDSTREAMCHAR;
  42.  *    return CSource->Buffer[ CSource->CurChr++ ];
  43.  * }
  44.  *
  45.  * BOOL CS_UnReadChar( struct CSource *CSource )
  46.  * {
  47.  *    if ( CSource == 0 )    return UnReadChar();
  48.  *    if ( CSource->CurChr <= 0 )    return FALSE;
  49.  *    CSource->CurChr--;
  50.  *    return TRUE;
  51.  * }
  52.  *
  53.  * To initialize a struct CSource, you set CSource->CS_Buffer to
  54.  * a string which is used as the data source, and set CS_Length to
  55.  * the number of characters in the string.  Normally CS_CurChr should
  56.  * be initialized to ZERO, or left as it was from prior use as
  57.  * a CSource.
  58.  *
  59.  **********************************************************************/
  60.  
  61. struct CSource {
  62.     UBYTE    *CS_Buffer;
  63.     LONG    CS_Length;
  64.     LONG    CS_CurChr;
  65. };
  66.  
  67. /**********************************************************************
  68.  *
  69.  * The RDArgs data structure is the input parameter passed to the DOS
  70.  * ReadArgs() function call.
  71.  *
  72.  * The RDA_Source structure is a CSource as defined above;
  73.  * if RDA_Source.CS_Buffer is non-null, RDA_Source is used as the input
  74.  * character stream to parse, else the input comes from the buffered STDIN
  75.  * calls ReadChar/UnReadChar.
  76.  *
  77.  * RDA_DAList is a private address which is used internally to track
  78.  * allocations which are freed by FreeArgs().  This MUST be initialized
  79.  * to NULL prior to the first call to ReadArgs().
  80.  *
  81.  * The RDA_Buffer and RDA_BufSiz fields allow the application to supply
  82.  * a fixed-size buffer in which to store the parsed data.  This allows
  83.  * the application to pre-allocate a buffer rather than requiring buffer
  84.  * space to be allocated.  If either RDA_Buffer or RDA_BufSiz is NULL,
  85.  * the application has not supplied a buffer.
  86.  *
  87.  * RDA_ExtHelp is a text string which will be displayed instead of the
  88.  * template string, if the user is prompted for input.
  89.  *
  90.  * RDA_Flags bits control how ReadArgs() works.  The flag bits are
  91.  * defined below.  Defaults are initialized to ZERO.
  92.  *
  93.  **********************************************************************/
  94.  
  95. struct RDArgs {
  96.     struct    CSource RDA_Source;    /* Select input source */
  97.     LONG    RDA_DAList;        /* PRIVATE. */
  98.     UBYTE    *RDA_Buffer;        /* Optional string parsing space. */
  99.     LONG    RDA_BufSiz;        /* Size of RDA_Buffer (0..n) */
  100.     UBYTE    *RDA_ExtHelp;        /* Optional extended help */
  101.     LONG    RDA_Flags;        /* Flags for any required control */
  102. };
  103.  
  104. #define RDAB_STDIN    0    /* Use "STDIN" rather than "COMMAND LINE" */
  105. #define RDAF_STDIN    1
  106. #define RDAB_NOALLOC    1    /* If set, do not allocate extra string space.*/
  107. #define RDAF_NOALLOC    2
  108. #define RDAB_NOPROMPT    2    /* Disable reprompting for string input. */
  109. #define RDAF_NOPROMPT    4
  110.  
  111. /**********************************************************************
  112.  * Maximum number of template keywords which can be in a template passed
  113.  * to ReadArgs(). IMPLEMENTOR NOTE - must be a multiple of 4.
  114.  **********************************************************************/
  115. #define MAX_TEMPLATE_ITEMS    100
  116.  
  117. /**********************************************************************
  118.  * Maximum number of MULTIARG items returned by ReadArgs(), before
  119.  * an ERROR_LINE_TOO_LONG.  These two limitations are due to stack
  120.  * usage.  Applications should allow "a lot" of stack to use ReadArgs().
  121.  **********************************************************************/
  122. #define MAX_MULTIARGS        128
  123.  
  124. #endif /* DOS_RDARGS_H */
  125.