const char *StrBufNOTNULL = ((char*) NULL) - 1;
+const char HexList[256][3] = {
+"00","01","02","03","04","05","06","07","08","09","0A","0B","0C","0D","0E","0F",
+"10","11","12","13","14","15","16","17","18","19","1A","1B","1C","1D","1E","1F",
+"20","21","22","23","24","25","26","27","28","29","2A","2B","2C","2D","2E","2F",
+"30","31","32","33","34","35","36","37","38","39","3A","3B","3C","3D","3E","3F",
+"40","41","42","43","44","45","46","47","48","49","4A","4B","4C","4D","4E","4F",
+"50","51","52","53","54","55","56","57","58","59","5A","5B","5C","5D","5E","5F",
+"60","61","62","63","64","65","66","67","68","69","6A","6B","6C","6D","6E","6F",
+"70","71","72","73","74","75","76","77","78","79","7A","7B","7C","7D","7E","7F",
+"80","81","82","83","84","85","86","87","88","89","8A","8B","8C","8D","8E","8F",
+"90","91","92","93","94","95","96","97","98","99","9A","9B","9C","9D","9E","9F",
+"A0","A1","A2","A3","A4","A5","A6","A7","A8","A9","AA","AB","AC","AD","AE","AF",
+"B0","B1","B2","B3","B4","B5","B6","B7","B8","B9","BA","BB","BC","BD","BE","BF",
+"C0","C1","C2","C3","C4","C5","C6","C7","C8","C9","CA","CB","CC","CD","CE","CF",
+"D0","D1","D2","D3","D4","D5","D6","D7","D8","D9","DA","DB","DC","DD","DE","DF",
+"E0","E1","E2","E3","E4","E5","E6","E7","E8","E9","EA","EB","EC","ED","EE","EF",
+"F0","F1","F2","F3","F4","F5","F6","F7","F8","F9","FA","FB","FC","FD","FE","FF"};
+
+/**
+ * @defgroup StrBuf Stringbuffer, A class for manipulating strings with dynamic buffers
+ * StrBuf is a versatile class, aiding the handling of dynamic strings
+ * * reduce de/reallocations
+ * * reduce the need to remeasure it
+ * * reduce scanning over the string (in @ref StrBuf_NextTokenizer "Tokenizers")
+ * * allow asyncroneous IO for line and Blob based operations
+ * * reduce the use of memove in those
+ * * Quick filling in several operations with append functions
+ */
+
+/**
+ * @defgroup StrBuf_DeConstructors Create/Destroy StrBufs
+ * @ingroup StrBuf
+ */
+
+/**
+ * @defgroup StrBuf_Cast Cast operators to interact with char* based code
+ * @ingroup StrBuf
+ * use these operators to interfere with code demanding char*;
+ * if you need to own the content, smash me. Avoid, since we loose the length information.
+ */
+
+/**
+ * @defgroup StrBuf_Filler Create/Replace/Append Content into a StrBuf
+ * @ingroup StrBuf
+ * operations to get your Strings into a StrBuf, manipulating them, or appending
+ */
+/**
+ * @defgroup StrBuf_NextTokenizer Fast tokenizer to pull tokens in sequence
+ * @ingroup StrBuf
+ * Quick tokenizer; demands of the user to pull its tokens in sequence
+ */
+
+/**
+ * @defgroup StrBuf_Tokenizer tokenizer Functions; Slow ones.
+ * @ingroup StrBuf
+ * versatile tokenizer; random access to tokens, but slower; Prefer the @ref StrBuf_NextTokenizer "Next Tokenizer"
+ */
+
+/**
+ * @defgroup StrBuf_BufferedIO Buffered IO with Asynchroneous reads and no unneeded memmoves (the fast ones)
+ * @ingroup StrBuf
+ * File IO to fill StrBufs; Works with work-buffer shared across several calls;
+ * External Cursor to maintain the current read position inside of the buffer
+ * the non-fast ones will use memove to keep the start of the buffer the read buffer (which is slower)
+ */
+
+/**
+ * @defgroup StrBuf_IO FileIO; Prefer @ref StrBuf_BufferedIO
+ * @ingroup StrBuf
+ * Slow I/O; avoid.
+ */
+
+/**
+ * @defgroup StrBuf_DeEnCoder functions to translate the contents of a buffer
+ * @ingroup StrBuf
+ * these functions translate the content of a buffer into another representation;
+ * some are combined Fillers and encoders
+ */
+
/**
* Private Structure for the Stringbuffer
*/
struct StrBuf {
char *buf; /**< the pointer to the dynamic buffer */
long BufSize; /**< how many spcae do we optain */
- long BufUsed; /**< StNumber of Chars used excluding the trailing \0 */
+ long BufUsed; /**< StNumber of Chars used excluding the trailing \\0 */
int ConstBuf; /**< are we just a wrapper arround a static buffer and musn't we be changed? */
#ifdef SIZE_DEBUG
- long nIncreases;
- char bt [SIZ];
- char bt_lastinc [SIZ];
+ long nIncreases; /**< for profiling; cound how many times we needed more */
+ char bt [SIZ]; /**< Stacktrace of last increase */
+ char bt_lastinc [SIZ]; /**< How much did we increase last time? */
#endif
};
+
+static inline int Ctdl_GetUtf8SequenceLength(const char *CharS, const char *CharE);
+static inline int Ctdl_IsUtf8SequenceStart(const char Char);
+
#ifdef SIZE_DEBUG
#ifdef HAVE_BACKTRACE
static void StrBufBacktrace(StrBuf *Buf, int which)
#endif
/**
+ * @ingroup StrBuf_Cast
* @brief Cast operator to Plain String
- * Note: if the buffer is altered by StrBuf operations, this pointer may become
+ * @note if the buffer is altered by StrBuf operations, this pointer may become
* invalid. So don't lean on it after altering the buffer!
* Since this operation is considered cheap, rather call it often than risking
* your pointer to become invalid!
}
/**
+ * @ingroup StrBuf_Cast
* @brief since we know strlen()'s result, provide it here.
* @param Str the string to return the length to
* @returns contentlength of the buffer
}
/**
+ * @ingroup StrBuf_DeConstructors
* @brief local utility function to resize the buffer
* @param Buf the buffer whichs storage we should increase
* @param KeepOriginal should we copy the original buffer or just start over with a new one
}
/**
+ * @ingroup StrBuf_DeConstructors
* @brief shrink an _EMPTY_ buffer if its Buffer superseeds threshhold to NewSize. Buffercontent is thoroughly ignored and flushed.
* @param Buf Buffer to shrink (has to be empty)
* @param ThreshHold if the buffer is bigger then this, its readjusted
}
/**
+ * @ingroup StrBuf_DeConstructors
* @brief shrink long term buffers to their real size so they don't waste memory
* @param Buf buffer to shrink
* @param Force if not set, will just executed if the buffer is much to big; set for lifetime strings
}
/**
+ * @ingroup StrBuf_DeConstructors
* @brief Allocate a new buffer with default buffer size
* @returns the new stringbuffer
*/
}
/**
+ * @ingroup StrBuf_DeConstructors
* @brief Copy Constructor; returns a duplicate of CopyMe
- * @params CopyMe Buffer to faxmilate
+ * @param CopyMe Buffer to faxmilate
* @returns the new stringbuffer
*/
StrBuf* NewStrBufDup(const StrBuf *CopyMe)
}
/**
+ * @ingroup StrBuf_DeConstructors
* @brief create a new Buffer using an existing c-string
* this function should also be used if you want to pre-suggest
* the buffer size to allocate in conjunction with ptr == NULL
}
/**
+ * @ingroup StrBuf_DeConstructors
* @brief Set an existing buffer from a c-string
+ * @param Buf buffer to load
* @param ptr c-string to put into
* @param nChars set to -1 if we should work 0-terminated
* @returns the new length of the string
/**
+ * @ingroup StrBuf_DeConstructors
* @brief use strbuf as wrapper for a string constant for easy handling
* @param StringConstant a string to wrap
- * @param SizeOfConstant should be sizeof(StringConstant)-1
+ * @param SizeOfStrConstant should be sizeof(StringConstant)-1
*/
StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant)
{
/**
+ * @ingroup StrBuf_DeConstructors
* @brief flush the content of a Buf; keep its struct
* @param buf Buffer to flush
*/
}
/**
+ * @ingroup StrBuf_DeConstructors
* @brief wipe the content of a Buf thoroughly (overwrite it -> expensive); keep its struct
* @param buf Buffer to wipe
*/
int hFreeDbglog = -1;
#endif
/**
+ * @ingroup StrBuf_DeConstructors
* @brief Release a Buffer
* Its a double pointer, so it can NULL your pointer
* so fancy SIG11 appear instead of random results
}
/**
+ * @ingroup StrBuf_DeConstructors
* @brief flatten a Buffer to the Char * we return
* Its a double pointer, so it can NULL your pointer
* so fancy SIG11 appear instead of random results
}
/**
+ * @ingroup StrBuf_DeConstructors
* @brief Release the buffer
* If you want put your StrBuf into a Hash, use this as Destructor.
* @param VFreeMe untyped pointer to a StrBuf. be shure to do the right thing [TM]
}
/**
+ * @ingroup StrBuf
* @brief Wrapper around atol
*/
long StrTol(const StrBuf *Buf)
}
/**
+ * @ingroup StrBuf
* @brief Wrapper around atoi
*/
int StrToi(const StrBuf *Buf)
}
/**
+ * @ingroup StrBuf
* @brief Checks to see if the string is a pure number
*/
int StrBufIsNumber(const StrBuf *Buf) {
return 0;
}
/**
+ * @ingroup StrBuf
* @brief modifies a Single char of the Buf
* You can point to it via char* or a zero-based integer
+ * @param Buf The buffer to manipulate
* @param ptr char* to zero; use NULL if unused
* @param nThChar zero based pointer into the string; use -1 if unused
* @param PeekValue The Character to place into the position
}
/**
+ * @ingroup StrBuf
* @brief Append a StringBuffer to the buffer
* @param Buf Buffer to modify
* @param AppendBuf Buffer to copy at the end of our buffer
/**
+ * @ingroup StrBuf
* @brief Append a C-String to the buffer
* @param Buf Buffer to modify
* @param AppendBuf Buffer to copy at the end of our buffer
}
/**
+ * @ingroup StrBuf
* @brief Callback for cURL to append the webserver reply to a buffer
- * @params pre-defined by the cURL API; see man 3 curl for mre info
+ * @param ptr pre-defined by the cURL API; see man 3 curl for mre info
+ * @param size pre-defined by the cURL API; see man 3 curl for mre info
+ * @param nmemb pre-defined by the cURL API; see man 3 curl for mre info
+ * @param stream pre-defined by the cURL API; see man 3 curl for mre info
*/
size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream)
{
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief Escape a string for feeding out as a URL while appending it to a Buffer
- * @param outbuf the output buffer
- * @param oblen the size of outbuf to sanitize
- * @param strbuf the input buffer
+ * @param OutBuf the output buffer
+ * @param In Buffer to encode
+ * @param PlainIn way in from plain old c strings
*/
void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn)
{
const char *pch, *pche;
char *pt, *pte;
- int b, c, len;
- const char ec[] = " +#&;`'|*?-~<>^()[]{}/$\"\\";
- int eclen = sizeof(ec) -1;
-
+ int len;
+
if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
return;
if (PlainIn != NULL) {
pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
pt = OutBuf->buf + OutBuf->BufUsed;
}
-
- c = 0;
- for (b = 0; b < eclen; ++b) {
- if (*pch == ec[b]) {
- c = 1;
- b += eclen;
- }
- }
- if (c == 1) {
- sprintf(pt,"%%%02X", *pch);
+
+ if((*pch >= 'a' && *pch <= 'z') ||
+ (*pch >= '@' && *pch <= 'Z') || /* @ A-Z */
+ (*pch >= '0' && *pch <= ':') || /* 0-9 : */
+ (*pch == '!') || (*pch == '_') ||
+ (*pch == ',') || (*pch == '.') ||
+ (*pch == ','))
+ {
+ *(pt++) = *(pch++);
+ OutBuf->BufUsed++;
+ }
+ else {
+ *pt = '%';
+ *(pt + 1) = HexList[(unsigned char)*pch][0];
+ *(pt + 2) = HexList[(unsigned char)*pch][1];
pt += 3;
OutBuf->BufUsed += 3;
pch ++;
}
- else {
- *(pt++) = *(pch++);
- OutBuf->BufUsed++;
- }
}
*pt = '\0';
}
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief Append a string, escaping characters which have meaning in HTML.
*
* @param Target target buffer
}
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief Append a string, escaping characters which have meaning in HTML.
* Converts linebreaks into blanks; escapes single quotes
* @param Target target buffer
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief Append a string, escaping characters which have meaning in ICAL.
* [\n,]
* @param Target target buffer
}
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief Append a string, escaping characters which have meaning in JavaScript strings .
*
* @param Target target buffer
}
/**
+ * @ingroup StrBuf_DeEnCoder
+ * @brief Append a string, escaping characters which have meaning in HTML + json.
+ *
+ * @param Target target buffer
+ * @param Source source buffer; set to NULL if you just have a C-String
+ * @param PlainIn Plain-C string to append; set to NULL if unused
+ * @param nbsp If nonzero, spaces are converted to non-breaking spaces.
+ * @param nolinebreaks if set to 1, linebreaks are removed from the string.
+ * if set to 2, linebreaks are replaced by <br/>
+ */
+long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks)
+{
+ const char *aptr, *eiptr;
+ char *bptr, *eptr;
+ long len;
+ int IsUtf8Sequence = 0;
+
+ if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
+ return -1;
+
+ if (PlainIn != NULL) {
+ aptr = PlainIn;
+ len = strlen(PlainIn);
+ eiptr = aptr + len;
+ }
+ else {
+ aptr = Source->buf;
+ eiptr = aptr + Source->BufUsed;
+ len = Source->BufUsed;
+ }
+
+ if (len == 0)
+ return -1;
+
+ bptr = Target->buf + Target->BufUsed;
+ eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
+
+ while (aptr < eiptr){
+ if(bptr >= eptr) {
+ IncreaseBuf(Target, 1, -1);
+ eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
+ bptr = Target->buf + Target->BufUsed;
+ }
+ if (*aptr == '<') {
+ memcpy(bptr, "<", 4);
+ bptr += 4;
+ Target->BufUsed += 4;
+ }
+ else if (*aptr == '>') {
+ memcpy(bptr, ">", 4);
+ bptr += 4;
+ Target->BufUsed += 4;
+ }
+ else if (*aptr == '&') {
+ memcpy(bptr, "&", 5);
+ bptr += 5;
+ Target->BufUsed += 5;
+ }
+ else if (*aptr == LB) {
+ *bptr = '<';
+ bptr ++;
+ Target->BufUsed ++;
+ }
+ else if (*aptr == RB) {
+ *bptr = '>';
+ bptr ++;
+ Target->BufUsed ++;
+ }
+ else if ((*aptr == 32) && (nbsp == 1)) {
+ memcpy(bptr, " ", 6);
+ bptr += 6;
+ Target->BufUsed += 6;
+ }
+ else if ((*aptr == '\n') && (nolinebreaks == 1)) {
+ *bptr='\0'; /* nothing */
+ }
+ else if ((*aptr == '\n') && (nolinebreaks == 2)) {
+ memcpy(bptr, "<br/>", 11);
+ bptr += 11;
+ Target->BufUsed += 11;
+ }
+
+ else if ((*aptr == '\r') && (nolinebreaks != 0)) {
+ *bptr='\0'; /* nothing */
+ }
+
+ else if ((*aptr == '"') || (*aptr == QU)) {
+ *bptr = '\\';
+ bptr ++;
+ *bptr = '"';
+ bptr ++;
+ Target->BufUsed += 2;
+ } else if (*aptr == '\\') {
+ *bptr = '\\';
+ bptr ++;
+ *bptr = '\\';
+ bptr ++;
+ Target->BufUsed += 2;
+ }
+ else {
+ if (((unsigned char)*aptr) >= 0x20)
+ {
+ IsUtf8Sequence = Ctdl_GetUtf8SequenceLength(aptr, eiptr);
+
+ *bptr = *aptr;
+ Target->BufUsed ++;
+ while (IsUtf8Sequence > 1){
+ if(bptr + IsUtf8Sequence >= eptr) {
+ IncreaseBuf(Target, 1, -1);
+ eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
+ bptr = Target->buf + Target->BufUsed - 1;
+ }
+ bptr++; aptr++;
+ IsUtf8Sequence --;
+ *bptr = *aptr;
+ Target->BufUsed ++;
+ }
+ bptr++;
+ }
+
+ }
+ aptr ++;
+ }
+ *bptr = '\0';
+ if ((bptr = eptr - 1 ) && !IsEmptyStr(aptr) )
+ return -1;
+ return Target->BufUsed;
+}
+
+
+/**
+ * @ingroup StrBuf
* @brief extracts a substring from Source into dest
* @param dest buffer to place substring into
* @param Source string to copy substring from
}
/**
+ * @ingroup StrBuf
* @brief sprintf like function appending the formated string to the buffer
* vsnprintf version to wrap into own calls
- * @param Buf Buffer to extend by format and @params
+ * @param Buf Buffer to extend by format and Params
* @param format printf alike format to add
* @param ap va_list containing the items for format
*/
}
/**
+ * @ingroup StrBuf
* @brief sprintf like function appending the formated string to the buffer
- * @param Buf Buffer to extend by format and @params
+ * @param Buf Buffer to extend by format and Params
* @param format printf alike format to add
- * @param ap va_list containing the items for format
*/
void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...)
{
}
/**
+ * @ingroup StrBuf
* @brief sprintf like function putting the formated string into the buffer
- * @param Buf Buffer to extend by format and @params
+ * @param Buf Buffer to extend by format and Parameters
* @param format printf alike format to add
- * @param ap va_list containing the items for format
*/
void StrBufPrintf(StrBuf *Buf, const char *format, ...)
{
/**
+ * @ingroup StrBuf_Tokenizer
* @brief Counts the numbmer of tokens in a buffer
- * @param Source String to count tokens in
+ * @param source String to count tokens in
* @param tok Tokenizer char to count
* @returns numbers of tokenizer chars found
*/
* remove_token() - a tokenizer that kills, maims, and destroys
*/
/**
+ * @ingroup StrBuf_Tokenizer
* @brief a string tokenizer
* @param Source StringBuffer to read into
- * @param parmnum n'th @parameter to remove
- * @param separator tokenizer @param
+ * @param parmnum n'th Parameter to remove
+ * @param separator tokenizer character
* @returns -1 if not found, else length of token.
*/
int StrBufRemove_token(StrBuf *Source, int parmnum, char separator)
/* Find desired @parameter */
end = Source->buf + Source->BufUsed;
d = Source->buf;
- while ((count < parmnum) &&
- (d <= end))
+ while ((d <= end) &&
+ (count < parmnum))
{
/* End of string, bail! */
if (!*d) {
/* Find next @parameter */
s = d;
- while ((*s && *s != separator) &&
- (s <= end))
+ while ((s <= end) &&
+ (*s && *s != separator))
{
s++;
}
ReducedBy = d - s;
/* Hack and slash */
- if (*s) {
+ if (s >= end) {
+ return 0;
+ }
+ else if (*s) {
memmove(d, s, Source->BufUsed - (s - Source->buf));
Source->BufUsed += ReducedBy;
+ Source->buf[Source->BufUsed] = '\0';
}
else if (d == Source->buf) {
*d = 0;
Source->BufUsed = 0;
}
else {
- *--d = 0;
+ *--d = '\0';
Source->BufUsed += ReducedBy;
}
/*
/**
+ * @ingroup StrBuf_Tokenizer
* @brief a string tokenizer
* @param dest Destination StringBuffer
* @param Source StringBuffer to read into
- * @param parmnum n'th @parameter to extract
- * @param separator tokenizer @param
+ * @param parmnum n'th Parameter to extract
+ * @param separator tokenizer character
* @returns -1 if not found, else length of token.
*/
int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator)
/**
+ * @ingroup StrBuf_Tokenizer
* @brief a string tokenizer to fetch an integer
- * @param dest Destination StringBuffer
- * @param parmnum n'th @parameter to extract
- * @param separator tokenizer @param
+ * @param Source String containing tokens
+ * @param parmnum n'th Parameter to extract
+ * @param separator tokenizer character
* @returns 0 if not found, else integer representation of the token
*/
int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator)
}
/**
+ * @ingroup StrBuf_Tokenizer
* @brief a string tokenizer to fetch a long integer
- * @param dest Destination StringBuffer
- * @param parmnum n'th @parameter to extract
- * @param separator tokenizer @param
+ * @param Source String containing tokens
+ * @param parmnum n'th Parameter to extract
+ * @param separator tokenizer character
* @returns 0 if not found, else long integer representation of the token
*/
long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator)
/**
+ * @ingroup StrBuf_Tokenizer
* @brief a string tokenizer to fetch an unsigned long
- * @param dest Destination StringBuffer
- * @param parmnum n'th @parameter to extract
- * @param separator tokenizer @param
+ * @param Source String containing tokens
+ * @param parmnum n'th Parameter to extract
+ * @param separator tokenizer character
* @returns 0 if not found, else unsigned long representation of the token
*/
unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator)
/**
- * @briefa string tokenizer; Bounds checker
+ * @ingroup StrBuf_NextTokenizer
+ * @brief a string tokenizer; Bounds checker
* function to make shure whether StrBufExtract_NextToken and friends have reached the end of the string.
* @param Source our tokenbuffer
* @param pStart the token iterator pointer to inspect
}
/**
+ * @ingroup StrBuf_NextTokenizer
* @brief a string tokenizer
* @param dest Destination StringBuffer
* @param Source StringBuffer to read into
* @param pStart pointer to the end of the last token. Feed with NULL on start.
- * @param separator tokenizer @param
+ * @param separator tokenizer
* @returns -1 if not found, else length of token.
*/
int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator)
/**
+ * @ingroup StrBuf_NextTokenizer
* @brief a string tokenizer
- * @param dest Destination StringBuffer
- * @param Source StringBuffer to read into
+ * @param Source StringBuffer to read from
* @param pStart pointer to the end of the last token. Feed with NULL.
- * @param separator tokenizer @param
+ * @param separator tokenizer character
+ * @param nTokens number of tokens to fastforward over
* @returns -1 if not found, else length of token.
*/
int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens)
}
/**
+ * @ingroup StrBuf_NextTokenizer
* @brief a string tokenizer to fetch an integer
- * @param dest Destination StringBuffer
- * @param parmnum n'th @parameter to extract
- * @param separator tokenizer @param
+ * @param Source StringBuffer to read from
+ * @param pStart Cursor on the tokenstring
+ * @param separator tokenizer character
* @returns 0 if not found, else integer representation of the token
*/
int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator)
}
/**
+ * @ingroup StrBuf_NextTokenizer
* @brief a string tokenizer to fetch a long integer
- * @param dest Destination StringBuffer
- * @param parmnum n'th @parameter to extract
- * @param separator tokenizer @param
+ * @param Source StringBuffer to read from
+ * @param pStart Cursor on the tokenstring
+ * @param separator tokenizer character
* @returns 0 if not found, else long integer representation of the token
*/
long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator)
/**
+ * @ingroup StrBuf_NextTokenizer
* @brief a string tokenizer to fetch an unsigned long
- * @param dest Destination StringBuffer
- * @param parmnum n'th @parameter to extract
- * @param separator tokenizer @param
+ * @param Source StringBuffer to read from
+ * @param pStart Cursor on the tokenstring
+ * @param separator tokenizer character
* @returns 0 if not found, else unsigned long representation of the token
*/
unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator)
/**
+ * @ingroup StrBuf_IO
* @brief Read a line from socket
* flushes and closes the FD on error
* @param buf the buffer to get the input to
break;
if (buf->buf[len] != '\r')
len ++;
- if (len >= buf->BufSize) {
+ if (len + 2 >= buf->BufSize) {
buf->BufUsed = len;
buf->buf[len+1] = '\0';
IncreaseBuf(buf, 1, -1);
}
/**
+ * @ingroup StrBuf_BufferedIO
* @brief Read a line from socket
* flushes and closes the FD on error
+ * @param Line the line to read from the fd / I/O Buffer
* @param buf the buffer to get the input to
* @param fd pointer to the filedescriptor to read
- * @param append Append to an existing string or replace?
+ * @param timeout number of successless selects until we bail out
+ * @param selectresolution how long to wait on each select
* @param Error strerror() on error
* @returns numbers of chars read
*/
}
+static const char *ErrRBLF_PreConditionFailed="StrBufTCP_read_buffered_line_fast: Wrong arguments or invalid Filedescriptor";
static const char *ErrRBLF_SelectFailed="StrBufTCP_read_buffered_line_fast: Select failed without reason";
static const char *ErrRBLF_NotEnoughSentFromServer="StrBufTCP_read_buffered_line_fast: No complete line was sent from peer";
/**
+ * @ingroup StrBuf_BufferedIO
* @brief Read a line from socket
* flushes and closes the FD on error
- * @param buf the buffer to get the input to
+ * @param Line Line to read from the fd / I/O Buffer
+ * @param IOBuf the buffer to get the input to
* @param Pos pointer to the current read position, should be NULL initialized!
* @param fd pointer to the filedescriptor to read
- * @param append Append to an existing string or replace?
+ * @param timeout number of successless selects until we bail out
+ * @param selectresolution how long to wait on each select
* @param Error strerror() on error
* @returns numbers of chars read
*/
int IsNonBlock;
struct timeval tv;
+ if ((Line == NULL) ||
+ (IOBuf == NULL) ||
+ (*fd == -1))
+ {
+ *Error = ErrRBLF_PreConditionFailed;
+ return -1;
+ }
+
pos = *Pos;
if ((IOBuf->BufUsed > 0) &&
(pos != NULL) &&
IOBuf->buf[IOBuf->BufUsed] = '\0';
if (IOBuf->BufUsed + 10 > IOBuf->BufSize) {
IncreaseBuf(IOBuf, 1, -1);
+ *Pos = NULL;
}
pche = IOBuf->buf + IOBuf->BufUsed;
}
+static const char *ErrRBLF_BLOBPreConditionFailed="StrBufReadBLOB: Wrong arguments or invalid Filedescriptor";
/**
+ * @ingroup StrBuf_IO
* @brief Input binary data from socket
* flushes and closes the FD on error
- * @param buf the buffer to get the input to
+ * @param Buf the buffer to get the input to
* @param fd pointer to the filedescriptor to read
* @param append Append to an existing string or replace?
* @param nBytes the maximal number of bytes to read
int IsNonBlock;
struct timeval tv;
fd_set rfds;
+
if ((Buf == NULL) || (*fd == -1))
+ {
+ *Error = ErrRBLF_BLOBPreConditionFailed;
return -1;
+ }
if (!append)
FlushStrBuf(Buf);
if (Buf->BufUsed + nBytes >= Buf->BufSize)
return nRead;
}
+const char *ErrRBB_BLOBFPreConditionFailed = "StrBufReadBLOBBuffered: to many selects; aborting.";
const char *ErrRBB_too_many_selects = "StrBufReadBLOBBuffered: to many selects; aborting.";
/**
+ * @ingroup StrBuf_BufferedIO
* @brief Input binary data from socket
* flushes and closes the FD on error
- * @param buf the buffer to get the input to
+ * @param Blob put binary thing here
+ * @param IOBuf the buffer to get the input to
+ * @param Pos offset inside of IOBuf
* @param fd pointer to the filedescriptor to read
* @param append Append to an existing string or replace?
* @param nBytes the maximal number of bytes to read
+ * @param check whether we should search for '000\n' terminators in case of timeouts
* @param Error strerror() on error
* @returns numbers of chars read
*/
int nSuccessLess;
if ((Blob == NULL) || (*fd == -1) || (IOBuf == NULL) || (Pos == NULL))
+ {
+ *Error = ErrRBB_BLOBFPreConditionFailed;
return -1;
+ }
+
if (!append)
FlushStrBuf(Blob);
if (Blob->BufUsed + nBytes >= Blob->BufSize)
}
/**
+ * @ingroup StrBuf
* @brief Cut nChars from the start of the string
* @param Buf Buffer to modify
* @param nChars how many chars should be skipped?
}
/**
+ * @ingroup StrBuf
* @brief Cut the trailing n Chars from the string
* @param Buf Buffer to modify
* @param nChars how many chars should be trunkated?
}
/**
+ * @ingroup StrBuf
* @brief Cut the string after n Chars
* @param Buf Buffer to modify
* @param AfternChars after how many chars should we trunkate the string?
/**
+ * @ingroup StrBuf
* @brief Strip leading and trailing spaces from a string; with premeasured and adjusted length.
- * @param buf the string to modify
- * @param len length of the string.
+ * @param Buf the string to modify
*/
void StrBufTrim(StrBuf *Buf)
{
}
/**
+ * @ingroup StrBuf
* @brief uppercase the contents of a buffer
* @param Buf the buffer to translate
*/
/**
+ * @ingroup StrBuf
* @brief lowercase the contents of a buffer
* @param Buf the buffer to translate
*/
}
/**
+ * @ingroup StrBuf
* @brief removes double slashes from pathnames
* @param Dir directory string to filter
* @param RemoveTrailingSlash allows / disallows trailing slashes
}
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief unhide special chars hidden to the HTML escaper
* @param target buffer to put the unescaped string in
* @param source buffer to unescape
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief hide special chars from the HTML escapers and friends
* @param target buffer to put the escaped string in
* @param source buffer to escape
target->buf[target->BufUsed + 1] = '\0';
}
-/**
- * @brief uses the same calling syntax as compress2(), but it
- * creates a stream compatible with HTTP "Content-encoding: gzip"
- */
#ifdef HAVE_ZLIB
#define DEF_MEM_LEVEL 8 /*< memlevel??? */
#define OS_CODE 0x03 /*< unix */
-int ZEXPORT compress_gzip(Bytef * dest, /*< compressed buffer*/
- size_t * destLen, /*< length of the compresed data */
- const Bytef * source, /*< source to encode */
- uLong sourceLen, /*< length of source to encode */
- int level) /*< compression level */
+
+/**
+ * @ingroup StrBuf_DeEnCoder
+ * @brief uses the same calling syntax as compress2(), but it
+ * creates a stream compatible with HTTP "Content-encoding: gzip"
+ * @param dest compressed buffer
+ * @param destLen length of the compresed data
+ * @param source source to encode
+ * @param sourceLen length of source to encode
+ * @param level compression level
+ */
+int ZEXPORT compress_gzip(Bytef * dest,
+ size_t * destLen,
+ const Bytef * source,
+ uLong sourceLen,
+ int level)
{
const int gz_magic[2] = { 0x1f, 0x8b }; /* gzip magic header */
/**
+ * @ingroup StrBuf_DeEnCoder
+ * @brief compress the buffer with gzip
* Attention! If you feed this a Const String, you must maintain the uncompressed buffer yourself!
+ * @param Buf buffer whose content is to be gzipped
*/
int CompressBuffer(StrBuf *Buf)
{
}
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief decode a buffer from base 64 encoding; destroys original
* @param Buf Buffor to transform
*/
}
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief decode a buffer from base 64 encoding; destroys original
* @param Buf Buffor to transform
*/
}
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief replace all chars >0x20 && < 0x7F with Mute
* @param Mute char to put over invalid chars
* @param Buf Buffor to transform
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief remove escaped strings from i.e. the url string (like %20 for blanks)
* @param Buf Buffer to translate
* @param StripBlanks Reduce several blanks to one?
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief RFC2047-encode a header field if necessary.
* If no non-ASCII characters are found, the string
* will be copied verbatim without encoding.
}
/**
+ * @ingroup StrBuf
* @brief replaces all occurances of 'search' by 'replace'
* @param buf Buffer to modify
* @param search character to search
- * @param relpace character to replace search by
+ * @param replace character to replace search by
*/
void StrBufReplaceChars(StrBuf *buf, char search, char replace)
{
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief Wrapper around iconv_open()
* Our version adds aliases for non-standard Microsoft charsets
* such as 'MS950', aliasing them to names like 'CP950'
*
* @param tocode Target encoding
* @param fromcode Source encoding
+ * @param pic anonimized pointer to iconv struct
*/
void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic)
{
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief find one chunk of a RFC822 encoded string
* @param Buffer where to search
* @param bptr where to start searching
}
/**
+ * @ingroup StrBuf
* @brief swaps the contents of two StrBufs
* this is to be used to have cheap switched between a work-buffer and a target buffer
* @param A First one
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief convert one buffer according to the preselected iconv pointer PIC
* @param ConvertBuf buffer we need to translate
* @param TmpBuf To share a workbuffer over several iterations. prepare to have it filled with useless stuff afterwards.
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief catches one RFC822 encoded segment, and decodes it.
* @param Target buffer to fill with result
* @param DecodeMe buffer with stuff to process
char encoding[16];
#ifdef HAVE_ICONV
iconv_t ic = (iconv_t)(-1);
+#else
+ void *ic = NULL;
#endif
/* Now we handle foreign character sets properly encoded
* in RFC2047 format.
}
/**
+ * @ingroup StrBuf_DeEnCoder
* @brief Handle subjects with RFC2047 encoding such as:
* =?koi8-r?B?78bP0s3Mxc7JxSDXz9rE1dvO2c3JINvB0sHNySDP?=
* @param Target where to put the decoded string to
}
/**
+ * @ingroup StrBuf
* @brief evaluate the length of an utf8 special character sequence
* @param Char the character to examine
* @returns width of utf8 chars in bytes
*/
-static inline int Ctdl_GetUtf8SequenceLength(char *CharS, char *CharE)
+static inline int Ctdl_GetUtf8SequenceLength(const char *CharS, const char *CharE)
{
int n = 1;
char test = (1<<7);
test = test << 1;
n ++;
}
- if ((n > 6) || ((CharE - CharS) > n))
+ if ((n > 6) || ((CharE - CharS) < n))
n = 1;
return n;
}
/**
+ * @ingroup StrBuf
* @brief detect whether this char starts an utf-8 encoded char
* @param Char character to inspect
* @returns yes or no
*/
-static inline int Ctdl_IsUtf8SequenceStart(char Char)
+static inline int Ctdl_IsUtf8SequenceStart(const char Char)
{
/** 11??.???? indicates an UTF8 Sequence. */
return ((Char & 0xC0) != 0);
}
/**
+ * @ingroup StrBuf
* @brief measure the number of glyphs in an UTF8 string...
- * @param str string to measure
- * @returns the length of str
+ * @param Buf string to measure
+ * @returns the number of glyphs in Buf
*/
long StrBuf_Utf8StrLen(StrBuf *Buf)
{
while ((aptr < eptr) && (*aptr != '\0')) {
if (Ctdl_IsUtf8SequenceStart(*aptr)){
m = Ctdl_GetUtf8SequenceLength(aptr, eptr);
- while ((aptr < eptr) && (m-- > 0) && (*aptr++ != '\0'))
- n ++;
+ while ((aptr < eptr) && (*aptr++ != '\0')&& (m-- > 0) );
+ n ++;
}
else {
n++;
aptr++;
}
-
}
return n;
}
/**
+ * @ingroup StrBuf
* @brief cuts a string after maxlen glyphs
- * @param str string to cut to maxlen glyphs
+ * @param Buf string to cut to maxlen glyphs
* @param maxlen how long may the string become?
- * @returns pointer to maxlen or the end of the string
+ * @returns current length of the string
*/
long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen)
{
while ((aptr < eptr) && (*aptr != '\0')) {
if (Ctdl_IsUtf8SequenceStart(*aptr)){
m = Ctdl_GetUtf8SequenceLength(aptr, eptr);
- while ((m-- > 0) && (*aptr++ != '\0'))
- n ++;
+ while ((*aptr++ != '\0') && (m-- > 0));
+ n ++;
}
else {
n++;
/**
+ * @ingroup StrBuf
* @brief extract a "next line" from Buf; Ptr to persist across several iterations
* @param LineBuf your line will be copied here.
* @param Buf BLOB with lines of text...
return Buf->BufUsed - (ptr - Buf->buf);
}
+
projects / citadel.git / blobdiff