HPM Update

Made SQL and strlib functions HPM-friendly, special thanks to Yommy for bringing the issue up.
Added partial map.c support, for the all-handy map[] array, beware that soon the whole map.c renewal design will be commit and when that happens your usage of map.c functions in plugins might require some updates.

Signed-off-by: shennetsind <ind@henn.et>

1 files changed, 140 insertions, 104 deletions

diff --git a/src/common/strlib.h b/src/common/strlib.h
index bbc2c6105..af0fb2764 100644
--- a/src/common/strlib.h
+++ b/src/common/strlib.h
@@ -1,5 +1,6 @@
-// Copyright (c) Athena Dev Teams - Licensed under GNU GPL
-// For more information, see LICENCE in the main folder
+// Copyright (c) Hercules Dev Team, licensed under GNU GPL.
+// See the LICENSE file
+// Portions Copyright (c) Athena Dev Teams
 
 #ifndef _STRLIB_H_
 #define _STRLIB_H_
@@ -11,56 +12,14 @@
 #include <string.h>
 #undef __USE_GNU
 
-char* jstrescape (char* pt);
-char* jstrescapecpy (char* pt, const char* spt);
-int jmemescapecpy (char* pt, const char* spt, int size);
-
-int remove_control_chars(char* str);
-char* trim(char* str);
-char* normalize_name(char* str,const char* delims);
-const char *stristr(const char *haystack, const char *needle);
-
 #ifdef WIN32
-#define HAVE_STRTOK_R
-#define strtok_r(s,delim,save_ptr) _strtok_r((s),(delim),(save_ptr))
-char* _strtok_r(char* s1, const char* s2, char** lasts);
-#endif
-
-#if !(defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1400) && !defined(HAVE_STRNLEN)
-size_t strnlen (const char* string, size_t maxlen);
+	#define HAVE_STRTOK_R
+	#define strtok_r(s,delim,save_ptr) _strtok_r((s),(delim),(save_ptr))
+	char _strtok_r(char* s1, const char* s2, char** lasts);
 #endif
 
-#if defined(WIN32) && defined(_MSC_VER) && _MSC_VER <= 1200
-uint64 strtoull(const char* str, char** endptr, int base);
-#endif
-
-int e_mail_check(char* email);
-int config_switch(const char* str);
-
-/// strncpy that always nul-terminates the string
-char* safestrncpy(char* dst, const char* src, size_t n);
-
-/// doesn't crash on null pointer
-size_t safestrnlen(const char* string, size_t maxlen);
-
-/// Works like snprintf, but always nul-terminates the buffer.
-/// Returns the size of the string (without nul-terminator)
-/// or -1 if the buffer is too small.
-int safesnprintf(char* buf, size_t sz, const char* fmt, ...);
-
-/// Returns the line of the target position in the string.
-/// Lines start at 1.
-int strline(const char* str, size_t pos);
-
-/// Produces the hexadecimal representation of the given input.
-/// The output buffer must be at least count*2+1 in size.
-/// Returns true on success, false on failure.
-bool bin2hex(char* output, unsigned char* input, size_t count);
-
-
 /// Bitfield determining the behaviour of sv_parse and sv_split.
