Annotation of parser3/src/include/pa_common.h, revision 1.89.2.5
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.89.2.5! paf 11: static const char* IDENT_COMMON_H="$Date: 2003/01/27 15:07:47 $";
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.3 paf 18: typedef Hash<ConstStringPtr, ValuePtr> HashStringValue;
1.64 paf 19:
20: // replace system s*nprintf with our versions
1.69 paf 21: #undef vsnprintf
1.63 paf 22: int __vsnprintf(char *, size_t, const char *, va_list);
1.64 paf 23: #define vsnprintf __vsnprintf
24: #undef snprintf
1.63 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: /*
30: inline int open( const char *filename, int oflag ) { return _open(filename, oflag); }
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); }
34: inline int stat( const char *path, struct _stat *buffer ) { return _stat(path, buffer); }
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.4 paf 97: ConstStringPtr 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.4 paf 107: bool file_read_action_under_lock(Pool& pool, ConstStringPtr file_spec,
1.83 paf 108: const char *action_name, File_read_action action, void *context,
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:
115: @returns true if read OK
1.15 paf 116: */
1.89.2.3 paf 117: char *file_read_text(Pool& pool, Charset& charset,
1.89.2.1 paf 118: ConstStringPtr file_spec,
1.85 paf 119: bool fail_on_read_problem=true,
1.89.2.3 paf 120: HashStringValue* options=0, HashStringValue** out_fields=0);
1.17 paf 121:
1.89.2.4 paf 122: struct File_read_result {
123: bool success;
124: HashStringValuePtr fields;
125: };
126:
1.17 paf 127: /**
1.29 paf 128: read specified file using pool,
129: if fail_on_read_problem is true[default] throws an exception
1.83 paf 130:
131: @returns true if read OK
1.29 paf 132: */
1.89.2.4 paf 133: File_read_result file_read(Pool& pool, Charset& charset,
1.89.2.1 paf 134: ConstStringPtr file_spec,
1.89.2.4 paf 135: char *& ptr, size_t& size,
1.29 paf 136: bool as_text,
1.89.2.3 paf 137: HashStringValue* options=0, HashStringValue** out_fields=0,
1.83 paf 138: bool fail_on_read_problem=true);
139:
140: typedef void (*File_write_action)(int f, void *context);
1.29 paf 141:
142: /**
1.71 paf 143: lock specified file exclusively,
144: do actions under lock.
145: throws an exception in case of problems
1.72 paf 146:
147: if block=false does non-blocking lock
148: @returns true if locked OK, or false if non-blocking locking failed
1.71 paf 149: */
1.72 paf 150: bool file_write_action_under_lock(
1.89.2.1 paf 151: ConstStringPtr file_spec,
1.83 paf 152: const char *action_name, File_write_action action, void *context,
1.71 paf 153: bool as_text=false,
1.72 paf 154: bool do_append=false,
1.77 paf 155: bool do_block=true,
156: bool fail_on_lock_problem=true);
1.71 paf 157:
158: /**
159: write data to specified file,
1.17 paf 160: throws an exception in case of problems
161: */
1.70 paf 162: void file_write(
1.89.2.1 paf 163: ConstStringPtr file_spec,
1.29 paf 164: const void *data, size_t size,
1.58 paf 165: bool as_text,
1.67 paf 166: bool do_append=false);
1.26 paf 167:
168: /**
169: delete specified file
170: throws an exception in case of problems
171: */
1.89.2.1 paf 172: bool file_delete(ConstStringPtr file_spec, bool fail_on_read_problem=true);
1.47 parser 173: /**
174: move specified file
175: throws an exception in case of problems
176: */
1.89.2.1 paf 177: void file_move(ConstStringPtr old_spec, ConstStringPtr new_spec);
1.27 paf 178:
1.81 paf 179: bool entry_exists(const char *fname, struct stat *afinfo=0);
1.89.2.1 paf 180: bool entry_exists(ConstStringPtr file_spec);
181: bool file_readable(ConstStringPtr file_spec);
182: bool dir_readable(ConstStringPtr file_spec);
1.89.2.4 paf 183: ConstStringPtr file_readable(ConstStringPtr path, ConstStringPtr name);
1.89.2.1 paf 184: bool file_executable(ConstStringPtr file_spec);
1.37 paf 185:
1.89.2.1 paf 186: bool file_stat(ConstStringPtr file_spec,
1.46 parser 187: size_t& rsize,
188: time_t& ratime,
189: time_t& rmtime,
1.48 parser 190: time_t& rctime,
191: bool fail_on_read_problem=true);
1.15 paf 192:
193: /**
1.18 paf 194: scans for @a delim[default \n] in @a *row_ref,
195: @return piece of line before it or end of string, if no @a delim found
196: assigns @a *row_ref to point right after delimiter if there were one
197: or to zero if no @a delim were found.
1.15 paf 198: */
1.7 paf 199: char *getrow(char **row_ref,char delim='\n');
1.76 paf 200: char *lsplit(char *string, char delim);
1.7 paf 201: char *lsplit(char **string_ref,char delim);
1.8 paf 202: char *rsplit(char *string, char delim);
1.89.2.4 paf 203: const char *format(Pool& pool, double value, char *fmt);
1.10 paf 204:
205: #ifndef max
1.75 paf 206: inline int max(int a, int b) { return a>b?a:b; }
207: inline int min(int a, int b){ return a<b?a:b; }
208: inline size_t max(size_t a, size_t b) { return a>b?a:b; }
209: inline size_t min(size_t a, size_t b){ return a<b?a:b; }
1.10 paf 210: #endif
211:
1.30 paf 212: size_t stdout_write(const void *buf, size_t size);
1.14 paf 213:
1.89.2.5! paf 214: char *unescape_chars(Pool& pool, const char *cp, int len);
1.23 paf 215:
216: #ifdef WIN32
217: void back_slashes_to_slashes(char *s);
1.35 paf 218: //void slashes_to_back_slashes(char *s);
1.23 paf 219: #endif
220:
1.28 paf 221: #ifndef _qsort
222: # define _qsort(names,cnt,sizeof_names,func_addr) \
223: qsort(names,cnt,sizeof_names,func_addr)
224: #endif
1.34 paf 225:
1.40 paf 226: bool StrEqNc(const char *s1, const char *s2, bool strict=true);
1.45 parser 227:
228: #define SECS_PER_DAY (60*60*24)
229: int getMonthDays(int year, int month);
1.52 parser 230:
231: void remove_crlf(char *start, char *end);
1.1 paf 232:
233: #endif
E-mail:
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to pa_common.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [parser3project] / parser3 / src / include