src/basic/string-table.h

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