src/declare.c

   1 /*
   2  *  Render C declarations.
   3  *  Copyright © 2011, 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 <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #include <config.h>
  20 #include <stdio.h>
  21 #include <stdbool.h>
  22 #include <inttypes.h>
  23 #include <assert.h>
  24
  25 #include "cdecl.h"
  26 #include "cdecl-internal.h"
  27
  28 static void
  29 declare_declarator(struct output_state *dst, struct cdecl_declarator *d);
  30
  31 static void declare_decl(struct output_state *dst, struct cdecl *decl)
  32 {
  33         const char *sep;
  34
  35         sep = cdecl__emit_specs(dst, decl->specifiers, -1);
  36         if (decl->declarators->type != CDECL_DECL_NULL)
  37                 cdecl__emit(dst, sep);
  38
  39         declare_declarator(dst, decl->declarators);
  40 }
  41
  42 static void
  43 declare_postfix_child(struct output_state *dst, struct cdecl_declarator *d)
  44 {
  45         if (d->type == CDECL_DECL_POINTER)
  46                 cdecl__emit(dst, "(");
  47
  48         declare_declarator(dst, d);
  49
  50         if (d->type == CDECL_DECL_POINTER)
  51                 cdecl__emit(dst, ")");
  52 }
  53
  54 static void declare_pointer(struct output_state *dst, struct cdecl_pointer *p)
  55 {
  56         struct cdecl_declspec *q = p->qualifiers;
  57
  58         if (q) {
  59                 cdecl__emit(dst, "* ");
  60                 cdecl__emit_specs(dst, q, -1);
  61                 cdecl__emit(dst, " ");
  62         } else {
  63                 cdecl__emit(dst, "*");
  64         }
  65 }
  66
  67 static void declare_array(struct output_state *dst, struct cdecl_array *a)
  68 {
  69         cdecl__emit(dst, "[");
  70
  71         if (a->vla) {
  72                 const char *s = a->vla[0] ? a->vla : "*";
  73                 cdecl__emit(dst, s);
  74         } else {
  75                 size_t rc = snprintf(dst->dst, dst->dstlen, "%.0" PRIuMAX, a->length);
  76                 cdecl__advance(dst, rc);
  77         }
  78
  79         cdecl__emit(dst, "]");
  80 }
  81
  82 static void
  83 declare_function(struct output_state *dst, struct cdecl_function *f)
  84 {
  85         struct cdecl *p;
  86
  87         cdecl__emit(dst, "(");
  88
  89         for (p = f->parameters; p; p = p->next) {
  90                 declare_decl(dst, p);
  91
  92                 if (p->next)
  93                         cdecl__emit(dst, ", ");
  94                 else if (f->variadic)
  95                         cdecl__emit(dst, ", ...");
  96         }
  97
  98         cdecl__emit(dst, ")");
  99 }
 100
 101 static void
 102 declare_declarator(struct output_state *dst, struct cdecl_declarator *d)
 103 {
 104         for (; d; d = d->child) {
 105                 switch (d->type) {
 106                 case CDECL_DECL_NULL:
 107                         break;
 108                 case CDECL_DECL_IDENT:
 109                         cdecl__emit(dst, d->u.ident);
 110                         break;
 111                 case CDECL_DECL_POINTER:
 112                         declare_pointer(dst, &d->u.pointer);
 113                         break;
 114                 /*
 115                  * Arrays and functions are special: since they are postfix,
 116                  * we need to render the children before rendering their
 117                  * "bodies".
 118                  */
 119                 case CDECL_DECL_ARRAY:
 120                         declare_postfix_child(dst, d->child);
 121                         declare_array(dst, &d->u.array);
 122                         return;
 123                 case CDECL_DECL_FUNCTION:
 124                         declare_postfix_child(dst, d->child);
 125                         declare_function(dst, &d->u.function);
 126                         return;
 127                 default:
 128                         assert(0);
 129                 }
 130         }
 131 }
 132
 133 size_t cdecl_declare(char *buf, size_t n, struct cdecl *decl)
 134 {
 135         struct output_state dst = { buf, n };
 136
 137         declare_decl(&dst, decl);
 138
 139         return dst.accum;
 140 }