cxstring.h
/*
* This file is part of the ESO C Extension Library
* Copyright (C) 2001-2026 European Southern Observatory
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, see <https://www.gnu.org/licenses/>.
*/
#ifndef CX_STRING_H_
#define CX_STRING_H_
#include <ctype.h>
#include <stdarg.h>
#include <string.h>
#include "cxmacros.h"
#include "cxtypes.h"
CX_BEGIN_DECLS
struct _cx_string_
{
/* <private> */
cxchar *data;
cxsize sz;
};
typedef struct _cx_string_ cx_string;
/*
* Create, copy and destroy operations
*/
cx_string *cx_string_new(void);
cx_string *cx_string_copy(const cx_string *);
cx_string *cx_string_create(const cxchar *);
void cx_string_delete(cx_string *);
/*
* Non modifying operations
*/
cxsize cx_string_size(const cx_string *);
cxbool cx_string_empty(const cx_string *);
/*
* Data access
*/
const cxchar *cx_string_get(const cx_string *);
/*
* Assignment operations
*/
void cx_string_set(cx_string *, const cxchar *);
/*
* Modifying operations
*/
void cx_string_resize(cx_string *, cxsize, cxchar);
void cx_string_extend(cx_string *, cxsize, cxchar);
void cx_string_replace_character(cx_string *, cxsize, cxsize, cxchar, cxchar);
cx_string *cx_string_upper(cx_string *);
cx_string *cx_string_lower(cx_string *);
cx_string *cx_string_trim(cx_string *);
cx_string *cx_string_rtrim(cx_string *);
cx_string *cx_string_strip(cx_string *);
/*
* Inserting and removing elements
*/
cx_string *cx_string_prepend(cx_string *, const cxchar *);
cx_string *cx_string_append(cx_string *, const cxchar *);
cx_string *cx_string_insert(cx_string *, cxssize, const cxchar *);
cx_string *cx_string_erase(cx_string *, cxssize, cxssize);
cx_string *cx_string_truncate(cx_string *, cxsize);
cx_string *cx_string_substr(const cx_string *, cxsize, cxsize);
/*
* Comparison functions
*/
cxbool cx_string_equal(const cx_string *, const cx_string *);
cxint cx_string_compare(const cx_string *, const cx_string *);
cxint cx_string_casecmp(const cx_string *, const cx_string *);
cxint cx_string_ncasecmp(const cx_string *, const cx_string *, cxsize);
/*
* Search functions
*/
cxsize cx_string_find_first_not_of(const cx_string *, const cxchar *);
cxsize cx_string_find_last_not_of(const cx_string *, const cxchar *);
/*
* I/O functions
*/
cxint cx_string_sprintf(cx_string *, const cxchar *, ...) CX_GNUC_PRINTF(2, 3);
cxint cx_string_vsprintf(cx_string *, const cxchar *, va_list)
CX_GNUC_PRINTF(2, 0);
/*
* Debugging utilities
*/
void cx_string_print(const cx_string *);
CX_END_DECLS
#endif /* CX_STRING_H */
cx_string_upper
cx_string * cx_string_upper(cx_string *)
Converts the string into uppercase.
Definition cxstring.c:415
cx_string_create
cx_string * cx_string_create(const cxchar *)
Create a new string from a standard C string.
Definition cxstring.c:262
cx_string_truncate
cx_string * cx_string_truncate(cx_string *, cxsize)
Truncate the string.
Definition cxstring.c:785
cx_string_insert
cx_string * cx_string_insert(cx_string *, cxssize, const cxchar *)
Inserts a copy of a string at a given position.
Definition cxstring.c:659
cx_string_vsprintf
cxint cx_string_vsprintf(cx_string *self, const cxchar *format, va_list args)
Write to the string from a variable-length argument list under format control.
Definition cxstring.c:982
cx_string_sprintf
cxint cx_string_sprintf(cx_string *self, const char *format,...)
Writes to a string under format control.
Definition cxstring.c:944
cx_string_append
cx_string * cx_string_append(cx_string *, const cxchar *)
Append an array of characters to the string.
Definition cxstring.c:607
cx_string_substr
cx_string * cx_string_substr(const cx_string *, cxsize, cxsize)
Create a new string from a portion of a string.
Definition cxstring.c:1270
cx_string_replace_character
void cx_string_replace_character(cx_string *, cxsize, cxsize, cxchar, cxchar)
Replace a given character with a new character in a portion of a string.
Definition cxstring.c:1035
cx_string_compare
cxint cx_string_compare(const cx_string *, const cx_string *)
Compare two strings.
Definition cxstring.c:855
cx_string_resize
void cx_string_resize(cx_string *, cxsize, cxchar)
Resize a string to a given length.
Definition cxstring.c:1086
cx_string
struct _cx_string_ cx_string
The cx_string data type.
Definition cxstring.h:48
cx_string_find_last_not_of
cxsize cx_string_find_last_not_of(const cx_string *, const cxchar *)
Search a string for the last character that does not match any of the given characters.
Definition cxstring.c:1216
cx_string_new
cx_string * cx_string_new(void)
Create a new, empty string container.
Definition cxstring.c:218
cx_string_lower
cx_string * cx_string_lower(cx_string *)
Converts the string into lowercase.
Definition cxstring.c:448
cx_string_erase
cx_string * cx_string_erase(cx_string *, cxssize, cxssize)
Erase a portion of the string.
Definition cxstring.c:716
cx_string_get
const cxchar * cx_string_get(const cx_string *)
Get the string's value.
Definition cxstring.c:390
cx_string_set
void cx_string_set(cx_string *, const cxchar *)
Assign a value to a string.
Definition cxstring.c:359
cx_string_delete
void cx_string_delete(cx_string *)
Destroy a string.
Definition cxstring.c:287
cx_string_strip
cx_string * cx_string_strip(cx_string *)
Remove leading and trailing whitespaces from the string.
Definition cxstring.c:531
cx_string_trim
cx_string * cx_string_trim(cx_string *)
Remove leading whitespaces from the string.
Definition cxstring.c:481
cx_string_rtrim
cx_string * cx_string_rtrim(cx_string *)
Remove trailing whitespaces from the string.
Definition cxstring.c:506
cx_string_empty
cxbool cx_string_empty(const cx_string *)
Checks whether a string contains any characters.
Definition cxstring.c:333
cx_string_prepend
cx_string * cx_string_prepend(cx_string *, const cxchar *)
Prepend an array of characters to the string.
Definition cxstring.c:557
cx_string_copy
cx_string * cx_string_copy(const cx_string *)
Create a copy a cx_string.
Definition cxstring.c:234
cx_string_equal
cxbool cx_string_equal(const cx_string *, const cx_string *)
Compare two cx_string for equality.
Definition cxstring.c:812
cx_string_print
void cx_string_print(const cx_string *string)
Print the value of a cx_string to the standard output.
Definition cxstring.c:1002
cx_string_size
cxsize cx_string_size(const cx_string *)
Computes the length of the string.
Definition cxstring.c:312
cx_string_find_first_not_of
cxsize cx_string_find_first_not_of(const cx_string *, const cxchar *)
Search a string for the first character that does not match any of the given characters.
Definition cxstring.c:1174
cx_string_extend
void cx_string_extend(cx_string *, cxsize, cxchar)
Extend a string to a given length.
Definition cxstring.c:1134
cx_string_ncasecmp
cxint cx_string_ncasecmp(const cx_string *, const cx_string *, cxsize)
Compare the first n characters of two strings ignoring the case of characters.
Definition cxstring.c:911
cx_string_casecmp
cxint cx_string_casecmp(const cx_string *, const cx_string *)
Compare two strings ignoring the case of characters.
Definition cxstring.c:878