gwenhywfar  5.11.1beta
Macros | Typedefs | Functions
text.h File Reference
#include <gwenhywfar/gwenhywfarapi.h>
#include <gwenhywfar/types.h>
#include <gwenhywfar/logger.h>
#include <gwenhywfar/buffer.h>
#include <stdio.h>

Go to the source code of this file.

Macros

#define GWEN_TEXT_FLAGS_CHECK_BACKSLASH   0x00000040
 
#define GWEN_TEXT_FLAGS_DEL_LEADING_BLANKS   0x00000001
 
#define GWEN_TEXT_FLAGS_DEL_MULTIPLE_BLANKS   0x00000004
 
#define GWEN_TEXT_FLAGS_DEL_QUOTES   0x00000020
 
#define GWEN_TEXT_FLAGS_DEL_TRAILING_BLANKS   0x00000002
 
#define GWEN_TEXT_FLAGS_NEED_DELIMITER   0x00000008
 
#define GWEN_TEXT_FLAGS_NULL_IS_DELIMITER   0x00000010
 
#define GWEN_TEXT_FUZZY_SHIFT   10
 

Typedefs

typedef int GWENHYWFAR_CB(* GWEN_TEXT_REPLACE_VARS_CB) (void *cbPtr, const char *name, int index, int maxLen, GWEN_BUFFER *dstBuf)
 

Functions

GWENHYWFAR_API double GWEN_Text_CheckSimilarity (const char *s1, const char *s2, int ign)
 
GWENHYWFAR_API int GWEN_Text_Compare (const char *s1, const char *s2, int ign)
 
GWENHYWFAR_API int GWEN_Text_ComparePattern (const char *w, const char *p, int sensecase)
 
GWENHYWFAR_API void GWEN_Text_CondenseBuffer (GWEN_BUFFER *buf)
 
GWENHYWFAR_API int GWEN_Text_ConvertCharset (const char *fromCharset, const char *toCharset, const char *text, int len, GWEN_BUFFER *tbuf)
 
GWENHYWFAR_API int GWEN_Text_CountUtf8Chars (const char *s, int len)
 
GWENHYWFAR_API int GWEN_Text_DoubleToBuffer (double num, GWEN_BUFFER *buf)
 
GWENHYWFAR_API void GWEN_Text_DumpString (const char *s, unsigned int l, unsigned int insert)
 
GWENHYWFAR_API void GWEN_Text_DumpString2Buffer (const char *s, unsigned int l, GWEN_BUFFER *mbuf, unsigned int insert)
 
GWENHYWFAR_API char * GWEN_Text_Escape (const char *src, char *buffer, unsigned int maxsize)
 
GWENHYWFAR_API int GWEN_Text_EscapeToBuffer (const char *src, GWEN_BUFFER *buf)
 
GWENHYWFAR_API int GWEN_Text_EscapeToBufferTolerant (const char *src, GWEN_BUFFER *buf)
 
GWENHYWFAR_API int GWEN_Text_EscapeToBufferTolerant2 (GWEN_BUFFER *src, GWEN_BUFFER *buf)
 
GWENHYWFAR_API char * GWEN_Text_EscapeTolerant (const char *src, char *buffer, unsigned int maxsize)
 
GWENHYWFAR_API int GWEN_Text_EscapeXmlToBuffer (const char *src, GWEN_BUFFER *buf)
 
GWENHYWFAR_API int GWEN_Text_FromBcdBuffer (const char *src, GWEN_BUFFER *buf)
 
GWENHYWFAR_API int GWEN_Text_FromHex (const char *src, char *buffer, unsigned maxsize)
 
GWENHYWFAR_API int GWEN_Text_FromHexBuffer (const char *src, GWEN_BUFFER *buf)
 
GWENHYWFAR_API char * GWEN_Text_GetWord (const char *src, const char *delims, char *buffer, unsigned int maxsize, uint32_t flags, const char **next)
 
GWENHYWFAR_API int GWEN_Text_GetWordToBuffer (const char *src, const char *delims, GWEN_BUFFER *buf, uint32_t flags, const char **next)
 
