WebSVN – tendra.SVN – Diff – /branches/tendra5/src/producers/common/c_types.h

+/*
+ * Copyright (c) 2002-2006 The TenDRA Project <http://www.tendra.org/>.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of The TenDRA Project nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific, prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
+ * IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+ * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+ * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * $Id$
+ */
 /*
     		 Crown Copyright (c) 1997
     This TenDRA(r) Computer Program is subject to Copyright
     owned by the United Kingdom Secretary of State for Defence
     acting through the Defence Evaluation and Research Agency
     (DERA).  It is made available to Recipients with a
     royalty-free licence for its use, reproduction, transfer
     to other parties and amendment for any purpose not excluding
     product development provided that any such use et cetera
     shall be deemed to be acceptance of the following conditions:-
         (1) Its Recipients shall ensure that this Notice is
         reproduced upon any copies or amended versions of it;
         (2) Any amended version of it shall be clearly marked to
         show both the nature of and the organisation responsible
         for the relevant amendment or amendments;
         (3) Its onward transfer from a recipient to another
         party shall be deemed to be that party's acceptance of
         these conditions;
         (4) DERA gives no warranty or assurance as to its
         quality or suitability for any purpose and DERA accepts
         no liability whatsoever in relation to any use to which
         it may be put.
 */
 #ifndef C_TYPES_INCLUDED
 #define C_TYPES_INCLUDED
 /*
-    CLEAN UP NAMESPACE
+ * CLEAN UP NAMESPACE
+ *
-    Certain symbols need to be undefined on some systems.  It is convenient
+ * Certain symbols need to be undefined on some systems. It is convenient to
-    to do this here as this header is usually included directly after any
+ * do this here as this header is usually included directly after any system
-    system headers.
+ * headers.
-*/
+ */
 #ifdef FLOAT
 #undef FLOAT
 #endif
 #ifdef ulong
 #undef ulong
 #endif
 /*
-    BASIC TYPES
+ * BASIC TYPES
+ *
-    All characters and strings within the program are represented in terms
+ * All characters and strings within the program are represented in terms of
-    of the type character.  In particular, the type string is defined to
+ * the type character. In particular, the type string is defined to be
-    be chararacter *.  ulong is defined as a macro to avoid duplicate
+ * chararacter *. ulong is defined as a macro to avoid duplicate definitions
-    definitions in the system headers.
+ * in the system headers.
-*/
+ */
-typedef unsigned char character ;
+typedef unsigned char character;
 #define ulong ulong_type
 #define CONST_S CONST
 /*
-    CONST TOKENS
+ * CONST TOKENS
+ *
-    The tokens generated by the calculus toolset use const to indicate
+ * The tokens generated by the calculus toolset use const to indicate run-time
-    run-time constant expression tokens.  Older versions of the TenDRA
+ * constant expression tokens. Older versions of the TenDRA C producer which
-    C producer which do not understand const tokens may suppress them
+ * do not understand const tokens may suppress them by defining
-    by defining NO_CONST_TOKEN.
+ * NO_CONST_TOKEN.
-*/
+ */
 #ifdef NO_CONST_TOKEN
 #define const
 #endif
 /*
-    MAIN TYPE SYSTEM
+ *  MAIN TYPE SYSTEM
+ *
-    The main type system is generated using the calculus tool.  See
+ *  The main type system is generated using the calculus tool. See c_class.alg
-    c_class.alg for more details.
+ *  for more details.
-*/
+ */
 #include "c_class.h"
-/*
-    DEBUG MEMORY ALLOCATION ROUTINES
+/*
+ * DEBUG MEMORY ALLOCATION ROUTINES
+ *
-    In debug mode an alternative memory allocation scheme allowing for
+ * In debug mode an alternative memory allocation scheme allowing for run-time
-    run-time type information is implemented.
+ * type information is implemented.
-*/
+ */
 #ifdef RUNTIME
 #if c_class_IMPLEMENTATION
-extern c_class *debug_c_class PROTO_S ( ( unsigned, unsigned ) ) ;
+extern c_class *debug_c_class(unsigned, unsigned);
 #undef GEN_c_class
