git.ozlabs.org Git - ccan/blob - tools/ccanlint/tests/headers_idempotent.c

   1 #include <tools/ccanlint/ccanlint.h>
   2 #include <tools/tools.h>
   3 #include <ccan/str/str.h>
   4 #include <sys/types.h>
   5 #include <sys/stat.h>
   6 #include <fcntl.h>
   7 #include <unistd.h>
   8 #include <limits.h>
   9 #include <errno.h>
  10 #include <stdlib.h>
  11 #include <stdio.h>
  12 #include <err.h>
  13 #include <string.h>
  14 #include <ctype.h>
  15
  16 static const char explain[]
  17 = "Headers usually start with the C preprocessor lines to prevent multiple\n"
  18   "inclusions.  These look like the following:\n"
  19   "#ifndef CCAN_<MODNAME>_H\n"
  20   "#define CCAN_<MODNAME>_H\n"
  21   "...\n"
  22   "#endif /* CCAN_<MODNAME>_H */\n";
  23
  24 static void fix_name(char *name)
  25 {
  26         unsigned int i;
  27
  28         for (i = 0; name[i]; i++) {
  29                 if (cisalnum(name[i]))
  30                         name[i] = toupper(name[i]);
  31                 else
  32                         name[i] = '_';
  33         }
  34 }
  35
  36 static void handle_idem(struct manifest *m, struct score *score)
  37 {
  38         struct file_error *e;
  39
  40         list_for_each(&score->per_file_errors, e, list) {
  41                 char *name, *q, *tmpname;
  42                 FILE *out;
  43                 unsigned int i;
  44
  45                 /* Main header gets CCAN_FOO_H, others CCAN_FOO_XXX_H */
  46                 if (strstarts(e->file->name, m->basename)
  47                     || strlen(e->file->name) == strlen(m->basename) + 2)
  48                         name = tal_fmt(score, "CCAN_%s_H", m->modname);
  49                 else
  50                         name = tal_fmt(score, "CCAN_%s_%s",
  51                                        m->modname, e->file->name);
  52                 fix_name(name);
  53
  54                 q = tal_fmt(score,
  55                             "Should I wrap %s in #ifndef/#define %s for you?",
  56                             e->file->name, name);
  57                 if (!ask(q))
  58                         continue;
  59
  60                 tmpname = temp_file(score, ".h", e->file->name);
  61                 out = fopen(tmpname, "w");
  62                 if (!out)
  63                         err(1, "Opening %s", tmpname);
  64                 if (fprintf(out, "#ifndef %s\n#define %s\n", name, name) < 0)
  65                         err(1, "Writing %s", tmpname);
  66
  67                 for (i = 0; i < e->file->num_lines; i++)
  68                         if (fprintf(out, "%s\n", e->file->lines[i]) < 0)
  69                                 err(1, "Writing %s", tmpname);
  70
  71                 if (fprintf(out, "#endif /* %s */\n", name) < 0)
  72                         err(1, "Writing %s", tmpname);
  73
  74                 if (fclose(out) != 0)
  75                         err(1, "Closing %s", tmpname);
  76
  77                 if (!move_file(tmpname, e->file->fullname))
  78                         err(1, "Moving %s to %s", tmpname, e->file->fullname);
  79         }
  80 }
  81
  82 static void check_idem(struct ccan_file *f, struct score *score)
  83 {
  84         struct line_info *line_info;
  85         unsigned int i, first_preproc_line;
  86         const char *line, *sym;
  87
  88         line_info = get_ccan_line_info(f);
  89         if (f->num_lines < 3)
  90                 /* FIXME: We assume small headers probably uninteresting. */
  91                 return;
  92
  93         for (i = 0; i < f->num_lines; i++) {
  94                 if (line_info[i].type == DOC_LINE
  95                     || line_info[i].type == COMMENT_LINE)
  96                         continue;
  97                 if (line_info[i].type == CODE_LINE) {
  98                         score_file_error(score, f, i+1,
  99                                          "Expect first non-comment line to be"
 100                                          " #ifndef.");
 101                         return;
 102                 } else if (line_info[i].type == PREPROC_LINE)
 103                         break;
 104         }
 105
 106         /* No code at all?  Don't complain. */
 107         if (i == f->num_lines)
 108                 return;
 109
 110         first_preproc_line = i;
 111         for (i = first_preproc_line+1; i < f->num_lines; i++) {
 112                 if (line_info[i].type == DOC_LINE
 113                     || line_info[i].type == COMMENT_LINE)
 114                         continue;
 115                 if (line_info[i].type == CODE_LINE) {
 116                         score_file_error(score, f, i+1,
 117                                          "Expect second non-comment line to be"
 118                                          " #define.");
 119                         return;
 120                 } else if (line_info[i].type == PREPROC_LINE)
 121                         break;
 122         }
 123
 124         /* No code at all?  Weird. */
 125         if (i == f->num_lines)
 126                 return;
 127
 128         /* We expect a condition on this line. */
 129         if (!line_info[i].cond) {
 130                 score_file_error(score, f, i+1, "Expected #ifndef");
 131                 return;
 132         }
 133
 134         line = f->lines[i];
 135
 136         /* We expect the condition to be ! IFDEF <symbol>. */
 137         if (line_info[i].cond->type != PP_COND_IFDEF
 138             || !line_info[i].cond->inverse) {
 139                 score_file_error(score, f, i+1, "Expected #ifndef");
 140                 return;
 141         }
 142
 143         /* And this to be #define <symbol> */
 144         if (!get_token(&line, "#"))
 145                 abort();
 146         if (!get_token(&line, "define")) {
 147                 score_file_error(score, f, i+1,
 148                                  "expected '#define %s'",
 149                                  line_info[i].cond->symbol);
 150                 return;
 151         }
 152         sym = get_symbol_token(f, &line);
 153         if (!sym || !streq(sym, line_info[i].cond->symbol)) {
 154                 score_file_error(score, f, i+1,
 155                                  "expected '#define %s'",
 156                                  line_info[i].cond->symbol);
 157                 return;
 158         }
 159
 160         /* Rest of code should all be covered by that conditional. */
 161         for (i++; i < f->num_lines; i++) {
 162                 unsigned int val = 0;
 163                 if (line_info[i].type == DOC_LINE
 164                     || line_info[i].type == COMMENT_LINE)
 165                         continue;
 166                 if (get_ccan_line_pp(line_info[i].cond, sym, &val, NULL)
 167                     != NOT_COMPILED) {
 168                         score_file_error(score, f, i+1, "code outside"
 169                                          " idempotent region");
 170                         return;
 171                 }
 172         }
 173 }
 174
 175 static void check_idempotent(struct manifest *m,
 176                              unsigned int *timeleft, struct score *score)
 177 {
 178         struct ccan_file *f;
 179
 180         /* We don't fail ccanlint for this. */
 181         score->pass = true;
 182
 183         list_for_each(&m->h_files, f, list) {
 184                 check_idem(f, score);
 185         }
 186         if (!score->error) {
 187                 score->score = score->total;
 188         }
 189 }
 190
 191 struct ccanlint headers_idempotent = {
 192         .key = "headers_idempotent",
 193         .name = "Module headers are #ifndef/#define wrapped",
 194         .check = check_idempotent,
 195         .handle = handle_idem,
 196         .needs = "info_exists main_header_exists"
 197 };
 198
 199 REGISTER_TEST(headers_idempotent);