git.sur5r.net Git - bacula/bacula/blob - bacula/src/lib/lex.h

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2014 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from many
   7    others, a complete list can be found in the file AUTHORS.
   8
   9    You may use this file and others of this release according to the
  10    license defined in the LICENSE file, which includes the Affero General
  11    Public License, v3.0 ("AGPLv3") and some additional permissions and
  12    terms pursuant to its AGPLv3 Section 7.
  13
  14    Bacula® is a registered trademark of Kern Sibbald.
  15 */
  16 /*
  17  *   lex.h
  18  *
  19  *    Lexical scanning of configuration files, used by parsers.
  20  *
  21  *   Kern Sibbald, MM
  22  *
  23  */
  24
  25 #ifndef _LEX_H
  26 #define _LEX_H
  27
  28 /* Lex get_char() return values */
  29 #define L_EOF                         (-1)
  30 #define L_EOL                         (-2)
  31
  32 /* Internal tokens */
  33 #define T_NONE                        100
  34
  35 /* Tokens returned by get_token() */
  36 #define T_EOF                         101
  37 #define T_NUMBER                      102
  38 #define T_IPADDR                      103
  39 #define T_IDENTIFIER                  104
  40 #define T_UNQUOTED_STRING             105
  41 #define T_QUOTED_STRING               106
  42 #define T_BOB                         108  /* begin block */
  43 #define T_EOB                         109  /* end of block */
  44 #define T_EQUALS                      110
  45 #define T_COMMA                       111
  46 #define T_EOL                         112
  47 #define T_ERROR                       200
  48 #define T_UTF8_BOM                    201 /* File starts with a UTF-8 BOM*/
  49 #define T_UTF16_BOM                   202 /* File starts with a UTF-16LE BOM*/
  50
  51 /*
  52  * The following will be returned only if
  53  * the appropriate expect flag has been set
  54  */
  55 #define T_SKIP_EOL                    113  /* scan through EOLs */
  56 #define T_PINT32                      114  /* positive integer */
  57 #define T_PINT32_RANGE                115  /* positive integer range */
  58 #define T_INT32                       116  /* integer */
  59 #define T_INT64                       117  /* 64 bit integer */
  60 #define T_NAME                        118  /* name max 128 chars */
  61 #define T_STRING                      119  /* string */
  62 #define T_PINT64_RANGE                120  /* positive integer range */
  63 #define T_PINT64                      121  /* positive integer range */
  64
  65 #define T_ALL                           0  /* no expectations */
  66
  67 /* Lexical state */
  68 enum lex_state {
  69    lex_none,
  70    lex_comment,
  71    lex_number,
  72    lex_ip_addr,
  73    lex_identifier,
  74    lex_string,
  75    lex_quoted_string,
  76    lex_include_quoted_string,
  77    lex_include,
  78    lex_utf8_bom,      /* we are parsing out a utf8 byte order mark */
  79    lex_utf16_le_bom   /* we are parsing out a utf-16 (little endian) byte order mark */
  80 };
  81
  82 /* Lex scan options */
  83 #define LOPT_NO_IDENT            0x1  /* No Identifiers -- use string */
  84 #define LOPT_STRING              0x2  /* Force scan for string */
  85 #define LOPT_NO_EXTERN           0x4  /* Don't follow @ command */
  86
  87 class BPIPE;                          /* forward reference */
  88
  89 /* Lexical context */
  90 typedef struct s_lex_context {
  91    struct s_lex_context *next;        /* pointer to next lexical context */
  92    int options;                       /* scan options */
  93    char *fname;                       /* filename */
  94    FILE *fd;                          /* file descriptor */
  95    POOLMEM *line;                     /* input line */
  96    char str[MAXSTRING];               /* string being scanned */
  97    int str_len;                       /* length of string */
  98    int line_no;                       /* file line number */
  99    int col_no;                        /* char position on line */
 100    int begin_line_no;                 /* line no of beginning of string */
 101    enum lex_state state;              /* lex_state variable */
 102    int ch;                            /* last char/L_VAL returned by get_char */
 103    int token;
 104    uint32_t pint32_val;
 105    uint32_t pint32_val2;
 106    int32_t int32_val;
 107    int64_t int64_val;
 108    uint64_t pint64_val;
 109    uint64_t pint64_val2;
 110    void (*scan_error)(const char *file, int line, struct s_lex_context *lc, const char *msg, ...);
 111    int err_type;                      /* message level for scan_error (M_..) */
 112    void *caller_ctx;                  /* caller private data */
 113    BPIPE *bpipe;                      /* set if we are piping */
 114 } LEX;
 115
 116 typedef void (LEX_ERROR_HANDLER)(const char *file, int line, LEX *lc, const char *msg, ...);
 117
 118 /* Lexical scanning errors in parsing conf files */
 119 #define scan_err0(lc, msg) lc->scan_error(__FILE__, __LINE__, lc, msg)
 120 #define scan_err1(lc, msg, a1) lc->scan_error(__FILE__, __LINE__, lc, msg, a1)
 121 #define scan_err2(lc, msg, a1, a2) lc->scan_error(__FILE__, __LINE__, lc, msg, a1, a2)
 122 #define scan_err3(lc, msg, a1, a2, a3) lc->scan_error(__FILE__, __LINE__, lc, msg, a1, a2, a3)
 123 #define scan_err4(lc, msg, a1, a2, a3, a4) lc->scan_error(__FILE__, __LINE__, lc, msg, a1, a2, a3, a4)
 124 #define scan_err5(lc, msg, a1, a2, a3, a4, a5) lc->scan_error(__FILE__, __LINE__, lc, msg, a1, a2, a3, a4, a5)
 125 #define scan_err6(lc, msg, a1, a2, a3, a4, a5, a6) lc->scan_error(__FILE__, __LINE__, lc, msg, a1, a2, a3, a4, a5, a6)
 126
 127 void scan_to_eol(LEX *lc);
 128 int scan_to_next_not_eol(LEX * lc);
 129
 130 #endif /* _LEX_H */