git.ozlabs.org Git - ccan/blob - 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 /* 0 == Describe failed tests.
  15    1 == Describe results for partial failures.
  16    2 == One line per test, plus details of failures.
  17
  18    Mainly for debugging ccanlint:
  19    3 == Describe every object built.
  20    4 == Describe every action. */
  21 extern int verbose;
  22
  23 struct manifest {
  24         char *dir;
  25         /* The module name, ie. final element of dir name */
  26         char *basename;
  27         struct ccan_file *info_file;
  28
  29         struct list_head c_files;
  30         struct list_head h_files;
  31
  32         struct list_head run_tests;
  33         struct list_head api_tests;
  34         struct list_head compile_ok_tests;
  35         struct list_head compile_fail_tests;
  36         struct list_head other_test_c_files;
  37         struct list_head other_test_files;
  38
  39         struct list_head other_files;
  40         struct list_head examples;
  41         struct list_head mangled_examples;
  42
  43         /* From tests/check_depends_exist.c */
  44         struct list_head dep_dirs;
  45 };
  46
  47 struct manifest *get_manifest(const void *ctx, const char *dir);
  48
  49 struct file_error {
  50         struct list_node list;
  51         struct ccan_file *file;
  52         unsigned int line; /* 0 not to print */
  53         const char *error;
  54 };
  55
  56 struct score {
  57         bool pass;
  58         unsigned int score, total;
  59         const char *error;
  60         struct list_head per_file_errors;
  61 };
  62
  63 struct ccanlint {
  64         struct list_node list;
  65
  66         /* More concise unique name of test. */
  67         const char *key;
  68
  69         /* Unique name of test */
  70         const char *name;
  71
  72         /* Can we run this test?  Return string explaining why, if not. */
  73         const char *(*can_run)(struct manifest *m);
  74
  75         /* keep is set if you should keep the results.
  76          * If timeleft is set to 0, means it timed out.
  77          * score is the result, and a talloc context freed after all our
  78          * depends are done. */
  79         void (*check)(struct manifest *m,
  80                       bool keep, unsigned int *timeleft, struct score *score);
  81
  82         /* Can we do something about it? (NULL if not) */
  83         void (*handle)(struct manifest *m, struct score *score);
  84
  85         /* Options from _info. */
  86         char *options;
  87         /* If not set, we'll give an error if they try to set options. */
  88         bool takes_options;
  89
  90         /* Internal use fields: */
  91         /* Who depends on us? */
  92         struct list_head dependencies;
  93         /* How many things do we (still) depend on? */
  94         unsigned int num_depends;
  95         /* Did we skip a dependency?  If so, must skip this, too. */
  96         const char *skip;
  97         /* Did we fail a dependency?  If so, skip and mark as fail. */
  98         bool skip_fail;
  99         /* Did the user want to keep these results? */
 100         bool keep_results;
 101 };
 102
 103 /* Ask the user a yes/no question: the answer is NO if there's an error. */
 104 bool ask(const char *question);
 105
 106 enum line_info_type {
 107         PREPROC_LINE, /* Line starts with # */
 108         CODE_LINE, /* Code (ie. not pure comment). */
 109         DOC_LINE, /* Line with kernel-doc-style comment. */
 110         COMMENT_LINE, /* (pure) comment line */
 111 };
 112
 113 /* So far, only do simple #ifdef/#ifndef/#if defined/#if !defined tests,
 114  * and #if <SYMBOL>/#if !<SYMBOL> */
 115 struct pp_conditions {
 116         /* We're inside another ifdef? */
 117         struct pp_conditions *parent;
 118
 119         enum {
 120                 PP_COND_IF,
 121                 PP_COND_IFDEF,
 122                 PP_COND_UNKNOWN,
 123         } type;
 124
 125         bool inverse;
 126         const char *symbol;
 127 };
 128
 129 /* Preprocessor information about each line. */
 130 struct line_info {
 131         enum line_info_type type;
 132
 133         /* Is this actually a continuation of line above? (which ends in \) */
 134         bool continued;
 135
 136         /* Conditions for this line to be compiled. */
 137         struct pp_conditions *cond;
 138 };
 139
 140 struct ccan_file {
 141         struct list_node list;
 142
 143         /* Name (usually, within m->dir). */
 144         char *name;
 145
 146         /* Full path name. */
 147         char *fullname;
 148
 149         /* Pristine version of the original file.
 150          * Use get_ccan_file_contents to fill this. */
 151         const char *contents;
 152         size_t contents_size;
 153
 154         /* Use get_ccan_file_lines / get_ccan_line_info to fill these. */
 155         unsigned int num_lines;
 156         char **lines;
 157         struct line_info *line_info;
 158
 159         struct list_head *doc_sections;
 160
 161         /* If this file gets compiled (eg. .C file to .o file), result here. */
 162         char *compiled;
 163
 164         /* Compiled with coverage information. */
 165         char *cov_compiled;
 166 };
 167
 168 /* A new ccan_file, with the given name (talloc_steal onto returned value). */
 169 struct ccan_file *new_ccan_file(const void *ctx, const char *dir, char *name);
 170
 171 /* Use this rather than accessing f->contents directly: loads on demand. */
 172 const char *get_ccan_file_contents(struct ccan_file *f);
 173
 174 /* Use this rather than accessing f->lines directly: loads on demand. */
 175 char **get_ccan_file_lines(struct ccan_file *f);
 176
 177 /* Use this rather than accessing f->lines directly: loads on demand. */
 178 struct line_info *get_ccan_line_info(struct ccan_file *f);
 179
 180 enum line_compiled {
 181         NOT_COMPILED,
 182         COMPILED,
 183         MAYBE_COMPILED,
 184 };
 185
 186 /* Simple evaluator.  If symbols are set this way, is this condition true?
 187  * NULL values mean undefined, NULL symbol terminates. */
 188 enum line_compiled get_ccan_line_pp(struct pp_conditions *cond,
 189                                     const char *symbol,
 190                                     const unsigned int *value, ...);
 191
 192 /* Get token if it's equal to token. */
 193 bool get_token(const char **line, const char *token);
 194 /* Talloc copy of symbol token, or NULL.  Increment line. */
 195 char *get_symbol_token(void *ctx, const char **line);
 196
 197 /* Similarly for ->doc_sections */
 198 struct list_head *get_ccan_file_docs(struct ccan_file *f);
 199
 200 /* Add an error about this file (and line, if non-zero) to the score struct */
 201 void score_file_error(struct score *, struct ccan_file *f, unsigned line,
 202                       const char *error);
 203
 204 /* Normal tests. */
 205 extern struct ccanlint trailing_whitespace;
 206
 207 /* Dependencies */
 208 struct dependent {
 209         struct list_node node;
 210         struct ccanlint *dependent;
 211 };
 212
 213 /* Are we happy to compile stuff, or just non-intrusive tests? */
 214 extern bool safe_mode;
 215
 216 /* Where is the ccan dir?  Available after first manifest. */
 217 extern const char *ccan_dir;
 218
 219 #endif /* CCAN_LINT_H */