GWENHYWFAR_API void GWEN_Text_LogString (const char *s, unsigned int l, const char *logDomain, GWEN_LOGGER_LEVEL lv)
 
GWENHYWFAR_API int GWEN_Text_NumToString (int num, char *buffer, unsigned int bufsize, int fillchar)
 
GWENHYWFAR_API int GWEN_Text_ReplaceVars (const char *s, GWEN_BUFFER *dbuf, GWEN_TEXT_REPLACE_VARS_CB fn, void *ptr)
 
GWENHYWFAR_API const char * GWEN_Text_StrCaseStr (const char *haystack, const char *needle)
 
GWENHYWFAR_API int GWEN_Text_StringToDouble (const char *s, double *num)
 
GWENHYWFAR_API char * GWEN_Text_strndup (const char *s, size_t n)
 
GWENHYWFAR_API int GWEN_Text_ToBcdBuffer (const char *src, unsigned l, GWEN_BUFFER *buf, unsigned int groupsize, char delimiter, int skipLeadingZeroes)
 
GWENHYWFAR_API char * GWEN_Text_ToHex (const char *src, unsigned l, char *buffer, unsigned int maxsize)
 
GWENHYWFAR_API int GWEN_Text_ToHexBuffer (const char *src, unsigned l, GWEN_BUFFER *buf, unsigned int groupsize, char delimiter, int skipLeadingZeroes)
 
GWENHYWFAR_API char * GWEN_Text_ToHexGrouped (const char *src, unsigned l, char *buffer, unsigned maxsize, unsigned int groupsize, char delimiter, int skipLeadingZeros)
 
GWENHYWFAR_API char * GWEN_Text_Unescape (const char *src, char *buffer, unsigned int maxsize)
 
GWENHYWFAR_API char * GWEN_Text_UnescapeN (const char *src, unsigned int srclen, char *buffer, unsigned int maxsize)
 
GWENHYWFAR_API int GWEN_Text_UnescapeToBuffer (const char *src, GWEN_BUFFER *buf)
 
GWENHYWFAR_API int GWEN_Text_UnescapeToBufferTolerant (const char *src, GWEN_BUFFER *buf)
 
GWENHYWFAR_API char * GWEN_Text_UnescapeTolerant (const char *src, char *buffer, unsigned int maxsize)
 
GWENHYWFAR_API char * GWEN_Text_UnescapeTolerantN (const char *src, unsigned int srclen, char *buffer, unsigned int maxsize)
 
GWENHYWFAR_API int GWEN_Text_UnescapeXmlToBuffer (const char *src, GWEN_BUFFER *buf)
 

Macro Definition Documentation

◆ GWEN_TEXT_FLAGS_CHECK_BACKSLASH

#define GWEN_TEXT_FLAGS_CHECK_BACKSLASH   0x00000040

Definition at line 50 of file text.h.

◆ GWEN_TEXT_FLAGS_DEL_LEADING_BLANKS

#define GWEN_TEXT_FLAGS_DEL_LEADING_BLANKS   0x00000001

Definition at line 44 of file text.h.

◆ GWEN_TEXT_FLAGS_DEL_MULTIPLE_BLANKS

#define GWEN_TEXT_FLAGS_DEL_MULTIPLE_BLANKS   0x00000004

Definition at line 46 of file text.h.

◆ GWEN_TEXT_FLAGS_DEL_QUOTES

#define GWEN_TEXT_FLAGS_DEL_QUOTES   0x00000020

Definition at line 49 of file text.h.

◆ GWEN_TEXT_FLAGS_DEL_TRAILING_BLANKS

#define GWEN_TEXT_FLAGS_DEL_TRAILING_BLANKS   0x00000002

Definition at line 45 of file text.h.

◆ GWEN_TEXT_FLAGS_NEED_DELIMITER

#define GWEN_TEXT_FLAGS_NEED_DELIMITER   0x00000008

Definition at line 47 of file text.h.

◆ GWEN_TEXT_FLAGS_NULL_IS_DELIMITER

#define GWEN_TEXT_FLAGS_NULL_IS_DELIMITER   0x00000010

