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 static inline void
 118 mala_stringlist_elem_delete_fwd (MalaStringList head, MalaStringListNode_ref elem);
 119
 120 static inline int
 121 mala_stringlist_is_tail (MalaStringList head, MalaStringListNode elem);
 122
 123 static inline int
 124 mala_stringlist_is_end (MalaStringList head, MalaStringListNode elem);
 125
 126 static inline int
 127 mala_stringlist_is_empty (MalaStringList head);
 128
 129 static inline MalaStringListNode
 130 mala_stringlist_node_remove (MalaStringList head, MalaStringListNode self);
 131
 132
 133 /*
 134 static inline int mala_stringlist_insert_before (MalaStringList head,
 135                                                  MalaStringListNode succ,
 136                                                  MalaStringListNode elem);
 137 static inline int mala_stringlist_insert_head (MalaStringList head, MalaStringListNode elem);
 138 static inline int mala_stringlist_insert_tail (MalaStringList head, MalaStringListNode elem);
 139 */
 140 /*
 141 static inline int mala_stringlist_new_after (MalaStringList head,
 142                                                 MalaStringListNode pred,
 143                                                 MalaString str);
 144 static inline int mala_stringlist_new_before (MalaStringList head,
 145                                                  MalaStringListNode succ,
 146                                                  MalaString str);
 147 */
 148
 149 /*
 150 static inline MalaStringListNode mala_stringlist_head_new_cstr (MalaStringList head,
 151                                                                 const char * cstr);
 152 static inline MalaStringListNode mala_stringlist_tail_new_cstr (MalaStringList head,
 153                                                                 const char * cstr);
 154 */
 155
 156 \f
 157 /*
 158  * Inlines
 159  */
 160 #if 0
 161 static inline void
 162 mala_stringlist_insert_after (MalaStringList head,
 163                               MalaStringListNode pred,
 164                               MalaString str)
 165 {
 166
 167   CIRCLEQ_INSERT_AFTER(head, TYPE *listelm, TYPE *elm, CIRCLEQ_ENTRY NAME);
 168 }
 169
 170 static inline void
 171 mala_stringlist_insert_before (MalaStringList head,
 172                                MalaStringListNode succ,
 173                                MalaString str)
 174 {
 175      CIRCLEQ_INSERT_BEFORE(CIRCLEQ_HEAD *head, TYPE *listelm, TYPE *elm, CIRCLEQ_ENTRY NAME);
 176 }
 177 static inline void
 178 mala_stringlist_insert_head (MalaStringList head, MalaString str)
 179      CIRCLEQ_INSERT_HEAD(CIRCLEQ_HEAD *head, TYPE *elm, CIRCLEQ_ENTRY NAME);
 180
 181 #endif
 182
 183 /* statics */
 184
 185 static inline void
 186 mala_stringlist_elem_delete_fwd (MalaStringList head, MalaStringListNode_ref elem)
 187 {
 188   MalaStringListNode tmp = *elem;
 189   *elem = (*elem)->node.cqe_next;
 190   mala_stringlist_elem_delete (head, tmp);
 191 }
 192
 193 static inline MalaStringListNode
 194 mala_stringlist_node_remove (MalaStringList head, MalaStringListNode self)
 195 {
 196    CIRCLEQ_REMOVE (head, self, node);
 197    return self;
 198 }
 199
 200 static inline void
 201 mala_stringlist_tail_insert (MalaStringList head, MalaStringListNode self)
 202 {
 203   CIRCLEQ_INSERT_TAIL (head, self, node);
 204 }
 205
 206
 207 static inline int
 208 mala_stringlist_is_empty (MalaStringList head)
 209 {
 210   return head->cqh_first == (void *)head;
 211 }
 212
 213 static inline void
 214 mala_stringlist_fwd (MalaStringListNode_ref self)
 215 {
 216   *self = (*self)->node.cqe_next;
 217 }
 218
 219 static inline void
 220 mala_stringlist_rev (MalaStringListNode_ref self)
 221 {
 222   *self = (*self)->node.cqe_prev;
 223 }
 224
 225 static inline MalaStringListNode
 226 mala_stringlist_next (MalaStringListNode self)
 227 {
 228   return self->node.cqe_next;
 229 }
 230
 231 static inline MalaStringListNode
 232 mala_stringlist_prev (MalaStringListNode self)
 233 {
 234   return self->node.cqe_prev;
 235 }
 236
 237 static inline void
 238 mala_stringlist_init (MalaStringList self)
 239 {
 240     CIRCLEQ_INIT(self);
 241 }
 242
 243 static inline MalaStringListNode
 244 mala_stringlist_head (MalaStringList self)
 245 {
 246   return self->cqh_first;
 247 }
 248
 249 static inline MalaStringListNode
 250 mala_stringlist_tail (MalaStringList self)
 251 {
 252   return self->cqh_last;
 253 }
 254
 255 static inline int
 256 mala_stringlist_is_tail (MalaStringList head, MalaStringListNode elem)
 257 {
 258   return elem->node.cqe_next == (void *)head;
 259 }
 260
 261 static inline int
 262 mala_stringlist_is_end (MalaStringList head, MalaStringListNode elem)
 263 {
 264   return elem == (void *)head;
 265 }
 266
 267
 268 #endif /* MALA_STRINGLIST_H */
 269
 270 /*
 271 // Local Variables:
 272 // mode: C
 273 // c-file-style: "gnu"
 274 // End:
 275 // arch-tag: 44b2b6d9-80b8-43fa-938a-a492bd52cea2
 276 // end_of_file
 277 */