engine/engine.h

   1 /*
   2     engine.h - MaLa core engine
   3
   4   Copyright (C) 2004, Christian Thaeter <chth@gmx.net>
   5
   6   This program is free software; you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License version 2 as
   8   published by the Free Software Foundation.
   9
  10   This program is distributed in the hope that it will be useful,
  11   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13   GNU General Public License for more details.
  14
  15   You should have received a copy of the GNU General Public License
  16   along with this program; if not, contact me.
  17
  18 */
  19 \f
  20 #ifndef MALA_ENGINE_H
  21 #define MALA_ENGINE_H
  22
  23 #include "mala_types.h"
  24 #include "stringbucket.h"
  25 #include "stringlist.h"
  26 //#include "action.h"
  27
  28 /*
  29    Build a table of common strings, this strings are
  30    a) get never garbage collected (except at end)
  31    b) are fast accessible with their symbolic index
  32
  33    note that "--WORLD" must be the first one
  34 */
  35
  36 #define MALA_COMMON_STRINGS                                                             \
  37 {                                                                                       \
  38     MALA_COMMON_STRING (WORLD, "--WORLD"),                                              \
  39     MALA_COMMON_STRING (COMMANDLINE, "--COMMANDLINE"),                                  \
  40     MALA_COMMON_STRING (PROGRAM, "--PROGRAM"),                                          \
  41     MALA_COMMON_STRING (ARGUMENTS, "--ARGUMENTS"),                                      \
  42     MALA_COMMON_STRING (FALSE, "--FALSE"),                                              \
  43     MALA_COMMON_STRING (TRUE, "--TRUE"),                                                \
  44     MALA_COMMON_STRING (EMPTY, ""),                                                     \
  45     MALA_COMMON_STRING (ZERO, "0"),                                                     \
  46     MALA_COMMON_STRING (PASS, "--PASS"),                                                \
  47     MALA_COMMON_STRING (EXCLAMATIONMARK, "!"),                                          \
  48     MALA_COMMON_STRING (ASSIGN, "="),                                                   \
  49     MALA_COMMON_STRING (BACKQUOTE, "`"),                                                \
  50     MALA_COMMON_STRING (NOT, "--NOT"),                                                  \
  51     MALA_COMMON_STRING (LITERAL, "--LITERAL"),                                          \
  52     MALA_COMMON_STRING (ENVSUBST, "--ENVSUBST"),                                        \
  53     MALA_COMMON_STRING (SETENV, "--SETENV"),                                            \
  54     MALA_COMMON_STRING (SECTION, "--SECTION"),                                          \
  55     MALA_COMMON_STRING (BEFORE_HERE, "--BEFORE-HERE"),                                  \
  56     MALA_COMMON_STRING (BEGIN, "--BEGIN"),                                              \
  57     MALA_COMMON_STRING (END, "--END"),                                                  \
  58     MALA_COMMON_STRING (DEL, "--DEL"),                                                  \
  59     MALA_COMMON_STRING (DEFAULT_PARSER, "--DEFAULT-PARSER"),                            \
  60     MALA_COMMON_STRING (PP_COMMANDLINE, "--PP-COMMANDLINE"),                            \
  61     MALA_COMMON_STRING (PP_CONFIGFILE, "--PP-CONFIGFILE"),                              \
  62     MALA_COMMON_STRING (PP_INTERACTIVE, "--PP-INTERACTIVE"),                            \
  63     MALA_COMMON_STRING (FLAG_LITERAL_EXPANSION, "--FLAG-LITERAL-EXPANSION"),            \
  64     MALA_COMMON_STRING (FLAG_EXCLAM_EXPANSION, "--FLAG-EXCLAM-EXPANSION"),              \
  65     MALA_COMMON_STRING (FLAG_NO_EXPANSION, "--FLAG-NO-EXPANSION"),                      \
  66     MALA_COMMON_STRING (FLAG_NUMSPLIT_EXPANSION, "--FLAG-NUMSPLIT-EXPANSION"),          \
  67     MALA_COMMON_STRING (FLAG_CHAR_EXPANSION, "--FLAG-CHAR-EXPANSION"),                  \
  68     MALA_COMMON_STRING (FLAG_ASSIGN_EXPANSION, "--FLAG-ASSIGN-EXPANSION"),              \
  69     MALA_COMMON_STRING (FLAG_SETENV_EXPANSION, "--FLAG-SETENV-EXPANSION"),              \
  70     MALA_COMMON_STRING (FLAG_ENVVAR_EXPANSION, "--FLAG-ENVVAR-EXPANSION"),              \
  71     MALA_COMMON_STRING (FLAG_UNDERSCORE_EXPANSION, "--FLAG-UNDERSCORE-EXPANSION"),      \
  72     MALA_COMMON_STRING (FLAG_BRACKET_EXPANSION, "--FLAG-BRACKET-EXPANSION"),            \
  73     MALA_COMMON_STRING (FLAG_ASSIGN_CONTRACTION, "--FLAG-ASSIGN-CONTRACTION"),          \
  74     MALA_COMMON_STRING (ERROR, "--ERROR"),                                              \
  75     MALA_COMMON_STRING (ERROR_MISSING_ARGUMENT, "--ERROR-MISSING-ARGUMENT"),            \
  76     MALA_COMMON_STRING (ERROR_MISSING_END, "--ERROR-MISSING-END"),                      \
  77     MALA_COMMON_STRING (ERROR_END_WITHOUT_BEGIN, "--ERROR-END-WITHOUT-BEGIN"),          \
  78     MALA_COMMON_STRING (ERROR_MACRO_SYNTAX, "--ERROR-MACRO-SYNTAX"),                    \
  79     MALA_COMMON_STRING (ERROR_NESTING_LIMIT_EXCEED, "--ERROR-NESTING-LIMIT-EXCEED"),    \
  80     MALA_COMMON_STRING (ERROR_ACTION_NOT_DEFINED, "--ERROR-ACTION-NOT-DEFINED"),        \
  81     MALA_COMMON_STRING (ERROR_NOT_A_PREDICATE, "--ERROR-NOT-A-PREDICATE"),              \
  82     MALA_COMMON_STRING (MAX, "")                                                        \
  83 }
  84
  85
  86 #define MALA_COMMON_STRING(E,s) MALA_STRING_##E
  87 enum mala_common_strings_enum MALA_COMMON_STRINGS;
  88 #undef MALA_COMMON_STRING
  89
  90 typedef enum mala_common_strings_enum mala_common_string;
  91
  92 const char * mala_engine_states [MALA_STATE_TABLE_SIZEOF+1];
  93
  94 //#ifdef MALA_PRIVATE
  95 struct mala_engine_struct
  96 {
  97   /*
  98    * every tokenized word is collected in 'words'
  99    * actions can be bound to these words through the strings user variable
 100    */
 101   acogc_root gcroot;
 102
 103   acogc_factory gcfactory_buckets;
 104   acogc_factory gcfactory_strings;
 105   acogc_factory gcfactory_stringbucketnodes;
 106   acogc_factory gcfactory_stringlists;
 107   acogc_factory gcfactory_actions;
 108   acogc_factory gcfactory_programs;
 109
 110   MalaStringBucket words;
 111
 112   mala_trace engine_trace;      // TODO
 113
 114   /* --BEGIN ... --END blocks are translated to --BLOCK-xxxxxxxx macros,
 115      where xxxxxxxx is a monotonic incrementing counter, its value is stored here */
 116   unsigned blockcnt;
 117
 118   mala_state state;
 119
 120   MalaString common_string[MALA_STRING_MAX];
 121 };
 122 \f
 123
 124 /*
 125  * Mala engine
 126  */
 127 void
 128 mala_engine_init (MalaEngine self);
 129
 130 MalaEngine
 131 mala_engine_new ();
 132
 133 #if 0
 134 MalaEngine
 135 mala_engine_new_main (int (*initfunc) (MalaEngine),
 136                       int argc, char ** argv,
 137                       mala_actioninit * actions_init);
 138 #endif
 139
 140 void
 141 mala_engine_erase (MalaEngine self);
 142
 143 void
 144 mala_engine_free (MalaEngine self);
 145
 146 mala_state
 147 mala_engine_actions_register (MalaEngine, MalaActionInit);
 148
 149
 150 void
 151 mala_engine_action_new_cstr (MalaEngine self,
 152                              const char* name,
 153                              MalaParserFunc parser,
 154                              void *data,
 155                              acogc_alloc_type data_alloc,
 156                              MalaAction parent);
 157
 158
 159 void
 160 mala_engine_run_cstr (MalaEngine self,
 161                       const char* cmd,
 162                       MalaStringList_ref result);
 163
 164 mala_state
 165 mala_engine_state_get (MalaEngine self);
 166
 167 const char *
 168 mala_engine_state_str (MalaEngine self);
 169
 170 void
 171 mala_engine_clearstate (MalaEngine self);
 172
 173 MalaString
 174 mala_engine_tmpname (MalaEngine self, const char* templ);
 175
 176 static inline MalaAction
 177 mala_engine_action_get_cstr (MalaEngine engine, const char * cname)
 178 {
 179   MalaString s = mala_stringbucket_find (engine->words, cname);
 180   return  s ? s->action : NULL;
 181 }
 182
 183 #endif /*MALA_ENGINE_H*/
 184 /*
 185 // Local Variables:
 186 // mode: C
 187 // c-file-style: "gnu"
 188 // End:
 189 // arch-tag: 47d718f6-e397-400c-93a6-bc71f475c0c7
 190 // end_of_file
 191 */