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 } mem_t;
  39
  40 /* fifo buffered growing mem region */
  41 typedef struct _ringbuffer_t
  42 {
  43     void*internal;
  44     int available;
  45 } ringbuffer_t;
  46
  47 /* non-nul terminated string */
  48 typedef struct _string_t {
  49     const char*str;
  50     int len;
  51 } string_t;
  52
  53 /* key/value pairs of strings */
  54 typedef struct _map_t {
  55     void*internal;
  56 } map_t;
  57
  58 /* type information */
  59 typedef char (*equals_func)(const void*o1, const void*o2);
  60 typedef unsigned int (*hash_func)(const void*o);
  61 typedef void* (*dup_func)(const void*o);
  62 typedef void (*free_func)(void*o);
  63
  64 typedef struct _type_t {
  65     equals_func equals;
  66     hash_func hash;
  67     dup_func dup;
  68     free_func free;
  69 } type_t;
  70
  71 extern type_t charptr_type;
  72 extern type_t stringstruct_type;
  73 extern type_t ptr_type;
  74
  75 typedef struct _dictentry {
  76     void*key;
  77     unsigned int hash;
  78     void*data;
  79     struct _dictentry*next;
  80 } dictentry_t;
  81
  82 /* (void*) pointers referenced by strings */
  83 typedef struct _dict {
  84     dictentry_t**slots;
  85     type_t*key_type;
  86     int hashsize;
  87     int num;
  88 } dict_t;
  89
  90 /* array of key/value pairs, with fast lookup */
  91 typedef struct _array_entry {
  92     void*name;
  93     void*data;
  94 } array_entry_t;
  95
  96 typedef struct _array {
  97     int num;
  98     int size;
  99     array_entry_t*d;
 100     dict_t*entry2pos;
 101 } array_t;
 102
 103 /* array of strings, string<->int mapping,
 104    with O(1) for int->string lookup and
 105         ~O(n/hashsize) for string->int lookup */
 106 typedef struct _stringarray_t
 107 {
 108     void*internal;
 109 } stringarray_t;
 110
 111 /* heap */
 112 typedef struct _heap
 113 {
 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 char* strdup_n(const char*str, int size);
 123
 124 unsigned int crc32_add_byte(unsigned int crc32, unsigned char b);
 125 unsigned int crc32_add_string(unsigned int crc32, const char*s);
 126
 127 void mem_init(mem_t*mem);
 128 int mem_put(mem_t*m, void*data, int length);
 129 int mem_putstring(mem_t*m, string_t str);
 130 void mem_clear(mem_t*mem);
 131 void mem_destroy(mem_t*mem);
 132
 133 void ringbuffer_init(ringbuffer_t*r);
 134 void ringbuffer_put(ringbuffer_t*r, void*buf, int size);
 135 int ringbuffer_read(ringbuffer_t*r, void*buf, int size);
 136 void ringbuffer_clear(ringbuffer_t*r);
 137
 138 /* old style functions- should be renamed */
 139 string_t string_new(const char*text, int len);
 140 string_t string_new2(const char*text);
 141 void string_dup(string_t*str, const char*text);
 142 void string_dup2(string_t*str, const char*text, int len);
 143
 144 char* string_cstr(string_t*str);
 145 char* string_escape(string_t*str);
 146 string_t* string_new3(const char*text, int len);
 147 string_t* string_new4(const char*text);
 148 void string_free(string_t*s);
 149 unsigned int string_hash(const string_t*str);
 150 unsigned int string_hash2(const char*str);
 151 unsigned int string_hash3(const char*str, int len);
 152 void string_set(string_t*str, const char*text);
 153 void string_set2(string_t*str, const char*text, int len);
 154 string_t*string_dup3(string_t*s);
 155 int string_equals(string_t*str, const char*text);
 156
 157 void stringarray_init(stringarray_t*sa, int hashsize);
 158 void stringarray_put(stringarray_t*sa, string_t str);
 159
 160 char* stringarray_at(stringarray_t*sa, int pos);
 161 string_t stringarray_at2(stringarray_t*sa, int pos);
 162 int stringarray_find(stringarray_t*sa, string_t*str);
 163 void stringarray_clear(stringarray_t*sa);
 164 void stringarray_destroy(stringarray_t*sa);
 165
 166 dict_t*dict_new();
 167 dict_t*dict_new2(type_t*type);
 168 void dict_init(dict_t*dict, int size);
 169 dictentry_t*dict_put(dict_t*h, const void*key, void* data);
 170 void dict_put2(dict_t*h, const char*s, void*data);
 171 int dict_count(dict_t*h);
 172 void dict_dump(dict_t*h, FILE*fi, const char*prefix);
 173 dictentry_t* dict_get_slot(dict_t*h, const void*key);
 174 char dict_contains(dict_t*h, const void*s);
 175 void* dict_lookup(dict_t*h, const void*s);
 176 char dict_del(dict_t*h, const void*s);
 177 dict_t*dict_clone(dict_t*);
 178
 179 void dict_foreach_keyvalue(dict_t*h, void (*runFunction)(void*data, const void*key, void*val), void*data);
 180 void dict_foreach_value(dict_t*h, void (*runFunction)(void*));
 181 void dict_free_all(dict_t*h, void (*freeFunction)(void*));
 182 void dict_clear(dict_t*h);
 183 void dict_destroy(dict_t*dict);
 184
 185 void map_init(map_t*map);
 186 void map_put(map_t*map, string_t t1, string_t t2);
 187 const char* map_lookup(map_t*map, const char*name);
 188 void map_dump(map_t*map, FILE*fi, const char*prefix);
 189 void map_clear(map_t*map);
 190 void map_destroy(map_t*map);
 191
 192 void heap_init(heap_t*h,int n,int elem_size, int(*compare)(const void *, const void *));
 193 void heap_clear(heap_t*h);
 194 void heap_put(heap_t*h, void*e);
 195 int heap_size(heap_t*h);
 196 void* heap_max(heap_t*h);
 197 void* heap_chopmax(heap_t*h);
 198 void heap_dump(heap_t*h, FILE*fi);
 199 void** heap_flatten(heap_t*h);
 200
 201 array_t* array_new();
 202 array_t* array_new2(type_t*type);
 203 void array_free(array_t*array);
 204 void*array_getkey(array_t*array, int nr);
 205 void*array_getvalue(array_t*array, int nr);
 206 int array_append(array_t*array, const void*name, void*data);
 207 #define array_contains(a,b) (array_find((a),(b))>=0)
 208 int array_find(array_t*array, const void*name);
 209 int array_find2(array_t*array, const void*name, void*data);
 210 int array_update(array_t*array, const void*name, void*data);
 211 int array_append_if_new(array_t*array, const void*name, void*data);
 212 #define array_length(a) ((a)->num)
 213
 214 #define DECLARE(x) struct _##x;typedef struct _##x x##_t;
 215 #define DECLARE_LIST(x) \
 216 struct _##x##_list { \
 217     struct _##x* x; \
 218     struct _##x##_list*next; \
 219 }; \
 220 typedef struct _##x##_list x##_list_t;
 221 int list_length_(void*_list);
 222 void*list_clone_(void*_list);
 223 void list_append_(void*_list, void*entry);
 224 void list_prepend_(void*_list, void*entry);
 225 void list_free_(void*_list);
 226 #define list_new() ((void*)0)
 227 #define list_append(list, e) {sizeof((list)->next);list_append_(&(list),(e));}
 228 #define list_prepend(list, e) {sizeof((list)->next);list_prepend_(&(list),(e));}
 229 #define list_free(list) {sizeof((list)->next);list_free_(&(list));}
 230 #define list_clone(list) (sizeof((list)->next),list_clone_(&(list)))
 231 #define list_length(list) (sizeof((list)->next),list_length_(list))
 232
 233 #ifdef __cplusplus
 234 }
 235 #endif
 236
 237 #endif //__q_h__