[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) {                  \
                if (!s)                                                 \
                        return -EINVAL;                                 \
                int b = parse_boolean(s);                               \
                if (b == 0)                                             \
                        return (type) 0;                                \
                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 -EINVAL;                                 \
                i = (type) string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
                if (i >= 0)                                             \
                        return i;                                       \
                if (safe_atou(s, &u) < 0)                               \
                        return -EINVAL;                                 \
                if (u > max)                                            \
                        return -EINVAL;                                 \
                return (type) u;                                        \
        }

#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_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,)
#define DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(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,)
#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_WITH_BOOLEAN(name,type,yes) _DEFINE_STRING_TABLE_LOOKUP_WITH_BOOLEAN(name,type,yes,static)
#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING_WITH_BOOLEAN(name,type,yes) \
        _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_WITH_BOOLEAN(name,type,yes,static)

/* 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 {                                                            \
                flockfile(stdout);                                      \
                for (type _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
a032b68d	1	/* SPDX-License-Identifier: LGPL-2.1-or-later */
db2df898	2
db2df898 MP	3	#pragma once
db2df898 MP	4
4c89c718	5	#include <errno.h>
db2df898 MP	6	#include <stddef.h>
db2df898 MP	7	#include <stdio.h>
db2df898 MP	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
4c89c718 MP	29	#define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_WITH_BOOLEAN(name,type,yes,scope) \
4c89c718 MP	30	scope type name##_from_string(const char *s) { \
5a920b42	31	if (!s) \
3a6ce677 BR	32	return -EINVAL; \
3a6ce677 BR	33	int b = parse_boolean(s); \
4c89c718 MP	34	if (b == 0) \
4c89c718 MP	35	return (type) 0; \
3a6ce677	36	if (b > 0) \
4c89c718 MP	37	return yes; \
	38	return (type) string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
	39	}
	40
aa27b158 MP	41	#define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING_FALLBACK(name,type,max,scope) \
aa27b158 MP	42	scope int name##_to_string_alloc(type i, char **str) { \
db2df898 MP	43	char *s; \
	44	if (i < 0 \|\| i > max) \
	45	return -ERANGE; \
46cdbd49	46	if (i < (type) ELEMENTSOF(name##_table) && name##_table[i]) { \
db2df898 MP	47	s = strdup(name##_table[i]); \
	48	if (!s) \
	49	return -ENOMEM; \
	50	} else { \
	51	if (asprintf(&s, "%i", i) < 0) \
	52	return -ENOMEM; \
	53	} \
	54	*str = s; \
	55	return 0; \
aa27b158 MP	56	}
	57
	58	#define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_FALLBACK(name,type,max,scope) \
6e866b33	59	scope type name##_from_string(const char *s) { \
db2df898	60	unsigned u = 0; \
bb4f798a	61	type i; \
db2df898	62	if (!s) \
3a6ce677	63	return -EINVAL; \
bb4f798a MB	64	i = (type) string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
	65	if (i >= 0) \
	66	return i; \
3a6ce677 BR	67	if (safe_atou(s, &u) < 0) \
	68	return -EINVAL; \
	69	if (u > max) \
	70	return -EINVAL; \
	71	return (type) u; \
	72	}
aa27b158	73
aa27b158 MP	74	#define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
aa27b158 MP	75	_DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
b012e921	76	_DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope)
aa27b158 MP	77
	78	#define _DEFINE_STRING_TABLE_LOOKUP_WITH_BOOLEAN(name,type,yes,scope) \
	79	_DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
b012e921	80	_DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_WITH_BOOLEAN(name,type,yes,scope)
aa27b158 MP	81
aa27b158 MP	82	#define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
3a6ce677 BR	83	#define DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,)
3a6ce677 BR	84	#define DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,)
aa27b158 MP	85	#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
	86	#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
	87	#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,static)
	88
	89	#define DEFINE_STRING_TABLE_LOOKUP_WITH_BOOLEAN(name,type,yes) _DEFINE_STRING_TABLE_LOOKUP_WITH_BOOLEAN(name,type,yes,)
3a6ce677 BR	90	#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_WITH_BOOLEAN(name,type,yes) _DEFINE_STRING_TABLE_LOOKUP_WITH_BOOLEAN(name,type,yes,static)
	91	#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING_WITH_BOOLEAN(name,type,yes) \
	92	_DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_WITH_BOOLEAN(name,type,yes,static)
aa27b158 MP	93
	94	/* For string conversions where numbers are also acceptable */
	95	#define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
	96	_DEFINE_STRING_TABLE_LOOKUP_TO_STRING_FALLBACK(name,type,max,) \
b012e921	97	_DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_FALLBACK(name,type,max,)
aa27b158 MP	98
	99	#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING_FALLBACK(name,type,max) \
	100	_DEFINE_STRING_TABLE_LOOKUP_TO_STRING_FALLBACK(name,type,max,static)
	101	#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING_FALLBACK(name,type,max) \
	102	_DEFINE_STRING_TABLE_LOOKUP_FROM_STRING_FALLBACK(name,type,max,static)
b012e921 MB	103
	104	#define DUMP_STRING_TABLE(name,type,max) \
	105	do { \
b012e921	106	flockfile(stdout); \
3a6ce677	107	for (type _k = 0; _k < (max); _k++) { \
b012e921 MB	108	const char *_t; \
	109	_t = name##_to_string(_k); \
	110	if (!_t) \
	111	continue; \
	112	fputs_unlocked(_t, stdout); \
	113	fputc_unlocked('\n', stdout); \
	114	} \
	115	funlockfile(stdout); \
8f232108	116	} while (false)