include/ecoli.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2016, Olivier MATZ <zer0@droids-corp.org>
   3  */
   4
   5 /**
   6  * @anchor main_page
   7  * @mainpage About Libecoli
   8  *
   9  * This is the C API documentation of libecoli. This library provides
  10  * helpers to build interactive command line interfaces.
  11  *
  12  * To create a command line parser, one should create a @ref
  13  * grammar_tree, which is composed of @ref nodes. Then an input can be
  14  * parsed or completed, respectively using the @ref parse and @ref
  15  * complete APIs.
  16  *
  17  * The library also provides helpers to create a an interactive command
  18  * line based on @ref editline library, and a @ref yaml parser for
  19  * grammar graphs.
  20  */
  21
  22 #ifndef ECOLI_
  23 #define ECOLI_
  24
  25 #include <ecoli_assert.h>
  26 #include <ecoli_complete.h>
  27 #include <ecoli_config.h>
  28 #include <ecoli_dict.h>
  29 #include <ecoli_editline.h>
  30 #include <ecoli_htable.h>
  31 #include <ecoli_init.h>
  32 #include <ecoli_log.h>
  33 #include <ecoli_malloc.h>
  34 #include <ecoli_murmurhash.h>
  35 #include <ecoli_node_any.h>
  36 #include <ecoli_node_bypass.h>
  37 #include <ecoli_node_cmd.h>
  38 #include <ecoli_node_cond.h>
  39 #include <ecoli_node_dynamic.h>
  40 #include <ecoli_node_empty.h>
  41 #include <ecoli_node_expr.h>
  42 #include <ecoli_node_file.h>
  43 #include <ecoli_node.h>
  44 #include <ecoli_node_helper.h>
  45 #include <ecoli_node_int.h>
  46 #include <ecoli_node_many.h>
  47 #include <ecoli_node_none.h>
  48 #include <ecoli_node_once.h>
  49 #include <ecoli_node_option.h>
  50 #include <ecoli_node_or.h>
  51 #include <ecoli_node_re.h>
  52 #include <ecoli_node_re_lex.h>
  53 #include <ecoli_node_seq.h>
  54 #include <ecoli_node_sh_lex.h>
  55 #include <ecoli_node_space.h>
  56 #include <ecoli_node_str.h>
  57 #include <ecoli_node_subset.h>
  58 #include <ecoli_parse.h>
  59 #include <ecoli_string.h>
  60 #include <ecoli_strvec.h>
  61 #include <ecoli_test.h>
  62 #include <ecoli_utils.h>
  63 #include <ecoli_vec.h>
  64 #include <ecoli_yaml.h>
  65
  66 #endif