1 #include <tools/ccanlint/ccanlint.h>
2 #include <tools/tools.h>
3 #include <ccan/talloc/talloc.h>
4 #include <ccan/str/str.h>
17 static const char explain[]
18 = "Headers usually start with the C preprocessor lines to prevent multiple\n"
19 "inclusions. These look like the following:\n"
20 "#ifndef CCAN_<MODNAME>_H\n"
21 "#define CCAN_<MODNAME>_H\n"
23 "#endif /* CCAN_<MODNAME>_H */\n";
25 static void fix_name(char *name)
29 for (i = 0; name[i]; i++) {
31 name[i] = toupper(name[i]);
37 static void handle_idem(struct manifest *m, struct score *score)
41 list_for_each(&score->per_file_errors, e, list) {
42 char *name, *q, *tmpname;
46 /* Main header gets CCAN_FOO_H, others CCAN_FOO_XXX_H */
47 if (strstarts(e->file->name, m->basename)
48 || strlen(e->file->name) == strlen(m->basename) + 2)
49 name = talloc_asprintf(score, "CCAN_%s_H", m->basename);
51 name = talloc_asprintf(score, "CCAN_%s_%s",
52 m->basename, e->file->name);
55 q = talloc_asprintf(score,
56 "Should I wrap %s in #ifndef/#define %s for you?",
61 tmpname = maybe_temp_file(score, ".h", false, e->file->name);
62 out = fopen(tmpname, "w");
64 err(1, "Opening %s", tmpname);
65 if (fprintf(out, "#ifndef %s\n#define %s\n", name, name) < 0)
66 err(1, "Writing %s", tmpname);
68 for (i = 0; i < e->file->num_lines; i++)
69 if (fprintf(out, "%s\n", e->file->lines[i]) < 0)
70 err(1, "Writing %s", tmpname);
72 if (fprintf(out, "#endif /* %s */\n", name) < 0)
73 err(1, "Writing %s", tmpname);
76 err(1, "Closing %s", tmpname);
78 if (!move_file(tmpname, e->file->fullname))
79 err(1, "Moving %s to %s", tmpname, e->file->fullname);
83 static void check_idem(struct ccan_file *f, struct score *score)
85 struct line_info *line_info;
86 unsigned int i, first_preproc_line;
87 const char *line, *sym;
89 line_info = get_ccan_line_info(f);
91 /* FIXME: We assume small headers probably uninteresting. */
94 for (i = 0; i < f->num_lines; i++) {
95 if (line_info[i].type == DOC_LINE
96 || line_info[i].type == COMMENT_LINE)
98 if (line_info[i].type == CODE_LINE) {
99 score_file_error(score, f, i+1,
100 "Expect first non-comment line to be"
103 } else if (line_info[i].type == PREPROC_LINE)
107 /* No code at all? Don't complain. */
108 if (i == f->num_lines)
111 first_preproc_line = i;
112 for (i = first_preproc_line+1; i < f->num_lines; i++) {
113 if (line_info[i].type == DOC_LINE
114 || line_info[i].type == COMMENT_LINE)
116 if (line_info[i].type == CODE_LINE) {
117 score_file_error(score, f, i+1,
118 "Expect second non-comment line to be"
121 } else if (line_info[i].type == PREPROC_LINE)
125 /* No code at all? Weird. */
126 if (i == f->num_lines)
129 /* We expect a condition on this line. */
130 if (!line_info[i].cond) {
131 score_file_error(score, f, i+1, "Expected #ifndef");
137 /* We expect the condition to be ! IFDEF <symbol>. */
138 if (line_info[i].cond->type != PP_COND_IFDEF
139 || !line_info[i].cond->inverse) {
140 score_file_error(score, f, i+1, "Expected #ifndef");
144 /* And this to be #define <symbol> */
145 if (!get_token(&line, "#"))
147 if (!get_token(&line, "define")) {
148 char *str = talloc_asprintf(score,
149 "expected '#define %s'",
150 line_info[i].cond->symbol);
151 score_file_error(score, f, i+1, str);
154 sym = get_symbol_token(f, &line);
155 if (!sym || !streq(sym, line_info[i].cond->symbol)) {
156 char *str = talloc_asprintf(score,
157 "expected '#define %s'",
158 line_info[i].cond->symbol);
159 score_file_error(score, f, i+1, str);
163 /* Rest of code should all be covered by that conditional. */
164 for (i++; i < f->num_lines; i++) {
165 unsigned int val = 0;
166 if (line_info[i].type == DOC_LINE
167 || line_info[i].type == COMMENT_LINE)
169 if (get_ccan_line_pp(line_info[i].cond, sym, &val, NULL)
171 score_file_error(score, f, i+1, "code outside"
172 " idempotent region");
178 static void check_idempotent(struct manifest *m,
180 unsigned int *timeleft, struct score *score)
184 list_for_each(&m->h_files, f, list) {
185 check_idem(f, score);
189 score->score = score->total;
193 struct ccanlint headers_idempotent = {
194 .key = "headers_idempotent",
195 .name = "Module headers are #ifndef/#define wrapped",
196 .check = check_idempotent,
197 .handle = handle_idem,
201 REGISTER_TEST(headers_idempotent);