[thirdparty/systemd.git] / src / basic / string-table.h

/* SPDX-License-Identifier: LGPL-2.1-or-later */

#pragma once

#include <errno.h>
#include <stddef.h>
#include <stdio.h>
#include <sys/types.h>

#include "macro.h"
#include "parse-util.h"
#include "string-util.h"

ssize_t string_table_lookup(const char * const *table, size_t len, const char *key);

/* For basic lookup tables with strictly enumerated entries */
#define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope)          \
        scope const char *name##_to_string(type i) {                    \
                if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
                        return NULL;                                    \
                return name##_table[i];                                 \
        }

#define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope)        \
        scope type name##_from_string(const char *s) {                  \
                return (type) string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
        }

#define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_WITH_BOOLEAN(name,type,yes,scope) \
        scope type name##_from_string(const char *s) {                  \
                int b;                                                  \
                if (!s)                                                 \
                        return -1;                                      \
                b = parse_boolean(s);                                   \
                if (b == 0)                                             \
                        return (type) 0;                                \
                else if (b > 0)                                         \
                        return yes;                                     \
                return (type) string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
        }

#define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING_FALLBACK(name,type,max,scope) \
        scope int name##_to_string_alloc(type i, char **str) {          \
                char *s;                                                \
                if (i < 0 || i > max)                                   \
                        return -ERANGE;                                 \
                if (i < (type) ELEMENTSOF(name##_table) && name##_table[i]) { \
                        s = strdup(name##_table[i]);                    \
                        if (!s)                                         \
                                return -ENOMEM;                         \
                } else {                                                \
                        if (asprintf(&s, "%i", i) < 0)                  \
                                return -ENOMEM;                         \
                }                                                       \
                *str = s;                                               \
                return 0;                                               \
        }

#define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_FALLBACK(name,type,max,scope) \
        scope type name##_from_string(const char *s) {                  \
                unsigned u = 0;                                         \
                type i;                                                 \
                if (!s)                                                 \
                        return (type) -1;                               \
                i = (type) string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
                if (i >= 0)                                             \
                        return i;                                       \
                if (safe_atou(s, &u) >= 0 && u <= max)                  \
                        return (type) u;                                \
                return (type) -1;                                       \
        }                                                               \

#define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                    \
        _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope)          \
        _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope)

#define _DEFINE_STRING_TABLE_LOOKUP_WITH_BOOLEAN(name,type,yes,scope)   \
        _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope)          \
        _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_WITH_BOOLEAN(name,type,yes,scope)

#define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,static)

#define DEFINE_STRING_TABLE_LOOKUP_WITH_BOOLEAN(name,type,yes) _DEFINE_STRING_TABLE_LOOKUP_WITH_BOOLEAN(name,type,yes,)

/* For string conversions where numbers are also acceptable */
#define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max)         \
        _DEFINE_STRING_TABLE_LOOKUP_TO_STRING_FALLBACK(name,type,max,)  \
        _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_FALLBACK(name,type,max,)

#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING_FALLBACK(name,type,max) \
        _DEFINE_STRING_TABLE_LOOKUP_TO_STRING_FALLBACK(name,type,max,static)
#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING_FALLBACK(name,type,max) \
        _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_FALLBACK(name,type,max,static)

#define DUMP_STRING_TABLE(name,type,max)                                \
        do {                                                            \
                type _k;                                                \
                flockfile(stdout);                                      \
                for (_k = 0; _k < (max); _k++) {                        \
                        const char *_t;                                 \
                        _t = name##_to_string(_k);                      \
                        if (!_t)                                        \
                                continue;                               \
                        fputs_unlocked(_t, stdout);                     \
                        fputc_unlocked('\n', stdout);                   \
                }                                                       \
                funlockfile(stdout);                                    \
        } while(false)
