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