X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=c57f92037c6ba3a8197c8c48e102369f31db8dcd;hp=3a79fb94245daec756da410f35d48138a571bd56;hb=4786b6edb824262957bfd5e7cff74c1e3983a9c9;hpb=24908e18c8db7543084e16707b7b82ef5a094d7a diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h index 3a79fb94..c57f9203 100644 --- a/tools/ccanlint/ccanlint.h +++ b/tools/ccanlint/ccanlint.h @@ -1,20 +1,21 @@ #ifndef CCAN_LINT_H #define CCAN_LINT_H +#include "config.h" #include #include #include "../doc_extract.h" +#include "licenses.h" #define REGISTER_TEST(name, ...) extern struct ccanlint name -#include "generated-compulsory-tests" -#include "generated-normal-tests" -#undef REGISTER_TEST -#define REGISTER_TEST(name, ...) +/* 0 == Describe failed tests. + 1 == Describe results for partial failures. + 2 == One line per test, plus details of failures. -/* 1 == Describe results for partial failures. - 2 == Describe gory details. - 3 == Describe every action. */ -extern unsigned int verbose; + Mainly for debugging ccanlint: + 3 == Describe every object built. + 4 == Describe every action. */ +extern int verbose; struct manifest { char *dir; @@ -22,6 +23,11 @@ struct manifest { char *basename; struct ccan_file *info_file; + /* Linked off deps. */ + struct list_node list; + /* Where our final compiled output is */ + char *compiled; + struct list_head c_files; struct list_head h_files; @@ -33,13 +39,39 @@ struct manifest { struct list_head other_test_files; struct list_head other_files; + struct list_head examples; + struct list_head mangled_examples; /* From tests/check_depends_exist.c */ - struct list_head dep_dirs; + struct list_head deps; + + /* From tests/license_exists.c */ + enum license license; }; +/* Get the manifest for a given directory. */ struct manifest *get_manifest(const void *ctx, const char *dir); +/* Error in a particular file: stored off score->per_file_errors. */ +struct file_error { + struct list_node list; + struct ccan_file *file; + unsigned int line; +}; + +/* The score for an individual test. */ +struct score { + /* Starts as false: if not set to true, ccanlint exits non-zero. + * Thus it is usually set for compilation or other serious failures. */ + bool pass; + /* Starts at 0 and 1 respectively. */ + unsigned int score, total; + /* The error message to print. */ + char *error; + /* Per file errors, set by score_file_error() */ + struct list_head per_file_errors; +}; + struct ccanlint { struct list_node list; @@ -49,27 +81,26 @@ struct ccanlint { /* Unique name of test */ const char *name; - /* Total score that this test is worth. */ - unsigned int total_score; - /* Can we run this test? Return string explaining why, if not. */ const char *(*can_run)(struct manifest *m); - /* If this returns non-NULL, it means the check failed. - * keep is set if you should keep the results. - * If timeleft is set to 0, means it timed out. */ - void *(*check)(struct manifest *m, bool keep, unsigned int *timeleft); + /* keep is set if you should keep the results. + * If timeleft is set to 0, means it timed out. + * score is the result, and a talloc context freed after all our + * depends are done. */ + void (*check)(struct manifest *m, + bool keep, unsigned int *timeleft, struct score *score); - /* The non-NULL return from check is passed to one of these: */ - - /* So, what did this get out of the total_score? (NULL means 0). */ - unsigned int (*score)(struct manifest *m, void *check_result); + /* Can we do something about it? (NULL if not) */ + void (*handle)(struct manifest *m, struct score *score); - /* Verbose description of what was wrong. */ - const char *(*describe)(struct manifest *m, void *check_result); + /* Options from _info. */ + char **options; + /* If not set, we'll give an error if they try to set options. */ + bool takes_options; - /* Can we do something about it? (NULL if not) */ - void (*handle)(struct manifest *m, void *check_result); + /* Space-separated list of dependency keys. */ + const char *needs; /* Internal use fields: */ /* Who depends on us? */ @@ -77,7 +108,7 @@ struct ccanlint { /* How many things do we (still) depend on? */ unsigned int num_depends; /* Did we skip a dependency? If so, must skip this, too. */ - bool skip; + const char *skip; /* Did we fail a dependency? If so, skip and mark as fail. */ bool skip_fail; /* Did the user want to keep these results? */ @@ -131,7 +162,7 @@ struct ccan_file { char *fullname; /* Pristine version of the original file. - * Use get_ccan_file_lines to fill this. */ + * Use get_ccan_file_contents to fill this. */ const char *contents; size_t contents_size; @@ -147,17 +178,29 @@ struct ccan_file { /* Compiled with coverage information. */ char *cov_compiled; + + /* Leak output from valgrind. */ + char *leak_info; + + /* Simplified stream (lowercase letters and single spaces) */ + char *simplified; }; /* A new ccan_file, with the given name (talloc_steal onto returned value). */ struct ccan_file *new_ccan_file(const void *ctx, const char *dir, char *name); +/* Use this rather than accessing f->contents directly: loads on demand. */ +const char *get_ccan_file_contents(struct ccan_file *f); + /* Use this rather than accessing f->lines directly: loads on demand. */ char **get_ccan_file_lines(struct ccan_file *f); /* Use this rather than accessing f->lines directly: loads on demand. */ struct line_info *get_ccan_line_info(struct ccan_file *f); +/* Use this rather than accessing f->simplified directly: loads on demand. */ +const char *get_ccan_simplified(struct ccan_file *f); + enum line_compiled { NOT_COMPILED, COMPILED, @@ -178,12 +221,12 @@ char *get_symbol_token(void *ctx, const char **line); /* Similarly for ->doc_sections */ struct list_head *get_ccan_file_docs(struct ccan_file *f); +/* Get NULL-terminated array options for this file for this test */ +char **per_file_options(const struct ccanlint *test, struct ccan_file *f); -/* Call the reporting on every line in the file. sofar contains - * previous results. */ -char *report_on_lines(struct list_head *files, - char *(*report)(const char *), - char *sofar); +/* Append message about this file (and line, if non-zero) to the score->error */ +void score_file_error(struct score *, struct ccan_file *f, unsigned line, + const char *errorfmt, ...); /* Normal tests. */ extern struct ccanlint trailing_whitespace; @@ -200,4 +243,10 @@ extern bool safe_mode; /* Where is the ccan dir? Available after first manifest. */ extern const char *ccan_dir; +/* Compiler and CFLAGS, from config.h if available. */ +extern const char *compiler, *cflags; + +/* Contents of config.h (or NULL if not found) */ +extern const char *config_header; + #endif /* CCAN_LINT_H */