Commit	Line	Data
db9ecf05	1	/* SPDX-License-Identifier: LGPL-2.1-or-later */
8b43440b	2
8b43440b LP	3	#pragma once
8b43440b LP	4
11c3a366	5	#include <errno.h>
8b43440b LP	6	#include <stddef.h>
8b43440b LP	7	#include <stdio.h>
8b43440b LP	8	#include <sys/types.h>
	9
	10	#include "macro.h"
	11	#include "parse-util.h"
	12	#include "string-util.h"
	13
	14	ssize_t string_table_lookup(const char * const table, size_t len, const char key);
	15
	16	/* For basic lookup tables with strictly enumerated entries */
	17	#define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
	18	scope const char *name##_to_string(type i) { \
	19	if (i < 0 \|\| i >= (type) ELEMENTSOF(name##_table)) \
	20	return NULL; \
	21	return name##_table[i]; \
	22	}
	23
	24	#define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
	25	scope type name##_from_string(const char *s) { \
	26	return (type) string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
	27	}
	28
b18b8662 LP	29	#define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_WITH_BOOLEAN(name,type,yes,scope) \
	30	scope type name##_from_string(const char *s) { \
	31	int b; \
35ca4ce0 LP	32	if (!s) \
35ca4ce0 LP	33	return -1; \
b18b8662 LP	34	b = parse_boolean(s); \
	35	if (b == 0) \
	36	return (type) 0; \
	37	else if (b > 0) \
	38	return yes; \
	39	return (type) string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
	40	}
	41
8e98476e ZJS	42	#define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING_FALLBACK(name,type,max,scope) \
8e98476e ZJS	43	scope int name##_to_string_alloc(type i, char **str) { \
8b43440b LP	44	char *s; \
	45	if (i < 0 \|\| i > max) \
	46	return -ERANGE; \
aa73f181	47	if (i < (type) ELEMENTSOF(name##_table) && name##_table[i]) { \
8b43440b LP	48	s = strdup(name##_table[i]); \
	49	if (!s) \
	50	return -ENOMEM; \
	51	} else { \
	52	if (asprintf(&s, "%i", i) < 0) \
	53	return -ENOMEM; \
	54	} \
	55	*str = s; \
	56	return 0; \
8e98476e ZJS	57	}
	58
	59	#define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_FALLBACK(name,type,max,scope) \
22ac37aa	60	scope type name##_from_string(const char *s) { \
8b43440b	61	unsigned u = 0; \
63c691c6	62	type i; \
8b43440b LP	63	if (!s) \
8b43440b LP	64	return (type) -1; \
63c691c6 LP	65	i = (type) string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
	66	if (i >= 0) \
	67	return i; \
8b43440b LP	68	if (safe_atou(s, &u) >= 0 && u <= max) \
	69	return (type) u; \
	70	return (type) -1; \
	71	} \
8e98476e	72
8e98476e ZJS	73	#define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
8e98476e ZJS	74	_DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
f6a8265b	75	_DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope)
8e98476e ZJS	76
	77	#define _DEFINE_STRING_TABLE_LOOKUP_WITH_BOOLEAN(name,type,yes,scope) \
	78	_DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
f6a8265b	79	_DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_WITH_BOOLEAN(name,type,yes,scope)
8e98476e ZJS	80
	81	#define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
	82	#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
	83	#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
	84	#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,static)
	85
	86	#define DEFINE_STRING_TABLE_LOOKUP_WITH_BOOLEAN(name,type,yes) _DEFINE_STRING_TABLE_LOOKUP_WITH_BOOLEAN(name,type,yes,)
	87
	88	/* For string conversions where numbers are also acceptable */
	89	#define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
	90	_DEFINE_STRING_TABLE_LOOKUP_TO_STRING_FALLBACK(name,type,max,) \
f6a8265b	91	_DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_FALLBACK(name,type,max,)
8e98476e ZJS	92
	93	#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING_FALLBACK(name,type,max) \
	94	_DEFINE_STRING_TABLE_LOOKUP_TO_STRING_FALLBACK(name,type,max,static)
	95	#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING_FALLBACK(name,type,max) \
	96	_DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_FALLBACK(name,type,max,static)
d34f3bc4 LP	97
	98	#define DUMP_STRING_TABLE(name,type,max) \
	99	do { \
	100	type _k; \
	101	flockfile(stdout); \
	102	for (_k = 0; _k < (max); _k++) { \
	103	const char *_t; \
	104	_t = name##_to_string(_k); \
	105	if (!_t) \
	106	continue; \
	107	fputs_unlocked(_t, stdout); \
	108	fputc_unlocked('\n', stdout); \
	109	} \
	110	funlockfile(stdout); \
	111	} while(false)