X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=ee12ce04fb81083c228e2ac47604c27ed39e25b8;hp=ac169fa81156b57452708208af65fecd05402fdf;hb=83a1386b50966eb9667478c7cef9154dbd622541;hpb=7eb00644b848b551b2db5d9de40893e488c2790d diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h index ac169fa8..ee12ce04 100644 --- a/tools/ccanlint/ccanlint.h +++ b/tools/ccanlint/ccanlint.h @@ -4,6 +4,12 @@ #include #include "../doc_extract.h" +#define REGISTER_TEST(name, ...) extern struct ccanlint name +#include "generated-init-tests" +#undef REGISTER_TEST + +#define REGISTER_TEST(name, ...) + struct manifest { char *basename; struct ccan_file *info_file; @@ -44,18 +50,65 @@ struct ccanlint { /* Can we do something about it? (NULL if not) */ void (*handle)(struct manifest *m, void *check_result); + + /* Internal use fields: */ + /* Who depends on us? */ + struct list_head dependencies; + /* How many things do we (still) depend on? */ + unsigned int num_depends; }; /* Ask the user a yes/no question: the answer is NO if there's an error. */ bool ask(const char *question); +enum line_info_type { + PREPROC_LINE, /* Line starts with # */ + CODE_LINE, /* Code (ie. not pure comment). */ + DOC_LINE, /* Line with kernel-doc-style comment. */ + COMMENT_LINE, /* (pure) comment line */ +}; + +/* So far, only do simple #ifdef/#ifndef/#if defined/#if !defined tests, + * and #if /#if ! */ +struct pp_conditions { + /* We're inside another ifdef? */ + struct pp_conditions *parent; + + enum { + PP_COND_IF, + PP_COND_IFDEF, + PP_COND_UNKNOWN, + } type; + + bool inverse; + const char *symbol; +}; + +/* Preprocessor information about each line. */ +struct line_info { + enum line_info_type type; + + /* Is this actually a continuation of line above? (which ends in \) */ + bool continued; + + /* Conditions for this line to be compiled. */ + struct pp_conditions *cond; +}; + struct ccan_file { struct list_node list; char *name; + /* Pristine version of the original file. + * Use get_ccan_file_lines to fill this. */ + const char *contents; + size_t contents_size; + + /* Use get_ccan_file_lines / get_ccan_line_info to fill these. */ unsigned int num_lines; char **lines; + struct line_info *line_info; struct list_head *doc_sections; }; @@ -63,21 +116,43 @@ struct ccan_file { /* 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); + +enum line_compiled { + NOT_COMPILED, + COMPILED, + MAYBE_COMPILED, +}; + +/* Simple evaluator. If symbols are set this way, is this condition true? + * NULL values mean undefined, NULL symbol terminates. */ +enum line_compiled get_ccan_line_pp(struct pp_conditions *cond, + const char *symbol, + const unsigned int *value, ...); + +/* Get token if it's equal to token. */ +bool get_token(const char **line, const char *token); +/* Talloc copy of symbol token, or NULL. Increment line. */ +char *get_symbol_token(void *ctx, const char **line); + /* Similarly for ->doc_sections */ 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); -/* The critical tests which mean fail if they don't pass. */ -extern struct ccanlint no_info; -extern struct ccanlint has_main_header; - /* Normal tests. */ extern struct ccanlint trailing_whitespace; +/* Dependencies */ +struct dependent { + struct list_node node; + struct ccanlint *dependent; +}; #endif /* CCAN_LINT_H */