diff options
Diffstat (limited to 'src/z-util.h')
-rw-r--r-- | src/z-util.h | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/src/z-util.h b/src/z-util.h new file mode 100644 index 00000000..64871cf2 --- /dev/null +++ b/src/z-util.h @@ -0,0 +1,84 @@ +/* File z-util.h */ + +#ifndef INCLUDED_Z_UTIL_H +#define INCLUDED_Z_UTIL_H + +#include "h-basic.h" + + +/* + * Extremely basic stuff, like global temp and constant variables. + * Also, some very useful low level functions, such as "streq()". + * All variables and functions in this file are "addressable". + */ + + +/**** Available variables ****/ + +/* Temporary Vars */ +extern char char_tmp; +extern byte byte_tmp; +extern sint sint_tmp; +extern uint uint_tmp; +extern long long_tmp; +extern huge huge_tmp; +extern errr errr_tmp; + +/* Temporary Pointers */ +extern cptr cptr_tmp; +extern vptr vptr_tmp; + + +/* Constant pointers (NULL) */ +extern cptr cptr_null; +extern vptr vptr_null; + + +/* A bizarre vptr that always points at itself */ +extern vptr vptr_self; + + +/* A cptr to the name of the program */ +extern cptr argv0; + + +/* Aux functions */ +extern void (*plog_aux)(cptr); +extern void (*quit_aux)(cptr); +extern void (*core_aux)(cptr); + + +/**** Available Functions ****/ + +/* Function that does nothing */ +extern void func_nothing(void); + +/* Functions that return basic "errr" codes */ +extern errr func_success(void); +extern errr func_problem(void); +extern errr func_failure(void); + +/* Functions that return bools */ +extern bool func_true(void); +extern bool func_false(void); + + +/* Test equality, prefix, suffix */ +extern bool streq(cptr s, cptr t); +extern bool prefix(cptr s, cptr t); +extern bool suffix(cptr s, cptr t); + + +/* Print an error message */ +extern void plog(cptr str); + +/* Exit, with optional message */ +extern void quit(cptr str); + +/* Dump core, with optional message */ +extern void core(cptr str); + + + +#endif + |