Definition at line 48 of file text.h.

◆ GWEN_TEXT_FUZZY_SHIFT

#define GWEN_TEXT_FUZZY_SHIFT   10

Definition at line 41 of file text.h.

Typedef Documentation

◆ GWEN_TEXT_REPLACE_VARS_CB

typedef int GWENHYWFAR_CB(* GWEN_TEXT_REPLACE_VARS_CB) (void *cbPtr, const char *name, int index, int maxLen, GWEN_BUFFER *dstBuf)

Definition at line 368 of file text.h.

Function Documentation

◆ GWEN_Text_CheckSimilarity()

GWENHYWFAR_API double GWEN_Text_CheckSimilarity ( const char *  s1,
const char *  s2,
int  ign 
)

Compares two strings and returns the percentage of their equality. It is calculated by this formula: matches*100 / ((length of s1)+(length of s2)) Each match is weight like this:

  • *s1==*s2: 2
  • toupper(*s1)==toupper(*s2): 2 if ign, 1 otherwise
  • isalnum(*s1)==isalnum(*s2): 1
Returns
percentage of equality between both strings
Parameters
s11st of two strings to compare
s22nd of two strings to compare
ignif !=0 then the cases are ignored

◆ GWEN_Text_Compare()

GWENHYWFAR_API int GWEN_Text_Compare ( const char *  s1,
const char *  s2,
int  ign 
)

Compares two strings. If either of them is given but empty, that string will be treaten as not given. This way a string NOT given equals a string which is given but empty.

Parameters
ignset to !=0 to ignore cases

◆ GWEN_Text_ComparePattern()

GWENHYWFAR_API int GWEN_Text_ComparePattern ( const char *  w,
const char *  p,
int  sensecase 
)

This function compares two string and returns the number of matches or -1 on error.

Parameters
wstring to compare
ppattern to compare against
sensecaseif 0 then cases are ignored

◆ GWEN_Text_CondenseBuffer()

GWENHYWFAR_API void GWEN_Text_CondenseBuffer ( GWEN_BUFFER buf)

Condenses a buffer containing chars. This means removing unnecessary spaces.

◆ GWEN_Text_ConvertCharset()

GWENHYWFAR_API int GWEN_Text_ConvertCharset ( const char *  fromCharset,
const char *  toCharset,
const char *  text,
int  len,
GWEN_BUFFER tbuf 
)

This function converts a given text from one charset to another one. Currently, iconv is used for this conversion.

Parameters
fromCharsetcharset of the source text
toCharsetcharset of the source text
texttext to convert
lenlength of the text (excluding trailing 0)
tbufdestination buffer for the converted text

◆ GWEN_Text_CountUtf8Chars()

GWENHYWFAR_API int GWEN_Text_CountUtf8Chars ( const char *  s,
int  len 
)

This function counts the number of characters in the given UTF-8 buffer.

Parameters
spointer to a buffer which contains UTF-8 characters
lennumber of bytes (if 0 then all bytes up to a zero byte are counted)

◆ GWEN_Text_DoubleToBuffer()

GWENHYWFAR_API int GWEN_Text_DoubleToBuffer ( double  num,
GWEN_BUFFER buf 
)

This functions transforms a string into a double float value. It always uses a decimal point (".") regardless of the current locale settings. This makes sure that a value can always be parsed regardless of the country settings of the producer of that string.

◆ GWEN_Text_DumpString()

GWENHYWFAR_API void GWEN_Text_DumpString ( const char *  s,
unsigned int  l,
unsigned int  insert 
)

This is used for debugging purposes and it shows the given data as a classical hexdump.

◆ GWEN_Text_DumpString2Buffer()

GWENHYWFAR_API void GWEN_Text_DumpString2Buffer ( const char *  s,
unsigned int  l,
GWEN_BUFFER mbuf,
unsigned int  insert 
)

◆ GWEN_Text_Escape()

GWENHYWFAR_API char* GWEN_Text_Escape ( const char *  src,
char *  buffer,
unsigned int  maxsize 
)

This function does escaping like it is used for HTTP URL encoding. All characters which are not alphanumeric are escaped by XX where XX ist the hexadecimal code of the character.

