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 "mala_types.h"
  24 #include "strings.h"
  25 \f
  26 /*
  27  *      StringList
  28  */
  29
  30 struct mala_stringlistnode_struct
  31 {
  32   CIRCLEQ_ENTRY(mala_stringlistnode_struct) node;
  33   MalaString    string;
  34 };
  35
  36 \f
  37 #define MALA_STATIC_STRINGLIST_INIT(args...) \
  38   (const char*[]){args, NULL}
  39
  40 \f
  41 static inline void
  42 mala_stringlist_init (MalaStringList self);
  43
  44
  45 static inline MalaStringListNode
  46 mala_stringlist_head (MalaStringList self);
  47
  48 static inline MalaStringListNode
  49 mala_stringlist_tail (MalaStringList self);
  50
  51 static inline MalaString
  52 mala_stringlist_head_string_copy (MalaStringList self);
  53
  54
  55 MalaStringList
  56 mala_stringlist_new ();
  57
  58 MalaStringList
  59 mala_stringlist_new_cstrs (char **cstrs,
  60                            int nelem,
  61                            MalaStringBucket bucket);
  62
  63 void
  64 mala_stringlist_erase (MalaStringList head);
  65
  66 void
  67 mala_stringlist_free (MalaStringList head);
  68
  69 void *
  70 mala_stringlist_factory (MalaStringList_ref dest, char** src, MalaStringBucket bucket);
  71
  72 MalaStringListNode
  73 mala_stringlist_head_new (MalaStringList head, MalaString str);
  74
  75 MalaStringListNode
  76 mala_stringlist_tail_new (MalaStringList head, MalaString str);
  77
  78 MalaStringListNode
  79 mala_stringlist_head_new_cstr (MalaStringList head, const char * cstr, MalaStringBucket bucket);
  80
  81 MalaStringListNode
  82 mala_stringlist_tail_new_cstr (MalaStringList head, const char * cstr, MalaStringBucket bucket);
  83
  84 static inline void
  85 mala_stringlist_tail_insert (MalaStringList head, MalaStringListNode self);
  86
  87 //static inline void
  88 //mala_stringlist_tail_move (MalaStringList to, MalaStringList from, MalaStringListNode self);
  89
  90 MalaStringListNode
  91 mala_stringlist_after_new (MalaStringList head,
  92                            MalaStringListNode pred,
  93                            MalaString str);
  94
  95 MalaStringListNode
  96 mala_stringlist_before_new (MalaStringList head,
  97                             MalaStringListNode succ,
  98                             MalaString str);
  99
 100
 101 MalaStringListNode
 102 mala_stringlist_elem_remove (MalaStringList head,
 103                              MalaStringListNode elem);
 104
 105 void
 106 mala_stringlist_elem_delete (MalaStringList head, MalaStringListNode elem);
 107
 108 int
 109 mala_stringlist_char_exists (MalaStringList head, const char c);
 110
 111
 112 static inline void
 113 mala_stringlist_elem_delete_fwd (MalaStringList head, MalaStringListNode_ref elem);
 114
 115 static inline int
 116 mala_stringlist_is_tail (MalaStringList head, MalaStringListNode elem);
 117
 118 static inline int
 119 mala_stringlist_is_end (MalaStringList head, MalaStringListNode elem);
 120
 121 static inline int
 122 mala_stringlist_is_single (MalaStringList head);
 123
 124 static inline int
 125 mala_stringlist_is_empty (MalaStringList head);
 126
 127 static inline MalaStringListNode
 128 mala_stringlist_node_remove (MalaStringList head, MalaStringListNode self);
 129
 130 /*stringlistnode*/
 131 static inline void
 132 mala_stringlistnode_fwd (MalaStringListNode_ref self);
 133
 134 static inline void
 135 mala_stringlistnode_rev (MalaStringListNode_ref self);
 136
 137 static inline MalaStringListNode
 138 mala_stringlistnode_next (MalaStringListNode self);
 139
 140 static inline MalaStringListNode
 141 mala_stringlistnode_prev (MalaStringListNode self);
 142
 143 static inline MalaString
 144 mala_stringlistnode_string (MalaStringListNode self);
 145
 146 static inline void
 147 mala_stringlistnode_substitute_string (MalaStringListNode self, MalaString subst);
 148
 149 static inline void*
 150 mala_stringlistnode_user_get (MalaStringListNode self);
 151
 152 static inline const char*
 153 mala_stringlistnode_cstr (MalaStringListNode self);
 154
 155
 156 /*
 157 static inline int mala_stringlist_insert_before (MalaStringList head,
 158                                                  MalaStringListNode succ,
 159                                                  MalaStringListNode elem);
 160 static inline int mala_stringlist_insert_head (MalaStringList head, MalaStringListNode elem);
 161 static inline int mala_stringlist_insert_tail (MalaStringList head, MalaStringListNode elem);
 162 */
 163 /*
 164 static inline int mala_stringlist_new_after (MalaStringList head,
 165                                                 MalaStringListNode pred,
 166                                                 MalaString str);
 167 static inline int mala_stringlist_new_before (MalaStringList head,
 168                                                  MalaStringListNode succ,
 169                                                  MalaString str);
 170 */
 171
 172 /*
 173 static inline MalaStringListNode mala_stringlist_head_new_cstr (MalaStringList head,
 174                                                                 const char * cstr);
 175 static inline MalaStringListNode mala_stringlist_tail_new_cstr (MalaStringList head,
 176                                                                 const char * cstr);
 177 */
 178
 179 \f
 180 /*
 181  * Inlines
 182  */
 183 #if 0
 184 static inline void
 185 mala_stringlist_insert_after (MalaStringList head,
 186                               MalaStringListNode pred,
 187                               MalaString str)
 188 {
 189
 190   CIRCLEQ_INSERT_AFTER(head, TYPE *listelm, TYPE *elm, CIRCLEQ_ENTRY NAME);
 191 }
 192
 193 static inline void
 194 mala_stringlist_insert_before (MalaStringList head,
 195                                MalaStringListNode succ,
 196                                MalaString str)
 197 {
 198      CIRCLEQ_INSERT_BEFORE(CIRCLEQ_HEAD *head, TYPE *listelm, TYPE *elm, CIRCLEQ_ENTRY NAME);
 199 }
 200 static inline void
 201 mala_stringlist_insert_head (MalaStringList head, MalaString str)
 202      CIRCLEQ_INSERT_HEAD(CIRCLEQ_HEAD *head, TYPE *elm, CIRCLEQ_ENTRY NAME);
 203
 204 #endif
 205
 206 /* statics */
 207
 208 static inline MalaString
 209 mala_stringlist_head_string_copy (MalaStringList self)
 210 {
 211   return mala_string_copy (mala_stringlistnode_string (mala_stringlist_head (self)));
 212 }
 213
 214 static inline void
 215 mala_stringlist_elem_delete_fwd (MalaStringList head, MalaStringListNode_ref elem)
 216 {
 217   MalaStringListNode tmp = *elem;
 218   *elem = (*elem)->node.cqe_next;
 219   mala_stringlist_elem_delete (head, tmp);
 220 }
 221
 222 static inline void
 223 mala_stringlist_elem_delete_fwd_n (MalaStringList head,
 224                                    MalaStringListNode_ref elem,
 225                                    unsigned n)
 226 {
 227   while (n--)
 228     mala_stringlist_elem_delete_fwd (head, elem);
 229 }
 230
 231 static inline MalaStringListNode
 232 mala_stringlist_node_remove (MalaStringList head, MalaStringListNode self)
 233 {
 234    CIRCLEQ_REMOVE (head, self, node);
 235    return self;
 236 }
 237
 238 static inline void
 239 mala_stringlist_tail_insert (MalaStringList head, MalaStringListNode self)
 240 {
 241   CIRCLEQ_INSERT_TAIL (head, self, node);
 242 }
 243
 244
 245 static inline int
 246 mala_stringlist_is_empty (MalaStringList head)
 247 {
 248   return head->cqh_first == (void *)head;
 249 }
 250
 251 static inline void
 252 mala_stringlist_init (MalaStringList self)
 253 {
 254     CIRCLEQ_INIT(self);
 255 }
 256
 257 static inline MalaStringListNode
 258 mala_stringlist_head (MalaStringList self)
 259 {
 260   return self->cqh_first;
 261 }
 262
 263 static inline MalaStringListNode
 264 mala_stringlist_tail (MalaStringList self)
 265 {
 266   return self->cqh_last;
 267 }
 268
 269 static inline int
 270 mala_stringlist_is_single (MalaStringList head)
 271 {
 272   return head->cqh_first != (void *)head && head->cqh_first->node.cqe_next == (void *)head;
 273 }
 274
 275 static inline int
 276 mala_stringlist_is_tail (MalaStringList head, MalaStringListNode elem)
 277 {
 278   return elem->node.cqe_next == (void *)head;
 279 }
 280
 281 static inline int
 282 mala_stringlist_is_end (MalaStringList head, MalaStringListNode elem)
 283 {
 284   return elem == (void *)head;
 285 }
 286
 287 static inline void
 288 mala_stringlistnode_fwd (MalaStringListNode_ref self)
 289 {
 290   *self = (*self)->node.cqe_next;
 291 }
 292
 293 static inline void
 294 mala_stringlistnode_rev (MalaStringListNode_ref self)
 295 {
 296   *self = (*self)->node.cqe_prev;
 297 }
 298
 299 static inline MalaStringListNode
 300 mala_stringlistnode_next (MalaStringListNode self)
 301 {
 302   return self->node.cqe_next;
 303 }
 304
 305 static inline MalaStringListNode
 306 mala_stringlistnode_prev (MalaStringListNode self)
 307 {
 308   return self->node.cqe_prev;
 309 }
 310
 311 static inline MalaString
 312 mala_stringlistnode_string (MalaStringListNode self)
 313 {
 314   return self ? self->string : NULL;
 315 }
 316
 317 static inline void
 318 mala_stringlistnode_substitute_string (MalaStringListNode self, MalaString subst)
 319 {
 320   mala_string_free (self->string);
 321   self->string = mala_string_copy (subst);
 322 }
 323
 324 static inline void*
 325 mala_stringlistnode_user_get (MalaStringListNode self)
 326 {
 327   return self ? mala_string_user_get (self->string) : NULL;
 328 }
 329
 330 static inline const char*
 331 mala_stringlistnode_cstr (MalaStringListNode self)
 332 {
 333   return self ? mala_string_cstr (self->string) : NULL;
 334 }
 335
 336 static inline MalaString
 337 mala_stringlistnode_string_copy (MalaStringListNode self)
 338 {
 339   return mala_string_copy (mala_stringlistnode_string (self));
 340 }
 341
 342 #endif /* MALA_STRINGLIST_H */
 343
 344 /*
 345 // Local Variables:
 346 // mode: C
 347 // c-file-style: "gnu"
 348 // End:
 349 // arch-tag: 44b2b6d9-80b8-43fa-938a-a492bd52cea2
 350 // end_of_file
 351 */