changed router binary to opensrf_router to prevent opensrf_all from destroying
[OpenSRF.git] / src / utils / utils.h
1 /*
2 Copyright (C) 2005  Georgia Public Library Service 
3 Bill Erickson <highfalutin@gmail.com>
4 Mike Rylander <mrylander@gmail.com>
5
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.
10
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.
15 */
16
17 #ifndef UTILS_H
18 #define UTILS_H
19
20 #include <stdio.h>
21 #include <stdarg.h>
22 #include <fcntl.h>
23 #include <unistd.h>
24 #include <sys/time.h>
25 #include <sys/stat.h>
26 #include <fcntl.h>
27 #include <sys/types.h>
28 #include <stdlib.h>
29 #include <string.h>
30 //#include <sys/timeb.h>
31
32
33 /* turns a va_list into a string */
34 #define VA_LIST_TO_STRING(x) \
35         unsigned long len = 0;\
36         va_list args; \
37         va_list a_copy;\
38         va_copy(a_copy, args); \
39         va_start(args, x); \
40         len = vsnprintf(NULL, 0, x, args); \
41         va_end(args); \
42         len += 2; \
43         char _b[len]; \
44         bzero(_b, len); \
45         va_start(a_copy, x); \
46         vsnprintf(_b, len - 1, x, a_copy); \
47         va_end(a_copy); \
48         char* VA_BUF = _b; \
49
50 /* turns a long into a string */
51 #define LONG_TO_STRING(l) \
52         unsigned int __len = snprintf(NULL, 0, "%ld", l) + 2;\
53         char __b[__len]; \
54         bzero(__b, __len); \
55         snprintf(__b, __len - 1, "%ld", l); \
56         char* LONGSTR = __b;
57
58 #define DOUBLE_TO_STRING(l) \
59         unsigned int __len = snprintf(NULL, 0, "%lf", l) + 2; \
60         char __b[__len]; \
61         bzero(__b, __len); \
62         snprintf(__b, __len - 1, "%lf", l); \
63         char* DOUBLESTR = __b;
64
65 #define INT_TO_STRING(l) \
66         unsigned int __len = snprintf(NULL, 0, "%d", l) + 2; \
67         char __b[__len]; \
68         bzero(__b, __len); \
69         snprintf(__b, __len - 1, "%d", l); \
70         char* INTSTR = __b;
71
72
73         
74
75
76 #define BUFFER_MAX_SIZE 10485760 
77
78 /* these are evil and should be condemned 
79         ! Only use these if you are done with argv[].
80         call init_proc_title() first, then call
81         set_proc_title. 
82         the title is only allowed to be as big as the
83         initial process name of the process (full size of argv[]).
84         truncation may occurr.
85  */
86 int init_proc_title( int argc, char* argv[] );
87 int set_proc_title( char* format, ... );
88
89
90 int daemonize();
91
92 void* safe_malloc(int size);
93
94 // ---------------------------------------------------------------------------------
95 // Generic growing buffer. Add data all you want
96 // ---------------------------------------------------------------------------------
97 struct growing_buffer_struct {
98         char *buf;
99         int n_used;
100         int size;
101 };
102 typedef struct growing_buffer_struct growing_buffer;
103
104 growing_buffer* buffer_init( int initial_num_bytes);
105
106 // XXX This isn't defined in utils.c!! removing for now...
107 //int buffer_addchar(growing_buffer* gb, char c);
108
109 int buffer_add(growing_buffer* gb, char* c);
110 int buffer_fadd(growing_buffer* gb, const char* format, ... );
111 int buffer_reset( growing_buffer* gb);
112 char* buffer_data( growing_buffer* gb);
113 int buffer_free( growing_buffer* gb );
114 int buffer_add_char(growing_buffer* gb, char c);
115
116 /* returns the size needed to fill in the vsnprintf buffer.  
117         * ! this calls va_end on the va_list argument*
118         */
119 long va_list_size(const char* format, va_list);
120
121 /* turns a va list into a string, caller must free the 
122         allocated char */
123 char* va_list_to_string(const char* format, ...);
124
125
126 /* string escape utility method.  escapes unicode embeded characters.
127         escapes the usual \n, \t, etc. 
128         for example, if you provide a string like so:
129
130         hello,
131                 you
132
133         you would get back:
134         hello,\n\tyou
135  
136  */
137 char* uescape( const char* string, int size, int full_escape );
138
139 /* utility methods */
140 int set_fl( int fd, int flags );
141 int clr_fl( int fd, int flags );
142
143
144
145 // Utility method
146 double get_timestamp_millis();
147
148
149 /* returns true if the whole string is a number */
150 int stringisnum(char* s);
151
152 /* reads a file and returns the string version of the file
153         user is responsible for freeing the returned char*
154         */
155 char* file_to_string(const char* filename);
156
157
158
159
160
161 #endif