Annotation of parser3/src/include/pa_common.h, revision 1.89.2.8

1.15      paf         1: /** @file
1.16      paf         2:        Parser: commonly used functions.
                      3: 
1.89.2.7  paf         4:        Copyright (c) 2001-2003 ArtLebedev Group (http://www.artlebedev.com)
1.74      paf         5:        Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.1       paf         6: */
                      7: 
                      8: #ifndef PA_COMMON_H
                      9: #define PA_COMMON_H
1.78      paf        10: 
1.89.2.8! paf        11: static const char* IDENT_COMMON_H="$Date: 2003/01/31 12:34:29 $";
1.1       paf        12: 
1.2       paf        13: #include "pa_pool.h"
1.33      paf        14: #include "pa_string.h"
1.89.2.3  paf        15: #include "pa_hash.h"
                     16: #include "pa_value.h"
1.1       paf        17: 
1.89.2.6  paf        18: typedef Hash<StringPtr, ValuePtr> HashStringValue;
1.64      paf        19: 
                     20: // replace system s*nprintf with our versions
1.69      paf        21: #undef vsnprintf 
1.89.2.7  paf        22: int __vsnprintf(char *, size_t, const char* , va_list);
1.64      paf        23: #define vsnprintf __vsnprintf 
                     24: #undef snprintf
1.89.2.7  paf        25: int __snprintf(char *, size_t, const char* , ...);
1.64      paf        26: #define snprintf __snprintf
1.63      paf        27: 
1.21      paf        28: #if _MSC_VER
1.56      paf        29: /*
1.89.2.7  paf        30: inline int open( const char* filename, int oflag ) { return _open(filename, oflag); }
1.56      paf        31: inline int close( int handle ) { return _close(handle); }
                     32: inline int read( int handle, void *buffer, unsigned int count ) { return _read(handle,buffer,count); }
                     33: inline int write( int handle, const void *buffer, unsigned int count ) { return _write(handle,buffer,count); }
1.89.2.7  paf        34: inline int stat( const char* path, struct _stat *buffer ) { return _stat(path, buffer); }
1.56      paf        35: inline long lseek( int handle, long offset, int origin ) { return _lseek(handle, offset, origin); }
                     36: */
1.17      paf        37: 
                     38: //access
                     39: #define F_OK 0
                     40: #define X_OK 1
                     41: #define W_OK 2
                     42: #define R_OK 4
                     43: 
1.20      paf        44: #ifndef strcasecmp
                     45: #      define strcasecmp _stricmp
                     46: #endif
                     47: #ifndef strncasecmp
                     48: #      define strncasecmp _strnicmp
                     49: #endif
                     50: #ifndef mkdir
                     51: #      define mkdir(path, mode) _mkdir(path)
                     52: #endif
1.17      paf        53: 
1.20      paf        54: #ifndef putenv
                     55: #      define putenv _putenv
1.1       paf        56: #endif
1.2       paf        57: 
1.17      paf        58: #endif
1.59      paf        59: 
1.61      paf        60: #ifdef HAVE_TRUNC
                     61: #      ifndef trunc
                     62: extern "C" double trunc(double);
                     63: #      endif
                     64: #else
1.59      paf        65: inline double trunc(double param) { return param > 0? floor(param) : ceil(param); }
                     66: #endif
1.61      paf        67: 
                     68: #ifdef HAVE_ROUND
                     69: #      ifndef round
                     70: extern "C" double round(double);
                     71: #      endif
                     72: #else
1.59      paf        73: inline double round(double param) { return floor(param+0.5); }
                     74: #endif
1.61      paf        75: #ifdef HAVE_SIGN
                     76: #      ifndef sign
                     77: extern "C" double sign(double);
                     78: #      endif
                     79: #else
1.59      paf        80: inline double sign(double param) { return param > 0 ? 1 : ( param < 0 ? -1 : 0 ); }
                     81: #endif
