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 void
  52 mala_stringlist_fwd (MalaStringListNode_ref self);
  53
  54
  55 static inline void
  56 mala_stringlist_rev (MalaStringListNode_ref self);
  57
  58 static inline MalaStringListNode
  59 mala_stringlist_next (MalaStringListNode self);
  60
  61 static inline MalaStringListNode
  62 mala_stringlist_prev (MalaStringListNode self);
  63
  64 MalaStringList
  65 mala_stringlist_new ();
  66
  67 MalaStringList
  68 mala_stringlist_new_cstrs (char **cstrs,
  69                            int nelem,
  70                            MalaStringBucket bucket);
  71
  72 void
  73 mala_stringlist_erase (MalaStringList head);
  74
  75 void
  76 mala_stringlist_free (MalaStringList head);
  77
  78 void *
  79 mala_stringlist_factory (MalaStringList_ref dest, char** src, MalaStringBucket bucket);
  80
  81 MalaStringListNode
  82 mala_stringlist_head_new (MalaStringList head, MalaString str);
  83
  84 MalaStringListNode
  85 mala_stringlist_tail_new (MalaStringList head, MalaString str);
  86
  87 MalaStringListNode
  88 mala_stringlist_head_new_cstr (MalaStringList head, const char * cstr, MalaStringBucket bucket);
  89
  90 MalaStringListNode
  91 mala_stringlist_tail_new_cstr (MalaStringList head, const char * cstr, MalaStringBucket bucket);
  92
  93 static inline void
  94 mala_stringlist_tail_insert (MalaStringList head, MalaStringListNode self);
  95
  96 //static inline void
  97 //mala_stringlist_tail_move (MalaStringList to, MalaStringList from, MalaStringListNode self);
  98
  99 MalaStringListNode
 100 mala_stringlist_after_new (MalaStringList head,
 101                            MalaStringListNode pred,
 102                            MalaString str);
 103
 104 MalaStringListNode
 105 mala_stringlist_before_new (MalaStringList head,
 106                             MalaStringListNode succ,
 107                             MalaString str);
 108
 109
 110 MalaStringListNode
 111 mala_stringlist_elem_remove (MalaStringList head,
 112                              MalaStringListNode elem);
 113
 114 void
 115 mala_stringlist_elem_delete (MalaStringList head, MalaStringListNode elem);
 116
 117 int
 118 mala_stringlist_char_exists (MalaStringList head, const char c);
 119
 120
 121 static inline void
 122 mala_stringlist_elem_delete_fwd (MalaStringList head, MalaStringListNode_ref elem);
 123
 124 static inline int
 125 mala_stringlist_is_tail (MalaStringList head, MalaStringListNode elem);
 126
 127 static inline int
 128 mala_stringlist_is_end (MalaStringList head, MalaStringListNode elem);
 129
 130 static inline int
 131 mala_stringlist_is_single (MalaStringList head);
 132
 133 static inline int
 134 mala_stringlist_is_empty (MalaStringList head);
 135
 136 static inline MalaStringListNode
 137 mala_stringlist_node_remove (MalaStringList head, MalaStringListNode self);
 138
 139
 140 /*
 141 static inline int mala_stringlist_insert_before (MalaStringList head,
 142                                                  MalaStringListNode succ,
 143                                                  MalaStringListNode elem);
 144 static inline int mala_stringlist_insert_head (MalaStringList head, MalaStringListNode elem);
 145 static inline int mala_stringlist_insert_tail (MalaStringList head, MalaStringListNode elem);
 146 */
 147 /*
 148 static inline int mala_stringlist_new_after (MalaStringList head,
 149                                                 MalaStringListNode pred,
 150                                                 MalaString str);
 151 static inline int mala_stringlist_new_before (MalaStringList head,
 152                                                  MalaStringListNode succ,
 153                                                  MalaString str);
 154 */
 155
 156 /*
 157 static inline MalaStringListNode mala_stringlist_head_new_cstr (MalaStringList head,
 158                                                                 const char * cstr);
 159 static inline MalaStringListNode mala_stringlist_tail_new_cstr (MalaStringList head,
 160                                                                 const char * cstr);
 161 */
 162
 163 \f
 164 /*
 165  * Inlines
 166  */
 167 #if 0
 168 static inline void
 169 mala_stringlist_insert_after (MalaStringList head,
 170                               MalaStringListNode pred,
 171                               MalaString str)
 172 {
 173
 174   CIRCLEQ_INSERT_AFTER(head, TYPE *listelm, TYPE *elm, CIRCLEQ_ENTRY NAME);
 175 }
 176
 177 static inline void
 178 mala_stringlist_insert_before (MalaStringList head,
 179                                MalaStringListNode succ,
 180                                MalaString str)
 181 {
 182      CIRCLEQ_INSERT_BEFORE(CIRCLEQ_HEAD *head, TYPE *listelm, TYPE *elm, CIRCLEQ_ENTRY NAME);
 183 }
 184 static inline void
 185 mala_stringlist_insert_head (MalaStringList head, MalaString str)
 186      CIRCLEQ_INSERT_HEAD(CIRCLEQ_HEAD *head, TYPE *elm, CIRCLEQ_ENTRY NAME);
 187
 188 #endif
 189
 190 /* statics */
 191
 192 static inline void
 193 mala_stringlist_elem_delete_fwd (MalaStringList head, MalaStringListNode_ref elem)
 194 {
 195   MalaStringListNode tmp = *elem;
 196   *elem = (*elem)->node.cqe_next;
 197   mala_stringlist_elem_delete (head, tmp);
 198 }
 199
 200 static inline MalaStringListNode
 201 mala_stringlist_node_remove (MalaStringList head, MalaStringListNode self)
 202 {
 203    CIRCLEQ_REMOVE (head, self, node);
 204    return self;
 205 }
 206
 207 static inline void
 208 mala_stringlist_tail_insert (MalaStringList head, MalaStringListNode self)
 209 {
 210   CIRCLEQ_INSERT_TAIL (head, self, node);
 211 }
 212
 213
 214 static inline int
 215 mala_stringlist_is_empty (MalaStringList head)
 216 {
 217   return head->cqh_first == (void *)head;
 218 }
 219
 220 static inline void
 221 mala_stringlist_fwd (MalaStringListNode_ref self)
 222 {
 223   *self = (*self)->node.cqe_next;
 224 }
 225
 226 static inline void
 227 mala_stringlist_rev (MalaStringListNode_ref self)
 228 {
 229   *self = (*self)->node.cqe_prev;
 230 }
 231
 232 static inline MalaStringListNode
 233 mala_stringlist_next (MalaStringListNode self)
 234 {
 235   return self->node.cqe_next;
 236 }
 237
 238 static inline MalaStringListNode
 239 mala_stringlist_prev (MalaStringListNode self)
 240 {
 241   return self->node.cqe_prev;
 242 }
 243
 244 static inline void
 245 mala_stringlist_init (MalaStringList self)
 246 {
 247     CIRCLEQ_INIT(self);
 248 }
 249
 250 static inline MalaStringListNode
 251 mala_stringlist_head (MalaStringList self)
 252 {
 253   return self->cqh_first;
 254 }
 255
 256 static inline MalaStringListNode
 257 mala_stringlist_tail (MalaStringList self)
 258 {
 259   return self->cqh_last;
 260 }
 261
 262 static inline int
 263 mala_stringlist_is_single (MalaStringList head)
 264 {
 265   return head->cqh_first != (void *)head && head->cqh_first->node.cqe_next == (void *)head;
 266 }
 267
 268 static inline int
 269 mala_stringlist_is_tail (MalaStringList head, MalaStringListNode elem)
 270 {
 271   return elem->node.cqe_next == (void *)head;
 272 }
 273
 274 static inline int
 275 mala_stringlist_is_end (MalaStringList head, MalaStringListNode elem)
 276 {
 277   return elem == (void *)head;
 278 }
 279
 280
 281 #endif /* MALA_STRINGLIST_H */
 282
 283 /*
 284 // Local Variables:
 285 // mode: C
 286 // c-file-style: "gnu"
 287 // End:
 288 // arch-tag: 44b2b6d9-80b8-43fa-938a-a492bd52cea2
 289 // end_of_file
 290 */