]> mj.ucw.cz Git - libucw.git/blob - lib/lib.h
Added a couple of FIXME's.
[libucw.git] / lib / lib.h
1 /*
2  *      Sherlock Library -- Miscellaneous Functions
3  *
4  *      (c) 1997 Martin Mares, <mj@atrey.karlin.mff.cuni.cz>
5  */
6
7 #ifndef _SHERLOCK_LIB_H
8 #define _SHERLOCK_LIB_H
9
10 #include "lib/config.h"
11
12 /* Ugly structure handling macros */
13
14 #define OFFSETOF(s, i) ((unsigned int)&((s *)0)->i)
15 #define SKIP_BACK(s, i, p) ((s *)((char *)p - OFFSETOF(s, i)))
16 #define ALIGN(s, a) (((s)+a-1)&~(a-1))
17
18 /* Temporary Files */
19
20 #define TMP_DIR "tmp"
21 #define TMP_DIR_LEN 3
22
23 struct tempfile {
24   int fh;
25   byte name[32];
26 };
27
28 void open_temp(struct tempfile *, byte *);
29 void delete_temp(struct tempfile *);
30 u32 temprand(uns);
31
32 /* FIXME: Remove? */
33 #define TF_GENERIC "t"
34 #define TF_QUEUE_CONTROL "c"
35 #define TF_QUEUE_DATA "d"
36 #define TF_DECODE "x"
37 #define TF_TRANSFORM "s"
38 #define TF_OBJECT "o"
39
40 /* Logging */
41
42 /* FIXME: Define new logging mechanism? */
43
44 #define L_DEBUG "<0>"
45 #define L_INFO "<2>"
46 #define L_WARN "<4>"
47 #define L_ERROR "<6>"
48 #define L_FATAL "<9>"
49
50 void log(byte *, ...);
51 void die(byte *, ...) NONRET;
52 void initlog(byte *);
53 void open_log_file(byte *);
54
55 #ifdef DEBUG
56 #define ASSERT(x) do { if (!(x)) die("Assertion `%s' failed at %s:%d", #x, __FILE__, __LINE__); } while(0)
57 #else
58 #define ASSERT(x) do { } while(0)
59 #endif
60
61 /* Allocation */
62
63 void *xmalloc(uns);
64 void *xrealloc(void *, uns);
65 byte *stralloc(byte *);
66
67 /* Content-Type pattern matching and filters */
68
69 int match_ct_patt(byte *, byte *);
70
71 /* Binary log */
72
73 int log2(u32);
74
75 /* obj.c */
76
77 /* FIXME: What to do with this? */
78
79 struct odes {                           /* Object description */
80   struct oattr *attrs;
81   struct mempool *pool;
82 };
83
84 struct oattr {                          /* Object attribute */
85   struct oattr *next, *same;
86   byte attr;
87   byte val[1];
88 };
89
90 void obj_dump(struct odes *);
91 struct odes *obj_fload(FILE *, byte *);
92 struct odes *obj_new(void);
93 struct odes *obj_load(byte *);
94 void obj_fwrite(FILE *, struct odes *);
95 void obj_write(byte *, struct odes *);
96 void obj_free(struct odes *);
97 struct oattr *find_attr(struct odes *, uns);
98 struct oattr *find_attr_last(struct odes *, uns);
99 uns del_attr(struct odes *, struct oattr *);
100 byte *find_aval(struct odes *, uns);
101 struct oattr *set_attr(struct odes *, uns, byte *);
102 struct oattr *set_attr_num(struct odes *, uns, uns);
103 struct oattr *add_attr(struct odes *, struct oattr *, uns, byte *);
104 struct oattr *prepend_attr(struct odes *, uns, byte *);
105
106 /* oname.c */
107
108 /* FIXME: Kill? */
109
110 #define OID_MIN 0x10000         /* Values less than this have special meaning */
111
112 oid_t new_oid(uns);
113 void mk_obj_name(byte *, oid_t, byte *);
114 int dump_obj_to_file(byte *, oid_t, struct odes *, int);
115
116 /* wordsplit.c */
117
118 int wordsplit(byte *, byte **, uns);
119
120 /* pat(i)match.c */
121
122 int match_pattern(byte *, byte *);
123 int match_pattern_nocase(byte *, byte *);
124
125 /* md5hex.c */
126
127 void md5_to_hex(byte *, byte *);
128 void hex_to_md5(byte *, byte *);
129
130 #define MD5_SIZE 16
131 #define MD5_HEX_SIZE 33
132
133 /* prime.c */
134
135 int isprime(uns);
136 uns nextprime(uns);
137
138 /* timer.c */
139
140 void init_timer(void);
141 uns get_timer(void);
142
143 /* regex.c */
144
145 typedef struct regex regex;
146
147 regex *rx_compile(byte *r);
148 void rx_free(regex *r);
149 int rx_match(regex *r, byte *s);
150 int rx_subst(regex *r, byte *by, byte *src, byte *dest, uns destlen);
151
152 /* random.c */
153
154 uns random_max(uns);
155
156 /* mmap.c */
157
158 void *mmap_file(byte *name, unsigned *len);
159
160 #endif