-typedef enum e_svopt
-{
+typedef enum e_svopt {
 	// default: no escapes and no line terminator
 	SV_NOESCAPE_NOTERMINATE = 0,
 	// Escapes according to the C compiler.
@@ -78,8 +37,7 @@ typedef enum e_svopt
 
 /// Parse state.
 /// The field is [start,end[
-struct s_svstate
-{
+struct s_svstate {
 	const char* str; //< string to parse
 	int len; //< string length
 	int off; //< current offset in the string
@@ -90,66 +48,144 @@ struct s_svstate
 	bool done; //< if all the text has been parsed
 };
 
-/// Parses a single field in a delim-separated string.
-/// The delimiter after the field is skipped.
-///
-/// @param sv Parse state
-/// @return 1 if a field was parsed, 0 if done, -1 on error.
-int sv_parse_next(struct s_svstate* sv);
-
-/// Parses a delim-separated string.
-/// Starts parsing at startoff and fills the pos array with position pairs.
-/// out_pos[0] and out_pos[1] are the start and end of line.
-/// Other position pairs are the start and end of fields.
-/// Returns the number of fields found or -1 if an error occurs.
-int sv_parse(const char* str, int len, int startoff, char delim, int* out_pos, int npos, enum e_svopt opt);
-
-/// Splits a delim-separated string.
-/// WARNING: this function modifies the input string
-/// Starts splitting at startoff and fills the out_fields array.
-/// out_fields[0] is the start of the next line.
-/// Other entries are the start of fields (nul-teminated).
-/// Returns the number of fields found or -1 if an error occurs.
-int sv_split(char* str, int len, int startoff, char delim, char** out_fields, int nfields, enum e_svopt opt);
-
-/// Escapes src to out_dest according to the format of the C compiler.
-/// Returns the length of the escaped string.
-/// out_dest should be len*4+1 in size.
-size_t sv_escape_c(char* out_dest, const char* src, size_t len, const char* escapes);
-
-/// Unescapes src to out_dest according to the format of the C compiler.
-/// Returns the length of the unescaped string.
-/// out_dest should be len+1 in size and can be the same buffer as src.
-size_t sv_unescape_c(char* out_dest, const char* src, size_t len);
-
-/// Skips a C escape sequence (starting with '\\').
-const char* skip_escaped_c(const char* p);
-
-/// Opens and parses a file containing delim-separated columns, feeding them to the specified callback function row by row.
-/// Tracks the progress of the operation (current line number, number of successfully processed rows).
-/// Returns 'true' if it was able to process the specified file, or 'false' if it could not be read.
-bool sv_readdb(const char* directory, const char* filename, char delim, int mincols, int maxcols, int maxrows, bool (*parseproc)(char* fields[], int columns, int current));
-
 
 /// StringBuf - dynamic string
-struct StringBuf
-{
+struct StringBuf {
 	char *buf_;
 	char *ptr_;
 	unsigned int max_;
 };
 typedef struct StringBuf StringBuf;
 
-StringBuf* StringBuf_Malloc(void);
-void StringBuf_Init(StringBuf* self);
-int StringBuf_Printf(StringBuf* self, const char* fmt, ...);
-int StringBuf_Vprintf(StringBuf* self, const char* fmt, va_list args);
-int StringBuf_Append(StringBuf* self, const StringBuf *sbuf);
-int StringBuf_AppendStr(StringBuf* self, const char* str);
-int StringBuf_Length(StringBuf* self);
-char* StringBuf_Value(StringBuf* self);
-void StringBuf_Clear(StringBuf* self);
-void StringBuf_Destroy(StringBuf* self);
-void StringBuf_Free(StringBuf* self);
-
+struct strlib_interface {
+	char *(*jstrescape) (char* pt);
+	char *(*jstrescapecpy) (char* pt, const char* spt);
+	int (*jmemescapecpy) (char* pt, const char* spt, int size);
+	int (*remove_control_chars) (char* str);
+	char *(*trim) (char* str);
+	char *(*normalize_name) (char* str,const char* delims);
+	const char *(*stristr) (const char *haystack, const char *needle);
+		
+#if !(defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1400) && !defined(HAVE_STRNLEN)
+	size_t (*strnlen) (const char* string, size_t maxlen);
+#endif
+	
+#if defined(WIN32) && defined(_MSC_VER) && _MSC_VER <= 1200
+	uint64 (*strtoull) (const char* str, char** endptr, int base);
+#endif
+	
+	int (*e_mail_check) (char* email);
+	int (*config_switch) (const char* str);
+	
+	/// strncpy that always nul-terminates the string
+	char *(*safestrncpy) (char* dst, const char* src, size_t n);
+	
+	/// doesn't crash on null pointer
+	size_t (*safestrnlen) (const char* string, size_t maxlen);
+	
+	/// Works like snprintf, but always nul-terminates the buffer.
+	/// Returns the size of the string (without nul-terminator)
+	/// or -1 if the buffer is too small.
+	int (*safesnprintf) (char* buf, size_t sz, const char* fmt, ...);
+	
+	/// Returns the line of the target position in the string.
+	/// Lines start at 1.
+	int (*strline) (const char* str, size_t pos);
+	
+	/// Produces the hexadecimal representation of the given input.
+	/// The output buffer must be at least count*2+1 in size.
+	/// Returns true on success, false on failure.
+	bool (*bin2hex) (char* output, unsigned char* input, size_t count);
+} strlib_s;
+
+struct strlib_interface *strlib;
+
+struct stringbuf_interface {
+	StringBuf* (*Malloc) (void);
+	void (*Init) (StringBuf* self);
+	int (*Printf) (StringBuf* self, const char* fmt, ...);
+	int (*Vprintf) (StringBuf* self, const char* fmt, va_list args);
+	int (*Append) (StringBuf* self, const StringBuf *sbuf);
+	int (*AppendStr) (StringBuf* self, const char* str);
+	int (*Length) (StringBuf* self);
+	char* (*Value) (StringBuf* self);
+	void (*Clear) (StringBuf* self);
+	void (*Destroy) (StringBuf* self);
+	void (*Free) (StringBuf* self);
+} stringbuf_s;
+
+struct stringbuf_interface *StrBuf;
+
+struct sv_interface {
+	/// Parses a single field in a delim-separated string.
+	/// The delimiter after the field is skipped.
+	///
+	/// @param sv Parse state
+	/// @return 1 if a field was parsed, 0 if done, -1 on error.
+	int (*parse_next) (struct s_svstate* sv);
+	
+	/// Parses a delim-separated string.
+	/// Starts parsing at startoff and fills the pos array with position pairs.
+	/// out_pos[0] and out_pos[1] are the start and end of line.
+	/// Other position pairs are the start and end of fields.
+	/// Returns the number of fields found or -1 if an error occurs.
+	int (*parse) (const char* str, int len, int startoff, char delim, int* out_pos, int npos, enum e_svopt opt);
+	
+	/// Splits a delim-separated string.
+	/// WARNING: this function modifies the input string
+	/// Starts splitting at startoff and fills the out_fields array.
+	/// out_fields[0] is the start of the next line.
+	/// Other entries are the start of fields (nul-teminated).
+	/// Returns the number of fields found or -1 if an error occurs.
+	int (*split) (char* str, int len, int startoff, char delim, char** out_fields, int nfields, enum e_svopt opt);
+	
+	/// Escapes src to out_dest according to the format of the C compiler.
+	/// Returns the length of the escaped string.
+	/// out_dest should be len*4+1 in size.
+	size_t (*escape_c) (char* out_dest, const char* src, size_t len, const char* escapes);
+	
+	/// Unescapes src to out_dest according to the format of the C compiler.
+	/// Returns the length of the unescaped string.
+	/// out_dest should be len+1 in size and can be the same buffer as src.
+	size_t (*unescape_c) (char* out_dest, const char* src, size_t len);
+	
+	/// Skips a C escape sequence (starting with '\\').
+	const char* (*skip_escaped_c) (const char* p);
+	
+	/// Opens and parses a file containing delim-separated columns, feeding them to the specified callback function row by row.
+	/// Tracks the progress of the operation (current line number, number of successfully processed rows).
+	/// Returns 'true' if it was able to process the specified file, or 'false' if it could not be read.
+	bool (*readdb) (const char* directory, const char* filename, char delim, int mincols, int maxcols, int maxrows, bool (*parseproc)(char* fields[], int columns, int current));
+} sv_s;
+
+struct sv_interface *sv;
+
+void strlib_defaults(void);
+
+/* the purpose of these macros is simply to not make calling them be an annoyance */
+#ifndef STRLIB_C
+	#define jstrescape(pt) strlib->jstrescape(pt)
+	#define jstrescapecpy(pt,spt) strlib->jstrescapecpy(pt,spt)
+	#define jmemescapecpy(pt,spt,size) strlib->jmemescapecpy(pt,spt,size)
+	#define remove_control_chars(str) strlib->remove_control_chars(str)
+	#define trim(str) strlib->trim(str)
+	#define normalize_name(str,delims) strlib->normalize_name(str,delims)
+	#define stristr(haystack,needle) strlib->stristr(haystack,needle)
+
+	#if !(defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1400) && !defined(HAVE_STRNLEN)
+		#define strnln(string,maxlen) strlib->strnlen(string,maxlen)
+	#endif
+
+	#if defined(WIN32) && defined(_MSC_VER) && _MSC_VER <= 1200
+		#define strtoull(str,endptr,base) strlib->strtoull(str,endptr,base)
+	#endif
+
+	#define e_mail_check(email) strlib->e_mail_check(email)
+	#define config_switch(str) strlib->config_switch(str)
+	#define safestrncpy(dst,src,n) strlib->safestrncpy(dst,src,n)
+	#define safestrnlen(string,maxlen) strlib->safestrnlen(string,maxlen)
+	#define safesnprintf(buf,sz,fmt,...) strlib->safesnprintf(buf,sz,fmt,##__VA_ARGS__)
+	#define strline(str,pos) strlib->strline(str,pos)
+	#define bin2hex(output,input,count) strlib->bin2hex(output,input,count)
+#endif /* STRLIB_C */
 #endif /* _STRLIB_H_ */