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