X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=76e14a2aac0c8f9b77631dd4f296b55637dcf495;hp=247d0d0d12cbe92c18f22feb6ee09565bbd1a5e3;hb=13c2e75f28189c87d527c0c752de549f21cf505d;hpb=a200e1ad1cf5a4828ea4e4e222838ddad5a4a9a3 diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h index 247d0d0d..76e14a2a 100644 --- a/tools/ccanlint/ccanlint.h +++ b/tools/ccanlint/ccanlint.h @@ -11,6 +11,15 @@ #define REGISTER_TEST(name, ...) +/* 0 == Describe failed tests. + 1 == Describe results for partial failures. + 2 == One line per test, plus details of failures. + + Mainly for debugging ccanlint: + 3 == Describe every object built. + 4 == Describe every action. */ +extern int verbose; + struct manifest { char *dir; /* The module name, ie. final element of dir name */ @@ -28,6 +37,8 @@ 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; @@ -35,6 +46,20 @@ struct manifest { struct manifest *get_manifest(const void *ctx, const char *dir); +struct file_error { + struct list_node list; + struct ccan_file *file; + unsigned int line; /* 0 not to print */ + const char *error; +}; + +struct score { + bool pass; + unsigned int score, total; + const char *error; + struct list_head per_file_errors; +}; + struct ccanlint { struct list_node list; @@ -44,27 +69,18 @@ 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); - - /* 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); - - /* Verbose description of what was wrong. */ - const char *(*describe)(struct manifest *m, void *check_result); + /* 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); /* Can we do something about it? (NULL if not) */ - void (*handle)(struct manifest *m, void *check_result); + void (*handle)(struct manifest *m, struct score *score); /* Internal use fields: */ /* Who depends on us? */ @@ -72,7 +88,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? */ @@ -126,7 +142,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,6 +163,9 @@ struct ccan_file { /* 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); @@ -174,11 +193,9 @@ char *get_symbol_token(void *ctx, const char **line); struct list_head *get_ccan_file_docs(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); +/* Add an error about this file (and line, if non-zero) to the score struct */ +void score_file_error(struct score *, struct ccan_file *f, unsigned line, + const char *error); /* Normal tests. */ extern struct ccanlint trailing_whitespace;