lib/q.h

   1 /* q.h
   2    Header file for q.c.
   3
   4    Part of the swftools package.
   5
   6    Copyright (c) 2001,2002,2003,2004 Matthias Kramm <kramm@quiss.org>
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
  21
  22 #ifndef __q_h__
  23 #define __q_h__
  24
  25 #include <stdio.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 #define NEW(t,y) t*y = (t*)rfx_calloc(sizeof(t));
  32
  33 /* dynamically growing mem section */
  34 typedef struct _mem_t {
  35     char*buffer;
  36     int len;
  37     int pos;
  38     int read_pos;
  39 } mem_t;
  40
  41 /* fifo buffered growing mem region */
  42 typedef struct _ringbuffer_t
  43 {
  44     void*internal;
  45     int available;
  46 } ringbuffer_t;
  47
  48 /* non-nul terminated string */
  49 typedef struct _string_t {
  50     const char*str;
  51     int len;
  52 } string_t;
  53
  54 /* key/value pairs of strings */
  55 typedef struct _map_t {
  56     void*internal;
  57 } map_t;
  58
  59 /* type information */
  60 typedef char (*equals_func)(const void*o1, const void*o2);
  61 typedef unsigned int (*hash_func)(const void*o);
  62 typedef void* (*dup_func)(const void*o);
  63 typedef void (*free_func)(void*o);
  64
  65 typedef struct _type_t {
  66     equals_func equals;
  67     hash_func hash;
  68     dup_func dup;
  69     free_func free;
  70 } type_t;
  71
  72 extern type_t charptr_type;
  73 extern type_t stringstruct_type;
  74 extern type_t ptr_type;
  75
  76 typedef struct _dictentry {
  77     void*key;
  78     unsigned int hash;
  79     void*data;
  80     struct _dictentry*next;
  81 } dictentry_t;
  82
  83 /* (void*) pointers referenced by strings */
  84 typedef struct _dict {
  85     dictentry_t**slots;
  86     type_t*key_type;
  87     int hashsize;
  88     int num;
  89 } dict_t;
  90
  91 /* array of key/value pairs, with fast lookup */
  92 typedef struct _array_entry {
  93     void*name;
  94     void*data;
  95 } array_entry_t;
  96
  97 typedef struct _array {
  98     int num;
  99     int size;
 100     array_entry_t*d;
 101     dict_t*entry2pos;
 102 } array_t;
 103
 104 /* array of strings, string<->int mapping,
 105    with O(1) for int->string lookup and
 106         ~O(n/hashsize) for string->int lookup */
 107 typedef struct _stringarray_t
 108 {
 109     void*internal;
 110 } stringarray_t;
 111
 112 /* heap */
 113 typedef struct _heap {
 114     void**elements;
 115     char*data;
 116     int elem_size;
 117     int size;
 118     int max_size;
 119     int(*compare)(const void *, const void *);
 120 } heap_t;
 121
 122 /* trie (with rollback) */
 123 typedef struct _trielayer {
 124     struct _trielayer*row[256];
 125     unsigned char*rest;
 126     void*data;
 127 } trielayer_t;
 128
 129 typedef struct _trie {
 130     trielayer_t* start;
 131     void*rollback;
 132 } trie_t;
 133
 134 char* strdup_n(const char*str, int size);
 135 char* allocprintf(const char*str, ...);
 136
 137 unsigned int crc32_add_byte(unsigned int crc32, unsigned char b);
 138 unsigned int crc32_add_string(unsigned int crc32, const char*s);
 139
 140 void mem_init(mem_t*mem);
 141 int mem_put(mem_t*m, void*data, int length);
 142 int mem_putstring(mem_t*m, string_t str);
 143 int mem_get(mem_t*m, void*data, int length);
 144 void mem_clear(mem_t*mem);
 145 void mem_destroy(mem_t*mem);
 146
 147 void ringbuffer_init(ringbuffer_t*r);
 148 void ringbuffer_put(ringbuffer_t*r, void*buf, int size);
 149 int ringbuffer_read(ringbuffer_t*r, void*buf, int size);
 150 void ringbuffer_clear(ringbuffer_t*r);
 151
 152 /* old style functions- should be renamed */
 153 string_t string_new(const char*text, int len);
 154 string_t string_new2(const char*text);
 155 void string_dup(string_t*str, const char*text);
 156 void string_dup2(string_t*str, const char*text, int len);
 157
 158 char* string_cstr(string_t*str);
 159 char* string_escape(string_t*str);
 160 string_t* string_new3(const char*text, int len);
 161 string_t* string_new4(const char*text);
 162 void string_free(string_t*s);
 163 unsigned int string_hash(const string_t*str);
 164 unsigned int string_hash2(const char*str);
 165 unsigned int string_hash3(const char*str, int len);
 166 void string_set(string_t*str, const char*text);
 167 void string_set2(string_t*str, const char*text, int len);
 168 string_t*string_dup3(string_t*s);
 169 int string_equals(string_t*str, const char*text);
 170
 171 void stringarray_init(stringarray_t*sa, int hashsize);
 172 void stringarray_put(stringarray_t*sa, string_t str);
 173
 174 char* stringarray_at(stringarray_t*sa, int pos);
 175 string_t stringarray_at2(stringarray_t*sa, int pos);
 176 int stringarray_find(stringarray_t*sa, string_t*str);
 177 void stringarray_clear(stringarray_t*sa);
 178 void stringarray_destroy(stringarray_t*sa);
 179
 180 dict_t*dict_new();
 181 dict_t*dict_new2(type_t*type);
 182 void dict_init(dict_t*dict, int size);
 183 void dict_init2(dict_t*dict, type_t*type, int size);
 184 dictentry_t*dict_put(dict_t*h, const void*key, void* data);
 185 void dict_put2(dict_t*h, const char*s, void*data);
 186 int dict_count(dict_t*h);
 187 void dict_dump(dict_t*h, FILE*fi, const char*prefix);
 188 dictentry_t* dict_get_slot(dict_t*h, const void*key);
 189 char dict_contains(dict_t*h, const void*s);
 190 void* dict_lookup(dict_t*h, const void*s);
 191 char dict_del(dict_t*h, const void*s);
 192 dict_t*dict_clone(dict_t*);
 193
 194 void dict_foreach_keyvalue(dict_t*h, void (*runFunction)(void*data, const void*key, void*val), void*data);
 195 void dict_foreach_value(dict_t*h, void (*runFunction)(void*));
 196 void dict_free_all(dict_t*h, char free_keys, void (*free_data_function)(void*));
 197 void dict_clear(dict_t*h);
 198 void dict_destroy_shallow(dict_t*dict);
 199 void dict_destroy(dict_t*dict);
 200 #define DICT_ITERATE_DATA(d,t,v) \
 201     int v##_i;dictentry_t*v##_e;t v;\
 202     for(v##_i=0;v##_i<(d)->hashsize;v##_i++) \
 203         for(v##_e=(d)->slots[v##_i]; v##_e && ((v=(t)v##_e->data)||1); v##_e=v##_e->next)
 204 #define DICT_ITERATE_KEY(d,t,v)  \
 205     int v##_i;dictentry_t*v##_e;t v;\
 206     for(v##_i=0;v##_i<(d)->hashsize;v##_i++) \
 207         for(v##_e=(d)->slots[v##_i];v##_e && ((v=(t)v##_e->key)||1);v##_e=v##_e->next)
 208 #define DICT_ITERATE_ITEMS(d,t1,v1,t2,v2) \
 209     int v1##_i;dictentry_t*v1##_e;t1 v1;t2 v2; \
 210     for(v1##_i=0;v1##_i<(d)->hashsize;v1##_i++) \
 211         for(v1##_e=(d)->slots[v1##_i]; v1##_e && (((v1=(t1)v1##_e->key)&&(v2=(t2)v1##_e->data))||1); v1##_e=v1##_e->next)
 212
 213 void map_init(map_t*map);
 214 void map_put(map_t*map, string_t t1, string_t t2);
 215 const char* map_lookup(map_t*map, const char*name);
 216 void map_dump(map_t*map, FILE*fi, const char*prefix);
 217 void map_clear(map_t*map);
 218 void map_destroy(map_t*map);
 219
 220 void heap_init(heap_t*h,int elem_size, int(*compare)(const void *, const void *));
 221 heap_t* heap_new(int elem_size, int(*compare)(const void *, const void *));
 222 heap_t* heap_clone(heap_t*o);
 223 void heap_clear(heap_t*h);
 224 void heap_destroy(heap_t*h);
 225 void heap_put(heap_t*h, void*e);
 226 int heap_size(heap_t*h);
 227 void* heap_peek(heap_t*h);
 228 void* heap_chopmax(heap_t*h);
 229 void heap_dump(heap_t*h, FILE*fi);
 230 void** heap_flatten(heap_t*h);
 231
 232 trie_t*trie_new();
 233 void trie_put(trie_t*t, unsigned const char*id, void*data);
 234 char trie_remove(trie_t*t, unsigned const char*id);
 235 void*trie_lookup(trie_t*t, unsigned const char*id);
 236 int trie_contains(trie_t*t, unsigned const char*id);
 237 void trie_remember(trie_t*t);
 238 void trie_rollback(trie_t*t);
 239 void trie_dump(trie_t*t);
 240
 241 array_t* array_new();
 242 array_t* array_new2(type_t*type);
 243 void array_free(array_t*array);
 244 void*array_getkey(array_t*array, int nr);
 245 void*array_getvalue(array_t*array, int nr);
 246 int array_append(array_t*array, const void*name, void*data);
 247 #define array_contains(a,b) (array_find((a),(b))>=0)
 248 int array_find(array_t*array, const void*name);
 249 int array_find2(array_t*array, const void*name, void*data);
 250 int array_update(array_t*array, const void*name, void*data);
 251 int array_append_if_new(array_t*array, const void*name, void*data);
 252 #define array_length(a) ((a)->num)
 253
 254 #define DECLARE(x) struct _##x;typedef struct _##x x##_t;
 255 #define DECLARE_LIST(x) \
 256 struct _##x##_list { \
 257     struct _##x* x; \
 258     struct _##x##_list*next; \
 259 }; \
 260 typedef struct _##x##_list x##_list_t;
 261 int list_length_(void*_list);
 262 void*list_clone_(void*_list);
 263 void list_append_(void*_list, void*entry);
 264 void list_prepend_(void*_list, void*entry);
 265 void list_free_(void*_list);
 266 void list_deep_free_(void*_list);
 267 void list_concat_(void*l1, void*l2);
 268 #define list_new() ((void*)0)
 269 #define list_append(list, e) {sizeof((list)->next);list_append_(&(list),(e));}
 270 #define list_concat(l1, l2) {sizeof((l1)->next);sizeof((l2)->next);list_concat_(&(l1),&(l2));}
 271 #define list_prepend(list, e) {sizeof((list)->next);list_prepend_(&(list),(e));}
 272 #define list_free(list) {sizeof((list)->next);list_free_(&(list));}
 273 #define list_deep_free(list) {sizeof((list)->next);list_deep_free_(&(list));}
 274 #define list_clone(list) (sizeof((list)->next),(list?list_clone_(&(list)):0))
 275 #define list_length(list) (sizeof((list)->next),list_length_(list))
 276
 277 #ifdef __cplusplus
 278 }
 279 #endif
 280
 281 #endif //__q_h__