2 Copyright (C) 2005 Georgia Public Library Service
3 Bill Erickson <highfalutin@gmail.com>
4 Mike Rylander <mrylander@gmail.com>
6 This program is free software; you can redistribute it and/or
7 modify it under the terms of the GNU General Public License
8 as published by the Free Software Foundation; either version 2
9 of the License, or (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
27 #include <sys/types.h>
30 //#include <sys/timeb.h>
34 #define OSRF_MALLOC(ptr, size) \
36 ptr = (void*) malloc( size ); \
38 perror("OSRF_MALLOC(): Out of Memory" );\
41 memset( ptr, 0, size );\
45 // The original ... replace with noop once no more errors occur in NDEBUG mode
46 #define osrf_clearbuf( s, n ) memset( s, 0, n )
48 #define osrf_clearbuf( s, n ) \
50 char * clearbuf_temp_s = (s); \
51 size_t clearbuf_temp_n = (n); \
52 memset( clearbuf_temp_s, '!', clearbuf_temp_n ); \
53 clearbuf_temp_s[ clearbuf_temp_n - 1 ] = '\0'; \
57 #define OSRF_BUFFER_ADD(gb, data) \
60 growing_buffer* _gb = gb; \
61 const char* _data = data; \
63 _tl = strlen(_data) + _gb->n_used;\
64 if( _tl < _gb->size ) {\
65 strcpy( _gb->buf + _gb->n_used, _data ); \
67 } else { buffer_add(_gb, _data); }\
71 #define OSRF_BUFFER_ADD_N(gb, data, n) \
73 growing_buffer* gb__ = gb; \
74 const char* data__ = data; \
77 int tl__ = n__ + gb__->n_used;\
78 if( tl__ < gb__->size ) {\
79 memcpy( gb__->buf + gb__->n_used, data__, n__ ); \
80 gb__->buf[tl__] = '\0'; \
81 gb__->n_used = tl__; \
82 } else { buffer_add_n(gb__, data__, n__); }\
86 #define OSRF_BUFFER_ADD_CHAR(gb, c)\
88 growing_buffer* _gb = gb;\
91 if(_gb->n_used < _gb->size - 1) {\
92 _gb->buf[_gb->n_used++] = _c;\
93 _gb->buf[_gb->n_used] = '\0';\
96 buffer_add_char(_gb, _c);\
100 #define OSRF_BUFFER_RESET(gb) \
102 growing_buffer* _gb = gb;\
103 memset(_gb->buf, 0, _gb->size);\
107 #define OSRF_BUFFER_C_STR( x ) ((const char *) (x)->buf)
110 /* turns a va_list into a string */
111 #define VA_LIST_TO_STRING(x) \
112 unsigned long __len = 0;\
115 va_copy(a_copy, args); \
117 __len = vsnprintf(NULL, 0, x, args); \
122 va_start(a_copy, x); \
123 vsnprintf(_b, __len - 1, x, a_copy); \
127 /* turns a long into a string */
128 #define LONG_TO_STRING(l) \
129 unsigned int __len = snprintf(NULL, 0, "%ld", l) + 2;\
132 snprintf(__b, __len - 1, "%ld", l); \
135 #define DOUBLE_TO_STRING(l) \
136 unsigned int __len = snprintf(NULL, 0, "%f", l) + 2; \
139 snprintf(__b, __len - 1, "%f", l); \
140 char* DOUBLESTR = __b;
142 #define LONG_DOUBLE_TO_STRING(l) \
143 unsigned int __len = snprintf(NULL, 0, "%Lf", l) + 2; \
146 snprintf(__b, __len - 1, "%Lf", l); \
147 char* LONGDOUBLESTR = __b;
150 #define INT_TO_STRING(l) \
151 unsigned int __len = snprintf(NULL, 0, "%d", l) + 2; \
154 snprintf(__b, __len - 1, "%d", l); \
160 struct md5_ctx ctx; \
161 unsigned char digest[16];\
164 for ( i=0 ; i != strlen(text) ; i++ ) MD5_feed (&ctx, text[i]);\
165 MD5_stop (&ctx, digest);\
169 memset(final,0,256);\
170 for ( i=0 ; i<16 ; i++ ) {\
171 sprintf(buf, "%02x", digest[i]);\
172 strcat( final, buf );\
174 char* MD5STR = final;
181 #define BUFFER_MAX_SIZE 10485760
183 /* these are evil and should be condemned
184 ! Only use these if you are done with argv[].
185 call init_proc_title() first, then call
187 the title is only allowed to be as big as the
188 initial process name of the process (full size of argv[]).
189 truncation may occurr.
191 int init_proc_title( int argc, char* argv[] );
192 int set_proc_title( const char* format, ... );
195 int daemonize( void );
197 void* safe_malloc(int size);
198 void* safe_calloc(int size);
200 // ---------------------------------------------------------------------------------
201 // Generic growing buffer. Add data all you want
202 // ---------------------------------------------------------------------------------
203 struct growing_buffer_struct {
208 typedef struct growing_buffer_struct growing_buffer;
210 #define buffer_length(x) (x)->n_used
212 growing_buffer* buffer_init( int initial_num_bytes);
214 // XXX This isn't defined in utils.c!! removing for now...
215 //int buffer_addchar(growing_buffer* gb, char c);
217 int buffer_add(growing_buffer* gb, const char* c);
218 int buffer_add_n(growing_buffer* gb, const char* data, size_t n);
219 int buffer_fadd(growing_buffer* gb, const char* format, ... );
220 int buffer_reset( growing_buffer* gb);
221 char* buffer_data( const growing_buffer* gb);
222 char* buffer_release( growing_buffer* gb );
223 int buffer_free( growing_buffer* gb );
224 int buffer_add_char(growing_buffer* gb, char c);
225 char buffer_chomp(growing_buffer* gb); // removes the last character from the buffer
227 /* returns the size needed to fill in the vsnprintf buffer.
228 * ! this calls va_end on the va_list argument*
230 long va_list_size(const char* format, va_list);
232 /* turns a va list into a string, caller must free the
234 char* va_list_to_string(const char* format, ...);
237 /* string escape utility method. escapes unicode embedded characters.
238 escapes the usual \n, \t, etc.
239 for example, if you provide a string like so:
248 char* uescape( const char* string, int size, int full_escape );
250 /* utility methods */
251 int set_fl( int fd, int flags );
252 int clr_fl( int fd, int flags );
257 double get_timestamp_millis( void );
260 /* returns true if the whole string is a number */
261 int stringisnum(const char* s);
263 /* reads a file and returns the string version of the file
264 user is responsible for freeing the returned char*
266 char* file_to_string(const char* filename);
271 Calculates the md5 of the text provided.
272 The returned string must be freed by the caller.
274 char* md5sum( const char* text, ... );
278 Checks the validity of the file descriptor
279 returns -1 if the file descriptor is invalid
280 returns 0 if the descriptor is OK
282 int osrfUtilsCheckFileDescriptor( int fd );