◆ GWEN_Text_EscapeToBuffer()

GWENHYWFAR_API int GWEN_Text_EscapeToBuffer ( const char *  src,
GWEN_BUFFER buf 
)

◆ GWEN_Text_EscapeToBufferTolerant()

GWENHYWFAR_API int GWEN_Text_EscapeToBufferTolerant ( const char *  src,
GWEN_BUFFER buf 
)

Does the same as GWEN_Text_EscapeToBuffer does, but this version here does not escape some characters generally accepted within strings (such as space, comma, decimal point etc).

◆ GWEN_Text_EscapeToBufferTolerant2()

GWENHYWFAR_API int GWEN_Text_EscapeToBufferTolerant2 ( GWEN_BUFFER src,
GWEN_BUFFER buf 
)

◆ GWEN_Text_EscapeTolerant()

GWENHYWFAR_API char* GWEN_Text_EscapeTolerant ( const char *  src,
char *  buffer,
unsigned int  maxsize 
)

◆ GWEN_Text_EscapeXmlToBuffer()

GWENHYWFAR_API int GWEN_Text_EscapeXmlToBuffer ( const char *  src,
GWEN_BUFFER buf 
)

Replaces special characters which are used by XML (like "<", "&" etc) by known sequences (like "&amp;").

◆ GWEN_Text_FromBcdBuffer()

GWENHYWFAR_API int GWEN_Text_FromBcdBuffer ( const char *  src,
GWEN_BUFFER buf 
)

Reads bcd bytes and stores them in the given buffer.

◆ GWEN_Text_FromHex()

GWENHYWFAR_API int GWEN_Text_FromHex ( const char *  src,
char *  buffer,
unsigned  maxsize 
)

◆ GWEN_Text_FromHexBuffer()

GWENHYWFAR_API int GWEN_Text_FromHexBuffer ( const char *  src,
GWEN_BUFFER buf 
)

Reads hex bytes and stores them in the given buffer.

◆ GWEN_Text_GetWord()

GWENHYWFAR_API char* GWEN_Text_GetWord ( const char *  src,
const char *  delims,
char *  buffer,
unsigned int  maxsize,
uint32_t  flags,
const char **  next 
)

This function cuts out a word from a given string.

Returns
address of the new word, 0 on error
Parameters
srcpointer to the beginning of the source string
delimspointer to a string containing all delimiters
bufferpointer to the destination buffer
maxsizelength of the buffer. Actually up to this number of characters are copied to the buffer. If after this number of chars no delimiter follows the string will be terminated. You will have to check whether there is a delimiter directly after the copied string
flagsdefines how the source string is to be processed
nextpointer to a pointer to receive the address up to which the source string has been handled. You can use this to continue with the source string behind the word we've just cut out. This variable is only modified upon successfull return

◆ GWEN_Text_GetWordToBuffer()

GWENHYWFAR_API int GWEN_Text_GetWordToBuffer ( const char *  src,
const char *  delims,
GWEN_BUFFER buf,
uint32_t  flags,
const char **  next 
)

◆ GWEN_Text_LogString()

GWENHYWFAR_API void GWEN_Text_LogString ( const char *  s,
unsigned int  l,
const char *  logDomain,
GWEN_LOGGER_LEVEL  lv 
)

◆ GWEN_Text_NumToString()

GWENHYWFAR_API int GWEN_Text_NumToString ( int  num,
char *  buffer,
unsigned int  bufsize,
int  fillchar 
)
Returns
number of bytes in the buffer (-1 on error)
Parameters
fillcharif 0 then no filling takes place, positive values extend to the right, negative values to the left.

◆ GWEN_Text_ReplaceVars()

GWENHYWFAR_API int GWEN_Text_ReplaceVars ( const char *  s,
GWEN_BUFFER dbuf,
GWEN_TEXT_REPLACE_VARS_CB  fn,
void *  ptr 
)

Read the given string and replace every variable in that string ( noted as "$(varname)") with the value of the mentioned variable. Uses a callback to actually retrieve the data.

◆ GWEN_Text_StrCaseStr()

