X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=8c2ee0e8826b5ff0ba974f888f879a6953721e8e;hp=9644185f5af8fba4191bdc1570800535ef6bdd30;hb=ee0e05e46813b239453e9f52b924d4d9df4607df;hpb=b0f7eb297643941bd96eb209f35fbe223cd24e10 diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h index 9644185f..8c2ee0e8 100644 --- a/tools/ccanlint/ccanlint.h +++ b/tools/ccanlint/ccanlint.h @@ -5,12 +5,19 @@ #include "../doc_extract.h" #define REGISTER_TEST(name, ...) extern struct ccanlint name -#include "generated-init-tests" +#include "generated-compulsory-tests" +#include "generated-normal-tests" #undef REGISTER_TEST #define REGISTER_TEST(name, ...) +/* 1 == Describe results for partial failures. + 2 == Describe gory details. + 3 == Describe every action. */ +extern int verbose; + struct manifest { + char *dir; /* The module name, ie. final element of dir name */ char *basename; struct ccan_file *info_file; @@ -22,27 +29,38 @@ struct manifest { struct list_head api_tests; struct list_head compile_ok_tests; struct list_head compile_fail_tests; + struct list_head other_test_c_files; struct list_head other_test_files; struct list_head other_files; + struct list_head examples; + struct list_head mangled_examples; - /* From tests/check_depends.c */ - struct list_head dep_obj_files; + /* From tests/check_depends_exist.c */ + struct list_head dep_dirs; }; -struct manifest *get_manifest(const void *ctx); +struct manifest *get_manifest(const void *ctx, const char *dir); struct ccanlint { struct list_node list; + /* More concise unique name of test. */ + const char *key; + /* Unique name of test */ const char *name; - /* Total score that this test is worth. 0 means compulsory tests. */ + /* Total score that this test is worth. */ unsigned int total_score; - /* If this returns non-NULL, it means the check failed. */ - void *(*check)(struct manifest *m); + /* 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); /* The non-NULL return from check is passed to one of these: */ @@ -60,6 +78,12 @@ struct ccanlint { struct list_head dependencies; /* How many things do we (still) depend on? */ unsigned int num_depends; + /* 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; }; /* Ask the user a yes/no question: the answer is NO if there's an error. */ @@ -102,10 +126,14 @@ struct line_info { struct ccan_file { struct list_node list; + /* Name (usually, within m->dir). */ char *name; + /* Full path name. */ + 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; @@ -115,10 +143,19 @@ struct ccan_file { struct line_info *line_info; struct list_head *doc_sections; + + /* If this file gets compiled (eg. .C file to .o file), result here. */ + char *compiled; + + /* Compiled with coverage information. */ + char *cov_compiled; }; /* A new ccan_file, with the given name (talloc_steal onto returned value). */ -struct ccan_file *new_ccan_file(const void *ctx, char *name); +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); @@ -165,4 +202,7 @@ struct dependent { /* Are we happy to compile stuff, or just non-intrusive tests? */ extern bool safe_mode; +/* Where is the ccan dir? Available after first manifest. */ +extern const char *ccan_dir; + #endif /* CCAN_LINT_H */