Nilorea Library
C utilities for networking, threading, graphics
Loading...
Searching...
No Matches
ex_nstr.c
Go to the documentation of this file.
1/*
2 * Nilorea Library
3 * Copyright (C) 2005-2026 Castagnier Mickael
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
14 * implied. See the License for the specific language governing
15 * permissions and limitations under the License.
16 *
17 * SPDX-License-Identifier: Apache-2.0
18 */
19
28#include "nilorea/n_str.h"
29#include "nilorea/n_log.h"
30
31int main(void) {
33
34 char* chardest = NULL;
35 NSTRBYTE written = 0,
36 length = 0;
37
38 write_and_fit(&chardest, &length, &written, "Hello");
39 n_log(LOG_INFO, "charstr (%d/%d): %s", written, length, chardest);
40 write_and_fit(&chardest, &length, &written, " ");
41 n_log(LOG_INFO, "charstr (%d/%d): %s", written, length, chardest);
42 write_and_fit(&chardest, &length, &written, "world !");
43 n_log(LOG_INFO, "charstr (%d/%d): %s", written, length, chardest);
44 write_and_fit(&chardest, &length, &written, "world ! ");
45 n_log(LOG_INFO, "charstr (%d/%d): %s", written, length, chardest);
46 write_and_fit(&chardest, &length, &written, "world ! ");
47 n_log(LOG_INFO, "charstr (%d/%d): %s", written, length, chardest);
48 write_and_fit(&chardest, &length, &written, "world ! ");
49 n_log(LOG_INFO, "charstr (%d/%d): %s", written, length, chardest);
50
51 Free(chardest);
52 written = length = 0;
53
54 write_and_fit_ex(&chardest, &length, &written, "Hello", 5, 0);
55 n_log(LOG_INFO, "charstr (%d/%d): %s", written, length, chardest);
56 write_and_fit_ex(&chardest, &length, &written, " ", 1, 0);
57 n_log(LOG_INFO, "charstr (%d/%d): %s", written, length, chardest);
58 write_and_fit_ex(&chardest, &length, &written, "world !", 7, 0);
59 n_log(LOG_INFO, "charstr (%d/%d): %s", written, length, chardest);
60 write_and_fit_ex(&chardest, &length, &written, "Hello", 5, 0);
61 n_log(LOG_INFO, "charstr (%d/%d): %s", written, length, chardest);
62 write_and_fit_ex(&chardest, &length, &written, " ", 1, 10); // alocate 10 more byte if resize needed
63 n_log(LOG_INFO, "charstr (%d/%d): %s", written, length, chardest);
64 write_and_fit_ex(&chardest, &length, &written, "world !", 7, 0);
65 n_log(LOG_INFO, "charstr (%d/%d): %s", written, length, chardest);
66
67 Free(chardest);
68
69 N_STR* nstr = NULL;
70
71 n_log(LOG_INFO, "NULL str:%s", _nstr(nstr));
72
73 nstrprintf(nstr, "Hello, file is %s line %d date %s", __FILE__, __LINE__, __TIME__);
74
75 n_log(LOG_INFO, "str:%s", _nstr(nstr));
76
77 nstrprintf_cat(nstr, " - This will be added at file %s line %d date %s", __FILE__, __LINE__, __TIME__);
78
79 n_log(LOG_INFO, "str:%s", _nstr(nstr));
80
81 free_nstr(&nstr);
82
83 nstr = new_nstr(0);
84
85 n_log(LOG_INFO, "EMPTY str:%s", _nstr(nstr));
86
87 nstrprintf(nstr, "Hello, file is %s line %d date %s", __FILE__, __LINE__, __TIME__);
88
89 n_log(LOG_INFO, "str:%s", _nstr(nstr));
90
91 nstrprintf_cat(nstr, " - This will be added at file %s line %d date %s", __FILE__, __LINE__, __TIME__);
92
93 n_log(LOG_INFO, "str:%s", _nstr(nstr));
94
95 nstrprintf_cat(nstr, " - some more texte");
96
97 N_STR* nstr2 = nstrdup(nstr);
98
99 n_log(LOG_INFO, "str: %s\n str2: %s", _nstr(nstr), _nstr(nstr2));
100
101 N_STR* nstr3 = NULL;
102
103 nstrcat(nstr3, nstr);
104 nstrcat(nstr3, nstr2);
105
106 n_log(LOG_INFO, "str:%s", _nstr(nstr3));
107
108 free_nstr(&nstr3);
109
110 nstr3 = new_nstr(10);
111
112 nstrcat(nstr3, nstr);
113 nstrcat(nstr3, nstr2);
114
115 n_log(LOG_INFO, "str:%s", _nstr(nstr3));
116
117 free_nstr(&nstr);
118 free_nstr(&nstr2);
119 free_nstr(&nstr3);
120
121 nstr = new_nstr(128);
122 char data[1048576] = "";
123
124 for (int it = 0; it < 1048575; it++) {
125 data[it] = (char)(32 + rand() % 63);
126 }
127 data[1048574] = '\0';
128
129 for (int it = 0; it < 100; it++) {
130 write_and_fit(&nstr->data, &nstr->length, &nstr->written, data);
131 }
132
133 free_nstr(&nstr);
134
135 /* test char_to_nstr and empty_nstr */
136 nstr = char_to_nstr("char_to_nstr test");
137 n_log(LOG_INFO, "char_to_nstr: %s", _nstr(nstr));
138 empty_nstr(nstr);
139 n_log(LOG_INFO, "after empty_nstr: '%s' written=%zu", _nstr(nstr), nstr->written);
140 free_nstr(&nstr);
141
142 /* test trim */
143 char* trimmed = trim(" spaces around ");
144 if (trimmed) {
145 n_log(LOG_INFO, "trim result: '%s'", trimmed);
146 Free(trimmed);
147 }
148 /* test trim_nocopy */
149 char trimbuf[] = " hello ";
150 char* trimptr = trim_nocopy(trimbuf);
151 n_log(LOG_INFO, "trim_nocopy result: '%s'", trimptr);
152
153 /* test str_to_int, str_to_long, str_to_long_long */
154 int ival = 0;
155 if (str_to_int("12345", &ival, 10) == TRUE) {
156 n_log(LOG_INFO, "str_to_int: %d", ival);
157 }
158 long int lval = 0;
159 if (str_to_long("9876543210", &lval, 10) == TRUE) {
160 n_log(LOG_INFO, "str_to_long: %ld", lval);
161 }
162 long long int llval = 0;
163 if (str_to_long_long("123456789012345", &llval, 10) == TRUE) {
164 n_log(LOG_INFO, "str_to_long_long: %lld", llval);
165 }
166
167 /* test strup, strlo */
168 char upper[32] = "";
169 char lower[32] = "";
170 strup("hello world", upper);
171 n_log(LOG_INFO, "strup: %s", upper);
172 strlo("HELLO WORLD", lower);
173 n_log(LOG_INFO, "strlo: %s", lower);
174
175 /* test split, split_count, join, free_split_result */
176 char** parts = split("one:two:three:four", ":", 0);
177 if (parts) {
178 int count = split_count(parts);
179 n_log(LOG_INFO, "split count: %d", count);
180 for (int it = 0; it < count; it++) {
181 n_log(LOG_INFO, " split[%d]: %s", it, parts[it]);
182 }
183 char* joined = join(parts, " - ");
184 if (joined) {
185 n_log(LOG_INFO, "join result: %s", joined);
186 Free(joined);
187 }
188 free_split_result(&parts);
189 }
190
191 /* test wildmat, wildmatcase */
192 n_log(LOG_INFO, "wildmat(\"hello.txt\", \"*.txt\"): %d", wildmat("hello.txt", "*.txt"));
193 n_log(LOG_INFO, "wildmat(\"hello.txt\", \"*.csv\"): %d", wildmat("hello.txt", "*.csv"));
194 n_log(LOG_INFO, "wildmatcase(\"Hello.TXT\", \"*.txt\"): %d", wildmatcase("Hello.TXT", "*.txt"));
195
196 /* test str_replace */
197 char* replaced = str_replace("hello world hello", "hello", "bye");
198 if (replaced) {
199 n_log(LOG_INFO, "str_replace: %s", replaced);
200 Free(replaced);
201 }
202
203 /* test str_sanitize */
204 char sanitize_buf[] = "hello; rm -rf /";
205 str_sanitize(sanitize_buf, ";/", '_');
206 n_log(LOG_INFO, "str_sanitize: %s", sanitize_buf);
207
208 /* test file_to_nstr and nstr_to_file */
209 N_STR* file_content = char_to_nstr("file content test\nsecond line\n");
210 nstr_to_file(file_content, "nilorea_nstr_test.txt");
211 free_nstr(&file_content);
212 file_content = file_to_nstr("nilorea_nstr_test.txt");
213 if (file_content) {
214 n_log(LOG_INFO, "file_to_nstr: %s", _nstr(file_content));
215 free_nstr(&file_content);
216 }
217
218 /* an empty (0-byte) file is a valid read: file_to_nstr must return an empty
219 N_STR (data != NULL, written == 0), not NULL, and must log no error */
220 FILE* empty_fp = fopen("nilorea_nstr_empty.txt", "wb");
221 if (empty_fp)
222 fclose(empty_fp);
223 N_STR* empty_content = file_to_nstr("nilorea_nstr_empty.txt");
224 if (empty_content && empty_content->data && empty_content->written == 0)
225 n_log(LOG_INFO, "file_to_nstr on an empty file: OK (empty string, no error)");
226 else
227 n_log(LOG_ERR, "file_to_nstr on an empty file: FAILED (expected an empty N_STR)");
228 if (empty_content)
229 free_nstr(&empty_content);
230
231 /* test skipw, skipu */
232 char skipbuf[] = " hello";
233 NSTRBYTE it = 0;
234 skipw(skipbuf, ' ', &it, 1);
235 n_log(LOG_INFO, "skipw past spaces: pos=%zu char='%c'", it, skipbuf[it]);
236 it = 0;
237 skipu(skipbuf, 'h', &it, 1);
238 n_log(LOG_INFO, "skipu to 'h': pos=%zu char='%c'", it, skipbuf[it]);
239
240 /* test resize_nstr */
241 nstr = new_nstr(16);
242 n_log(LOG_INFO, "before resize: length=%zu", nstr->length);
243 resize_nstr(nstr, 256);
244 n_log(LOG_INFO, "after resize: length=%zu", nstr->length);
245 free_nstr(&nstr);
246
247 /* test scan_dir */
248 LIST* dir_list = new_generic_list(0);
249 if (scan_dir(".", dir_list, 0) == TRUE) {
250 n_log(LOG_INFO, "scan_dir found %zu entries", dir_list->nb_items);
251 }
252 list_destroy(&dir_list);
253
254 /* test n_str_url_encode */
255 int url_encode_errors = 0;
256
257 /* NULL input -> NULL */
258 N_STR* encoded = n_str_url_encode(NULL);
259 if (encoded != NULL) {
260 n_log(LOG_ERR, "FAIL: n_str_url_encode(NULL) expected NULL, got \"%s\"", _nstr(encoded));
261 url_encode_errors++;
262 free_nstr(&encoded);
263 } else {
264 n_log(LOG_INFO, "PASS: n_str_url_encode(NULL) == NULL");
265 }
266
267 /* empty string -> empty result */
268 encoded = n_str_url_encode("");
269 if (!encoded || strcmp(_nstr(encoded), "") != 0) {
270 n_log(LOG_ERR, "FAIL: n_str_url_encode(\"\") expected \"\", got \"%s\"", encoded ? _nstr(encoded) : "NULL");
271 url_encode_errors++;
272 } else {
273 n_log(LOG_INFO, "PASS: n_str_url_encode(\"\") == \"\"");
274 }
275 free_nstr(&encoded);
276
277 /* unreserved characters (A-Z a-z 0-9 - _ . ~) must be kept verbatim */
278 encoded = n_str_url_encode("Hello-World_1.0~");
279 if (!encoded || strcmp(_nstr(encoded), "Hello-World_1.0~") != 0) {
280 n_log(LOG_ERR, "FAIL: n_str_url_encode(\"Hello-World_1.0~\") expected verbatim, got \"%s\"", encoded ? _nstr(encoded) : "NULL");
281 url_encode_errors++;
282 } else {
283 n_log(LOG_INFO, "PASS: n_str_url_encode(\"Hello-World_1.0~\") == \"Hello-World_1.0~\"");
284 }
285 free_nstr(&encoded);
286
287 /* reserved / special characters must be percent-encoded */
288 encoded = n_str_url_encode("foo bar&baz=qux/path?q=1#frag");
289 const char* expected_reserved = "foo%20bar%26baz%3Dqux%2Fpath%3Fq%3D1%23frag";
290 if (!encoded || strcmp(_nstr(encoded), expected_reserved) != 0) {
291 n_log(LOG_ERR, "FAIL: n_str_url_encode(reserved chars) expected \"%s\", got \"%s\"", expected_reserved, encoded ? _nstr(encoded) : "NULL");
292 url_encode_errors++;
293 } else {
294 n_log(LOG_INFO, "PASS: n_str_url_encode(\"foo bar&baz=qux/path?q=1#frag\") == \"%s\"", expected_reserved);
295 }
296 free_nstr(&encoded);
297
298 /* bytes >= 0x80 (high-byte / non-ASCII) must be percent-encoded */
299 encoded = n_str_url_encode("\xC3\xA9\xFF");
300 if (!encoded || strcmp(_nstr(encoded), "%C3%A9%FF") != 0) {
301 n_log(LOG_ERR, "FAIL: n_str_url_encode(high bytes) expected \"%s\", got \"%s\"", "%C3%A9%FF", encoded ? _nstr(encoded) : "NULL");
302 url_encode_errors++;
303 } else {
304 n_log(LOG_INFO, "PASS: n_str_url_encode(\"\\xC3\\xA9\\xFF\") == \"%s\"", "%C3%A9%FF");
305 }
306 free_nstr(&encoded);
307
308 if (url_encode_errors > 0) {
309 n_log(LOG_ERR, "n_str_url_encode: %d test(s) failed", url_encode_errors);
310 exit(1);
311 }
312
313 exit(0);
314}
int main(void)
#define Free(__ptr)
Free Handler to get errors.
Definition n_common.h:263
#define _nstr(__PTR)
N_STR or "NULL" string for logging purposes.
Definition n_common.h:199
size_t nb_items
number of item currently in the list
Definition n_list.h:61
int list_destroy(LIST **list)
Empty and Free a list container.
Definition n_list.c:548
LIST * new_generic_list(size_t max_items)
Initialiaze a generic list container to max_items pointers.
Definition n_list.c:37
Structure of a generic LIST container.
Definition n_list.h:59
#define n_log(__LEVEL__,...)
Logging function wrapper to get line and func.
Definition n_log.h:89
#define LOG_DEBUG
debug-level messages
Definition n_log.h:84
#define LOG_ERR
error conditions
Definition n_log.h:76
void set_log_level(const int log_level)
Set the global log level value ( static int LOG_LEVEL )
Definition n_log.c:121
#define LOG_INFO
informational
Definition n_log.h:82
size_t written
number of meaningful bytes in data, excluding the null terminator; the size including the null termin...
Definition n_str.h:68
char * data
the string
Definition n_str.h:63
size_t length
total allocation (in bytes) of the data buffer, padding included
Definition n_str.h:65
int str_to_long_long(const char *s, long long int *i, const int base)
Helper for string to integer.
Definition n_str.c:703
char * trim_nocopy(char *s)
trim and zero end the string, WARNING: keep and original pointer to delete the string correctly
Definition n_str.c:123
N_STR * n_str_url_encode(const char *src)
Percent-encode a C string per RFC 3986 (unreserved set kept as-is).
Definition n_str.c:1725
size_t NSTRBYTE
N_STR base unit.
Definition n_str.h:58
#define free_nstr(__ptr)
free a N_STR structure and set the pointer to NULL
Definition n_str.h:203
int split_count(char **split_result)
Count split elements.
Definition n_str.c:1000
int nstr_to_file(N_STR *str, char *filename)
Write a N_STR content into a file.
Definition n_str.c:424
char * join(char **splitresult, const char *delim)
join the array into a string
Definition n_str.c:1037
#define nstrcat(__nstr_dst, __nstr_src)
Macro to quickly concatenate two N_STR.
Definition n_str.h:125
N_STR * nstrdup(N_STR *str)
Duplicate a N_STR.
Definition n_str.c:716
int strlo(const char *string, char *dest)
Lower case a string.
Definition n_str.c:861
int write_and_fit(char **dest, NSTRBYTE *size, NSTRBYTE *written, const char *src)
Append src to *dest.
Definition n_str.c:1229
#define nstrprintf_cat(__nstr_var, __format,...)
Macro to quickly allocate and sprintf and cat to a N_STR.
Definition n_str.h:121
int resize_nstr(N_STR *nstr, size_t size)
reallocate a nstr internal buffer.
Definition n_str.c:1534
N_STR * char_to_nstr(const char *src)
Convert a char into a N_STR, short version.
Definition n_str.c:255
int skipu(const char *string, char toskip, NSTRBYTE *iterator, int inc)
skip until 'toskip' occurence is found from 'iterator' to the next 'toskip' value.
Definition n_str.c:794
int empty_nstr(N_STR *nstr)
empty a N_STR string
Definition n_str.c:192
int wildmatcase(register const char *text, register const char *p)
Written by Rich Salz rsalz at osf.org, refurbished by me.
Definition n_str.c:1382
N_STR * new_nstr(NSTRBYTE size)
create a new N_STR string
Definition n_str.c:207
char * str_replace(const char *string, const char *substr, const char *replacement)
Replace "substr" by "replacement" inside string taken from http://coding.debuntu.org/c-implementing-s...
Definition n_str.c:1448
char * trim(const char *s)
trim and put a \0 at the end, return new char *
Definition n_str.c:152
int skipw(const char *string, char toskip, NSTRBYTE *iterator, int inc)
skip while 'toskip' occurence is found from 'iterator' to the next non 'toskip' position.
Definition n_str.c:747
#define nstrprintf(__nstr_var, __format,...)
Macro to quickly allocate and sprintf to N_STR.
Definition n_str.h:117
int scan_dir(const char *dir, LIST *result, const int recurse)
Scan a list of directory and return a list of char *file.
Definition n_str.c:1240
int str_sanitize(char *string, const char *mask, const char replacement)
clean a string by replacing evil characteres
Definition n_str.c:1524
char ** split(const char *str, const char *delim, int empty)
split the strings into a an array of char *pointer , ended by a NULL one.
Definition n_str.c:920
int wildmat(register const char *text, register const char *p)
Written by Rich Salz rsalz at osf.org, refurbished by me.
Definition n_str.c:1318
int str_to_long(const char *s, long int *i, const int base)
Helper for string to integer.
Definition n_str.c:688
int write_and_fit_ex(char **dest, NSTRBYTE *size, NSTRBYTE *written, const char *src, NSTRBYTE src_size, NSTRBYTE additional_padding)
Append src_size bytes from src to *dest, updating size/written, growing the buffer if needed.
Definition n_str.c:1187
N_STR * file_to_nstr(char *filename)
Load a whole file into a N_STR.
Definition n_str.c:288
int free_split_result(char ***tab)
Free a split result allocated array.
Definition n_str.c:1016
int str_to_int(const char *s, int *i, const int base)
Helper for string to integer.
Definition n_str.c:553
int strup(const char *string, char *dest)
Upper case a string.
Definition n_str.c:840
A box including a string and his lenght.
Definition n_str.h:61
Generic log system.
N_STR and string function declaration.