home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Amiga MA Magazine 1998 #6
/
amigamamagazinepolishissue1998.iso
/
coders
/
jËzyki_programowania
/
ace_basic
/
ace
/
include
/
dos
/
rdargs.h
< prev
next >
Wrap
C/C++ Source or Header
|
1977-12-31
|
5KB
|
139 lines
#ifndef DOS_RDARGS_H
#define DOS_RDARGS_H 1
/*
** rdargs.h for ACE Basic
**
** Note: Translated to ACE by ConvertC2ACE
** @ MapMeadow Software, Nils Sjoholm
**
**
** Date: 09/02/95
**
**
*/
/*
** This are the StructPointer defines for rdargs.h
*/
#ifndef CSourcePtr
#define CSourcePtr ADDRESS
#endif
#ifndef RDArgsPtr
#define RDArgsPtr ADDRESS
#endif
/*
** End of StructPointer defines for rdargs.h
*/
#ifndef EXEC_TYPES_H
#include <exec/types.h>
#endif
#ifndef EXEC_NODES_H
#include <exec/nodes.h>
#endif
/**********************************************************************
*
* The CSource data structure defines the input source for "ReadItem()"
* as well as the ReadArgs call. It is a publicly defined structure
* which may be used by applications which use code that follows the
* conventions defined for access.
*
* When passed to the dos.library functions, the value passed as
* STRUCT *CSource is defined as follows:
* if ( CSource == 0) Use buffered IO "ReadChar()" as data source
* else Use CSource for input character stream
*
* The following two pseudo-code routines define how the CSource structure
* is used:
*
* LONGINT CS_ReadChar( STRUCT CSource *CSource )
*
* if ( CSource == 0 ) return ReadChar()
* if ( CSource->CurChr >= CSource->Length ) return ENDSTREAMCHAR
* return CSource->Buffer[CSource->CurChr++]
* END STRUCT
*
* SHORTINT CS_UnReadChar( STRUCT CSource *CSource )
*
* if ( CSource == 0 ) return UnReadChar()
* if ( CSource->CurChr <= 0 ) return FALSE
* CSource->CurChr--
* return TRUE
* END STRUCT
*
* To initialize a STRUCT CSource, you set CSource->CS_Buffer to
* a string which is used as the data source, and set CS_Length to
* the number of characters in the string. Normally CS_CurChr should
* be initialized to ZERO, or left as it was from prior use as
* a CSource.
*
**********************************************************************/
STRUCT CSource
ADDRESS CS_Buffer
LONGINT CS_Length
LONGINT CS_CurChr
END STRUCT
/**********************************************************************
*
* The RDArgs data structure is the input parameter passed to the DOS
* ReadArgs() function call.
*
* The RDA_Source structure is a CSource as defined above
* if RDA_Source.CS_Buffer is non-null, RDA_Source is used as the input
* character stream to parse, else the input comes from the buffered STDIN
* calls ReadChar/UnReadChar.
*
* RDA_DAList is a private address which is used internally to track
* allocations which are freed by FreeArgs(). This MUST be initialized
* to NULL prior to the first call to ReadArgs().
*
* The RDA_Buffer and RDA_BufSiz fields allow the application to supply
* a fixed-size buffer in which to store the parsed data. This allows
* the application to pre-allocate a buffer rather than requiring buffer
* space to be allocated. If either RDA_Buffer or RDA_BufSiz is NULL,
* the application has not supplied a buffer.
*
* RDA_ExtHelp is a text string which will be displayed instead of the
* template string, if the user is prompted for input.
*
* RDA_Flags bits control how ReadArgs() works. The flag bits are
* defined below. Defaults are initialized to ZERO.
*
**********************************************************************/
STRUCT RDArgs
CSource RDA_Source /* Select input source */
LONGINT RDA_DAList /* PRIVATE. */
ADDRESS RDA_Buffer /* Optional string parsing space. */
LONGINT RDA_BufSiz /* Size of RDA_Buffer (0..n) */
ADDRESS RDA_ExtHelp /* Optional extended help */
LONGINT RDA_Flags /* Flags for any required control */
END STRUCT
#define RDAB_STDIN 0 /* Use "STDIN" rather than "COMMAND LINE" */
#define RDAF_STDIN 1
#define RDAB_NOALLOC 1 /* If set, do not allocate extra string space.*/
#define RDAF_NOALLOC 2
#define RDAB_NOPROMPT 2 /* Disable reprompting for string input. */
#define RDAF_NOPROMPT 4
/**********************************************************************
* Maximum number of template keywords which can be in a template passed
* to ReadArgs(). IMPLEMENTOR NOTE - must be a multiple of 4.
**********************************************************************/
#define MAX_TEMPLATE_ITEMS 100
/**********************************************************************
* Maximum number of MULTIARG items returned by ReadArgs(), before
* an ERROR_LINE_TOO_LONG. These two limitations are due to stack
* usage. Applications should allow "a lot" of stack to use ReadArgs().
**********************************************************************/
#define MAX_MULTIARGS 128
#endif /* DOS_RDARGS_H */