/*
	WARNING: This file was generated by dkct.
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk4strd.ctr
*/

/*
Copyright (C) 2015-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef DK4STRD_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4STRD_H_INCLUDED 1


#line 10 "dk4strd.ctr"

/**	@file
	String functions for dkChar characters.
*/

#ifndef DK4CONF_H_INCLUDED
#include "dk4conf.h"
#endif

#ifndef DK4TYPES_H_INCLUDED
#include "dk4types.h"
#endif

#ifndef DK4ERROR_H_INCLUDED
#include "dk4error.h"
#endif

#ifdef __cplusplus
extern "C" {
#endif

/**	Copy string, check destination buffer size.
	@param	dst	Destination buffer address.
	@param	sz	Destination buffer size.
	@param	src	Source string.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if dst or src is NULL or sz is 0,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the dst buffer is too small.
*/
int
dk4str_cpy_s(dkChar *dst, size_t sz, const dkChar *src, dk4_er_t *erp);

/**	Concatenate strings, check destination buffer size.
	@param	dst	Destination buffer address.
	@param	sz	Destination buffer size.
	@param	src	Source string.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if dst or src is NULL or sz is 0,
	- DK4_E_MATH_OVERFLOW<br>
	  if a mathematical overflow occured in size calculation,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the concatenated string doest not fit into the buffer.
*/
int
dk4str_cat_s(dkChar *dst, size_t sz, const dkChar *src, dk4_er_t *erp);

/**	Copy characters within a string from right to left.
	This copy operation is intended for moving characters within
	one string from right to left, making the string shorter
	as is. This function does not check buffer size or report
	any error.
	For normal string copy operations, use the dk4str_cpy_s()
	function instead.
	@param	dst	Destination buffer address.
	@param	src	Source string.
*/
void
dk4str_cpy_to_left(dkChar *dst, const dkChar *src);

/**	Find string length.
	@param	src	Source string.
	@return	String length.
*/
size_t
dk4str_len(const dkChar *src);

/**	Compare two strings.
	@param	s1	Left string, may be NULL.
	@param	s2	Right string, may be NULL.
	@return	1 if s1>s2, 0 if s1==s2, -1 if s1<s2.
*/
int
dk4str_cmp(const dkChar *s1, const dkChar *s2);

/**	Compare two strings.
	@param	s1	Left string, may be NULL.
	@param	s2	Right string, may be NULL.
	@param	n	Maximum number of characters to compare.
	@return	1 if s1>s2, 0 if s1==s2, -1 if s1<s2.
*/
int
dk4str_ncmp(const dkChar *s1, const dkChar *s2, size_t n);

/**	Compare two strings, case-insensitive comparison.
	@param	s1	Left string, may be NULL.
	@param	s2	Right string, may be NULL.
	@return	1 if s1>s2, 0 if s1==s2, -1 if s1<s2.
*/
int
dk4str_casecmp(const dkChar *s1, const dkChar *s2);

/**	Compare two file path names.
	@param	s1	Left string, may be NULL.
	@param	s2	Right string, may be NULL.
	@return	1 if s1>s2, 0 if s1==s2, -1 if s1<s2.
*/
int
dk4str_pathcmp(const dkChar *s1, const dkChar *s2);

/**	Find first occurance of character c in string s.
	@param	s	String to search for c.
	@param	c	Character to find.
	@return	Pointer to first occurance if found, NULL otherwise.
*/
dkChar *
dk4str_chr(const dkChar *s, dkChar c);

/**	Find last occurance of character c in string s.
	@param	s	String to search for c.
	@param	c	Character to find.
	@return	Pointer to last occurance if found, NULL otherwise.
*/
dkChar *
dk4str_rchr(const dkChar *s, dkChar c);

/**	Retrieve first token from *stringp.
	@param	stringp	Adress of string pointer.
	@param	delim	String containing the delimiter set,
			my be NULL to use the default delimiter
			set (space, tabulator, carriage return and newline).
	@return	Pointer to first token on success, NULL if no (further)
	token found.
*/
dkChar *
dk4str_sep(dkChar **stringp, const dkChar *delim);

/**	Find first token in string.
	@param	src	String to search for tokens.
	@param	delim	String containing the delimiter characters,
			may be NULL to use the default delimiter set.
	@return	Pointer to first token if found, NULL otherwise.
*/
dkChar *
dk4str_start(const dkChar *src, const dkChar *delim);

/**	Cut string after first token, find start of second token in string.
	@param	src	String to search for tokens,
			normally the result of dk4str_start() or a
			previous dk4str_next() call.
	@param	delim	String containing the delimiter characters,
			may be NULL to use the default delimiter set.
	@return	Pointer to second token if found, NULL otherwise.
*/
dkChar *
dk4str_next(dkChar *src, const dkChar *delim);

/**	Split a string into tokens.
	@param	dpp	Pointer to string pointer array.
	@param	szdpp	Size of destination string pointer array.
	@param	src	Source string to process.
	@param	delim	String containing delimiter characters,
			may be NULL to use the default delimiter set.
	@param	erp	Error report, may be NULL.
	@return	Number of tokens found on success, 0 if no token
	found or on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  for invalid function arguments,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  with dt.mem.nelem set to the number of tokens in string if the dpp
	  array is too short.
*/
size_t
dk4str_tokenize(
  dkChar **dpp, size_t szdpp, dkChar *src, const dkChar *delim, dk4_er_t *erp
);

/**	Normalize a string (remove leading and trailing delimiters,
	replace delimiter sequences by just one delimiter).
	@param	src	Buffer containing the string to normalize.
	@param	delim	String containing delimiter characters,
			may be NULL to use the default delimiter set.
*/
void
dk4str_normalize(dkChar *src, const dkChar *delim);

/**	Find index of a string in an array of strings.
	@param	arr	Array of strings.
	@param	str	String to find in array.
	@param	cs	Flag: Case-sensitive search (0=no, other=yes).
	@return	Non-negative index value on success, -1 on error.
*/
int
dk4str_array_index(const dkChar * const *arr, const dkChar *str, int cs);

/**	Find index of a string in an array of strings.
	@param	arr	Array of strings allowing abbreviation.
	@param	spec	Special character indicating start of optional text.
	@param	str	String to find in array.
	@param	cs	Flag: Case-sensitive search (0=no, other=yes).
	@return	Non-negative index value on success, -1 on error.
*/
int
dk4str_abbr_index(
  const dkChar * const	*arr,
  dkChar		 spec,
  const dkChar		*str,
  int cs
);

/**	Check whether a text matches a pattern, the text may be abbreviated.
 	@param	str	Text to check.
 	@param	pattern	Pattern for comparison.
 	@param	spec	Special character marking the abbreviation in the
	pattern.
 	@param	cs	Flag: Case sensitive (1) or not (0).
 	@return	1 for a match, 0 otherwise.
*/
int
dk4str_is_abbr(const dkChar *str, const dkChar *pattern, dkChar spec, int cs);

/**	Check whether a string represents a boolean value.
	@param	str	String to check.
	@return	1 if str represents a boolean value, 0 otherwise.
*/
int
dk4str_is_bool(const dkChar *str);

/**	Check whether a string represents the boolean value TRUE.
	@param	str	String to check.
	@return	1 if str represents the boolean value TRUE, 0 otherwise.
*/
int
dk4str_is_on(const dkChar *str);

#if (defined(_WIN32) && DK4_USE_WINDOWS_LOCAL_ALLOC) \
    || (DK4_HAVE_MALLOC && DK4_HAVE_FREE)

/**	Duplicate string in dynamically allocated memory.
	@param	src	String to duplicate.
	@param	erp	Error report, may be NULL.
	@return	Pointer to string in new memory on succes, NULL on error.
	Use dk4mem_free() to release the memory after usage.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if src is a NULL pointer,
	- DK4_E_MATH_OVERFLOW<br>
	  on mathematical overflow in size calculation,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  with mem.elsize and mem.nelem set if no memory is available.
*/
dkChar *
dk4str_dup(const dkChar *src, dk4_er_t *erp);

#endif
/* if (defined(_WIN32) ... */

/**	Remove trailing white spaces.
	@param	str	String to remove white spaces from.
	@param	whsp	White spaces set.
*/
void
dk4str_rtwh(dkChar *str, const dkChar *whsp);

/**	Remove trailing newline from line.
	@param	lptr	Line pointer.
*/
void
dk4str_delnl(dkChar *lptr);

/**	Skip the first text words in a line, return pointer to start
	of next word.
	@param	line	Line to process.
	@param	skip	Number of words to skip.
	@return	Pointer to next word on success, NULL on error.
*/
const dkChar *
dk4str_skip(const dkChar *line, size_t skip);


/**	Sanitize string (overwrite using 0 bytes).
	@param	str	Address of string to sanitize.
	@return	1 on success, 0 on error.
*/
int
dk4str_sanitize(dkChar *str);

/**	Sanitize string buffer (overwrite using 0 bytes).
	@param	str	Address of string  buffer.
	@param	sz	Size of string buffer (number of dkChar).
	@return	1 on success, 0 on error.
*/
int
dk4str_buffer_sanitize(dkChar *str, size_t sz);

/**	Sanitize dynamically allocated memory and release it.
	@param	str	Address of string to sanitize and release.
	@return	1 on success, 0 on error.
*/
int
dk4str_free_sanitized(dkChar *str);

#ifdef __cplusplus
}
#endif


#if DK4_CHAR_SIZE > 1
/**	Sanitize string and release it, set pointer to NULL.
	@param	p	Pointer to string to release.
*/
#define	dk4str_release_sanitized(p) \
do { if (NULL != p) { (void)dk4strw_free_sanitized(p); } p = NULL; } while (0)
#else
/**	Sanitize string and release it, set pointer to NULL.
	@param	p	Pointer to string to release.
*/
#define	dk4str_release_sanitized(p) \
do { if (NULL != p) { (void)dk4str8_free_sanitized(p); } p = NULL; } while (0)
#endif


#endif