summaryrefslogtreecommitdiff
path: root/support/dktools/dk4strw.h
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-09-20 03:03:26 +0000
committerNorbert Preining <norbert@preining.info>2020-09-20 03:03:26 +0000
commit1f457376b478257b88d4a857f5ec1b6155442dd7 (patch)
tree2a06a60551dea362cf8cb0cb0ba66c78608717c4 /support/dktools/dk4strw.h
parentac690ca29ad5bf8a5203a65fd6252f7b564f4727 (diff)
CTAN sync 202009200303
Diffstat (limited to 'support/dktools/dk4strw.h')
-rw-r--r--support/dktools/dk4strw.h77
1 files changed, 37 insertions, 40 deletions
diff --git a/support/dktools/dk4strw.h b/support/dktools/dk4strw.h
index 454b893a48..714a60c019 100644
--- a/support/dktools/dk4strw.h
+++ b/support/dktools/dk4strw.h
@@ -1,36 +1,14 @@
/*
- 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: dk4strw.ctr
+Copyright (C) 2015-2020, Dirk Krause
+SPDX-License-Identifier: BSD-3-Clause
*/
/*
-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.
+ WARNING: This file was generated by the dkct program (see
+ http://dktools.sourceforge.net/ for details).
+ 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: dk4strw.ctr
*/
#ifndef DK4STRW_H_INCLUDED
@@ -53,15 +31,27 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef DK4CONF_H_INCLUDED
+#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
+#else
+#include <dktools-4/dk4conf.h>
+#endif
#endif
#ifndef DK4TYPES_H_INCLUDED
+#if DK4_BUILDING_DKTOOLS4
#include "dk4types.h"
+#else
+#include <dktools-4/dk4types.h>
+#endif
#endif
#ifndef DK4ERROR_H_INCLUDED
+#if DK4_BUILDING_DKTOOLS4
#include "dk4error.h"
+#else
+#include <dktools-4/dk4error.h>
+#endif
#endif
#ifndef STDLIB_H_INCLUDED
@@ -82,7 +72,7 @@ extern "C" {
#endif
/** Copy string, check destination buffer size.
-
+
CRT on Windows: Optional.
@param dst Destination buffer address.
@param sz Destination buffer size.
@@ -100,7 +90,7 @@ int
dk4strw_cpy_s(wchar_t *dst, size_t sz, const wchar_t *src, dk4_er_t *erp);
/** Concatenate strings, check destination buffer size.
-
+
CRT on Windows: Optional.
@param dst Destination buffer address.
@param sz Destination buffer size.
@@ -167,7 +157,7 @@ dk4strw_ncmp(const wchar_t *s1, const wchar_t *s2, size_t n);
/** Compare two strings, case-insensitive comparison.
- CRT on Windows: Optional, disabling CRT probably degrades performance.
+ CRT on Windows: Optional.
@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.
@@ -224,7 +214,6 @@ wchar_t
dk4strw_tolower(wchar_t c);
/** Retrieve first token from *stringp.
-
CRT on Windows: Optional, disabling CRT degrades performance.
@param stringp Adress of string pointer.
@param delim String containing the delimiter set,
@@ -261,7 +250,6 @@ wchar_t *
dk4strw_next(wchar_t *src, const wchar_t *delim);
/** Split a string into tokens.
-
CRT on Windows: Optional, disabling CRT degrades performance.
@param dpp Pointer to string pointer array.
@param szdpp Size of destination string pointer array.
@@ -296,7 +284,7 @@ void
dk4strw_normalize(wchar_t *src, const wchar_t *delim);
/** Find index of a string in an array of strings.
-
+
CRT on Windows: Optional.
@param arr Array of strings.
@param str String to find in array.
@@ -307,7 +295,7 @@ int
dk4strw_array_index(const wchar_t * const *arr, const wchar_t *str, int cs);
/** Find index of a string in an array of strings.
-
+
CRT on windows: Optional, disabling CRT degrades performance
for case-insensitive comparisons.
@param arr Array of strings allowing abbreviation.
@@ -325,7 +313,7 @@ dk4strw_abbr_index(
);
/** Check whether a text matches a pattern, the text may be abbreviated.
-
+
CRT on windows: Optional, disabling CRT degrades performance
for case-insensitive comparisons.
@param str Text to check.
@@ -356,8 +344,7 @@ dk4strw_is_bool(const wchar_t *str);
int
dk4strw_is_on(const wchar_t *str);
-#if (defined(_WIN32) && DK4_USE_WINDOWS_LOCAL_ALLOC) \
- || (DK4_HAVE_MALLOC && DK4_HAVE_FREE)
+#if (DK4_ON_WINDOWS) || (DK4_HAVE_MALLOC && DK4_HAVE_FREE)
/** Duplicate string in dynamically allocated memory.
@@ -381,7 +368,7 @@ wchar_t *
dk4strw_dup(const wchar_t *src, dk4_er_t *erp);
#endif
-/* if (defined(_WIN32) ... */
+
/** Remove trailing white spaces.
@@ -394,6 +381,8 @@ void
dk4strw_rtwh(wchar_t *str, const wchar_t *whsp);
/** Remove trailing newline from line.
+
+ CRT on Windows: Not used.
@param lptr Line pointer.
*/
void
@@ -401,6 +390,8 @@ dk4strw_delnl(wchar_t *lptr);
/** Skip the first text words in a line, return pointer to start
of next word.
+
+ CRT on Windows: Optional, disabling CRT degrades performance.
@param line Line to process.
@param skip Number of words to skip.
@return Pointer to next word on success, NULL on error.
@@ -409,6 +400,8 @@ const wchar_t *
dk4strw_skip(const wchar_t *line, size_t skip);
/** Sanitize string (overwrite using 0).
+
+ CRT on Windows: Optional.
@param str Address of string to sanitize.
@return 1 on success, 0 on error.
*/
@@ -416,6 +409,8 @@ int
dk4strw_sanitize(wchar_t *str);
/** Sanitize string buffer (overwrite using 0 bytes).
+
+ CRT on Windows: Optional.
@param str Address of string buffer.
@param sz Size of string buffer (number of wchar_t).
@return 1 on success, 0 on error.
@@ -424,6 +419,8 @@ int
dk4strw_buffer_sanitize(wchar_t *str, size_t sz);
/** Sanitize dynamically allocated memory and release it.
+
+ CRT on Windows: Optional.
@param str Address of string to sanitize and release.
@return 1 on success, 0 on error.
*/