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 enum mala_common_strings_enum
  29   {
  30     MALA_STRING_FALSE,
  31     MALA_STRING_TRUE,
  32     MALA_STRING_ZERO,
  33     MALA_STRING_NULL,
  34     MALA_STRING_EXCLAMATIONMARK,
  35     MALA_STRING_ASSIGN,
  36     MALA_STRING_BACKQUOTE,
  37     MALA_STRING_NOT,
  38     MALA_STRING_LITERAL,
  39     MALA_STRING_ENVSUBST,
  40     MALA_STRING_SETENV,
  41     MALA_STRING_SECTION,
  42     MALA_STRING_HERE,
  43     MALA_STRING_BEGIN,
  44     MALA_STRING_END,
  45     MALA_STRING_DEL,
  46     MALA_STRING_FLAG_LITERAL_EXPANSION,
  47     MALA_STRING_FLAG_EXCLAM_EXPANSION,
  48     MALA_STRING_FLAG_NO_EXPANSION,
  49     MALA_STRING_FLAG_NUMSPLIT_EXPANSION,
  50     MALA_STRING_FLAG_CHAR_EXPANSION,
  51     MALA_STRING_FLAG_ASSIGN_EXPANSION,
  52     MALA_STRING_FLAG_SETENV_EXPANSION,
  53     MALA_STRING_FLAG_ENVVAR_EXPANSION,
  54     MALA_STRING_FLAG_UNDERSCORE_EXPANSION,
  55     MALA_STRING_FLAG_BRACKET_EXPANSION,
  56     MALA_STRING_FLAG_ASSIGN_CONTRACTION,
  57     MALA_STRING_ERROR_MISSING_ARGUMENT,
  58     MALA_STRING_ERROR_MISSING_END,
  59     MALA_STRING_ERROR_END_WITHOUT_BEGIN,
  60     MALA_MAX_COMMON_STRING
  61   };
  62
  63
  64
  65
  66
  67
  68 //#ifdef MALA_PRIVATE
  69 struct mala_engine_struct
  70 {
  71   /*
  72    * every tokenized word is collected in 'words'
  73    * actions can be bound to these words through the strings user variable
  74    */
  75   mala_stringbucket words;
  76   mala_stringlist program;
  77   mala_stringlist arguments;
  78
  79   MalaString common_string[MALA_MAX_COMMON_STRING];
  80
  81   /*TODO static ringbuffer char ringbuffer *[10] */
  82
  83   //const char * argv_0;
  84
  85   int negated:1;
  86
  87   /* --BEGIN ... --END blocks are translated to --BLOCK-xxxxxxxx macros,
  88      where xxxxxxxx is a monotonic incrementing counter, its value is stored here */
  89   unsigned blockcnt;
  90
  91   int state;
  92 };
  93 //#endif
  94
  95
  96 \f/**/
  97
  98
  99 \f
 100 /*
 101  * Mala engine
 102  */
 103 MalaEngine
 104 mala_engine_new ();
 105
 106 #if 0
 107 MalaEngine
 108 mala_engine_new_main (int (*initfunc) (MalaEngine),
 109                       int argc, char ** argv,
 110                       mala_actioninit * actions_init);
 111 #endif
 112
 113 void
 114 mala_engine_free (MalaEngine self);
 115
 116 int
 117 mala_engine_actions_register (MalaEngine, MalaActionInit);
 118
 119 int
 120 mala_engine_exception (MalaEngine self,
 121                        MalaStringListNode_ref pptr,
 122                        MalaStringListNode here,
 123                        MalaString message);
 124
 125 int
 126 mala_engine_macro_define (MalaEngine self, const char * name, int argc, char **argv);
 127
 128 int
 129 mala_engine_pushback_word (MalaEngine self, const char * word);
 130
 131 MalaStringList
 132 mala_engine_getprogram (MalaEngine self);
 133
 134 mala_state
 135 mala_engine_state_get (MalaEngine self);
 136
 137 void
 138 mala_engine_clearstate (MalaEngine self);
 139
 140 int
 141 mala_engine_negated (MalaEngine self);
 142
 143 void
 144 mala_engine_clear_negated (MalaEngine self);
 145
 146 void
 147 mala_engine_dumpprogram (MalaEngine self, const char * prefix, const char * suffix);
 148
 149 void
 150 mala_engine_dumpargs (MalaEngine self, const char * prefix, const char * suffix);
 151
 152 MalaEngine
 153 mala_engine_run (MalaEngine self);
 154
 155 int
 156 mala_engine_eval (MalaEngine self, MalaStringListNode_ref pptr);
 157
 158 //int
 159 //mala_engine_expansions (MalaEngine self, MalaStringListNode_ref pptr);
 160
 161
 162 int
 163 mala_engine_string_istrue (MalaEngine self, MalaString str);
 164
 165 int
 166 mala_engine_check_expansionflag (MalaEngine self, int flag);
 167
 168
 169 int
 170 mala_engine_expand (MalaEngine self, MalaStringList list, MalaStringListNode_ref pptr);
 171
 172 int
 173 mala_engine_literal_expansion (MalaEngine self,
 174                                MalaStringList list,
 175                                MalaStringListNode_ref pptr);
 176
 177 int
 178 mala_engine_backquote_expansion (MalaEngine self,
 179                                  MalaStringList list,
 180                                  MalaStringListNode_ref pptr);
 181
 182 int
 183 mala_engine_numsplit_expansion (MalaEngine self,
 184                                 MalaStringList list,
 185                                 MalaStringListNode_ref pptr);
 186
 187 int
 188 mala_engine_exclam_expansion (MalaEngine self,
 189                               MalaStringList list,
 190                               MalaStringListNode_ref pptr);
 191
 192 int
 193 mala_engine_no_expansion (MalaEngine self,
 194                           MalaStringList list,
 195                           MalaStringListNode_ref pptr);
 196
 197 int
 198 mala_engine_assign_expansion (MalaEngine self,
 199                               MalaStringList list,
 200                               MalaStringListNode_ref pptr);
 201
 202 int
 203 mala_engine_envvar_expansion (MalaEngine self,
 204                               MalaStringList list,
 205                               MalaStringListNode_ref pptr);
 206
 207 int
 208 mala_engine_char_expansion (MalaEngine self,
 209                             MalaStringList list,
 210                             MalaStringListNode_ref pptr);
 211
 212 int
 213 mala_engine_underscore_expansion (MalaEngine self,
 214                                   MalaStringList list,
 215                                   MalaStringListNode_ref pptr);
 216
 217 int mala_engine_setenv_expansion (MalaEngine self,
 218                                   MalaStringList list,
 219                                   MalaStringListNode_ref pptr);
 220
 221 int mala_engine_bracket_expansion (MalaEngine self,
 222                                    MalaStringList list,
 223                                    MalaStringListNode_ref pptr);
 224
 225 int mala_engine_assign_contraction (MalaEngine self,
 226                                     MalaStringList list,
 227                                     MalaStringListNode_ref pptr);
 228
 229 int
 230 mala_engine_add_action_cstr (MalaEngine self, const char* cname, void* data,
 231                              MalaParserFunc parser, MalaDataFactory factory,
 232                              MalaAction parent);
 233
 234 int
 235 mala_engine_add_action (MalaEngine self, MalaString name, void* data,
 236                         MalaParserFunc parser, MalaDataFactory factory,
 237                         MalaAction parent);
 238
 239 void
 240 mala_engine_try_eval_arg_n (MalaEngine self, MalaStringListNode_ref pptr, unsigned n);
 241
 242
 243 #if 0 /*TODO*/
 244
 245 MalaEngine
 246 mala_engine_new_initfunc (int (*initfunc) (MalaEngine));
 247
 248
 249
 250 void
 251 mala_engine_pushfront_program (MalaEngine self, int args, char ** argv);
 252
 253
 254 int
 255 mala_engine_erase_action (MalaEngine, const t_uchar * key);
 256
 257 int
 258 mala_engine_eval (MalaEngine self, LList pptr);
 259
 260 int
 261 mala_engine_deepeval (MalaEngine self, LList pptr);
 262
 263 MalaEngine
 264 mala_engine_run (MalaEngine);
 265 int
 266 mala_engine_exception (MalaEngine, LList begin, LList end, const char *);
 267
 268 MalaAction
 269 mala_engine_action_new (MalaEngine, t_uchar** name, void** data,
 270                         MalaParserFunc parser, MalaDataDestructor destructor);
 271
 272
 273 MalaAction
 274 mala_engine_getaction (MalaEngine, const t_uchar * name);
 275
 276 MalaAction
 277 mala_engine_getprevaction (MalaEngine, const t_uchar * name);
 278
 279 #endif /*TODO*/
 280
 281 \f
 282
 283
 284
 285 #endif /*MALA_ENGINE_H*/
 286 /*
 287 // Local Variables:
 288 // mode: C
 289 // c-file-style: "gnu"
 290 // End:
 291 // arch-tag: 47d718f6-e397-400c-93a6-bc71f475c0c7
 292 // end_of_file
 293 */