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_NOT,
  35     MALA_STRING_FLAG_EXCLAM_EXPANSION,
  36     MALA_STRING_FLAG_NO_EXPANSION,
  37     MALA_STRING_FLAG_NUMSPLIT_EXPANSION,
  38     MALA_STRING_FLAG_CHAR_EXPANSION,
  39     MALA_STRING_FLAG_ASSIGN_EXPANSION,
  40     MALA_STRING_FLAG_SETENV_EXPANSION,
  41     MALA_STRING_FLAG_ENVVAR_EXPANSION,
  42     MALA_STRING_FLAG_UNDERSCORE_EXPANSION,
  43     MALA_STRING_FLAG_BRACKET_EXPANSION,
  44     MALA_STRING_FLAG_ASSIGN_CONTRACTION,
  45     MALA_MAX_COMMON_STRING
  46   };
  47
  48
  49
  50
  51
  52
  53 //#ifdef MALA_PRIVATE
  54 struct mala_engine_struct
  55 {
  56   /*
  57    * every tokenized word is collected in 'words'
  58    * actions can be bound to these words through the strings user variable
  59    */
  60   mala_stringbucket words;
  61   mala_stringlist program;
  62   mala_stringlist arguments;
  63
  64   MalaString common_string[MALA_MAX_COMMON_STRING];
  65
  66   /*TODO static ringbuffer char ringbuffer *[10] */
  67
  68   const char * argv_0;
  69
  70   int negated:1;
  71
  72   int state;
  73 };
  74 //#endif
  75
  76
  77 \f/**/
  78
  79
  80
  81
  82
  83 \f
  84 /*
  85  * Mala engine
  86  */
  87 MalaEngine
  88 mala_engine_new_main (int (*initfunc) (MalaEngine),
  89                       int argc, char ** argv,
  90                       mala_actioninit * actions_init);
  91
  92
  93 void
  94 mala_engine_free (MalaEngine self);
  95
  96 int
  97 mala_engine_register_actions (MalaEngine, MalaActionInit);
  98
  99 int
 100 mala_engine_pushback_program (MalaEngine self, int args, char ** argv);
 101
 102 MalaStringList
 103 mala_engine_getprogram (MalaEngine self);
 104
 105 mala_state
 106 mala_engine_state_get (MalaEngine self);
 107
 108 void
 109 mala_engine_clearstate (MalaEngine self);
 110
 111 int
 112 mala_engine_negated (MalaEngine self);
 113
 114 void
 115 mala_engine_clear_negated (MalaEngine self);
 116
 117 void
 118 mala_engine_dumpprogram (MalaEngine self, const char * prefix, const char * suffix);
 119
 120 void
 121 mala_engine_dumpargs (MalaEngine self, const char * prefix, const char * suffix);
 122
 123 MalaEngine
 124 mala_engine_run (MalaEngine self);
 125
 126 int
 127 mala_engine_eval (MalaEngine self, MalaStringListNode_ref pptr);
 128
 129 //int
 130 //mala_engine_expansions (MalaEngine self, MalaStringListNode_ref pptr);
 131
 132
 133 int
 134 mala_engine_string_istrue (MalaEngine self, MalaString str);
 135
 136 int
 137 mala_engine_check_expansionflag (MalaEngine self, int flag);
 138
 139
 140 #if 0 /*TODO*/
 141
 142 MalaEngine
 143 mala_engine_new_initfunc (int (*initfunc) (MalaEngine));
 144
 145
 146
 147 void
 148 mala_engine_pushfront_program (MalaEngine self, int args, const char ** argv);
 149
 150 int
 151 mala_engine_add_action (MalaEngine self, const t_uchar* key, void* data,
 152                         MalaParserFunc, MalaDataDestructor);
 153
 154 int
 155 mala_engine_erase_action (MalaEngine, const t_uchar * key);
 156
 157 int
 158 mala_engine_eval (MalaEngine self, LList pptr);
 159
 160 int
 161 mala_engine_deepeval (MalaEngine self, LList pptr);
 162
 163 MalaEngine
 164 mala_engine_run (MalaEngine);
 165 int
 166 mala_engine_exception (MalaEngine, LList begin, LList end, const char *);
 167
 168 MalaAction
 169 mala_engine_action_new (MalaEngine, t_uchar** name, void** data,
 170                         MalaParserFunc parser, MalaDataDestructor destructor);
 171
 172 int
 173 mala_engine_check_expansionflag (MalaEngine self, const t_uchar * name);
 174
 175 MalaAction
 176 mala_engine_getaction (MalaEngine, const t_uchar * name);
 177
 178 MalaAction
 179 mala_engine_getprevaction (MalaEngine, const t_uchar * name);
 180
 181 #endif /*TODO*/
 182
 183 \f
 184
 185
 186
 187 #endif /*MALA_ENGINE_H*/
 188 /*
 189 // Local Variables:
 190 // mode: C
 191 // c-file-style: "gnu"
 192 // End:
 193 // arch-tag: 47d718f6-e397-400c-93a6-bc71f475c0c7
 194 // end_of_file
 195 */