From: Joseph Adams <joeyadams3.14159@gmail.com>
[ccan] / tools / ccanlint / ccanlint.h
1 #ifndef CCAN_LINT_H
2 #define CCAN_LINT_H
3 #include <ccan/list/list.h>
4 #include <stdbool.h>
5 #include "../doc_extract.h"
6
7 #define REGISTER_TEST(name, ...) extern struct ccanlint name
8 #include "generated-compulsory-tests"
9 #include "generated-normal-tests"
10 #undef REGISTER_TEST
11
12 #define REGISTER_TEST(name, ...) 
13
14 struct manifest {
15         char *dir;
16         /* The module name, ie. final element of dir name */
17         char *basename;
18         struct ccan_file *info_file;
19
20         struct list_head c_files;
21         struct list_head h_files;
22
23         struct list_head run_tests;
24         struct list_head api_tests;
25         struct list_head compile_ok_tests;
26         struct list_head compile_fail_tests;
27         struct list_head other_test_c_files;
28         struct list_head other_test_files;
29
30         struct list_head other_files;
31
32         /* From tests/check_depends_exist.c */
33         struct list_head dep_dirs;
34         /* From tests/check_depends_built.c */
35         struct list_head dep_objs;
36 };
37
38 struct manifest *get_manifest(const void *ctx, const char *dir);
39
40 struct ccanlint {
41         struct list_node list;
42
43         /* More concise unique name of test. */
44         const char *key;
45
46         /* Unique name of test */
47         const char *name;
48
49         /* Total score that this test is worth. */
50         unsigned int total_score;
51
52         /* Can we run this test?  Return string explaining why, if not. */
53         const char *(*can_run)(struct manifest *m);
54
55         /* If this returns non-NULL, it means the check failed. */
56         void *(*check)(struct manifest *m);
57
58         /* The non-NULL return from check is passed to one of these: */
59
60         /* So, what did this get out of the total_score?  (NULL means 0). */
61         unsigned int (*score)(struct manifest *m, void *check_result);
62
63         /* Verbose description of what was wrong. */
64         const char *(*describe)(struct manifest *m, void *check_result);
65
66         /* Can we do something about it? (NULL if not) */
67         void (*handle)(struct manifest *m, void *check_result);
68
69         /* Internal use fields: */
70         /* Who depends on us? */
71         struct list_head dependencies;
72         /* How many things do we (still) depend on? */
73         unsigned int num_depends;
74         /* Did we skip a dependency?  If so, must skip this, too. */
75         bool skip;
76         /* Did we fail a dependency?  If so, skip and mark as fail. */
77         bool skip_fail;
78 };
79
80 /* Ask the user a yes/no question: the answer is NO if there's an error. */
81 bool ask(const char *question);
82
83 enum line_info_type {
84         PREPROC_LINE, /* Line starts with # */
85         CODE_LINE, /* Code (ie. not pure comment). */
86         DOC_LINE, /* Line with kernel-doc-style comment. */
87         COMMENT_LINE, /* (pure) comment line */
88 };
89
90 /* So far, only do simple #ifdef/#ifndef/#if defined/#if !defined tests,
91  * and #if <SYMBOL>/#if !<SYMBOL> */
92 struct pp_conditions {
93         /* We're inside another ifdef? */
94         struct pp_conditions *parent;
95
96         enum {
97                 PP_COND_IF,
98                 PP_COND_IFDEF,
99                 PP_COND_UNKNOWN,
100         } type;
101
102         bool inverse;
103         const char *symbol;
104 };
105
106 /* Preprocessor information about each line. */
107 struct line_info {
108         enum line_info_type type;
109
110         /* Is this actually a continuation of line above? (which ends in \) */
111         bool continued;
112
113         /* Conditions for this line to be compiled. */
114         struct pp_conditions *cond;
115 };
116
117 struct ccan_file {
118         struct list_node list;
119
120         /* Name (usually, within m->dir). */
121         char *name;
122
123         /* Full path name. */
124         char *fullname;
125
126         /* Pristine version of the original file.
127          * Use get_ccan_file_lines to fill this. */
128         const char *contents;
129         size_t contents_size;
130
131         /* Use get_ccan_file_lines / get_ccan_line_info to fill these. */
132         unsigned int num_lines;
133         char **lines;
134         struct line_info *line_info;
135
136         struct list_head *doc_sections;
137
138         /* If this file gets compiled (eg. .C file to .o file), result here. */
139         char *compiled;
140 };
141
142 /* A new ccan_file, with the given name (talloc_steal onto returned value). */
143 struct ccan_file *new_ccan_file(const void *ctx, const char *dir, char *name);
144
145 /* Use this rather than accessing f->lines directly: loads on demand. */
146 char **get_ccan_file_lines(struct ccan_file *f);
147
148 /* Use this rather than accessing f->lines directly: loads on demand. */
149 struct line_info *get_ccan_line_info(struct ccan_file *f);
150
151 enum line_compiled {
152         NOT_COMPILED,
153         COMPILED,
154         MAYBE_COMPILED,
155 };
156
157 /* Simple evaluator.  If symbols are set this way, is this condition true?
158  * NULL values mean undefined, NULL symbol terminates. */
159 enum line_compiled get_ccan_line_pp(struct pp_conditions *cond,
160                                     const char *symbol,
161                                     const unsigned int *value, ...);
162
163 /* Get token if it's equal to token. */
164 bool get_token(const char **line, const char *token);
165 /* Talloc copy of symbol token, or NULL.  Increment line. */
166 char *get_symbol_token(void *ctx, const char **line);
167
168 /* Similarly for ->doc_sections */
169 struct list_head *get_ccan_file_docs(struct ccan_file *f);
170
171
172 /* Call the reporting on every line in the file.  sofar contains
173  * previous results. */
174 char *report_on_lines(struct list_head *files,
175                       char *(*report)(const char *),
176                       char *sofar);
177
178 /* Normal tests. */
179 extern struct ccanlint trailing_whitespace;
180
181 /* Dependencies */
182 struct dependent {
183         struct list_node node;
184         struct ccanlint *dependent;
185 };
186
187 /* Are we happy to compile stuff, or just non-intrusive tests? */
188 extern bool safe_mode;
189
190 /* Where is the ccan dir?  Available after first manifest. */
191 extern const char *ccan_dir;
192
193 #endif /* CCAN_LINT_H */