Document case-insensitivity bug.
[nasm.git] / nasmlib.h
blob5492208c6d9296d1f734a57377ff284c6f09f9fc
1 /* nasmlib.h header file for nasmlib.c
3 * The Netwide Assembler is copyright (C) 1996 Simon Tatham and
4 * Julian Hall. All rights reserved. The software is
5 * redistributable under the license given in the file "LICENSE"
6 * distributed in the NASM archive.
7 */
9 #ifndef NASM_NASMLIB_H
10 #define NASM_NASMLIB_H
12 #include "compiler.h"
14 #include <inttypes.h>
15 #include <stdio.h>
16 #include <string.h>
17 #ifdef HAVE_STRINGS_H
18 #include <strings.h>
19 #endif
22 * tolower table -- avoids a function call on some platforms.
23 * NOTE: unlike the tolower() function in ctype, EOF is *NOT*
24 * a permitted value, for obvious reasons.
26 void tolower_init(void);
27 extern unsigned char nasm_tolower_tab[256];
28 #define nasm_tolower(x) nasm_tolower_tab[(unsigned char)(x)]
30 /* Wrappers around <ctype.h> functions */
31 /* These are only valid for values that cannot include EOF */
32 #define nasm_isspace(x) isspace((unsigned char)(x))
33 #define nasm_isalpha(x) isalpha((unsigned char)(x))
34 #define nasm_isdigit(x) isdigit((unsigned char)(x))
35 #define nasm_isalnum(x) isalnum((unsigned char)(x))
36 #define nasm_isxdigit(x) isxdigit((unsigned char)(x))
39 * If this is defined, the wrappers around malloc et al will
40 * transform into logging variants, which will cause NASM to create
41 * a file called `malloc.log' when run, and spew details of all its
42 * memory management into that. That can then be analysed to detect
43 * memory leaks and potentially other problems too.
45 /* #define LOGALLOC */
48 * -------------------------
49 * Error reporting functions
50 * -------------------------
54 * An error reporting function should look like this.
56 typedef void (*efunc) (int severity, const char *fmt, ...);
57 extern efunc nasm_malloc_error;
60 * These are the error severity codes which get passed as the first
61 * argument to an efunc.
64 #define ERR_DEBUG 0x00000008 /* put out debugging message */
65 #define ERR_WARNING 0x00000000 /* warn only: no further action */
66 #define ERR_NONFATAL 0x00000001 /* terminate assembly after phase */
67 #define ERR_FATAL 0x00000002 /* instantly fatal: exit with error */
68 #define ERR_PANIC 0x00000003 /* internal error: panic instantly
69 * and dump core for reference */
70 #define ERR_MASK 0x0000000F /* mask off the above codes */
71 #define ERR_NOFILE 0x00000010 /* don't give source file name/line */
72 #define ERR_USAGE 0x00000020 /* print a usage message */
73 #define ERR_PASS1 0x00000040 /* only print this error on pass one */
74 #define ERR_NO_SEVERITY 0x00000080 /* suppress printing severity */
77 * These codes define specific types of suppressible warning.
80 #define ERR_WARN_MASK 0x0000FF00 /* the mask for this feature */
81 #define ERR_WARN_SHR 8 /* how far to shift right */
83 #define WARN(x) ((x) << ERR_WARN_SHR)
85 #define ERR_WARN_MNP WARN(1) /* macro-num-parameters warning */
86 #define ERR_WARN_MSR WARN(2) /* macro self-reference */
87 #define ERR_WARN_OL WARN(3) /* orphan label (no colon, and
88 * alone on line) */
89 #define ERR_WARN_NOV WARN(4) /* numeric overflow */
90 #define ERR_WARN_GNUELF WARN(5) /* using GNU ELF extensions */
91 #define ERR_WARN_FL_OVERFLOW WARN(6) /* FP overflow */
92 #define ERR_WARN_FL_DENORM WARN(7) /* FP denormal */
93 #define ERR_WARN_FL_UNDERFLOW WARN(8) /* FP underflow */
94 #define ERR_WARN_FL_TOOLONG WARN(9) /* FP too many digits */
95 #define ERR_WARN_MAX 9 /* the highest numbered one */
98 * Wrappers around malloc, realloc and free. nasm_malloc will
99 * fatal-error and die rather than return NULL; nasm_realloc will
100 * do likewise, and will also guarantee to work right on being
101 * passed a NULL pointer; nasm_free will do nothing if it is passed
102 * a NULL pointer.
104 void nasm_set_malloc_error(efunc);
105 #ifndef LOGALLOC
106 void *nasm_malloc(size_t);
107 void *nasm_zalloc(size_t);
108 void *nasm_realloc(void *, size_t);
109 void nasm_free(void *);
110 char *nasm_strdup(const char *);
111 char *nasm_strndup(char *, size_t);
112 #else
113 void *nasm_malloc_log(char *, int, size_t);
114 void *nasm_zalloc_log(char *, int, size_t);
115 void *nasm_realloc_log(char *, int, void *, size_t);
116 void nasm_free_log(char *, int, void *);
117 char *nasm_strdup_log(char *, int, const char *);
118 char *nasm_strndup_log(char *, int, char *, size_t);
119 #define nasm_malloc(x) nasm_malloc_log(__FILE__,__LINE__,x)
120 #define nasm_zalloc(x) nasm_zalloc_log(__FILE__,__LINE__,x)
121 #define nasm_realloc(x,y) nasm_realloc_log(__FILE__,__LINE__,x,y)
122 #define nasm_free(x) nasm_free_log(__FILE__,__LINE__,x)
123 #define nasm_strdup(x) nasm_strdup_log(__FILE__,__LINE__,x)
124 #define nasm_strndup(x,y) nasm_strndup_log(__FILE__,__LINE__,x,y)
125 #endif
128 * ANSI doesn't guarantee the presence of `stricmp' or
129 * `strcasecmp'.
131 #if defined(HAVE_STRCASECMP)
132 #define nasm_stricmp strcasecmp
133 #elif defined(HAVE_STRICMP)
134 #define nasm_stricmp stricmp
135 #else
136 int nasm_stricmp(const char *, const char *);
137 #endif
139 #if defined(HAVE_STRNCASECMP)
140 #define nasm_strnicmp strncasecmp
141 #elif defined(HAVE_STRNICMP)
142 #define nasm_strnicmp strnicmp
143 #else
144 int nasm_strnicmp(const char *, const char *, size_t);
145 #endif
147 int nasm_memicmp(const char *, const char *, size_t);
149 #if defined(HAVE_STRSEP)
150 #define nasm_strsep strsep
151 #else
152 char *nasm_strsep(char **stringp, const char *delim);
153 #endif
157 * Convert a string into a number, using NASM number rules. Sets
158 * `*error' to true if an error occurs, and false otherwise.
160 int64_t readnum(char *str, bool *error);
163 * Convert a character constant into a number. Sets
164 * `*warn' to true if an overflow occurs, and false otherwise.
165 * str points to and length covers the middle of the string,
166 * without the quotes.
168 int64_t readstrnum(char *str, int length, bool *warn);
171 * seg_init: Initialise the segment-number allocator.
172 * seg_alloc: allocate a hitherto unused segment number.
174 void seg_init(void);
175 int32_t seg_alloc(void);
178 * many output formats will be able to make use of this: a standard
179 * function to add an extension to the name of the input file
181 #ifdef NASM_NASM_H
182 void standard_extension(char *inname, char *outname, char *extension,
183 efunc error);
184 #endif
187 * Utility macros...
189 * This is a useful #define which I keep meaning to use more often:
190 * the number of elements of a statically defined array.
193 #define elements(x) ( sizeof(x) / sizeof(*(x)) )
196 * some handy macros that will probably be of use in more than one
197 * output format: convert integers into little-endian byte packed
198 * format in memory
201 #if X86_MEMORY
203 #define WRITECHAR(p,v) \
204 do { \
205 *(uint8_t *)(p) = (v); \
206 (p) += 1; \
207 } while (0)
209 #define WRITESHORT(p,v) \
210 do { \
211 *(uint16_t *)(p) = (v); \
212 (p) += 2; \
213 } while (0)
215 #define WRITELONG(p,v) \
216 do { \
217 *(uint32_t *)(p) = (v); \
218 (p) += 4; \
219 } while (0)
221 #define WRITEDLONG(p,v) \
222 do { \
223 *(uint64_t *)(p) = (v); \
224 (p) += 8; \
225 } while (0)
227 #define WRITEADDR(p,v,s) \
228 do { \
229 uint64_t _wa_v = (v); \
230 memcpy((p), &_wa_v, (s)); \
231 (p) += (s); \
232 } while (0)
234 #else /* !X86_MEMORY */
236 #define WRITECHAR(p,v) \
237 do { \
238 uint8_t *_wc_p = (uint8_t *)(p); \
239 uint8_t _wc_v = (v); \
240 _wc_p[0] = _wc_v; \
241 (p) = (void *)(_wc_p + 1); \
242 } while (0)
244 #define WRITESHORT(p,v) \
245 do { \
246 uint8_t *_ws_p = (uint8_t *)(p); \
247 uint16_t _ws_v = (v); \
248 _ws_p[0] = _ws_v; \
249 _ws_p[1] = _ws_v >> 8; \
250 (p) = (void *)(_ws_p + 2); \
251 } while (0)
253 #define WRITELONG(p,v) \
254 do { \
255 uint8_t *_wl_p = (uint8_t *)(p); \
256 uint32_t _wl_v = (v); \
257 _wl_p[0] = _wl_v; \
258 _wl_p[1] = _wl_v >> 8; \
259 _wl_p[2] = _wl_v >> 16; \
260 _wl_p[3] = _wl_v >> 24; \
261 (p) = (void *)(_wl_p + 4); \
262 } while (0)
264 #define WRITEDLONG(p,v) \
265 do { \
266 uint8_t *_wq_p = (uint8_t *)(p); \
267 uint64_t _wq_v = (v); \
268 _wq_p[0] = _wq_v; \
269 _wq_p[1] = _wq_v >> 8; \
270 _wq_p[2] = _wq_v >> 16; \
271 _wq_p[3] = _wq_v >> 24; \
272 _wq_p[4] = _wq_v >> 32; \
273 _wq_p[5] = _wq_v >> 40; \
274 _wq_p[6] = _wq_v >> 48; \
275 _wq_p[7] = _wq_v >> 56; \
276 (p) = (void *)(_wq_p + 8); \
277 } while (0)
279 #define WRITEADDR(p,v,s) \
280 do { \
281 int _wa_s = (s); \
282 uint64_t _wa_v = (v); \
283 while (_wa_s--) { \
284 WRITECHAR(p,_wa_v); \
285 _wa_v >>= 8; \
287 } while(0)
289 #endif
292 * and routines to do the same thing to a file
294 #define fwriteint8_t(d,f) putc(d,f)
295 void fwriteint16_t(uint16_t data, FILE * fp);
296 void fwriteint32_t(uint32_t data, FILE * fp);
297 void fwriteint64_t(uint64_t data, FILE * fp);
298 void fwriteaddr(uint64_t data, int size, FILE * fp);
301 * Binary search routine. Returns index into `array' of an entry
302 * matching `string', or <0 if no match. `array' is taken to
303 * contain `size' elements.
305 * bsi() is case sensitive, bsii() is case insensitive.
307 int bsi(const char *string, const char **array, int size);
308 int bsii(const char *string, const char **array, int size);
310 char *src_set_fname(char *newname);
311 int32_t src_set_linnum(int32_t newline);
312 int32_t src_get_linnum(void);
314 * src_get may be used if you simply want to know the source file and line.
315 * It is also used if you maintain private status about the source location
316 * It return 0 if the information was the same as the last time you
317 * checked, -1 if the name changed and (new-old) if just the line changed.
319 int src_get(int32_t *xline, char **xname);
321 char *nasm_strcat(char *one, char *two);
323 void null_debug_routine(const char *directive, const char *params);
324 extern struct dfmt null_debug_form;
325 extern struct dfmt *null_debug_arr[2];
327 const char *prefix_name(int);
329 #endif