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

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

E-mail: