Return to pa_common.h CVS log

Up to [parser3project] / parser3 / src / include

table/xdoc/file::load now understand http:// prefix and additional params, sample:
$rates[^xdoc::load[http://www.cbr.ru/scripts/XML_daily.asp?date_req=02/03/2002;
   $.USER-AGENT[parser3]
]]

/** @file
	Parser: commonly used functions.

	Copyright (c) 2001, 2002 ArtLebedev Group (http://www.artlebedev.com)
	Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
*/

#ifndef PA_COMMON_H
#define PA_COMMON_H

static const char* IDENT_COMMON_H="$Date: 2002/11/25 14:10:52 $";

#include "pa_pool.h"
#include "pa_string.h"

class Hash;

// replace system s*nprintf with our versions
#undef vsnprintf 
int __vsnprintf(char *, size_t, const char *, va_list);
#define vsnprintf __vsnprintf 
#undef snprintf
int __snprintf(char *, size_t, const char *, ...);
#define snprintf __snprintf

#if _MSC_VER
/*
inline int open( const char *filename, int oflag ) { return _open(filename, oflag); }
inline int close( int handle ) { return _close(handle); }
inline int read( int handle, void *buffer, unsigned int count ) { return _read(handle,buffer,count); }
inline int write( int handle, const void *buffer, unsigned int count ) { return _write(handle,buffer,count); }
inline int stat( const char *path, struct _stat *buffer ) { return _stat(path, buffer); }
inline long lseek( int handle, long offset, int origin ) { return _lseek(handle, offset, origin); }
*/

//access
#define F_OK 0
#define X_OK 1
#define W_OK 2
#define R_OK 4

#ifndef strcasecmp
#	define strcasecmp _stricmp
#endif
#ifndef strncasecmp
#	define strncasecmp _strnicmp
#endif
#ifndef mkdir
#	define mkdir(path, mode) _mkdir(path)
#endif

#ifndef putenv
#	define putenv _putenv
#endif

#endif

#ifdef HAVE_TRUNC
#	ifndef trunc
extern "C" double trunc(double);
#	endif
#else
inline double trunc(double param) { return param > 0? floor(param) : ceil(param); }
#endif

#ifdef HAVE_ROUND
#	ifndef round
extern "C" double round(double);
#	endif
#else
inline double round(double param) { return floor(param+0.5); }
#endif
#ifdef HAVE_SIGN
#	ifndef sign
extern "C" double sign(double);
#	endif
#else
inline double sign(double param) { return param > 0 ? 1 : ( param < 0 ? -1 : 0 ); }
#endif

/// yields to OS for secs secs and usecs milliseconds
int pa_sleep(unsigned long secs, unsigned long usecs);

/** under WIN32 "t" mode fixes DOS chars OK, 
	can't say that about other systems/ line break styles
*/
void fix_line_breaks(
					 char *buf,
					 size_t& size ///< may change! used to speedup next actions
					 );

typedef void (*File_read_action)(Pool& pool,
								 struct stat& finfo,
								 int f, 
								 const String& file_spec, const char *fname, bool as_text,
								 void *context);

/**
	shared-lock specified file, 
	do actions under lock.
	if fail_on_read_problem is true[default] throws an exception
	
	@returns true if read OK
*/
bool file_read_action_under_lock(Pool& pool, const String& file_spec, 
				const char *action_name, File_read_action action, void *context,
				bool as_text=false,
				bool fail_on_read_problem=true);
/**
	read specified text file using pool, 
	if fail_on_read_problem is true[default] throws an exception

  	@returns true if read OK
*/
char *file_read_text(Pool& pool, 
					 const String& file_spec, 
					 bool fail_on_read_problem=true,
					 Hash *params=0, Hash** out_fields=0);

/**
	read specified file using pool, 
	if fail_on_read_problem is true[default] throws an exception

	@returns true if read OK
*/
bool file_read(Pool& pool, const String& file_spec, 
			   void*& data, size_t& size, 
			   bool as_text,
			   Hash *params=0, Hash** out_fields=0,
			   bool fail_on_read_problem=true);

typedef void (*File_write_action)(int f, void *context);

/**
	lock specified file exclusively, 
	do actions under lock.
	throws an exception in case of problems
	
	if block=false does non-blocking lock
	@returns true if locked OK, or false if non-blocking locking failed
*/
bool file_write_action_under_lock(
				const String& file_spec, 
				const char *action_name, File_write_action action, void *context,
				bool as_text=false,
				bool do_append=false,
				bool do_block=true,
				bool fail_on_lock_problem=true);

/**
	write data to specified file, 
	throws an exception in case of problems
*/
void file_write(
				const String& file_spec,
				const void *data, size_t size, 
				bool as_text,
				bool do_append=false);

/**
	delete specified file 
	throws an exception in case of problems
*/
bool file_delete(const String& file_spec, bool fail_on_read_problem=true);
/**
	move specified file 
	throws an exception in case of problems
*/
void file_move(const String& old_spec, const String& new_spec);

bool entry_exists(const char *fname, struct stat *afinfo=0);
bool entry_exists(const String& file_spec);
bool file_readable(const String& file_spec);
bool dir_readable(const String& file_spec);
String *file_readable(const String& path, const String& name);
bool file_executable(const String& file_spec);

bool file_stat(const String& file_spec, 
			   size_t& rsize, 
			   time_t& ratime,
			   time_t& rmtime,
			   time_t& rctime,
			   bool fail_on_read_problem=true);

/**
	scans for @a delim[default \n] in @a *row_ref, 
	@return piece of line before it or end of string, if no @a delim found
	assigns @a *row_ref to point right after delimiter if there were one
	or to zero if no @a delim were found.
*/
char *getrow(char **row_ref,char delim='\n');
char *lsplit(char *string, char delim);
char *lsplit(char **string_ref,char delim);
char *rsplit(char *string, char delim);
char *format(Pool& pool, double value, char *fmt);

#ifndef max
inline int max(int a, int b) { return a>b?a:b; }
inline int min(int a, int b){ return a<b?a:b; }
inline size_t max(size_t a, size_t b) { return a>b?a:b; }
inline size_t min(size_t a, size_t b){ return a<b?a:b; }
#endif

size_t stdout_write(const void *buf, size_t size);

char *unescape_chars(Pool& pool, const char *cp, int len);

#ifdef WIN32
void back_slashes_to_slashes(char *s);
//void slashes_to_back_slashes(char *s);
#endif

#ifndef _qsort
#	define _qsort(names,cnt,sizeof_names,func_addr) \
		qsort(names,cnt,sizeof_names,func_addr)
#endif

bool StrEqNc(const char *s1, const char *s2, bool strict=true);

#define SECS_PER_DAY (60*60*24)
int getMonthDays(int year, int month);

void remove_crlf(char *start, char *end);

#endif