Safe API Framework
Layered API framework for safety-related applications (ERTMS RBC reference targeting CENELEC EN 50128 SIL 4)
Loading...
Searching...
No Matches
sapi_string.h
Go to the documentation of this file.
1
26#ifndef SAFEAPI_COMMON_STRING_H
27#define SAFEAPI_COMMON_STRING_H
28
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
38typedef struct sapi_string_s
39{
42
51sapi_status_t sapi_string_init(sapi_string_t *str, char *storage, size_t capacity);
52
60
67size_t sapi_string_length(const sapi_string_t *str);
68
80sapi_status_t sapi_string_c_str(sapi_string_t *str, const char **out_cstr);
81
93sapi_status_t sapi_string_copy(sapi_string_t *dest, const char *src);
94
106sapi_status_t sapi_string_copy_n(sapi_string_t *dest, const char *src, size_t src_len);
107
118sapi_status_t sapi_string_concat(sapi_string_t *dest, const char *src);
119
129sapi_status_t sapi_string_compare(const sapi_string_t *a, const sapi_string_t *b, int32_t *out_cmp);
130
144 bool *out_found, size_t *out_index);
145
160 bool *out_found, size_t *out_index);
161
182sapi_status_t sapi_string_split_next(const sapi_string_t *str, char delimiter,
183 size_t *io_cursor,
184 sapi_const_buffer_t *out_token,
185 bool *out_has_token);
186
221
280sapi_status_t sapi_string_append_hex_u32(sapi_string_t *dest, uint32_t value, uint8_t min_digits);
281
292sapi_status_t sapi_string_to_u32(const sapi_string_t *str, uint32_t *out_value);
301sapi_status_t sapi_string_to_i32(const sapi_string_t *str, int32_t *out_value);
310sapi_status_t sapi_string_to_u64(const sapi_string_t *str, uint64_t *out_value);
319sapi_status_t sapi_string_to_i64(const sapi_string_t *str, int64_t *out_value);
320
321#ifdef __cplusplus
322}
323#endif
324
325#endif /* SAFEAPI_COMMON_STRING_H */
326 /* STRING */
sapi_status_t
Common result/status codes.
Definition sapi_status.h:27
sapi_status_t sapi_string_from_i32(sapi_string_t *dest, int32_t value)
Bounded base-10 itoa equivalent for int32_t. Replaces dest's content.
sapi_status_t sapi_string_from_u64(sapi_string_t *dest, uint64_t value)
Bounded base-10 itoa equivalent for uint64_t. Replaces dest's content.
sapi_status_t sapi_string_split_next(const sapi_string_t *str, char delimiter, size_t *io_cursor, sapi_const_buffer_t *out_token, bool *out_has_token)
Reentrant, bounded string splitting - unlike strtok(), all state is caller-owned via io_cursor,...
sapi_status_t sapi_string_init(sapi_string_t *str, char *storage, size_t capacity)
Binds a string to caller-owned storage. Initial length is 0 (empty string).
Definition sapi_string.c:10
sapi_status_t sapi_string_from_i64(sapi_string_t *dest, int64_t value)
Bounded base-10 itoa equivalent for int64_t. Replaces dest's content.
sapi_status_t sapi_string_c_str(sapi_string_t *str, const char **out_cstr)
Ensures a NUL terminator is present within capacity (without incrementing length) and returns a point...
Definition sapi_string.c:37
sapi_status_t sapi_string_append_hex_u32(sapi_string_t *dest, uint32_t value, uint8_t min_digits)
Bounded append of a uint32_t formatted as lowercase hexadecimal (no "0x" prefix - the caller prepends...
sapi_status_t sapi_string_append_i64(sapi_string_t *dest, int64_t value)
Bounded base-10 append of an int64_t; a leading '-' is emitted for negative values....
size_t sapi_string_length(const sapi_string_t *str)
Returns a string's current length (not counting a NUL terminator).
Definition sapi_string.c:28
sapi_status_t sapi_string_concat(sapi_string_t *dest, const char *src)
Bounded strcat equivalent. Never calls strlen(src) - scans for a NUL only up to dest's remaining capa...
sapi_status_t sapi_string_clear(sapi_string_t *str)
Resets a string to empty. Capacity and storage are unchanged.
Definition sapi_string.c:19
sapi_status_t sapi_string_append_u32(sapi_string_t *dest, uint32_t value)
Bounded base-10 append of a uint32_t to dest's existing content (unlike sapi_string_from_u32(),...
sapi_status_t sapi_string_copy(sapi_string_t *dest, const char *src)
Bounded strcpy equivalent. Never calls strlen(src) - scans for a NUL only up to dest's capacity (REQ-...
Definition sapi_string.c:68
sapi_status_t sapi_string_find_char(const sapi_string_t *str, char c, bool *out_found, size_t *out_index)
Bounded strchr equivalent. "Not found" is a normal outcome, not an error - see out_found.
sapi_status_t sapi_string_to_i64(const sapi_string_t *str, int64_t *out_value)
As sapi_string_to_i32(), for int64_t.
sapi_status_t sapi_string_append_u64(sapi_string_t *dest, uint64_t value)
Bounded base-10 append of a uint64_t. See sapi_string_append_u32().
sapi_status_t sapi_string_find_substr(const sapi_string_t *haystack, const sapi_string_t *needle, bool *out_found, size_t *out_index)
Bounded strstr equivalent. "Not found" is a normal outcome, not an error - see out_found.
sapi_status_t sapi_string_copy_n(sapi_string_t *dest, const char *src, size_t src_len)
Bounded copy of an exact-length, not-necessarily-NUL-terminated source (e.g. a length-prefixed field)...
Definition sapi_string.c:59
sapi_status_t sapi_string_compare(const sapi_string_t *a, const sapi_string_t *b, int32_t *out_cmp)
Bounded strcmp equivalent. Compares up to the shorter string's length, then by length if that prefix ...
sapi_status_t sapi_string_to_u32(const sapi_string_t *str, uint32_t *out_value)
Bounded base-10 atoi equivalent for uint32_t.
sapi_status_t sapi_string_append_i32(sapi_string_t *dest, int32_t value)
Bounded base-10 append of an int32_t; a leading '-' is emitted for negative values....
sapi_status_t sapi_string_to_i32(const sapi_string_t *str, int32_t *out_value)
As sapi_string_to_u32(), for int32_t; a leading '-' is accepted.
sapi_status_t sapi_string_from_u32(sapi_string_t *dest, uint32_t value)
Bounded base-10 itoa equivalent for uint32_t. Replaces dest's content.
sapi_status_t sapi_string_to_u64(const sapi_string_t *str, uint64_t *out_value)
As sapi_string_to_u32(), for uint64_t.
Cross-layer data buffer abstraction (ADR-002).
Common status/error codes returned by every Safe API Framework function. Shared across all OS Abstrac...
Common fixed-width types and the caller-owned-storage handle pattern used by every OAL service (see A...
Mutable, bounds-tracked view over caller-owned storage.
Definition sapi_buffer.h:36
Read-only view of a buffer's currently valid bytes. Grants no write access to the underlying storage.
Definition sapi_buffer.h:47
Bounded string: buf.length is the string length, not counting a NUL.
Definition sapi_string.h:39
sapi_buffer_t buf
Definition sapi_string.h:40