src/include/frontend/parser.h

   1 /*
   2  * SysDB - src/include/frontend/parser.h
   3  * Copyright (C) 2013 Sebastian 'tokkee' Harl <sh@tokkee.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  17  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
  19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef SDB_FRONTEND_PARSER_H
  29 #define SDB_FRONTEND_PARSER_H 1
  30
  31 #include "core/store.h"
  32 #include "frontend/connection.h"
  33 #include "utils/llist.h"
  34 #include "utils/strbuf.h"
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /* parser modes */
  41 enum {
  42         /* parser accepts any command statement */
  43         SDB_PARSE_DEFAULT = 0,
  44
  45         /* parser accepts any conditional statement */
  46         SDB_PARSE_COND    = 1 << 1,
  47
  48         /* parser accepts any arithmetic expression */
  49         SDB_PARSE_ARITH   = 1 << 2,
  50 };
  51
  52 /* YY_EXTRA data */
  53 typedef struct {
  54         /* list of sdb_conn_node_t objects */
  55         sdb_llist_t *parsetree;
  56
  57         /* parser mode */
  58         int mode;
  59
  60         /* buffer for parser error messages */
  61         sdb_strbuf_t *errbuf;
  62 } sdb_fe_yyextra_t;
  63
  64 /* see yyscan_t */
  65 typedef void *sdb_fe_yyscan_t;
  66
  67 sdb_fe_yyscan_t
  68 sdb_fe_scanner_init(const char *str, int len, sdb_fe_yyextra_t *yyext);
  69
  70 void
  71 sdb_fe_scanner_destroy(sdb_fe_yyscan_t scanner);
  72
  73 int
  74 sdb_fe_yyparse(sdb_fe_yyscan_t scanner);
  75
  76 sdb_store_matcher_t *
  77 sdb_fe_parse_matcher(const char *cond, int len, sdb_strbuf_t *errbuf);
  78
  79 sdb_store_expr_t *
  80 sdb_fe_parse_expr(const char *expr, int len, sdb_strbuf_t *errbuf);
  81
  82 /*
  83  * sdb_fe_analyze:
  84  * Analyze a parsed node, checking for semantical errors. Error messages will
  85  * be written to the string buffer, if provided.
  86  *
  87  * Returns:
  88  *  - 0 if the node is semantically correct
  89  *  - a negative value else
  90  */
  91 int
  92 sdb_fe_analyze(sdb_conn_node_t *node, sdb_strbuf_t *errbuf);
  93
  94 #ifdef __cplusplus
  95 } /* extern "C" */
  96 #endif
  97
  98 #endif /* ! SDB_FRONTEND_PARSER_H */
  99
 100 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 101