src/util/string.h - main - githubmirror/dbus-broker

src/util/string.h
128 строк4 KB
David Rheinsberg
build: add SPDX annotations
30 июн 2026, 15:45
30 июн 2026, 15:450bca774
#pragma once

/* SPDX-License-Identifier: GPL-3.0-or-later */
/* SPDX-FileCopyrightText: D-Bus Broker Developers */

/*
 * String Helpers
 */

#include <c-stdaux.h>
#include <stdlib.h>
#include <string.h>

enum {
        _UTIL_STRING_E_SUCCESS,

        UTIL_STRING_E_INVALID,
        UTIL_STRING_E_RANGE,
};

int util_strtou32(uint32_t *valp, const char *string);
int util_strtou64(uint64_t *valp, const char *string);
int util_strtoint(int *valp, const char *string);

/**
 * string_compare() - compare two strings
 * @a:          first string to compare, or NULL
 * @b:          second string to compare, or NULL
 *
 * Compare two strings, the same way strcmp() does it.
 * Additionally, NULL is allowed as input, which compares equal to itself
 * and smaller than any other string.
 *
 * Return: Less than, greater than or equal to zero, as strcmp().
 */
_c_pure_ static inline int string_compare(const char *a, const char *b) {
        if (a == b)
                return 0;

        return (!a || !b) ? (a ? 1 : -1) : strcmp(a, b);
}

/**
 * string_equal() - compare strings for equality
 * @a:          first string to compare, or NULL
 * @b:          second string to compare, or NULL
 *
 * Compare two strings for equality, the same way strcmp() does it.
 * Additionally, NULL is allowed as input and compares equal to itself only.
 * Unlike strcmp(), this returns a boolean.
 *
 * Return: True if both are equal, false if not.
 */
_c_pure_ static inline bool string_equal(const char *a, const char *b) {
        return (!a || !b) ? (a == b) : !strcmp(a, b);
}

/**
 * string_prefix() - check prefix of a string
 * @str:        string to check
 * @prefix:     prefix to look for
 *
 * This checks whether @str starts with @prefix. If it does, a pointer to the
 * first character in @str after the prefix is returned, if not, NULL is
 * returned.
 *
 * Return: Pointer directly behind the prefix in @str, or NULL if not found.
 */
_c_pure_ static inline char *string_prefix(const char *str, const char *prefix) {
        size_t l = strlen(prefix);
        return !strncmp(str, prefix, l) ? (char *)str + l : NULL;
}

/**
 * string_to_hex() - encode string as ascii-hex
 * @str:        string to encode from
 * @n:          length of @str in bytes
 * @hex:        destination buffer
 *
 * This hex-encodes the source string into the destination buffer. The
 * destination buffer must be at least twice as big as the source.
 */
static inline void string_to_hex(const char *str, size_t n, char *hex) {
        // Include terminating NUL to silence warnings about truncated strings.
        static const char table[17] = "0123456789abcdef";
        size_t i;

        for (i = 0; i < n; ++i) {
                *hex++ = table[(*str >> 4) & 0x0f];
                *hex++ = table[(*str++) & 0x0f];
        }
}

/**
 * string_from_hex() - decode ascii-hex string
 * @str:        string buffer to write into
 * @n:          length of @str in bytes
 * @hex:        hex encoded buffer to decode
 *
 * This hex-decodes @hex into the string buffer @str. Be aware that @hex must
 * be twice the size as @str / @n.
 *
 * Return: True if successful, false if invalid.
 */
static inline bool string_from_hex(char *str, size_t n, const char *hex) {
        static const uint8_t table[128] = {
                 -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,
                 -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,
                 -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,
                0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x9,  -1,  -1, -1,  -1,  -1,  -1,
                 -1, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf,  -1, -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,
                 -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,
                 -1, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf,  -1, -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,
                 -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1, -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,
        };
        uint8_t v1, v2;

        for ( ; n; --n, hex += 2) {
                v1 = table[hex[0] & 0x7f];
                v2 = table[hex[1] & 0x7f];
                if (_c_unlikely_((hex[0] | hex[1] | v1 | v2) & 0x80))
                        return false;

                *str++ = (v1 << 4) | v2;
        }

        return true;
}