GWENHYWFAR_API const char* GWEN_Text_StrCaseStr ( const char *  haystack,
const char *  needle 
)

This function provides the functionality of strcasestr() which is not available on some systems.

◆ GWEN_Text_StringToDouble()

GWENHYWFAR_API int GWEN_Text_StringToDouble ( const char *  s,
double *  num 
)

This functions transforms a double float value into a string. It always uses a decimal point (".") regardless of the current locale settings. This makes sure that a value can always be parsed regardless of the country settings of the producer of that string.

◆ GWEN_Text_strndup()

GWENHYWFAR_API char* GWEN_Text_strndup ( const char *  s,
size_t  n 
)

This function provides the functionality of strndup() which is not available on Windows (uses strndup() on all other systems).

◆ GWEN_Text_ToBcdBuffer()

GWENHYWFAR_API int GWEN_Text_ToBcdBuffer ( const char *  src,
unsigned  l,
GWEN_BUFFER buf,
unsigned int  groupsize,
char  delimiter,
int  skipLeadingZeroes 
)

Writes the given BCD data as a hex string to the destination buffer.

Parameters
groupsizeif !=0 then after this many characters in the destination buffer the delimiter is inserted
delimitercharacter to write after groupsize characters
skipLeadingZeroesif !=0 then leading zeroes are suppressed

◆ GWEN_Text_ToHex()

GWENHYWFAR_API char* GWEN_Text_ToHex ( const char *  src,
unsigned  l,
char *  buffer,
unsigned int  maxsize 
)

◆ GWEN_Text_ToHexBuffer()

GWENHYWFAR_API int GWEN_Text_ToHexBuffer ( const char *  src,
unsigned  l,
GWEN_BUFFER buf,
unsigned int  groupsize,
char  delimiter,
int  skipLeadingZeroes 
)

Writes the given binary data as a hex string to the destination buffer.

Parameters
groupsizeif !=0 then after this many characters in the destination buffer the delimiter is inserted
delimitercharacter to write after groupsize characters
skipLeadingZeroesif !=0 then leading zeroes are suppressed

◆ GWEN_Text_ToHexGrouped()

GWENHYWFAR_API char* GWEN_Text_ToHexGrouped ( const char *  src,
unsigned  l,
char *  buffer,
unsigned  maxsize,
unsigned int  groupsize,
char  delimiter,
int  skipLeadingZeros 
)

Converts a string to Hex. After "groupsize" bytes the "delimiter" is inserted.

◆ GWEN_Text_Unescape()

GWENHYWFAR_API char* GWEN_Text_Unescape ( const char *  src,
char *  buffer,
unsigned int  maxsize 
)

◆ GWEN_Text_UnescapeN()

GWENHYWFAR_API char* GWEN_Text_UnescapeN ( const char *  src,
unsigned int  srclen,
char *  buffer,
unsigned int  maxsize 
)

◆ GWEN_Text_UnescapeToBuffer()

GWENHYWFAR_API int GWEN_Text_UnescapeToBuffer ( const char *  src,
GWEN_BUFFER buf 
)

◆ GWEN_Text_UnescapeToBufferTolerant()

GWENHYWFAR_API int GWEN_Text_UnescapeToBufferTolerant ( const char *  src,
GWEN_BUFFER buf 
)

This function does the same as GWEN_Text_UnescapeToBuffer but it doesn't complain about unescaped characters in the source string.

◆ GWEN_Text_UnescapeTolerant()

GWENHYWFAR_API char* GWEN_Text_UnescapeTolerant ( const char *  src,
char *  buffer,
unsigned int  maxsize 
)

◆ GWEN_Text_UnescapeTolerantN()

GWENHYWFAR_API char* GWEN_Text_UnescapeTolerantN ( const char *  src,
unsigned int  srclen,
char *  buffer,
unsigned int  maxsize 
)

◆ GWEN_Text_UnescapeXmlToBuffer()

GWENHYWFAR_API int GWEN_Text_UnescapeXmlToBuffer ( const char *  src,
GWEN_BUFFER buf 
)

Replaces special character sequences to their coresponding character.