src/cdecl-internal.h

   1 /*
   2  * Internal declarations for libcdecl.
   3  * Copyright © 2021, 2023 Nick Bowler
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  17  */
  18 #ifndef CDECL_INTERNAL_H_
  19 #define CDECL_INTERNAL_H_
  20
  21 #include <stddef.h>
  22 #include <gettext.h>
  23 #include "cdecl.h"
  24
  25 #define _(s) dgettext(PACKAGE, s)
  26 #define N_(s) s
  27
  28 /* Pack the 4 "kind" bits of a valid cdecl specifier value into two bits. */
  29 #define PACK_KIND(x) ((( ((x>>8) - ((x)>>11)) ) >> 1) & 3)
  30
  31 /* Expand a packed "kind" to its original value. */
  32 #define UNPACK_KIND(x) (0x100 << (x))
  33
  34 /*
  35  * Pack a valid cdecl specifier value (CDECL_TYPE_xxx, CDECL_STOR_xxx, etc.)
  36  * into 8 bits.  We do this by encoding the specifier kind in the upper two
  37  * bits, and the enumerated sequence in the lower 6 bits. */
  38 #define PACK_SPEC(x) (((x) & 0x3f) | (PACK_KIND(x) << 6))
  39
  40 /*
  41  * Expand a packed specifier to its original value.
  42  */
  43 #define UNPACK_SPEC(x) (UNPACK_KIND((x) >> 6) | ((x) & 0x3f))
  44
  45 /*
  46  * Pack a parser token into 7 bits.
  47  *
  48  * Bison normally numbers user-defined tokens sequentially starting from 258.
  49  * If api.token,raw is used, then the numbering starts from 3.  As we have
  50  * about 50 tokens, the latter case will fit in 7 bits easily; in the former
  51  * case the upper bits are constant so we don't need to store them.
  52  */
  53 #define PACK_TOKEN(x) ((x) & 0x7f)
  54
  55 /*
  56  * Expand a packed token to its original value.
  57  */
  58 #define UNPACK_TOKEN(x) ((x) | ((T_IDENT > 256) << 8))
  59
  60 struct cdecl_error;
  61 struct cdecl_declspec;
  62
  63 #if ENABLE_NLS
  64 void cdecl__init_i18n(void);
  65 #else
  66 static inline void cdecl__init_i18n(void)
  67 {
  68 }
  69 #endif
  70
  71 void cdecl__err(unsigned code, const char *fmt, const char *arg);
  72 void cdecl__errmsg(unsigned msg);
  73
  74 struct cdecl_declspec *cdecl__normalize_specs(struct cdecl_declspec *specs);
  75
  76 struct output_state {
  77         char *dst;
  78         size_t dstlen;
  79         size_t accum;
  80 };
  81
  82 size_t cdecl__advance(struct output_state *dst, size_t amount);
  83 size_t cdecl__emit(struct output_state *dst, const char *src);
  84 size_t cdecl__emit_uint(struct output_state *dst, uintmax_t val);
  85 size_t cdecl__strlcpy(char *dst, const char *src, size_t len);
  86
  87 const char *cdecl__emit_specs(struct output_state *dst,
  88                               struct cdecl_declspec *s,
  89                               unsigned mask);
  90
  91 /*
  92  * If s is a (len bytes long) string corresponding to a declaration
  93  * specifier, then:
  94  *
  95  *   - bits 7:0 (LSB) of the return value is the packed specifier type, and
  96  *   - bits 15:8 of the return value is the packed parser token.
  97  *
  98  * Otherwise, if english_mode is nonzero and s is an "english keyword",
  99  * returns the appropriate packed parser token in bits 15:8.
 100  *
 101  * Otherwise, PACK_TOKEN(T_IDENT) is returned in bits 15:8.
 102  */
 103 unsigned cdecl__to_keyword(const char *s, int len, int english_mode);
 104
 105 /* Container for an allocated parser token's value */
 106 struct parse_item {
 107         union {
 108                 struct cdecl_declarator declarator;
 109                 struct cdecl_declspec   declspec;
 110                 struct cdecl            decl;
 111         } u;
 112
 113         char s[FLEXIBLE_ARRAY_MEMBER];
 114 };
 115
 116 struct parse_item *cdecl__alloc_item(size_t s_sz);
 117
 118 #endif