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