Mon, 18 Dec 2023 14:14:47 +0100
increase version number to 3.1
remove per-file version information
from Doxygen output
universe@576 | 1 | /* |
universe@576 | 2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
universe@576 | 3 | * |
universe@576 | 4 | * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved. |
universe@576 | 5 | * |
universe@576 | 6 | * Redistribution and use in source and binary forms, with or without |
universe@576 | 7 | * modification, are permitted provided that the following conditions are met: |
universe@576 | 8 | * |
universe@576 | 9 | * 1. Redistributions of source code must retain the above copyright |
universe@576 | 10 | * notice, this list of conditions and the following disclaimer. |
universe@576 | 11 | * |
universe@576 | 12 | * 2. Redistributions in binary form must reproduce the above copyright |
universe@576 | 13 | * notice, this list of conditions and the following disclaimer in the |
universe@576 | 14 | * documentation and/or other materials provided with the distribution. |
universe@576 | 15 | * |
universe@576 | 16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
universe@576 | 17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
universe@576 | 18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
universe@576 | 19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
universe@576 | 20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
universe@576 | 21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
universe@576 | 22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
universe@576 | 23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
universe@576 | 24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
universe@576 | 25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
universe@576 | 26 | * POSSIBILITY OF SUCH DAMAGE. |
universe@576 | 27 | */ |
universe@576 | 28 | /** |
universe@576 | 29 | * \file string.h |
universe@576 | 30 | * \brief Strings that know their length. |
universe@576 | 31 | * \author Mike Becker |
universe@576 | 32 | * \author Olaf Wintermann |
universe@576 | 33 | * \copyright 2-Clause BSD License |
universe@576 | 34 | */ |
universe@576 | 35 | |
universe@576 | 36 | #ifndef UCX_STRING_H |
universe@576 | 37 | #define UCX_STRING_H |
universe@576 | 38 | |
universe@576 | 39 | #include "common.h" |
universe@576 | 40 | #include "allocator.h" |
universe@576 | 41 | |
universe@576 | 42 | /** |
universe@576 | 43 | * The UCX string structure. |
universe@576 | 44 | */ |
universe@577 | 45 | struct cx_mutstr_s { |
universe@576 | 46 | /** |
universe@576 | 47 | * A pointer to the string. |
universe@576 | 48 | * \note The string is not necessarily \c NULL terminated. |
universe@576 | 49 | * Always use the length. |
universe@576 | 50 | */ |
universe@576 | 51 | char *ptr; |
universe@576 | 52 | /** The length of the string */ |
universe@576 | 53 | size_t length; |
universe@577 | 54 | }; |
universe@576 | 55 | |
universe@576 | 56 | /** |
universe@576 | 57 | * A mutable string. |
universe@576 | 58 | */ |
universe@576 | 59 | typedef struct cx_mutstr_s cxmutstr; |
universe@576 | 60 | |
universe@576 | 61 | /** |
universe@576 | 62 | * The UCX string structure for immutable (constant) strings. |
universe@576 | 63 | */ |
universe@577 | 64 | struct cx_string_s { |
universe@576 | 65 | /** |
universe@576 | 66 | * A pointer to the immutable string. |
universe@576 | 67 | * \note The string is not necessarily \c NULL terminated. |
universe@576 | 68 | * Always use the length. |
universe@576 | 69 | */ |
universe@576 | 70 | char const *ptr; |
universe@576 | 71 | /** The length of the string */ |
universe@576 | 72 | size_t length; |
universe@577 | 73 | }; |
universe@576 | 74 | |
universe@576 | 75 | /** |
universe@576 | 76 | * An immutable string. |
universe@576 | 77 | */ |
universe@576 | 78 | typedef struct cx_string_s cxstring; |
universe@576 | 79 | |
universe@583 | 80 | /** |
universe@645 | 81 | * Context for string tokenizing. |
universe@645 | 82 | */ |
universe@645 | 83 | struct cx_strtok_ctx_s { |
universe@645 | 84 | /** |
universe@645 | 85 | * The string to tokenize. |
universe@645 | 86 | */ |
universe@645 | 87 | cxstring str; |
universe@645 | 88 | /** |
universe@645 | 89 | * The primary delimiter. |
universe@645 | 90 | */ |
universe@645 | 91 | cxstring delim; |
universe@645 | 92 | /** |
universe@645 | 93 | * Optional array of more delimiters. |
universe@645 | 94 | */ |
universe@645 | 95 | cxstring const *delim_more; |
universe@645 | 96 | /** |
universe@645 | 97 | * Length of the array containing more delimiters. |
universe@645 | 98 | */ |
universe@645 | 99 | size_t delim_more_count; |
universe@645 | 100 | /** |
universe@645 | 101 | * Position of the currently active token in the source string. |
universe@645 | 102 | */ |
universe@645 | 103 | size_t pos; |
universe@645 | 104 | /** |
universe@645 | 105 | * Position of next delimiter in the source string. |
universe@645 | 106 | * |
universe@645 | 107 | * If the tokenizer has not yet returned a token, the content of this field |
universe@645 | 108 | * is undefined. If the tokenizer reached the end of the string, this field |
universe@645 | 109 | * contains the length of the source string. |
universe@645 | 110 | */ |
universe@645 | 111 | size_t delim_pos; |
universe@645 | 112 | /** |
universe@645 | 113 | * The position of the next token in the source string. |
universe@645 | 114 | */ |
universe@645 | 115 | size_t next_pos; |
universe@645 | 116 | /** |
universe@645 | 117 | * The number of already found tokens. |
universe@645 | 118 | */ |
universe@645 | 119 | size_t found; |
universe@645 | 120 | /** |
universe@645 | 121 | * The maximum number of tokens that shall be returned. |
universe@645 | 122 | */ |
universe@645 | 123 | size_t limit; |
universe@645 | 124 | }; |
universe@645 | 125 | |
universe@645 | 126 | /** |
universe@645 | 127 | * A string tokenizing context. |
universe@645 | 128 | */ |
universe@645 | 129 | typedef struct cx_strtok_ctx_s CxStrtokCtx; |
universe@645 | 130 | |
universe@684 | 131 | #ifdef __cplusplus |
universe@684 | 132 | extern "C" { |
universe@684 | 133 | |
universe@684 | 134 | /** |
universe@684 | 135 | * A literal initializer for an UCX string structure. |
universe@684 | 136 | * |
universe@684 | 137 | * @param literal the string literal |
universe@684 | 138 | */ |
universe@684 | 139 | #define CX_STR(literal) cxstring{literal, sizeof(literal) - 1} |
universe@684 | 140 | |
universe@684 | 141 | #else // __cplusplus |
universe@684 | 142 | |
universe@645 | 143 | /** |
universe@583 | 144 | * A literal initializer for an UCX string structure. |
universe@583 | 145 | * |
universe@583 | 146 | * The argument MUST be a string (const char*) \em literal. |
universe@583 | 147 | * |
universe@583 | 148 | * @param literal the string literal |
universe@583 | 149 | */ |
universe@684 | 150 | #define CX_STR(literal) (cxstring){literal, sizeof(literal) - 1} |
universe@583 | 151 | |
universe@576 | 152 | #endif |
universe@576 | 153 | |
universe@576 | 154 | |
universe@576 | 155 | /** |
universe@576 | 156 | * Wraps a mutable string that must be zero-terminated. |
universe@576 | 157 | * |
universe@576 | 158 | * The length is implicitly inferred by using a call to \c strlen(). |
universe@576 | 159 | * |
universe@576 | 160 | * \note the wrapped string will share the specified pointer to the string. |
universe@576 | 161 | * If you do want a copy, use cx_strdup() on the return value of this function. |
universe@576 | 162 | * |
universe@576 | 163 | * If you need to wrap a constant string, use cx_str(). |
universe@576 | 164 | * |
universe@584 | 165 | * @param cstring the string to wrap, must be zero-terminated |
universe@576 | 166 | * @return the wrapped string |
universe@576 | 167 | * |
universe@576 | 168 | * @see cx_mutstrn() |
universe@576 | 169 | */ |
universe@584 | 170 | __attribute__((__warn_unused_result__, __nonnull__)) |
universe@576 | 171 | cxmutstr cx_mutstr(char *cstring); |
universe@576 | 172 | |
universe@576 | 173 | /** |
universe@576 | 174 | * Wraps a string that does not need to be zero-terminated. |
universe@576 | 175 | * |
universe@576 | 176 | * The argument may be \c NULL if the length is zero. |
universe@576 | 177 | * |
universe@576 | 178 | * \note the wrapped string will share the specified pointer to the string. |
universe@576 | 179 | * If you do want a copy, use cx_strdup() on the return value of this function. |
universe@576 | 180 | * |
universe@576 | 181 | * If you need to wrap a constant string, use cx_strn(). |
universe@576 | 182 | * |
universe@584 | 183 | * @param cstring the string to wrap (or \c NULL, only if the length is zero) |
universe@576 | 184 | * @param length the length of the string |
universe@576 | 185 | * @return the wrapped string |
universe@576 | 186 | * |
universe@576 | 187 | * @see cx_mutstr() |
universe@576 | 188 | */ |
universe@576 | 189 | __attribute__((__warn_unused_result__)) |
universe@576 | 190 | cxmutstr cx_mutstrn( |
universe@576 | 191 | char *cstring, |
universe@576 | 192 | size_t length |
universe@576 | 193 | ); |
universe@576 | 194 | |
universe@576 | 195 | /** |
universe@576 | 196 | * Wraps a string that must be zero-terminated. |
universe@576 | 197 | * |
universe@576 | 198 | * The length is implicitly inferred by using a call to \c strlen(). |
universe@576 | 199 | * |
universe@576 | 200 | * \note the wrapped string will share the specified pointer to the string. |
universe@576 | 201 | * If you do want a copy, use cx_strdup() on the return value of this function. |
universe@576 | 202 | * |
universe@576 | 203 | * If you need to wrap a non-constant string, use cx_mutstr(). |
universe@576 | 204 | * |
universe@584 | 205 | * @param cstring the string to wrap, must be zero-terminated |
universe@576 | 206 | * @return the wrapped string |
universe@576 | 207 | * |
universe@576 | 208 | * @see cx_strn() |
universe@576 | 209 | */ |
universe@584 | 210 | __attribute__((__warn_unused_result__, __nonnull__)) |
universe@576 | 211 | cxstring cx_str(char const *cstring); |
universe@576 | 212 | |
universe@576 | 213 | |
universe@576 | 214 | /** |
universe@576 | 215 | * Wraps a string that does not need to be zero-terminated. |
universe@576 | 216 | * |
universe@576 | 217 | * The argument may be \c NULL if the length is zero. |
universe@576 | 218 | * |
universe@576 | 219 | * \note the wrapped string will share the specified pointer to the string. |
universe@576 | 220 | * If you do want a copy, use cx_strdup() on the return value of this function. |
universe@576 | 221 | * |
universe@576 | 222 | * If you need to wrap a non-constant string, use cx_mutstrn(). |
universe@576 | 223 | * |
universe@584 | 224 | * @param cstring the string to wrap (or \c NULL, only if the length is zero) |
universe@576 | 225 | * @param length the length of the string |
universe@576 | 226 | * @return the wrapped string |
universe@576 | 227 | * |
universe@576 | 228 | * @see cx_str() |
universe@576 | 229 | */ |
universe@576 | 230 | __attribute__((__warn_unused_result__)) |
universe@576 | 231 | cxstring cx_strn( |
universe@576 | 232 | char const *cstring, |
universe@576 | 233 | size_t length |
universe@576 | 234 | ); |
universe@576 | 235 | |
universe@576 | 236 | /** |
universe@576 | 237 | * Casts a mutable string to an immutable string. |
universe@576 | 238 | * |
universe@576 | 239 | * \note This is not seriously a cast. Instead you get a copy |
universe@576 | 240 | * of the struct with the desired pointer type. Both structs still |
universe@576 | 241 | * point to the same location, though! |
universe@576 | 242 | * |
universe@576 | 243 | * @param str the mutable string to cast |
universe@576 | 244 | * @return an immutable copy of the string pointer |
universe@576 | 245 | */ |
universe@576 | 246 | __attribute__((__warn_unused_result__)) |
universe@576 | 247 | cxstring cx_strcast(cxmutstr str); |
universe@576 | 248 | |
universe@576 | 249 | /** |
universe@576 | 250 | * Passes the pointer in this string to \c free(). |
universe@576 | 251 | * |
universe@576 | 252 | * The pointer in the struct is set to \c NULL and the length is set to zero. |
universe@576 | 253 | * |
universe@576 | 254 | * \note There is no implementation for cxstring, because it is unlikely that |
universe@576 | 255 | * you ever have a \c char \c const* you are really supposed to free. If you |
universe@576 | 256 | * encounter such situation, you should double-check your code. |
universe@576 | 257 | * |
universe@576 | 258 | * @param str the string to free |
universe@576 | 259 | */ |
universe@583 | 260 | __attribute__((__nonnull__)) |
universe@576 | 261 | void cx_strfree(cxmutstr *str); |
universe@576 | 262 | |
universe@576 | 263 | /** |
universe@583 | 264 | * Passes the pointer in this string to the allocators free function. |
universe@583 | 265 | * |
universe@583 | 266 | * The pointer in the struct is set to \c NULL and the length is set to zero. |
universe@583 | 267 | * |
universe@583 | 268 | * \note There is no implementation for cxstring, because it is unlikely that |
universe@583 | 269 | * you ever have a \c char \c const* you are really supposed to free. If you |
universe@583 | 270 | * encounter such situation, you should double-check your code. |
universe@583 | 271 | * |
universe@583 | 272 | * @param alloc the allocator |
universe@583 | 273 | * @param str the string to free |
universe@583 | 274 | */ |
universe@583 | 275 | __attribute__((__nonnull__)) |
universe@583 | 276 | void cx_strfree_a( |
universe@693 | 277 | CxAllocator const *alloc, |
universe@583 | 278 | cxmutstr *str |
universe@583 | 279 | ); |
universe@583 | 280 | |
universe@583 | 281 | /** |
universe@576 | 282 | * Returns the accumulated length of all specified strings. |
universe@576 | 283 | * |
universe@576 | 284 | * \attention if the count argument is larger than the number of the |
universe@576 | 285 | * specified strings, the behavior is undefined. |
universe@576 | 286 | * |
universe@576 | 287 | * @param count the total number of specified strings |
universe@576 | 288 | * @param ... all strings |
universe@576 | 289 | * @return the accumulated length of all strings |
universe@576 | 290 | */ |
universe@576 | 291 | __attribute__((__warn_unused_result__)) |
universe@576 | 292 | size_t cx_strlen( |
universe@576 | 293 | size_t count, |
universe@576 | 294 | ... |
universe@576 | 295 | ); |
universe@576 | 296 | |
universe@576 | 297 | /** |
universe@697 | 298 | * Concatenates strings. |
universe@576 | 299 | * |
universe@576 | 300 | * The resulting string will be allocated by the specified allocator. |
universe@697 | 301 | * So developers \em must pass the return value to cx_strfree_a() eventually. |
universe@697 | 302 | * |
universe@697 | 303 | * If \p str already contains a string, the memory will be reallocated and |
universe@697 | 304 | * the other strings are appended. Otherwise, new memory is allocated. |
universe@697 | 305 | * |
universe@697 | 306 | * \note It is guaranteed that there is only one allocation. |
universe@697 | 307 | * It is also guaranteed that the returned string is zero-terminated. |
universe@576 | 308 | * |
universe@576 | 309 | * @param alloc the allocator to use |
universe@697 | 310 | * @param str the string the other strings shall be concatenated to |
universe@697 | 311 | * @param count the number of the other following strings to concatenate |
universe@697 | 312 | * @param ... all other strings |
universe@576 | 313 | * @return the concatenated string |
universe@576 | 314 | */ |
universe@576 | 315 | __attribute__((__warn_unused_result__, __nonnull__)) |
universe@697 | 316 | cxmutstr cx_strcat_ma( |
universe@693 | 317 | CxAllocator const *alloc, |
universe@697 | 318 | cxmutstr str, |
universe@576 | 319 | size_t count, |
universe@576 | 320 | ... |
universe@576 | 321 | ); |
universe@576 | 322 | |
universe@576 | 323 | /** |
universe@697 | 324 | * Concatenates strings and returns a new string. |
universe@697 | 325 | * |
universe@697 | 326 | * The resulting string will be allocated by the specified allocator. |
universe@697 | 327 | * So developers \em must pass the return value to cx_strfree_a() eventually. |
universe@697 | 328 | * |
universe@697 | 329 | * \note It is guaranteed that there is only one allocation. |
universe@697 | 330 | * It is also guaranteed that the returned string is zero-terminated. |
universe@697 | 331 | * |
universe@697 | 332 | * @param alloc the allocator to use |
universe@697 | 333 | * @param count the number of the other following strings to concatenate |
universe@697 | 334 | * @param ... all other strings |
universe@697 | 335 | * @return the concatenated string |
universe@697 | 336 | */ |
universe@697 | 337 | #define cx_strcat_a(alloc, count, ...) \ |
universe@697 | 338 | cx_strcat_ma(alloc, cx_mutstrn(NULL, 0), count, __VA_ARGS__) |
universe@697 | 339 | |
universe@697 | 340 | /** |
universe@697 | 341 | * Concatenates strings and returns a new string. |
universe@576 | 342 | * |
universe@576 | 343 | * The resulting string will be allocated by standard \c malloc(). |
universe@576 | 344 | * So developers \em must pass the return value to cx_strfree() eventually. |
universe@576 | 345 | * |
universe@589 | 346 | * \note It is guaranteed that there is only one allocation. |
universe@589 | 347 | * It is also guaranteed that the returned string is zero-terminated. |
universe@589 | 348 | * |
universe@697 | 349 | * @param count the number of the other following strings to concatenate |
universe@697 | 350 | * @param ... all other strings |
universe@576 | 351 | * @return the concatenated string |
universe@576 | 352 | */ |
universe@576 | 353 | #define cx_strcat(count, ...) \ |
universe@697 | 354 | cx_strcat_ma(cxDefaultAllocator, cx_mutstrn(NULL, 0), count, __VA_ARGS__) |
universe@697 | 355 | |
universe@697 | 356 | /** |
universe@697 | 357 | * Concatenates strings. |
universe@697 | 358 | * |
universe@697 | 359 | * The resulting string will be allocated by standard \c malloc(). |
universe@697 | 360 | * So developers \em must pass the return value to cx_strfree() eventually. |
universe@697 | 361 | * |
universe@697 | 362 | * If \p str already contains a string, the memory will be reallocated and |
universe@697 | 363 | * the other strings are appended. Otherwise, new memory is allocated. |
universe@697 | 364 | * |
universe@697 | 365 | * \note It is guaranteed that there is only one allocation. |
universe@697 | 366 | * It is also guaranteed that the returned string is zero-terminated. |
universe@697 | 367 | * |
universe@697 | 368 | * @param str the string the other strings shall be concatenated to |
universe@697 | 369 | * @param count the number of the other following strings to concatenate |
universe@697 | 370 | * @param ... all other strings |
universe@697 | 371 | * @return the concatenated string |
universe@697 | 372 | */ |
universe@697 | 373 | #define cx_strcat_m(str, count, ...) \ |
universe@697 | 374 | cx_strcat_ma(cxDefaultAllocator, str, count, __VA_ARGS__) |
universe@576 | 375 | |
universe@576 | 376 | /** |
universe@576 | 377 | * Returns a substring starting at the specified location. |
universe@576 | 378 | * |
universe@576 | 379 | * \attention the new string references the same memory area as the |
universe@576 | 380 | * input string and is usually \em not zero-terminated. |
universe@576 | 381 | * Use cx_strdup() to get a copy. |
universe@576 | 382 | * |
universe@576 | 383 | * @param string input string |
universe@576 | 384 | * @param start start location of the substring |
universe@576 | 385 | * @return a substring of \p string starting at \p start |
universe@576 | 386 | * |
universe@576 | 387 | * @see cx_strsubsl() |
universe@576 | 388 | * @see cx_strsubs_m() |
universe@576 | 389 | * @see cx_strsubsl_m() |
universe@576 | 390 | */ |
universe@576 | 391 | __attribute__((__warn_unused_result__)) |
universe@576 | 392 | cxstring cx_strsubs( |
universe@576 | 393 | cxstring string, |
universe@576 | 394 | size_t start |
universe@576 | 395 | ); |
universe@576 | 396 | |
universe@576 | 397 | /** |
universe@576 | 398 | * Returns a substring starting at the specified location. |
universe@576 | 399 | * |
universe@576 | 400 | * The returned string will be limited to \p length bytes or the number |
universe@576 | 401 | * of bytes available in \p string, whichever is smaller. |
universe@576 | 402 | * |
universe@576 | 403 | * \attention the new string references the same memory area as the |
universe@576 | 404 | * input string and is usually \em not zero-terminated. |
universe@576 | 405 | * Use cx_strdup() to get a copy. |
universe@576 | 406 | * |
universe@576 | 407 | * @param string input string |
universe@576 | 408 | * @param start start location of the substring |
universe@576 | 409 | * @param length the maximum length of the returned string |
universe@576 | 410 | * @return a substring of \p string starting at \p start |
universe@576 | 411 | * |
universe@576 | 412 | * @see cx_strsubs() |
universe@576 | 413 | * @see cx_strsubs_m() |
universe@576 | 414 | * @see cx_strsubsl_m() |
universe@576 | 415 | */ |
universe@576 | 416 | __attribute__((__warn_unused_result__)) |
universe@576 | 417 | cxstring cx_strsubsl( |
universe@576 | 418 | cxstring string, |
universe@576 | 419 | size_t start, |
universe@576 | 420 | size_t length |
universe@576 | 421 | ); |
universe@576 | 422 | |
universe@576 | 423 | /** |
universe@576 | 424 | * Returns a substring starting at the specified location. |
universe@576 | 425 | * |
universe@576 | 426 | * \attention the new string references the same memory area as the |
universe@576 | 427 | * input string and is usually \em not zero-terminated. |
universe@576 | 428 | * Use cx_strdup() to get a copy. |
universe@576 | 429 | * |
universe@576 | 430 | * @param string input string |
universe@576 | 431 | * @param start start location of the substring |
universe@576 | 432 | * @return a substring of \p string starting at \p start |
universe@576 | 433 | * |
universe@576 | 434 | * @see cx_strsubsl_m() |
universe@576 | 435 | * @see cx_strsubs() |
universe@576 | 436 | * @see cx_strsubsl() |
universe@576 | 437 | */ |
universe@576 | 438 | __attribute__((__warn_unused_result__)) |
universe@576 | 439 | cxmutstr cx_strsubs_m( |
universe@576 | 440 | cxmutstr string, |
universe@576 | 441 | size_t start |
universe@576 | 442 | ); |
universe@576 | 443 | |
universe@576 | 444 | /** |
universe@576 | 445 | * Returns a substring starting at the specified location. |
universe@576 | 446 | * |
universe@576 | 447 | * The returned string will be limited to \p length bytes or the number |
universe@576 | 448 | * of bytes available in \p string, whichever is smaller. |
universe@576 | 449 | * |
universe@576 | 450 | * \attention the new string references the same memory area as the |
universe@576 | 451 | * input string and is usually \em not zero-terminated. |
universe@576 | 452 | * Use cx_strdup() to get a copy. |
universe@576 | 453 | * |
universe@576 | 454 | * @param string input string |
universe@576 | 455 | * @param start start location of the substring |
universe@576 | 456 | * @param length the maximum length of the returned string |
universe@576 | 457 | * @return a substring of \p string starting at \p start |
universe@576 | 458 | * |
universe@576 | 459 | * @see cx_strsubs_m() |
universe@576 | 460 | * @see cx_strsubs() |
universe@576 | 461 | * @see cx_strsubsl() |
universe@576 | 462 | */ |
universe@576 | 463 | __attribute__((__warn_unused_result__)) |
universe@576 | 464 | cxmutstr cx_strsubsl_m( |
universe@576 | 465 | cxmutstr string, |
universe@576 | 466 | size_t start, |
universe@576 | 467 | size_t length |
universe@576 | 468 | ); |
universe@576 | 469 | |
universe@576 | 470 | /** |
universe@576 | 471 | * Returns a substring starting at the location of the first occurrence of the |
universe@576 | 472 | * specified character. |
universe@576 | 473 | * |
universe@576 | 474 | * If the string does not contain the character, an empty string is returned. |
universe@576 | 475 | * |
universe@576 | 476 | * @param string the string where to locate the character |
universe@576 | 477 | * @param chr the character to locate |
universe@576 | 478 | * @return a substring starting at the first location of \p chr |
universe@576 | 479 | * |
universe@576 | 480 | * @see cx_strchr_m() |
universe@576 | 481 | */ |
universe@576 | 482 | __attribute__((__warn_unused_result__)) |
universe@576 | 483 | cxstring cx_strchr( |
universe@576 | 484 | cxstring string, |
universe@576 | 485 | int chr |
universe@576 | 486 | ); |
universe@576 | 487 | |
universe@576 | 488 | /** |
universe@576 | 489 | * Returns a substring starting at the location of the first occurrence of the |
universe@576 | 490 | * specified character. |
universe@576 | 491 | * |
universe@576 | 492 | * If the string does not contain the character, an empty string is returned. |
universe@576 | 493 | * |
universe@576 | 494 | * @param string the string where to locate the character |
universe@576 | 495 | * @param chr the character to locate |
universe@576 | 496 | * @return a substring starting at the first location of \p chr |
universe@576 | 497 | * |
universe@576 | 498 | * @see cx_strchr() |
universe@576 | 499 | */ |
universe@576 | 500 | __attribute__((__warn_unused_result__)) |
universe@576 | 501 | cxmutstr cx_strchr_m( |
universe@576 | 502 | cxmutstr string, |
universe@576 | 503 | int chr |
universe@576 | 504 | ); |
universe@576 | 505 | |
universe@576 | 506 | /** |
universe@576 | 507 | * Returns a substring starting at the location of the last occurrence of the |
universe@576 | 508 | * specified character. |
universe@576 | 509 | * |
universe@576 | 510 | * If the string does not contain the character, an empty string is returned. |
universe@576 | 511 | * |
universe@576 | 512 | * @param string the string where to locate the character |
universe@576 | 513 | * @param chr the character to locate |
universe@576 | 514 | * @return a substring starting at the last location of \p chr |
universe@576 | 515 | * |
universe@576 | 516 | * @see cx_strrchr_m() |
universe@576 | 517 | */ |
universe@576 | 518 | __attribute__((__warn_unused_result__)) |
universe@576 | 519 | cxstring cx_strrchr( |
universe@576 | 520 | cxstring string, |
universe@576 | 521 | int chr |
universe@576 | 522 | ); |
universe@576 | 523 | |
universe@576 | 524 | /** |
universe@576 | 525 | * Returns a substring starting at the location of the last occurrence of the |
universe@576 | 526 | * specified character. |
universe@576 | 527 | * |
universe@576 | 528 | * If the string does not contain the character, an empty string is returned. |
universe@576 | 529 | * |
universe@576 | 530 | * @param string the string where to locate the character |
universe@576 | 531 | * @param chr the character to locate |
universe@576 | 532 | * @return a substring starting at the last location of \p chr |
universe@576 | 533 | * |
universe@576 | 534 | * @see cx_strrchr() |
universe@576 | 535 | */ |
universe@576 | 536 | __attribute__((__warn_unused_result__)) |
universe@576 | 537 | cxmutstr cx_strrchr_m( |
universe@576 | 538 | cxmutstr string, |
universe@576 | 539 | int chr |
universe@576 | 540 | ); |
universe@576 | 541 | |
universe@576 | 542 | /** |
universe@576 | 543 | * Returns a substring starting at the location of the first occurrence of the |
universe@576 | 544 | * specified string. |
universe@576 | 545 | * |
universe@576 | 546 | * If \p haystack does not contain \p needle, an empty string is returned. |
universe@576 | 547 | * |
universe@576 | 548 | * If \p needle is an empty string, the complete \p haystack is |
universe@576 | 549 | * returned. |
universe@576 | 550 | * |
universe@576 | 551 | * @param haystack the string to be scanned |
universe@576 | 552 | * @param needle string containing the sequence of characters to match |
universe@576 | 553 | * @return a substring starting at the first occurrence of |
universe@576 | 554 | * \p needle, or an empty string, if the sequence is not |
universe@576 | 555 | * contained |
universe@576 | 556 | * @see cx_strstr_m() |
universe@576 | 557 | */ |
universe@576 | 558 | __attribute__((__warn_unused_result__)) |
universe@576 | 559 | cxstring cx_strstr( |
universe@576 | 560 | cxstring haystack, |
universe@576 | 561 | cxstring needle |
universe@576 | 562 | ); |
universe@576 | 563 | |
universe@576 | 564 | /** |
universe@576 | 565 | * Returns a substring starting at the location of the first occurrence of the |
universe@576 | 566 | * specified string. |
universe@576 | 567 | * |
universe@576 | 568 | * If \p haystack does not contain \p needle, an empty string is returned. |
universe@576 | 569 | * |
universe@576 | 570 | * If \p needle is an empty string, the complete \p haystack is |
universe@576 | 571 | * returned. |
universe@576 | 572 | * |
universe@576 | 573 | * @param haystack the string to be scanned |
universe@576 | 574 | * @param needle string containing the sequence of characters to match |
universe@576 | 575 | * @return a substring starting at the first occurrence of |
universe@576 | 576 | * \p needle, or an empty string, if the sequence is not |
universe@576 | 577 | * contained |
universe@576 | 578 | * @see cx_strstr() |
universe@576 | 579 | */ |
universe@576 | 580 | __attribute__((__warn_unused_result__)) |
universe@576 | 581 | cxmutstr cx_strstr_m( |
universe@576 | 582 | cxmutstr haystack, |
universe@576 | 583 | cxstring needle |
universe@576 | 584 | ); |
universe@576 | 585 | |
universe@576 | 586 | /** |
universe@576 | 587 | * Splits a given string using a delimiter string. |
universe@576 | 588 | * |
universe@576 | 589 | * \note The resulting array contains strings that point to the source |
universe@576 | 590 | * \p string. Use cx_strdup() to get copies. |
universe@576 | 591 | * |
universe@576 | 592 | * @param string the string to split |
universe@576 | 593 | * @param delim the delimiter |
universe@576 | 594 | * @param limit the maximum number of split items |
universe@576 | 595 | * @param output a pre-allocated array of at least \p limit length |
universe@576 | 596 | * @return the actual number of split items |
universe@576 | 597 | */ |
universe@576 | 598 | __attribute__((__warn_unused_result__, __nonnull__)) |
universe@576 | 599 | size_t cx_strsplit( |
universe@576 | 600 | cxstring string, |
universe@576 | 601 | cxstring delim, |
universe@576 | 602 | size_t limit, |
universe@576 | 603 | cxstring *output |
universe@576 | 604 | ); |
universe@576 | 605 | |
universe@576 | 606 | /** |
universe@576 | 607 | * Splits a given string using a delimiter string. |
universe@576 | 608 | * |
universe@576 | 609 | * The array pointed to by \p output will be allocated by \p allocator. |
universe@576 | 610 | * |
universe@576 | 611 | * \note The resulting array contains strings that point to the source |
universe@576 | 612 | * \p string. Use cx_strdup() to get copies. |
universe@576 | 613 | * |
universe@576 | 614 | * \attention If allocation fails, the \c NULL pointer will be written to |
universe@576 | 615 | * \p output and the number returned will be zero. |
universe@576 | 616 | * |
universe@576 | 617 | * @param allocator the allocator to use for allocating the resulting array |
universe@576 | 618 | * @param string the string to split |
universe@576 | 619 | * @param delim the delimiter |
universe@576 | 620 | * @param limit the maximum number of split items |
universe@576 | 621 | * @param output a pointer where the address of the allocated array shall be |
universe@576 | 622 | * written to |
universe@576 | 623 | * @return the actual number of split items |
universe@576 | 624 | */ |
universe@576 | 625 | __attribute__((__warn_unused_result__, __nonnull__)) |
universe@576 | 626 | size_t cx_strsplit_a( |
universe@693 | 627 | CxAllocator const *allocator, |
universe@576 | 628 | cxstring string, |
universe@576 | 629 | cxstring delim, |
universe@576 | 630 | size_t limit, |
universe@576 | 631 | cxstring **output |
universe@576 | 632 | ); |
universe@576 | 633 | |
universe@576 | 634 | |
universe@576 | 635 | /** |
universe@576 | 636 | * Splits a given string using a delimiter string. |
universe@576 | 637 | * |
universe@576 | 638 | * \note The resulting array contains strings that point to the source |
universe@576 | 639 | * \p string. Use cx_strdup() to get copies. |
universe@576 | 640 | * |
universe@576 | 641 | * @param string the string to split |
universe@576 | 642 | * @param delim the delimiter |
universe@576 | 643 | * @param limit the maximum number of split items |
universe@576 | 644 | * @param output a pre-allocated array of at least \p limit length |
universe@576 | 645 | * @return the actual number of split items |
universe@576 | 646 | */ |
universe@576 | 647 | __attribute__((__warn_unused_result__, __nonnull__)) |
universe@576 | 648 | size_t cx_strsplit_m( |
universe@576 | 649 | cxmutstr string, |
universe@576 | 650 | cxstring delim, |
universe@576 | 651 | size_t limit, |
universe@576 | 652 | cxmutstr *output |
universe@576 | 653 | ); |
universe@576 | 654 | |
universe@576 | 655 | /** |
universe@576 | 656 | * Splits a given string using a delimiter string. |
universe@576 | 657 | * |
universe@576 | 658 | * The array pointed to by \p output will be allocated by \p allocator. |
universe@576 | 659 | * |
universe@576 | 660 | * \note The resulting array contains strings that point to the source |
universe@576 | 661 | * \p string. Use cx_strdup() to get copies. |
universe@576 | 662 | * |
universe@576 | 663 | * \attention If allocation fails, the \c NULL pointer will be written to |
universe@576 | 664 | * \p output and the number returned will be zero. |
universe@576 | 665 | * |
universe@576 | 666 | * @param allocator the allocator to use for allocating the resulting array |
universe@576 | 667 | * @param string the string to split |
universe@576 | 668 | * @param delim the delimiter |
universe@576 | 669 | * @param limit the maximum number of split items |
universe@576 | 670 | * @param output a pointer where the address of the allocated array shall be |
universe@576 | 671 | * written to |
universe@576 | 672 | * @return the actual number of split items |
universe@576 | 673 | */ |
universe@576 | 674 | __attribute__((__warn_unused_result__, __nonnull__)) |
universe@576 | 675 | size_t cx_strsplit_ma( |
universe@693 | 676 | CxAllocator const *allocator, |
universe@576 | 677 | cxmutstr string, |
universe@576 | 678 | cxstring delim, |
universe@576 | 679 | size_t limit, |
universe@576 | 680 | cxmutstr **output |
universe@576 | 681 | ); |
universe@576 | 682 | |
universe@576 | 683 | /** |
universe@576 | 684 | * Compares two strings. |
universe@576 | 685 | * |
universe@576 | 686 | * @param s1 the first string |
universe@576 | 687 | * @param s2 the second string |
universe@576 | 688 | * @return negative if \p s1 is smaller than \p s2, positive if \p s1 is larger |
universe@576 | 689 | * than \p s2, zero if both strings equal |
universe@576 | 690 | */ |
universe@576 | 691 | __attribute__((__warn_unused_result__)) |
universe@576 | 692 | int cx_strcmp( |
universe@576 | 693 | cxstring s1, |
universe@576 | 694 | cxstring s2 |
universe@576 | 695 | ); |
universe@576 | 696 | |
universe@576 | 697 | /** |
universe@576 | 698 | * Compares two strings ignoring case. |
universe@576 | 699 | * |
universe@576 | 700 | * @param s1 the first string |
universe@576 | 701 | * @param s2 the second string |
universe@576 | 702 | * @return negative if \p s1 is smaller than \p s2, positive if \p s1 is larger |
universe@576 | 703 | * than \p s2, zero if both strings equal ignoring case |
universe@576 | 704 | */ |
universe@576 | 705 | __attribute__((__warn_unused_result__)) |
universe@576 | 706 | int cx_strcasecmp( |
universe@576 | 707 | cxstring s1, |
universe@576 | 708 | cxstring s2 |
universe@576 | 709 | ); |
universe@576 | 710 | |
universe@657 | 711 | /** |
universe@657 | 712 | * Compares two strings. |
universe@657 | 713 | * |
universe@677 | 714 | * This function has a compatible signature for the use as a cx_compare_func. |
universe@657 | 715 | * |
universe@657 | 716 | * @param s1 the first string |
universe@657 | 717 | * @param s2 the second string |
universe@657 | 718 | * @return negative if \p s1 is smaller than \p s2, positive if \p s1 is larger |
universe@657 | 719 | * than \p s2, zero if both strings equal |
universe@657 | 720 | */ |
universe@657 | 721 | __attribute__((__warn_unused_result__, __nonnull__)) |
universe@657 | 722 | int cx_strcmp_p( |
universe@657 | 723 | void const *s1, |
universe@657 | 724 | void const *s2 |
universe@657 | 725 | ); |
universe@657 | 726 | |
universe@657 | 727 | /** |
universe@657 | 728 | * Compares two strings ignoring case. |
universe@657 | 729 | * |
universe@677 | 730 | * This function has a compatible signature for the use as a cx_compare_func. |
universe@657 | 731 | * |
universe@657 | 732 | * @param s1 the first string |
universe@657 | 733 | * @param s2 the second string |
universe@657 | 734 | * @return negative if \p s1 is smaller than \p s2, positive if \p s1 is larger |
universe@657 | 735 | * than \p s2, zero if both strings equal ignoring case |
universe@657 | 736 | */ |
universe@657 | 737 | __attribute__((__warn_unused_result__, __nonnull__)) |
universe@657 | 738 | int cx_strcasecmp_p( |
universe@657 | 739 | void const *s1, |
universe@657 | 740 | void const *s2 |
universe@657 | 741 | ); |
universe@657 | 742 | |
universe@576 | 743 | |
universe@576 | 744 | /** |
universe@576 | 745 | * Creates a duplicate of the specified string. |
universe@576 | 746 | * |
universe@576 | 747 | * The new string will contain a copy allocated by \p allocator. |
universe@576 | 748 | * |
universe@589 | 749 | * \note The returned string is guaranteed to be zero-terminated. |
universe@576 | 750 | * |
universe@576 | 751 | * @param allocator the allocator to use |
universe@576 | 752 | * @param string the string to duplicate |
universe@576 | 753 | * @return a duplicate of the string |
universe@576 | 754 | * @see cx_strdup() |
universe@576 | 755 | */ |
universe@576 | 756 | __attribute__((__warn_unused_result__, __nonnull__)) |
universe@576 | 757 | cxmutstr cx_strdup_a( |
universe@693 | 758 | CxAllocator const *allocator, |
universe@576 | 759 | cxstring string |
universe@576 | 760 | ); |
universe@576 | 761 | |
universe@576 | 762 | /** |
universe@578 | 763 | * Creates a duplicate of the specified string. |
universe@578 | 764 | * |
universe@578 | 765 | * The new string will contain a copy allocated by standard |
universe@578 | 766 | * \c malloc(). So developers \em must pass the return value to cx_strfree(). |
universe@578 | 767 | * |
universe@589 | 768 | * \note The returned string is guaranteed to be zero-terminated. |
universe@578 | 769 | * |
universe@578 | 770 | * @param string the string to duplicate |
universe@578 | 771 | * @return a duplicate of the string |
universe@578 | 772 | * @see cx_strdup_a() |
universe@578 | 773 | */ |
universe@578 | 774 | #define cx_strdup(string) cx_strdup_a(cxDefaultAllocator, string) |
universe@578 | 775 | |
universe@700 | 776 | |
universe@700 | 777 | /** |
universe@700 | 778 | * Creates a duplicate of the specified string. |
universe@700 | 779 | * |
universe@700 | 780 | * The new string will contain a copy allocated by \p allocator. |
universe@700 | 781 | * |
universe@700 | 782 | * \note The returned string is guaranteed to be zero-terminated. |
universe@700 | 783 | * |
universe@700 | 784 | * @param allocator the allocator to use |
universe@700 | 785 | * @param string the string to duplicate |
universe@700 | 786 | * @return a duplicate of the string |
universe@700 | 787 | * @see cx_strdup_m() |
universe@700 | 788 | */ |
universe@700 | 789 | #define cx_strdup_ma(allocator, string) cx_strdup_a(allocator, cx_strcast(string)) |
universe@700 | 790 | |
universe@700 | 791 | /** |
universe@700 | 792 | * Creates a duplicate of the specified string. |
universe@700 | 793 | * |
universe@700 | 794 | * The new string will contain a copy allocated by standard |
universe@700 | 795 | * \c malloc(). So developers \em must pass the return value to cx_strfree(). |
universe@700 | 796 | * |
universe@700 | 797 | * \note The returned string is guaranteed to be zero-terminated. |
universe@700 | 798 | * |
universe@700 | 799 | * @param string the string to duplicate |
universe@700 | 800 | * @return a duplicate of the string |
universe@700 | 801 | * @see cx_strdup_ma() |
universe@700 | 802 | */ |
universe@700 | 803 | #define cx_strdup_m(string) cx_strdup_a(cxDefaultAllocator, cx_strcast(string)) |
universe@700 | 804 | |
universe@578 | 805 | /** |
universe@576 | 806 | * Omits leading and trailing spaces. |
universe@576 | 807 | * |
universe@576 | 808 | * \note the returned string references the same memory, thus you |
universe@576 | 809 | * must \em not free the returned memory. |
universe@576 | 810 | * |
universe@576 | 811 | * @param string the string that shall be trimmed |
universe@576 | 812 | * @return the trimmed string |
universe@576 | 813 | */ |
universe@576 | 814 | __attribute__((__warn_unused_result__)) |
universe@576 | 815 | cxstring cx_strtrim(cxstring string); |
universe@576 | 816 | |
universe@576 | 817 | /** |
universe@576 | 818 | * Omits leading and trailing spaces. |
universe@576 | 819 | * |
universe@576 | 820 | * \note the returned string references the same memory, thus you |
universe@576 | 821 | * must \em not free the returned memory. |
universe@576 | 822 | * |
universe@576 | 823 | * @param string the string that shall be trimmed |
universe@576 | 824 | * @return the trimmed string |
universe@576 | 825 | */ |
universe@576 | 826 | __attribute__((__warn_unused_result__)) |
universe@576 | 827 | cxmutstr cx_strtrim_m(cxmutstr string); |
universe@576 | 828 | |
universe@576 | 829 | /** |
universe@576 | 830 | * Checks, if a string has a specific prefix. |
universe@576 | 831 | * |
universe@576 | 832 | * @param string the string to check |
universe@576 | 833 | * @param prefix the prefix the string should have |
universe@576 | 834 | * @return \c true, if and only if the string has the specified prefix, |
universe@576 | 835 | * \c false otherwise |
universe@576 | 836 | */ |
universe@576 | 837 | __attribute__((__warn_unused_result__)) |
universe@576 | 838 | bool cx_strprefix( |
universe@576 | 839 | cxstring string, |
universe@576 | 840 | cxstring prefix |
universe@576 | 841 | ); |
universe@576 | 842 | |
universe@576 | 843 | /** |
universe@576 | 844 | * Checks, if a string has a specific suffix. |
universe@576 | 845 | * |
universe@576 | 846 | * @param string the string to check |
universe@576 | 847 | * @param suffix the suffix the string should have |
universe@576 | 848 | * @return \c true, if and only if the string has the specified suffix, |
universe@576 | 849 | * \c false otherwise |
universe@576 | 850 | */ |
universe@576 | 851 | __attribute__((__warn_unused_result__)) |
universe@581 | 852 | bool cx_strsuffix( |
universe@576 | 853 | cxstring string, |
universe@576 | 854 | cxstring suffix |
universe@576 | 855 | ); |
universe@576 | 856 | |
universe@576 | 857 | /** |
universe@576 | 858 | * Checks, if a string has a specific prefix, ignoring the case. |
universe@576 | 859 | * |
universe@576 | 860 | * @param string the string to check |
universe@576 | 861 | * @param prefix the prefix the string should have |
universe@576 | 862 | * @return \c true, if and only if the string has the specified prefix, |
universe@576 | 863 | * \c false otherwise |
universe@576 | 864 | */ |
universe@576 | 865 | __attribute__((__warn_unused_result__)) |
universe@581 | 866 | bool cx_strcaseprefix( |
universe@576 | 867 | cxstring string, |
universe@576 | 868 | cxstring prefix |
universe@576 | 869 | ); |
universe@576 | 870 | |
universe@576 | 871 | /** |
universe@576 | 872 | * Checks, if a string has a specific suffix, ignoring the case. |
universe@576 | 873 | * |
universe@576 | 874 | * @param string the string to check |
universe@576 | 875 | * @param suffix the suffix the string should have |
universe@576 | 876 | * @return \c true, if and only if the string has the specified suffix, |
universe@576 | 877 | * \c false otherwise |
universe@576 | 878 | */ |
universe@576 | 879 | __attribute__((__warn_unused_result__)) |
universe@581 | 880 | bool cx_strcasesuffix( |
universe@576 | 881 | cxstring string, |
universe@576 | 882 | cxstring suffix |
universe@576 | 883 | ); |
universe@576 | 884 | |
universe@576 | 885 | /** |
universe@576 | 886 | * Converts the string to lower case. |
universe@576 | 887 | * |
universe@576 | 888 | * The change is made in-place. If you want a copy, use cx_strdup(), first. |
universe@576 | 889 | * |
universe@576 | 890 | * @param string the string to modify |
universe@576 | 891 | * @see cx_strdup() |
universe@576 | 892 | */ |
universe@576 | 893 | void cx_strlower(cxmutstr string); |
universe@576 | 894 | |
universe@576 | 895 | /** |
universe@576 | 896 | * Converts the string to upper case. |
universe@576 | 897 | * |
universe@576 | 898 | * The change is made in-place. If you want a copy, use cx_strdup(), first. |
universe@576 | 899 | * |
universe@576 | 900 | * @param string the string to modify |
universe@576 | 901 | * @see cx_strdup() |
universe@576 | 902 | */ |
universe@576 | 903 | void cx_strupper(cxmutstr string); |
universe@576 | 904 | |
universe@576 | 905 | /** |
universe@576 | 906 | * Replaces a pattern in a string with another string. |
universe@576 | 907 | * |
universe@576 | 908 | * The pattern is taken literally and is no regular expression. |
universe@576 | 909 | * Replaces at most \p replmax occurrences. |
universe@576 | 910 | * |
universe@589 | 911 | * The returned string will be allocated by \p allocator and is guaranteed |
universe@589 | 912 | * to be zero-terminated. |
universe@576 | 913 | * |
universe@576 | 914 | * If allocation fails, or the input string is empty, |
universe@583 | 915 | * the returned string will be empty. |
universe@576 | 916 | * |
universe@576 | 917 | * @param allocator the allocator to use |
universe@576 | 918 | * @param str the string where replacements should be applied |
universe@576 | 919 | * @param pattern the pattern to search for |
universe@576 | 920 | * @param replacement the replacement string |
universe@576 | 921 | * @param replmax maximum number of replacements |
universe@576 | 922 | * @return the resulting string after applying the replacements |
universe@576 | 923 | */ |
universe@576 | 924 | __attribute__((__warn_unused_result__, __nonnull__)) |
universe@583 | 925 | cxmutstr cx_strreplacen_a( |
universe@693 | 926 | CxAllocator const *allocator, |
universe@576 | 927 | cxstring str, |
universe@576 | 928 | cxstring pattern, |
universe@576 | 929 | cxstring replacement, |
universe@576 | 930 | size_t replmax |
universe@576 | 931 | ); |
universe@576 | 932 | |
universe@578 | 933 | /** |
universe@578 | 934 | * Replaces a pattern in a string with another string. |
universe@578 | 935 | * |
universe@578 | 936 | * The pattern is taken literally and is no regular expression. |
universe@578 | 937 | * Replaces at most \p replmax occurrences. |
universe@578 | 938 | * |
universe@589 | 939 | * The returned string will be allocated by \c malloc() and is guaranteed |
universe@589 | 940 | * to be zero-terminated. |
universe@578 | 941 | * |
universe@578 | 942 | * If allocation fails, or the input string is empty, |
universe@583 | 943 | * the returned string will be empty. |
universe@578 | 944 | * |
universe@578 | 945 | * @param str the string where replacements should be applied |
universe@578 | 946 | * @param pattern the pattern to search for |
universe@578 | 947 | * @param replacement the replacement string |
universe@578 | 948 | * @param replmax maximum number of replacements |
universe@578 | 949 | * @return the resulting string after applying the replacements |
universe@578 | 950 | */ |
universe@583 | 951 | #define cx_strreplacen(str, pattern, replacement, replmax) \ |
universe@583 | 952 | cx_strreplacen_a(cxDefaultAllocator, str, pattern, replacement, replmax) |
universe@583 | 953 | |
universe@583 | 954 | /** |
universe@583 | 955 | * Replaces a pattern in a string with another string. |
universe@583 | 956 | * |
universe@583 | 957 | * The pattern is taken literally and is no regular expression. |
universe@583 | 958 | * |
universe@589 | 959 | * The returned string will be allocated by \p allocator and is guaranteed |
universe@589 | 960 | * to be zero-terminated. |
universe@583 | 961 | * |
universe@583 | 962 | * If allocation fails, or the input string is empty, |
universe@583 | 963 | * the returned string will be empty. |
universe@583 | 964 | * |
universe@583 | 965 | * @param allocator the allocator to use |
universe@583 | 966 | * @param str the string where replacements should be applied |
universe@583 | 967 | * @param pattern the pattern to search for |
universe@583 | 968 | * @param replacement the replacement string |
universe@583 | 969 | * @return the resulting string after applying the replacements |
universe@583 | 970 | */ |
universe@583 | 971 | #define cx_strreplace_a(allocator, str, pattern, replacement) \ |
universe@583 | 972 | cx_strreplacen_a(allocator, str, pattern, replacement, SIZE_MAX) |
universe@583 | 973 | |
universe@583 | 974 | /** |
universe@583 | 975 | * Replaces a pattern in a string with another string. |
universe@583 | 976 | * |
universe@583 | 977 | * The pattern is taken literally and is no regular expression. |
universe@583 | 978 | * Replaces at most \p replmax occurrences. |
universe@583 | 979 | * |
universe@589 | 980 | * The returned string will be allocated by \c malloc() and is guaranteed |
universe@589 | 981 | * to be zero-terminated. |
universe@583 | 982 | * |
universe@583 | 983 | * If allocation fails, or the input string is empty, |
universe@583 | 984 | * the returned string will be empty. |
universe@583 | 985 | * |
universe@583 | 986 | * @param str the string where replacements should be applied |
universe@583 | 987 | * @param pattern the pattern to search for |
universe@583 | 988 | * @param replacement the replacement string |
universe@583 | 989 | * @return the resulting string after applying the replacements |
universe@583 | 990 | */ |
universe@583 | 991 | #define cx_strreplace(str, pattern, replacement) \ |
universe@583 | 992 | cx_strreplacen_a(cxDefaultAllocator, str, pattern, replacement, SIZE_MAX) |
universe@578 | 993 | |
universe@645 | 994 | /** |
universe@645 | 995 | * Creates a string tokenization context. |
universe@645 | 996 | * |
universe@645 | 997 | * @param str the string to tokenize |
universe@645 | 998 | * @param delim the delimiter (must not be empty) |
universe@645 | 999 | * @param limit the maximum number of tokens that shall be returned |
universe@645 | 1000 | * @return a new string tokenization context |
universe@645 | 1001 | */ |
universe@645 | 1002 | __attribute__((__warn_unused_result__)) |
universe@645 | 1003 | CxStrtokCtx cx_strtok( |
universe@645 | 1004 | cxstring str, |
universe@645 | 1005 | cxstring delim, |
universe@645 | 1006 | size_t limit |
universe@645 | 1007 | ); |
universe@645 | 1008 | |
universe@645 | 1009 | /** |
universe@645 | 1010 | * Creates a string tokenization context for a mutable string. |
universe@645 | 1011 | * |
universe@645 | 1012 | * @param str the string to tokenize |
universe@645 | 1013 | * @param delim the delimiter (must not be empty) |
universe@645 | 1014 | * @param limit the maximum number of tokens that shall be returned |
universe@645 | 1015 | * @return a new string tokenization context |
universe@645 | 1016 | */ |
universe@645 | 1017 | __attribute__((__warn_unused_result__)) |
universe@645 | 1018 | CxStrtokCtx cx_strtok_m( |
universe@645 | 1019 | cxmutstr str, |
universe@645 | 1020 | cxstring delim, |
universe@645 | 1021 | size_t limit |
universe@645 | 1022 | ); |
universe@645 | 1023 | |
universe@645 | 1024 | /** |
universe@645 | 1025 | * Returns the next token. |
universe@645 | 1026 | * |
universe@645 | 1027 | * The token will point to the source string. |
universe@645 | 1028 | * |
universe@645 | 1029 | * @param ctx the tokenization context |
universe@645 | 1030 | * @param token a pointer to memory where the next token shall be stored |
universe@645 | 1031 | * @return true if successful, false if the limit or the end of the string |
universe@645 | 1032 | * has been reached |
universe@645 | 1033 | */ |
universe@645 | 1034 | __attribute__((__warn_unused_result__, __nonnull__)) |
universe@645 | 1035 | bool cx_strtok_next( |
universe@645 | 1036 | CxStrtokCtx *ctx, |
universe@645 | 1037 | cxstring *token |
universe@645 | 1038 | ); |
universe@645 | 1039 | |
universe@645 | 1040 | /** |
universe@645 | 1041 | * Returns the next token of a mutable string. |
universe@645 | 1042 | * |
universe@645 | 1043 | * The token will point to the source string. |
universe@645 | 1044 | * If the context was not initialized over a mutable string, modifying |
universe@645 | 1045 | * the data of the returned token is undefined behavior. |
universe@645 | 1046 | * |
universe@645 | 1047 | * @param ctx the tokenization context |
universe@645 | 1048 | * @param token a pointer to memory where the next token shall be stored |
universe@645 | 1049 | * @return true if successful, false if the limit or the end of the string |
universe@645 | 1050 | * has been reached |
universe@645 | 1051 | */ |
universe@645 | 1052 | __attribute__((__warn_unused_result__, __nonnull__)) |
universe@645 | 1053 | bool cx_strtok_next_m( |
universe@645 | 1054 | CxStrtokCtx *ctx, |
universe@645 | 1055 | cxmutstr *token |
universe@645 | 1056 | ); |
universe@645 | 1057 | |
universe@645 | 1058 | /** |
universe@645 | 1059 | * Defines an array of more delimiters for the specified tokenization context. |
universe@645 | 1060 | * |
universe@645 | 1061 | * @param ctx the tokenization context |
universe@645 | 1062 | * @param delim array of more delimiters |
universe@645 | 1063 | * @param count number of elements in the array |
universe@645 | 1064 | */ |
universe@645 | 1065 | __attribute__((__nonnull__)) |
universe@645 | 1066 | void cx_strtok_delim( |
universe@645 | 1067 | CxStrtokCtx *ctx, |
universe@645 | 1068 | cxstring const *delim, |
universe@645 | 1069 | size_t count |
universe@645 | 1070 | ); |
universe@645 | 1071 | |
universe@645 | 1072 | |
universe@576 | 1073 | #ifdef __cplusplus |
universe@576 | 1074 | } // extern "C" |
universe@576 | 1075 | #endif |
universe@576 | 1076 | |
universe@576 | 1077 | #endif //UCX_STRING_H |