-#define GEN_c_class( A, B )	debug_c_class ( ( unsigned ) ( A ), ( B ) )
+#define GEN_c_class(A, B)	debug_c_class((unsigned)(A), (B))
-#define TYPEID( A )		( ( A ) [-1].ag_tag )
+#define TYPEID(A)		((A)[-1].ag_tag)
-#define TYPEID_free		( ( unsigned ) 42 )
+#define TYPEID_free		((unsigned)42)
 #endif
 #endif
 /*
-    SYNONYMS FOR CALCULUS CONSTRUCTS
+ * SYNONYMS FOR CALCULUS CONSTRUCTS
+ *
-    These macros give synonyms for various constructs defined within the
+ * These macros give synonyms for various constructs defined within the
-    calculus plus some other useful constructs.
+ * calculus plus some other useful constructs.
-*/
+ */
 #define btype_struct		btype_struct_
 #define btype_union		btype_union_
 #define btype_enum		btype_enum_
 #define cinfo_struct		cinfo_struct_
 #define cinfo_union		cinfo_union_
 #define destroy			destroy_c_class
-#define null_tag		( ( unsigned ) 0xffff )
+#define null_tag		((unsigned)0xffff)
-#define NULL_string		( ( string ) NULL )
+#define NULL_string		((string)NULL)
 #if LANGUAGE_C
 #define cv_lang			cv_c
 #define dspec_lang		dspec_c
 #define btype_lang		btype_struct
 #define btype_lang		btype_class
 #endif
 /*
-    DISTINGUISHED LINKAGE VALUES
+ * DISTINGUISHED LINKAGE VALUES
+ *
-    These values are used as distinguished linkage numbers for use in
+ * These values are used as distinguished linkage numbers for use in the
-    the output routines.  Unassigned linkage numbers are given the value
+ * output routines. Unassigned linkage numbers are given the value LINK_NONE.
-    LINK_NONE.  External linkage numbers are or-ed with the value
+ * External linkage numbers are or-ed with the value LINK_EXTERN to
-    LINK_EXTERN to distinguish them from internal linkage numbers.
+ * distinguish them from internal linkage numbers.
-*/
+ */
 #if FS_NUMBER_SUFFIX
-#define LINK_NONE		( ( ulong ) 0xffffffffUL )
+#define LINK_NONE		((ulong)0xffffffffUL)
-#define LINK_EXTERN		( ( ulong ) 0x80000000UL )
+#define LINK_EXTERN		((ulong)0x80000000UL)
-#define LINK_ZERO		( ( ulong ) 0xfffffffeUL )
+#define LINK_ZERO		((ulong)0xfffffffeUL)
-#define LINK_TOKDEF		( ( ulong ) 0xfffffffdUL )
+#define LINK_TOKDEF		((ulong)0xfffffffdUL)
 #else
-#define LINK_NONE		( ( ulong ) 0xffffffff )
+#define LINK_NONE		((ulong)0xffffffff)
-#define LINK_EXTERN		( ( ulong ) 0x80000000 )
+#define LINK_EXTERN		((ulong)0x80000000)
-#define LINK_ZERO		( ( ulong ) 0xfffffffe )
+#define LINK_ZERO		((ulong)0xfffffffe)
-#define LINK_TOKDEF		( ( ulong ) 0xfffffffd )
+#define LINK_TOKDEF		((ulong)0xfffffffd)
 #endif
