1 #include <tools/ccanlint/ccanlint.h>
2 #include <tools/tools.h>
3 #include <ccan/str/str.h>
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"
22 "#endif /* CCAN_<MODNAME>_H */\n";
24 static void fix_name(char *name)
28 for (i = 0; name[i]; i++) {
29 if (cisalnum(name[i]))
30 name[i] = toupper(name[i]);
36 static void handle_idem(struct manifest *m, struct score *score)
40 list_for_each(&score->per_file_errors, e, list) {
41 char *name, *q, *tmpname;
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);
50 name = tal_fmt(score, "CCAN_%s_%s",
51 m->modname, e->file->name);
55 "Should I wrap %s in #ifndef/#define %s for you?",
60 tmpname = temp_file(score, ".h", e->file->name);
61 out = fopen(tmpname, "w");
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);
67 for (i = 0; e->file->lines[i]; i++)
68 if (fprintf(out, "%s\n", e->file->lines[i]) < 0)
69 err(1, "Writing %s", tmpname);
71 if (fprintf(out, "#endif /* %s */\n", name) < 0)
72 err(1, "Writing %s", tmpname);
75 err(1, "Closing %s", tmpname);
77 if (!move_file(tmpname, e->file->fullname))
78 err(1, "Moving %s to %s", tmpname, e->file->fullname);
82 static void check_idem(struct ccan_file *f, struct score *score)
84 struct line_info *line_info;
85 unsigned int i, first_preproc_line;
86 const char *line, *sym;
88 line_info = get_ccan_line_info(f);
89 if (tal_count(f->lines) < 4)
90 /* FIXME: We assume small headers probably uninteresting. */
93 for (i = 0; f->lines[i]; i++) {
94 if (line_info[i].type == DOC_LINE
95 || line_info[i].type == COMMENT_LINE)
97 if (line_info[i].type == CODE_LINE) {
98 score_file_error(score, f, i+1,
99 "Expect first non-comment line to be"
102 } else if (line_info[i].type == PREPROC_LINE)
106 /* No code at all? Don't complain. */
110 first_preproc_line = i;
111 for (i = first_preproc_line+1; f->lines[i]; i++) {
112 if (line_info[i].type == DOC_LINE
113 || line_info[i].type == COMMENT_LINE)
115 if (line_info[i].type == CODE_LINE) {
116 score_file_error(score, f, i+1,
117 "Expect second non-comment line to be"
120 } else if (line_info[i].type == PREPROC_LINE)
124 /* No code at all? Weird. */
128 /* We expect a condition around this line. */
129 if (!line_info[i].cond) {
130 score_file_error(score, f, first_preproc_line+1,
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, first_preproc_line+1,
145 /* And this to be #define <symbol> */
146 if (!get_token(&line, "#"))
148 if (!get_token(&line, "define")) {
149 score_file_error(score, f, i+1,
150 "expected '#define %s'",
151 line_info[i].cond->symbol);
154 sym = get_symbol_token(f, &line);
155 if (!sym || !streq(sym, line_info[i].cond->symbol)) {
156 score_file_error(score, f, i+1,
157 "expected '#define %s'",
158 line_info[i].cond->symbol);
162 /* Record this for use in depends_accurate */
163 f->idempotent_cond = line_info[i].cond;
165 /* Rest of code should all be covered by that conditional. */
166 for (i++; f->lines[i]; i++) {
167 unsigned int val = 0;
168 if (line_info[i].type == DOC_LINE
169 || line_info[i].type == COMMENT_LINE)
171 if (get_ccan_line_pp(line_info[i].cond, sym, &val, NULL)
173 score_file_error(score, f, i+1, "code outside"
174 " idempotent region");
180 static void check_idempotent(struct manifest *m,
181 unsigned int *timeleft, struct score *score)
185 /* We don't fail ccanlint for this. */
188 list_for_each(&m->h_files, f, list) {
189 check_idem(f, score);
192 score->score = score->total;
196 struct ccanlint headers_idempotent = {
197 .key = "headers_idempotent",
198 .name = "Module headers are #ifndef/#define wrapped",
199 .check = check_idempotent,
200 .handle = handle_idem,
201 .needs = "info_exists main_header_exists"
204 REGISTER_TEST(headers_idempotent);