xref: /dragonfly/contrib/flex/src/tables_shared.h (revision d9805213)
1 #ifdef FLEX_SCANNER
2 /*
3 dnl  tables_shared.h - tables serialization header
4 dnl
5 dnl  Copyright (c) 1990 The Regents of the University of California.
6 dnl  All rights reserved.
7 dnl
8 dnl  This code is derived from software contributed to Berkeley by
9 dnl  Vern Paxson.
10 dnl
11 dnl  The United States Government has rights in this work pursuant
12 dnl  to contract no. DE-AC03-76SF00098 between the United States
13 dnl  Department of Energy and the University of California.
14 dnl
15 dnl  This file is part of flex.
16 dnl
17 dnl  Redistribution and use in source and binary forms, with or without
18 dnl  modification, are permitted provided that the following conditions
19 dnl  are met:
20 dnl
21 dnl  1. Redistributions of source code must retain the above copyright
22 dnl     notice, this list of conditions and the following disclaimer.
23 dnl  2. Redistributions in binary form must reproduce the above copyright
24 dnl     notice, this list of conditions and the following disclaimer in the
25 dnl     documentation and/or other materials provided with the distribution.
26 dnl
27 dnl  Neither the name of the University nor the names of its contributors
28 dnl  may be used to endorse or promote products derived from this software
29 dnl  without specific prior written permission.
30 dnl
31 dnl  THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
32 dnl  IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
33 dnl  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
34 dnl  PURPOSE.
35 
36 dnl
37 dnl  This file is meant to be included in both the skeleton and the actual
38 dnl  flex code (hence the name "_shared").
39 */
40 #ifndef yyskel_static
41 #define yyskel_static static
42 #endif
43 #else
44 #ifndef yyskel_static
45 #define yyskel_static
46 #endif
47 #endif
48 
49 /* Structures and prototypes for serializing flex tables.  The
50  * binary format is documented in the manual.
51  *
52  * Design considerations:
53  *
54  *  -  The format allows many tables per file.
55  *  -  The tables can be streamed.
56  *  -  All data is stored in network byte order.
57  *  -  We do not hinder future unicode support.
58  *  -  We can lookup tables by name.
59  */
60 
61 /** Magic number for serialized format. */
62 #ifndef YYTBL_MAGIC
63 #define YYTBL_MAGIC 0xF13C57B1
64 #endif
65 
66 /** Calculate (0-7) = number bytes needed to pad n to next 64-bit boundary. */
67 #ifndef yypad64
68 #define yypad64(n) ((8-((n)%8))%8)
69 #endif
70 
71 
72 #ifndef YYTABLES_TYPES
73 #define YYTABLES_TYPES
74 /** Possible values for td_id field. Each one corresponds to a
75  *  scanner table of the same name.
76  */
77 enum yytbl_id {
78 	YYTD_ID_ACCEPT = 0x01,		/**< 1-dim ints */
79 	YYTD_ID_BASE = 0x02,		/**< 1-dim ints */
80 	YYTD_ID_CHK = 0x03,		/**< 1-dim ints */
81 	YYTD_ID_DEF = 0x04,		/**< 1-dim ints */
82 	YYTD_ID_EC = 0x05,		/**< 1-dim ints */
83 	YYTD_ID_META = 0x06,		/**< 1-dim ints */
84 	YYTD_ID_NUL_TRANS = 0x07,	/**< 1-dim ints, maybe indices */
85 	YYTD_ID_NXT = 0x08,		/**< may be 2 dimensional ints */
86 	YYTD_ID_RULE_CAN_MATCH_EOL = 0x09, /**< 1-dim ints */
87 	YYTD_ID_START_STATE_LIST = 0x0A,	/**< 1-dim indices into trans tbl  */
88 	YYTD_ID_TRANSITION = 0x0B,	/**< structs */
89 	YYTD_ID_ACCLIST = 0x0C		/**< 1-dim ints */
90 };
91 
92 /** bit flags for t_flags field of struct yytbl_data */
93 enum yytbl_flags {
94 	/* These first three are mutually exclusive */
95 	YYTD_DATA8 = 0x01,   /**< data is an array of type flex_int8_t */
96 	YYTD_DATA16 = 0x02,  /**< data is an array of type flex_int16_t */
97 	YYTD_DATA32 = 0x04,  /**< data is an array of type flex_int32_t */
98 
99 	/* These two are mutually exclusive. */
100 	YYTD_PTRANS = 0x08,  /**< data is a list of indexes of entries
101                                  into the expanded `yy_transition'
102                                  array. See notes in manual. */
103 	YYTD_STRUCT = 0x10  /**< data consists of yy_trans_info structs */
104 };
105 
106 /* The serialized tables header. */
107 struct yytbl_hdr {
108 	flex_uint32_t th_magic;  /**< Must be 0xF13C57B1 (comes from "Flex Table") */
109 	flex_uint32_t th_hsize;  /**< Size of this header in bytes. */
110 	flex_uint32_t th_ssize;  /**< Size of this dataset, in bytes, including header. */
111 	flex_uint16_t th_flags;  /**< Currently unused, must be 0 */
112 	char   *th_version; /**< Flex version string. NUL terminated. */
113 	char   *th_name;    /**< The name of this table set. NUL terminated. */
114 };
115 
116 /** A single serialized table */
117 struct yytbl_data {
118 	flex_uint16_t td_id;      /**< enum yytbl_id table identifier */
119 	flex_uint16_t td_flags;   /**< how to interpret this data */
120 	flex_uint32_t td_hilen;   /**< num elements in highest dimension array */
121 	flex_uint32_t td_lolen;   /**< num elements in lowest dimension array */
122 	void   *td_data;     /**< table data */
123 };
124 #endif
125 
126 /** Extract corresponding data size_t from td_flags */
127 #ifndef YYTDFLAGS2BYTES
128 #define YYTDFLAGS2BYTES(td_flags)\
129         (((td_flags) & YYTD_DATA8)\
130             ? sizeof(flex_int8_t)\
131             :(((td_flags) & YYTD_DATA16)\
132                 ? sizeof(flex_int16_t)\
133                 :sizeof(flex_int32_t)))
134 #endif
135 
136 #ifdef FLEX_SCANNER
137 %not-for-header
138 #endif
139 yyskel_static flex_int32_t yytbl_calc_total_len (const struct yytbl_data *tbl);
140 #ifdef FLEX_SCANNER
141 %ok-for-header
142 #endif
143 
144 /* vim:set noexpandtab cindent tabstop=8 softtabstop=0 shiftwidth=8 textwidth=0: */
145