OpenSRF/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 int init_proc_title( int argc, char* argv[] );
  80 int set_proc_title( char* format, ... );
  81
  82
  83 int daemonize();
  84
  85 void* safe_malloc(int size);
  86
  87 // ---------------------------------------------------------------------------------
  88 // Generic growing buffer. Add data all you want
  89 // ---------------------------------------------------------------------------------
  90 struct growing_buffer_struct {
  91         char *buf;
  92         int n_used;
  93         int size;
  94 };
  95 typedef struct growing_buffer_struct growing_buffer;
  96
  97 growing_buffer* buffer_init( int initial_num_bytes);
  98
  99 // XXX This isn't defined in utils.c!! removing for now...
 100 //int buffer_addchar(growing_buffer* gb, char c);
 101
 102 int buffer_add(growing_buffer* gb, char* c);
 103 int buffer_fadd(growing_buffer* gb, const char* format, ... );
 104 int buffer_reset( growing_buffer* gb);
 105 char* buffer_data( growing_buffer* gb);
 106 int buffer_free( growing_buffer* gb );
 107 int buffer_add_char(growing_buffer* gb, char c);
 108
 109 /* returns the size needed to fill in the vsnprintf buffer.
 110         * ! this calls va_end on the va_list argument*
 111         */
 112 long va_list_size(const char* format, va_list);
 113
 114 /* turns a va list into a string, caller must free the
 115         allocated char */
 116 char* va_list_to_string(const char* format, ...);
 117
 118
 119 /* string escape utility method.  escapes unicode embeded characters.
 120         escapes the usual \n, \t, etc.
 121         for example, if you provide a string like so:
 122
 123         hello,
 124                 you
 125
 126         you would get back:
 127         hello,\n\tyou
 128
 129  */
 130 char* uescape( const char* string, int size, int full_escape );
 131
 132 /* utility methods */
 133 int set_fl( int fd, int flags );
 134 int clr_fl( int fd, int flags );
 135
 136
 137
 138 // Utility method
 139 double get_timestamp_millis();
 140
 141
 142 /* returns true if the whole string is a number */
 143 int stringisnum(char* s);
 144
 145 /* reads a file and returns the string version of the file
 146         user is responsible for freeing the returned char*
 147         */
 148 char* file_to_string(const char* filename);
 149
 150
 151
 152
 153
 154 #endif