-/*
+/**
-    TYPE REPRESENTING A CHECKING SCOPE
+ * TYPE REPRESENTING A CHECKING SCOPE
+ *
-    This type is used to represent a checking scope, describing which
+ * This type is used to represent a checking scope, describing which checks
-    checks should be applied in a particular part of the program.  It
+ * should be applied in a particular part of the program. It consists of an
-    consists of an array of option states - one for each option which
+ * array of option states - one for each option which can be set - plus a
-    can be set - plus a pointer to the enclosing checking scope.  A
+ * pointer to the enclosing checking scope. A scope may have an associated
-    scope may have an associated name.  Also a list of all scopes is
+ * name. Also a list of all scopes is maintained.
-    maintained.
-*/
+ */
-typedef unsigned char OPTION ;
+typedef unsigned char OPTION;
+typedef struct opt_tag {
+	OPTION *opt;
+	OPTION *set;
+	DECL_SPEC lnk_opt[2];
+	unsigned long val_opt[1];
+	struct opt_tag *prev;
+	HASHID name;
+	struct opt_tag *next;
+} OPTIONS;
+/**
+ * TYPE REPRESENTING A PREPROCESSING TOKEN
+ *
+ * This type represents a preprocessing token. This consists of a token value,
+ * corresponding to the macros defined in syntax.h, plus any associated data.
+ * In some instances the space field is used to indicate that the token is
+ * preceded by a white-space. The next field points to the next token.
+ */
-typedef struct opt_tag {
+typedef struct pptok_tag {
+	int tok;
+	struct pptok_tag *next;
+	union {
+		/* Associated data */
+		int sint;
+		string text;
+		unsigned uint;
+		character buff[8];
+		EXP exp;
+		NAT nat;
-    OPTION *opt ;
+		FLOAT flt;
+		NAMESPACE ns;
+		STRING strlit;
+		TYPE type;
+		struct {
+			/* Identifier */
+			HASHID hash;
-    OPTION *set ;
+			IDENTIFIER use;
+		} id;
+		struct {
+			/* String */
+			string start;
+			string end;
+		} str;
+		struct {
-    DECL_SPEC lnk_opt [2] ;
+			/* Macro parameter */
+			HASHID hash;
-    unsigned long val_opt [1] ;
+			unsigned long no;
+		} par;
+		struct {
+			/* Location */
-    struct opt_tag *prev ;
+			unsigned long line;
+			PTR(POSITION)posn;
+		} loc;
+		struct {
+			/* Token application */
-    HASHID name ;
+			IDENTIFIER id;
-    struct opt_tag *next ;
+			struct pptok_tag *args;
+		} tok;
+	} pp_data;
+	unsigned long pp_space;
+	OPTIONS *pp_opts;
-} OPTIONS ;
+} PPTOKEN;
-/*
+/**
-    TYPE REPRESENTING A PREPROCESSING TOKEN
+ * TYPE REPRESENTING A SERIES OF BITS
-    This type represents a preprocessing token.  This consists of a token
-    value, corresponding to the macros defined in syntax.h, plus any
-    associated data.  In some instances the space field is used to indicate
-    that the token is preceded by a white-space.  The next field points
-    to the next token.
-*/
-typedef struct pptok_tag {
-    int tok ;
-    struct pptok_tag *next ;
-    union {
-	/* Associated data */
-	int sint ;
-	string text ;
-	unsigned uint ;
-	character buff [8] ;
-	EXP exp ;
-	NAT nat ;
-	FLOAT flt ;
-	NAMESPACE ns ;
-	STRING strlit ;
-	TYPE type ;
-	struct {
-	    /* Identifier */
-	    HASHID hash ;
-	    IDENTIFIER use ;
-	} id ;
-	struct {
-	    /* String */
-	    string start ;
-	    string end ;
-	} str ;
-	struct {
-	    /* Macro parameter */
-	    HASHID hash ;
-	    unsigned long no ;
-	} par ;
-	struct {
-	    /* Location */
-	    unsigned long line ;
-	    PTR ( POSITION ) posn ;
-	} loc ;
-	struct {
-	    /* Token application */
-	    IDENTIFIER id ;
-	    struct pptok_tag *args ;
-	} tok ;
-    } pp_data ;
-    unsigned long pp_space ;
-    OPTIONS *pp_opts ;
-} PPTOKEN ;
-/*
+ *
-    TYPE REPRESENTING A SERIES OF BITS
-    A bitstream consists of an array of characters comprising the
+ * A bitstream consists of an array of characters comprising the bits
-    bits themselves, plus the current offset (in bytes and bits) of the
+ * themselves, plus the current offset (in bytes and bits) of the end of these
-    end of these bits.  A pointer to the previous bitstream is used to
+ * bits. A pointer to the previous bitstream is used to chain bitstreams
-    chain bitstreams together.
-*/
-typedef struct bits_tag {
-    string text ;
+ * together.
-    unsigned bytes ;
-    unsigned bits ;
-    unsigned size ;
-    FILE *file ;
-    gen_ptr link ;
-    struct bits_tag *prev ;
-} BITSTREAM ;
-/*
-    TYPE REPRESENTING A CHARACTER BUFFER
-    A character buffer consists of an array of characters and a pointer
-    to the current position in the buffer.
 */
+typedef struct bits_tag {
+	string text;
+	unsigned bytes;
+	unsigned bits;
+	unsigned size;
+	FILE *file;
+	gen_ptr link;
+	struct bits_tag *prev;
+} BITSTREAM;
+/**
+ * TYPE REPRESENTING A CHARACTER BUFFER
+ *
+ * A character buffer consists of an array of characters and a pointer to the
+ * current position in the buffer.
+ */
 typedef struct buff_tag {
-    string start ;
+	string start;
-    string posn ;
+	string posn;
-    string end ;
+	string end;
-    FILE *file ;
+	FILE *file;
-} BUFFER ;
+} BUFFER;
-#define NULL_buff		{ NULL, NULL, NULL, NULL }
+#define NULL_buff	{ NULL, NULL, NULL, NULL }
 #endif

Subversion Repositories tendra.SVN

(root)/branches/tendra5/src/producers/common/c_types.h – Rev 5 → 6