1.87      paf        82: 
1.72      paf        83: /// yields to OS for secs secs and usecs milliseconds
                     84: int pa_sleep(unsigned long secs, unsigned long usecs);
1.54      parser     85: 
                     86: /** under WIN32 "t" mode fixes DOS chars OK, 
                     87:        can't say that about other systems/ line break styles
                     88: */
1.57      paf        89: void fix_line_breaks(
1.62      paf        90:                                         char *buf,
                     91:                                         size_t& size ///< may change! used to speedup next actions
1.57      paf        92:                                         );
1.17      paf        93: 
1.89.2.4  paf        94: typedef void (*File_read_action)(Pool& pool,
1.84      paf        95:                                                                 struct stat& finfo,
1.83      paf        96:                                                                 int f, 
1.89.2.7  paf        97:                                                                 StringPtr file_spec, const char* fname, bool as_text,
1.83      paf        98:                                                                 void *context);
                     99: 
                    100: /**
                    101:        shared-lock specified file, 
                    102:        do actions under lock.
                    103:        if fail_on_read_problem is true[default] throws an exception
                    104:        
                    105:        @returns true if read OK
                    106: */
1.89.2.6  paf       107: bool file_read_action_under_lock(Pool& pool, StringPtr file_spec, 
1.89.2.7  paf       108:                                const char* action_name, File_read_action action, void *context,
1.83      paf       109:                                bool as_text=false,
                    110:                                bool fail_on_read_problem=true);
1.15      paf       111: /**
1.19      paf       112:        read specified text file using pool, 
1.15      paf       113:        if fail_on_read_problem is true[default] throws an exception
1.83      paf       114: 
1.89.2.8! paf       115:        WARNING: charset is used for http header case conversion, it's not a charset of input file!
        !           116: 
1.83      paf       117:        @returns true if read OK
1.15      paf       118: */
1.89.2.3  paf       119: char *file_read_text(Pool& pool, Charset& charset, 
1.89.2.6  paf       120:                                         StringPtr file_spec, 
1.85      paf       121:                                         bool fail_on_read_problem=true,
1.89.2.3  paf       122:                                         HashStringValue* options=0, HashStringValue** out_fields=0);
1.17      paf       123: 
1.89.2.4  paf       124: struct File_read_result {
                    125:        bool success;
                    126:        HashStringValuePtr fields;
                    127: };
                    128: 
1.17      paf       129: /**
1.29      paf       130:        read specified file using pool, 
                    131:        if fail_on_read_problem is true[default] throws an exception
1.89.2.8! paf       132: 
        !           133:        WARNING: charset is used for http header case conversion, it's not a charset of input file!
1.83      paf       134: 
                    135:        @returns true if read OK
1.29      paf       136: */
1.89.2.4  paf       137: File_read_result file_read(Pool& pool, Charset& charset, 
1.89.2.6  paf       138:                           StringPtr file_spec, 
1.89.2.4  paf       139:                           char *& ptr, size_t& size, 
1.29      paf       140:                           bool as_text,
1.89.2.3  paf       141:                           HashStringValue* options=0, HashStringValue** out_fields=0,
1.83      paf       142:                           bool fail_on_read_problem=true);
                    143: 
                    144: typedef void (*File_write_action)(int f, void *context);
1.29      paf       145: 
                    146: /**
1.71      paf       147:        lock specified file exclusively, 
                    148:        do actions under lock.
                    149:        throws an exception in case of problems
1.72      paf       150:        
                    151:        if block=false does non-blocking lock
                    152:        @returns true if locked OK, or false if non-blocking locking failed
1.71      paf       153: */
1.72      paf       154: bool file_write_action_under_lock(
1.89.2.6  paf       155:                                StringPtr file_spec, 
1.89.2.7  paf       156:                                const char* action_name, File_write_action action, void *context,
1.71      paf       157:                                bool as_text=false,
1.72      paf       158:                                bool do_append=false,
1.77      paf       159:                                bool do_block=true,
                    160:                                bool fail_on_lock_problem=true);
