GM6000 Digital Heater Controller Branch: main
SDX-1330
strapi.h
Go to the documentation of this file.
1#ifndef Cpl_Text_strapi_h_
2#define Cpl_Text_strapi_h_
3/*-----------------------------------------------------------------------------
4* This file is part of the Colony.Core Project. The Colony.Core Project is an
5* open source project with a BSD type of licensing agreement. See the license
6* agreement (license.txt) in the top/ directory or on the Internet at
7* http://integerfox.com/colony.core/license.txt
8*
9* Copyright (c) 2014-2022 John T. Taylor
10*
11* Redistributions of the source code must retain the above copyright notice.
12*----------------------------------------------------------------------------*/
13/** @file
14
15 This file attempts to provide a "standardized" set of C library functions
16 that operate on C null terminated strings. In a perfect world there
17 would be no need for this interface since all compilers would follow
18 the ISO standards - however there are some compilers (VS comes to mind)
19 that still do no compile with C99 or C99 support as part of C++11. It
20 also facilities solutions for embedded platforms that need alternate
21 implementation of snprintf.
22
23 */
24
25#include "colony_map.h"
26
27
28
29 ///////////////////////////////////////////////////////////////////////////////
30
31 /** Compares two string ignoring case. It has the same semantics as
32 strcmp.
33
34 \b Prototype:
35 int strcasecmp(const char *s1, const char *s2);
36 */
37#ifndef HAVE_CPL_TEXT_STRCASECMP
38#define strcasecmp strcasecmp_MAP
39#endif
40
41
42 /** Same as strcasecmp, but only compares up to 'n' bytes. It has the same
43 semantics as strncmp.
44
45 \b Prototype:
46 int strncasecmp(const char *s1, const char *s2, size_t n);
47 */
48#ifndef HAVE_CPL_TEXT_STRNCASECMP
49#define strncasecmp strncasecmp_MAP
50#endif
51
52
53 /** Converts the entire string to upper case letters. Returns the
54 converted string (i.e. same pointer that is/was passed in)
55
56 \b Prototype:
57 char* strupr( char* s1 );
58 */
59#ifndef HAVE_CPL_TEXT_STRUPR
60#define strupr strupr_MAP
61#endif
62
63
64 /** Converts the entire string to lower case letters. Returns the
65 converted string (i.e. same pointer that is/was passed in)
66
67 \b Prototype:
68 char* strlwr( char* s1 );
69 */
70#ifndef HAVE_CPL_TEXT_STRLWR
71#define strlwr strlwr_MAP
72#endif
73
74 /** Fill a string with a given character. Returns the
75 converted string (i.e. same pointer that is/was passed in)
76
77 \b Prototype:
78 char* strset( char* s1, int fill );
79 */
80#ifndef HAVE_CPL_TEXT_STRSET
81#define strset strset_MAP
82#endif
83
84 /** Fill a string with a given character, to a given length. Returns the
85 converted string (i.e. same pointer that is/was passed in)
86
87 \b Prototype:
88 char* strnset( char* s1, int fill, size_t len );
89 */
90#ifndef HAVE_CPL_TEXT_STRNSET
91#define strnset strnset_MAP
92#endif
93
94
95 /** Reverse the specified string. Returns the reversed string (i.e. same
96 pointer that is/was passed in)
97
98 \b Prototype:
99 char* strrev( char* s1 );
100 */
101#ifndef HAVE_CPL_TEXT_STRREV
102#define strrev strrev_MAP
103#endif
104
105 /** Break a string into tokens, i.e. same as strtok(), but strtok_r is a
106 reentrant implementation. 'lasts' is the address of a pointer to a
107 character, which the function can use to store information necessary
108 for it to continue scanning the same string.
109
110 \b Prototype:
111 char* strtok_r( char* s, const char* sep, char** lasts );
112 */
113#ifndef HAVE_CPL_TEXT_STRTOK_R
114#define strtok_r strtok_r_MAP
115#endif
116
117 /** Same functionality as snprintf(), except at most 'count-1' character
118 will be stored in the output string. The result is guaranteed to be
119 null terminated.
120
121 Returns the number of characters that would have been written into the
122 array, not counting the terminating null character, had count been
123 large enough. It does this even if count is zero; in this case buf can
124 be NULL. If an error occurred, snprintf() returns a negative value
125 and sets errno.
126
127 \b Prototype:
128 int snprintf( char* buf, size_t count, const char* format, ... );
129 */
130#ifndef HAVE_CPL_TEXT_SNPRINTF
131#define snprintf snprintf_MAP
132#endif
133
134 /** Same as snprintf except uses vaargs arguments.
135
136 \b Prototype:
137 int vsnprintf(char *str, size_t size, const char *format, va_list ap);
138 */
139#ifndef HAVE_CPL_TEXT_VSNPRINTF
140#define vsnprintf vsnprintf_MAP
141#endif
142
143
144
145#endif // end header latch
Generated on Sat Jan 18 2025 22:23:55 for GM6000 Digital Heater Controller by doxygen 1.9.8