]> mj.ucw.cz Git - libucw.git/blob - lib/lib.h
New logging mechanism. Also cleaned up lib.h.
[libucw.git] / lib / lib.h
1 /*
2  *      Sherlock Library -- Miscellaneous Functions
3  *
4  *      (c) 1997--2001 Martin Mares <mj@ucw.cz>
5  */
6
7 /*
8  *  This file should be included as the very first include in all
9  *  source files, especially before all OS includes since it sets
10  *  up libc feature macros.
11  */
12
13 #ifndef _SHERLOCK_LIB_H
14 #define _SHERLOCK_LIB_H
15
16 #include "lib/config.h"
17
18 /* Tell libc we're going to use all extensions available */
19
20 #define _GNU_SOURCE
21
22 #ifndef NULL
23 #define NULL ((void *)0)
24 #endif
25
26 /* Ugly structure handling macros */
27
28 #define OFFSETOF(s, i) ((unsigned int)&((s *)0)->i)
29 #define SKIP_BACK(s, i, p) ((s *)((char *)p - OFFSETOF(s, i)))
30 #define ALIGN(s, a) (((s)+a-1)&~(a-1))
31
32 /* Temporary Files */
33
34 #define TMP_DIR "tmp"
35 #define TMP_DIR_LEN 3
36
37 struct tempfile {
38   int fh;
39   byte name[32];
40 };
41
42 void open_temp(struct tempfile *, byte *);
43 void delete_temp(struct tempfile *);
44 u32 temprand(uns);
45
46 /* Logging */
47
48 #define L_DEBUG         'D'             /* Debugging messages */
49 #define L_INFO          'I'             /* Informational msgs, warnings and errors */
50 #define L_WARN          'W'
51 #define L_ERROR         'E'
52 #define L_INFO_R        'i'             /* Errors caused by external events */
53 #define L_WARN_R        'w'
54 #define L_ERROR_R       'e'
55 #define L_FATAL         '!'             /* die() */
56
57 void log(unsigned int cat, byte *msg, ...);
58 void die(byte *, ...) NONRET;
59 void log_init(byte *);
60 void log_file(byte *);
61
62 #ifdef DEBUG
63 #define ASSERT(x) do { if (!(x)) die("Assertion `%s' failed at %s:%d", #x, __FILE__, __LINE__); } while(0)
64 #else
65 #define ASSERT(x) do { } while(0)
66 #endif
67
68 #ifdef LOCAL_DEBUG
69 #define DBG(x,y...) log(L_DEBUG, x,##y)
70 #else
71 #define DBG(x,y...) do { } while(0)
72 #endif
73
74 /* Memory allocation */
75
76 #ifdef DMALLOC
77 /*
78  * The standard dmalloc macros tend to produce lots of namespace
79  * conflicts and we use only xmalloc and xfree, so we can define
80  * the stubs ourselves.
81  */
82 #define DMALLOC_DISABLE
83 #include <dmalloc.h>
84 #define xmalloc(size) _xmalloc_leap(__FILE__, __LINE__, size)
85 #define xrealloc(ptr,size) _xrealloc_leap(__FILE__, __LINE__, ptr, size)
86 #define xfree(ptr) _xfree_leap(__FILE__, __LINE__, ptr)
87 #else
88 /*
89  * Unfortunately, several libraries we might want to link to define
90  * their own xmalloc and we don't want to interfere with them, hence
91  * the renaming.
92  */
93 #define xmalloc sh_xmalloc
94 void *xmalloc(unsigned);
95 void *xrealloc(void *, unsigned);
96 #define xfree(x) free(x)
97 #endif
98
99 byte *stralloc(byte *);
100
101 /* Content-Type pattern matching and filters */
102
103 int match_ct_patt(byte *, byte *);
104
105 /* log2.c */
106
107 int log2(u32);
108
109 /* wordsplit.c */
110
111 int wordsplit(byte *, byte **, uns);
112
113 /* pat(i)match.c: Matching of shell patterns */
114
115 int match_pattern(byte *, byte *);
116 int match_pattern_nocase(byte *, byte *);
117
118 /* md5hex.c */
119
120 void md5_to_hex(byte *, byte *);
121 void hex_to_md5(byte *, byte *);
122
123 #define MD5_SIZE 16
124 #define MD5_HEX_SIZE 33
125
126 /* prime.c */
127
128 int isprime(uns);
129 uns nextprime(uns);
130
131 /* timer.c */
132
133 void init_timer(void);
134 uns get_timer(void);
135
136 /* regex.c */
137
138 typedef struct regex regex;
139
140 regex *rx_compile(byte *r);
141 void rx_free(regex *r);
142 int rx_match(regex *r, byte *s);
143 int rx_subst(regex *r, byte *by, byte *src, byte *dest, uns destlen);
144
145 /* random.c */
146
147 uns random_max(uns);
148
149 /* mmap.c */
150
151 void *mmap_file(byte *name, unsigned *len);
152
153 #endif