1.71      paf       161: 
                    162: /**
                    163:        write data to specified file, 
1.17      paf       164:        throws an exception in case of problems
                    165: */
1.70      paf       166: void file_write(
1.89.2.6  paf       167:                                StringPtr file_spec,
1.29      paf       168:                                const void *data, size_t size, 
1.58      paf       169:                                bool as_text,
1.67      paf       170:                                bool do_append=false);
1.26      paf       171: 
                    172: /**
                    173:        delete specified file 
                    174:        throws an exception in case of problems
                    175: */
1.89.2.6  paf       176: bool file_delete(StringPtr file_spec, bool fail_on_read_problem=true);
1.47      parser    177: /**
                    178:        move specified file 
                    179:        throws an exception in case of problems
                    180: */
1.89.2.6  paf       181: void file_move(StringPtr old_spec, StringPtr new_spec);
1.27      paf       182: 
1.89.2.7  paf       183: bool entry_exists(const char* fname, struct stat *afinfo=0);
1.89.2.6  paf       184: bool entry_exists(StringPtr file_spec);
                    185: bool file_readable(StringPtr file_spec);
                    186: bool dir_readable(StringPtr file_spec);
                    187: StringPtr file_readable(StringPtr path, StringPtr name);
                    188: bool file_executable(StringPtr file_spec);
1.37      paf       189: 
1.89.2.6  paf       190: bool file_stat(StringPtr file_spec, 
1.46      parser    191:                           size_t& rsize, 
                    192:                           time_t& ratime,
                    193:                           time_t& rmtime,
1.48      parser    194:                           time_t& rctime,
                    195:                           bool fail_on_read_problem=true);
1.15      paf       196: 
                    197: /**
1.18      paf       198:        scans for @a delim[default \n] in @a *row_ref, 
                    199:        @return piece of line before it or end of string, if no @a delim found
                    200:        assigns @a *row_ref to point right after delimiter if there were one
                    201:        or to zero if no @a delim were found.
1.15      paf       202: */
1.7       paf       203: char *getrow(char **row_ref,char delim='\n');
1.76      paf       204: char *lsplit(char *string, char delim);
1.7       paf       205: char *lsplit(char **string_ref,char delim);
1.8       paf       206: char *rsplit(char *string, char delim);
1.89.2.7  paf       207: const char* format(Pool& pool, double value, char *fmt);
1.10      paf       208: 
                    209: #ifndef max
1.75      paf       210: inline int max(int a, int b) { return a>b?a:b; }
                    211: inline int min(int a, int b){ return a<b?a:b; }
                    212: inline size_t max(size_t a, size_t b) { return a>b?a:b; }
                    213: inline size_t min(size_t a, size_t b){ return a<b?a:b; }
1.10      paf       214: #endif
                    215: 
1.30      paf       216: size_t stdout_write(const void *buf, size_t size);
1.14      paf       217: 
1.89.2.7  paf       218: char *unescape_chars(Pool& pool, const char* cp, int len);
1.23      paf       219: 
                    220: #ifdef WIN32
                    221: void back_slashes_to_slashes(char *s);
1.35      paf       222: //void slashes_to_back_slashes(char *s);
1.23      paf       223: #endif
                    224: 
1.28      paf       225: #ifndef _qsort
                    226: #      define _qsort(names,cnt,sizeof_names,func_addr) \
                    227:                qsort(names,cnt,sizeof_names,func_addr)
                    228: #endif
1.34      paf       229: 
1.89.2.7  paf       230: bool StrEqNc(const char* s1, const char* s2, bool strict=true);
1.45      parser    231: 
                    232: #define SECS_PER_DAY (60*60*24)
                    233: int getMonthDays(int year, int month);
1.52      parser    234: 
                    235: void remove_crlf(char *start, char *end);
1.1       paf       236: 
                    237: #endif

E-mail: