engine/stringlist.h

   1 /*
   2     stringlist.h - MaLa stringlists
   3
   4   Copyright (C) 2004, 2005, 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_STRINGLIST_H
  21 #define MALA_STRINGLIST_H
  22
  23 #include <stdio.h>
  24 #include "mala_types.h"
  25 #include "engine.h"
  26 #include "strings.h"
  27 #include "llist.h"
  28 \f
  29
  30 #define MALA_STATIC_STRINGLIST_INIT(args...) \
  31   (const char*[]){args, NULL}
  32 \f
  33
  34 /*
  35  *      StringList
  36  */
  37
  38 struct mala_stringlist_struct
  39 {
  40   llist node;
  41   MalaString string;
  42 };
  43 \f
  44 /*gc support*/
  45 acogc_mark_result
  46 mala_stringlist_acogc_mark (void* o);
  47
  48 void
  49 mala_stringlist_acogc_initize (void * o);
  50
  51 void
  52 mala_stringlist_acogc_finalize (void * o);
  53
  54
  55 /* constructors */
  56 MalaStringList
  57 mala_stringlist_new (MalaEngine engine);
  58
  59 MalaStringList
  60 mala_stringlist_copy (MalaStringList source, MalaEngine engine);
  61
  62 void
  63 mala_stringlist_append_cstrs (MalaStringList self, int nelem, char** cstrs, MalaEngine engine);
  64
  65 void
  66 mala_stringlist_append_literal_cstrs (MalaStringList self, int nelem, char** cstrs, MalaEngine engine);
  67
  68 MalaStringList
  69 mala_stringlist_node_new_literal_cstr (const char * cstr, MalaEngine engine);
  70
  71 MalaStringList
  72 mala_stringlist_node_new_cstr (const char * cstr, MalaEngine engine);
  73
  74 MalaStringList
  75 mala_stringlist_node_new (MalaString str, MalaEngine engine);
  76
  77 /* declarations */
  78 static inline void
  79 mala_stringlist_insert_after_stringlist (MalaStringList self, MalaStringList src);
  80
  81 static inline MalaString
  82 mala_stringlist_string_from_llist (const_LList self);
  83
  84 static inline const char *
  85 mala_stringlist_cstr_from_llist (const_LList self);
  86
  87 void
  88 mala_stringlist_dump (MalaStringList self, FILE * f,
  89                       const char* head,
  90                       const char* before,
  91                       const char* fmt,
  92                       const char* after,
  93                       const char* foot);
  94
  95 void
  96 nobug_mala_stringlist_dump (const_MalaStringList self,
  97                             const int depth,
  98                             const char* file,
  99                             const int line,
 100                             const char* func);
 101
 102 static inline MalaString
 103 mala_stringlist_string (MalaStringList self);
 104
 105 static inline void
 106 mala_stringlist_string_set (MalaStringList self, MalaString str);
 107
 108 static inline MalaStringList
 109 mala_stringlist_next (MalaStringList self);
 110
 111 static inline MalaStringList
 112 mala_stringlist_prev (MalaStringList self);
 113
 114 static inline void
 115 mala_stringlist_fwd (MalaStringList_ref self);
 116
 117 static inline void
 118 mala_stringlist_rev (MalaStringList_ref self);
 119
 120 static inline void
 121 mala_stringlist_advance (MalaStringList self);
 122
 123 static inline void
 124 mala_stringlist_remove (MalaStringList self);
 125
 126 static inline void
 127 mala_stringlist_insert_tail (MalaStringList self, MalaStringList node);
 128
 129 static inline void
 130 mala_stringlist_insert_head (MalaStringList self, MalaStringList node);
 131
 132 #define mala_stringlist_insert_before mala_stringlist_insert_tail
 133 #define mala_stringlist_insert_after mala_stringlist_insert_head
 134
 135 /* inlines */
 136 static inline void
 137 mala_stringlist_insert_after_stringlist (MalaStringList self, MalaStringList src)
 138 {
 139   llist_insert_list_after (&src->node, &self->node);
 140 }
 141
 142 static inline MalaString
 143 mala_stringlist_string (MalaStringList self)
 144 {
 145   return self->string;
 146 }
 147
 148 static inline void
 149 mala_stringlist_string_set (MalaStringList self, MalaString str)
 150 {
 151   self->string = str;
 152 }
 153
 154 static inline const char*
 155 mala_stringlist_cstr (MalaStringList self)
 156 {
 157   return mala_string_cstr (self->string);
 158 }
 159
 160 static inline MalaStringList
 161 mala_stringlist_head_get (MalaStringList self)
 162 {
 163   return LLIST_TO_STRUCTP (llist_get_next (&self->node), mala_stringlist, node);
 164 }
 165
 166 static inline MalaString
 167 mala_stringlist_string_from_llist (const_LList self)
 168 {
 169   return LLIST_TO_STRUCTP (self, mala_stringlist, node)->string;
 170 }
 171
 172 static inline const char *
 173 mala_stringlist_cstr_from_llist (const_LList self)
 174 {
 175   return mala_string_cstr (mala_stringlist_string_from_llist (self));
 176 }
 177
 178 static inline void
 179 mala_stringlist_fwd (MalaStringList_ref self)
 180 {
 181   *self = LLIST_TO_STRUCTP (llist_get_next (&(*self)->node), mala_stringlist, node);
 182 }
 183
 184 static inline void
 185 mala_stringlist_rev (MalaStringList_ref self)
 186 {
 187   *self = LLIST_TO_STRUCTP (llist_get_prev (&(*self)->node), mala_stringlist, node);
 188 }
 189
 190 static inline void
 191 mala_stringlist_advance (MalaStringList self)
 192 {
 193   llist_advance (&self->node);
 194 }
 195
 196 static inline void
 197 mala_stringlist_remove (MalaStringList self)
 198 {
 199   llist_unlink (&self->node);
 200 }
 201
 202 static inline MalaStringList
 203 mala_stringlist_next (MalaStringList self)
 204 {
 205   return LLIST_TO_STRUCTP (llist_get_next(&self->node), mala_stringlist, node);
 206 }
 207
 208 static inline MalaStringList
 209 mala_stringlist_prev (MalaStringList self)
 210 {
 211   return LLIST_TO_STRUCTP (llist_get_prev(&self->node), mala_stringlist, node);
 212 }
 213
 214 static inline void
 215 mala_stringlist_insert_tail (MalaStringList self, MalaStringList node)
 216 {
 217   llist_insert_tail (&self->node, &node->node);
 218 }
 219
 220 static inline void
 221 mala_stringlist_insert_head (MalaStringList self, MalaStringList node)
 222 {
 223   llist_insert_head (&self->node, &node->node);
 224 }
 225
 226 static inline MalaStringList
 227 mala_stringlist_tail_get (MalaStringList self)
 228 {
 229   return LLIST_TO_STRUCTP(llist_get_tail (&self->node), mala_stringlist, node);
 230 }
 231
 232 static inline int
 233 mala_stringlist_is_end (MalaStringList self, MalaStringList other)
 234 {
 235   return self == other;
 236 }
 237
 238 #endif /* MALA_STRINGLIST_H */
 239
 240 /*
 241 // Local Variables:
 242 // mode: C
 243 // c-file-style: "gnu"
 244 // End:
 245 // arch-tag: 44b2b6d9-80b8-43fa-938a-a492bd52cea2
 246 // end_of_file
 247 */