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