X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=fc92cd783c7dcd26a4717af2bbcca40d37f02351;hp=41a569fab89c8fd906d6951fe635e14e9dae6c97;hb=af5b1a18948345c5f9f9abf4eda3ab9fe0aa9a9f;hpb=ca951c94fba731b878f5bb3f81bb99c397dc4e12 diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h index 41a569fa..fc92cd78 100644 --- a/tools/ccanlint/ccanlint.h +++ b/tools/ccanlint/ccanlint.h @@ -1,15 +1,13 @@ #ifndef CCAN_LINT_H #define CCAN_LINT_H +#include "config.h" #include +#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. @@ -20,12 +18,24 @@ 4 == Describe every action. */ extern int verbose; +enum compile_type { + COMPILE_NORMAL, + COMPILE_NOFEAT, + COMPILE_COVERAGE, + COMPILE_TYPES +}; + struct manifest { char *dir; /* The module name, ie. final element of dir name */ char *basename; struct ccan_file *info_file; + /* Linked off deps. */ + struct list_node list; + /* Where our final compiled output is */ + char *compiled[COMPILE_TYPES]; + struct list_head c_files; struct list_head h_files; @@ -41,28 +51,36 @@ struct manifest { 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; /* 0 not to print */ - const char *error; + 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; - const char *error; + /* 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; - /* More concise unique name of test. */ const char *key; @@ -72,27 +90,33 @@ struct ccanlint { /* Can we run this test? Return string explaining why, if not. */ const char *(*can_run)(struct manifest *m); - /* keep is set if you should keep the results. - * If timeleft is set to 0, means it timed out. + /* Should we stop immediately if test fails? */ + bool compulsory; + + /* 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); + unsigned int *timeleft, struct score *score); /* Can we do something about it? (NULL if not) */ void (*handle)(struct manifest *m, struct score *score); + /* Options from _info. */ + char **options; + /* If not set, we'll give an error if they try to set options. */ + bool takes_options; + + /* Space-separated list of dependency keys. */ + const char *needs; + /* Internal use fields: */ - /* Who depends on us? */ - struct list_head dependencies; - /* How many things do we (still) depend on? */ - unsigned int num_depends; + /* We are a node in a dependency graph. */ + struct dgraph_node node; /* Did we skip a dependency? If so, must skip this, too. */ 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? */ - bool keep_results; + /* Have we already run this? */ + bool done; }; /* Ask the user a yes/no question: the answer is NO if there's an error. */ @@ -154,10 +178,16 @@ struct ccan_file { struct list_head *doc_sections; /* If this file gets compiled (eg. .C file to .o file), result here. */ - char *compiled; + char *compiled[COMPILE_TYPES]; + + /* Filename containing output from valgrind. */ + char *valgrind_log; - /* 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). */ @@ -172,6 +202,9 @@ 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, @@ -192,9 +225,26 @@ char *get_symbol_token(void *ctx, const char **line); /* Similarly for ->doc_sections */ struct list_head *get_ccan_file_docs(struct ccan_file *f); -/* Add an error about this file (and line, if non-zero) to the score struct */ +/* Get NULL-terminated array options for this file for this test */ +char **per_file_options(const struct ccanlint *test, struct ccan_file *f); + +/* 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 *error); + const char *errorfmt, ...); + +/* Start a command in the background. */ +void run_command_async(const void *ctx, unsigned int time_ms, + const char *fmt, ...); + +/* Async version of compile_and_link. */ +void compile_and_link_async(const void *ctx, unsigned int time_ms, + const char *cfile, const char *ccandir, + const char *objs, const char *compiler, + const char *cflags, + const char *libs, const char *outfile); + +/* Get results of a command, returning ctx (and free it). */ +void *collect_command(bool *ok, char **output); /* Normal tests. */ extern struct ccanlint trailing_whitespace; @@ -205,10 +255,25 @@ struct dependent { struct ccanlint *dependent; }; +/* Is this test excluded (cmdline or _info). */ +bool is_excluded(const char *name); + +/* Called to add options from _info, once it's located. */ +void add_info_options(struct ccan_file *info); + /* Are we happy to compile stuff, or just non-intrusive tests? */ extern bool safe_mode; +/* Did the user want to keep all the results? */ +extern bool keep_results; + /* 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 */