]> git.evergreen-ils.org Git - OpenSRF.git/blob - src/utils/utils.h
added some license info and comments
[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 <stdarg.h>
21 #include <fcntl.h>
22 #include <unistd.h>
23 #include <sys/time.h>
24 #include <sys/stat.h>
25 #include <fcntl.h>
26
27 #define BUFFER_MAX_SIZE 10485760 
28
29 void* safe_malloc(int size);
30
31 // ---------------------------------------------------------------------------------
32 // Generic growing buffer. Add data all you want
33 // ---------------------------------------------------------------------------------
34 struct growing_buffer_struct {
35         char *buf;
36         int n_used;
37         int size;
38 };
39 typedef struct growing_buffer_struct growing_buffer;
40
41 growing_buffer* buffer_init( int initial_num_bytes);
42 int buffer_addchar(growing_buffer* gb, char c);
43 int buffer_add(growing_buffer* gb, char* c);
44 int buffer_fadd(growing_buffer* gb, const char* format, ... );
45 int buffer_reset( growing_buffer* gb);
46 char* buffer_data( growing_buffer* gb);
47 int buffer_free( growing_buffer* gb );
48 int buffer_add_char(growing_buffer* gb, char c);
49
50
51 /* string escape utility method.  escapes unicode embeded characters.
52         escapes the usual \n, \t, etc. 
53         for example, if you provide a string like so:
54
55         hello,
56                 you
57
58         you would get back:
59         hello,\n\tyou
60  
61  */
62 char* uescape( const char* string, int size, int full_escape );
63
64 /* utility methods */
65 int set_fl( int fd, int flags );
66 int clr_fl( int fd, int flags );
67
68
69
70 // Utility method
71 double get_timestamp_millis();
72
73
74
75
76 #endif