plomlompom.com Git - plomrogue/blob - src/client/parse.h

   1 /* src/client/parse.h
   2  *
   3  * Routines for file parsing.
   4  */
   5
   6 #ifndef PARSE_H
   7 #define PARSE_H
   8
   9 #include <stddef.h> /* size_t */
  10 #include <stdint.h> /* uint8_t */
  11
  12
  13
  14 enum parse_flags
  15 {
  16     EDIT_STARTED  = 0x01
  17 };
  18
  19
  20
  21 /* Parse file at "path" by passing each line's first two tokens to
  22  * "token_to_entry". Ignore empty lines. Non-empty lines must feature at least
  23  * two tokens as delimited either be whitespace or single quotes (to allow for
  24  * tokens featuring whitespaces). When EOF is reached, token_to_entry() is
  25  * called a last time with a first token of NULL.
  26  */
  27 extern void parse_file(char * path, void ( *token_to_entry) (char *, char *));
  28
  29 /* Calls err_line() with fitting message if EDIT_STARTED not set in "flags". */
  30 extern void parsetest_defcontext(uint8_t flags);
  31
  32 /* Ensure token_from_line() does not find any more tokens on the line. */
  33 extern void parsetest_too_many_values();
  34
  35 /* Trigger err_line() with "Unknown argument" message. */
  36 extern void parse_unknown_arg();
  37
  38 /* If "test"!=0 call err_line() with "Declaration of ID already used" message.*/
  39 extern void parse_id_uniq(int test);
  40
  41 /* Set "flags"=EDIT_STARTED and return pointer to new zeroed array of "size". */
  42 extern char * parse_init_entry(uint8_t * flags, size_t size);
  43
  44 /* Wrapper to parse_val() that sets "flags" to "flags"|"set_flag" on success. */
  45 extern uint8_t parse_flagval(char * token0, char * token1, char * comparand,
  46                              uint8_t * flags, uint8_t set_flag, char type,
  47                              char * element);
  48
  49 /* Check "ready_flag" is set in "flags", re-set "flags" to "ready_flag" only. */
  50 extern void parse_and_reduce_to_readyflag(uint8_t * flags, uint8_t ready_flag);
  51
  52
  53
  54 #endif
  55