]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/ccanlint.h
base64: fix for unsigned chars (e.g. ARM).
[ccan] / tools / ccanlint / ccanlint.h
index 13b10dcdd2a3539ba19ad2f700225816111ec6ff..7df951084f3aec4dd1ddbec10072c0d879c735a4 100644 (file)
@@ -2,11 +2,17 @@
 #define CCAN_LINT_H
 #include "config.h"
 #include <ccan/list/list.h>
+#include <ccan/tal/tal.h>
+#include <ccan/dgraph/dgraph.h>
+#include <ccan/autodata/autodata.h>
 #include <stdbool.h>
 #include "../doc_extract.h"
+#include "../manifest.h"
+#include "../tools.h"
 #include "licenses.h"
 
-#define REGISTER_TEST(name, ...) extern struct ccanlint name
+AUTODATA_TYPE(ccanlint_tests, struct ccanlint);
+#define REGISTER_TEST(test) AUTODATA(ccanlint_tests, &test)
 
 /* 0 == Describe failed tests.
    1 == Describe results for partial failures.
    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;
-
-       struct list_head run_tests;
-       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_exist.c */
-       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;
@@ -80,8 +44,6 @@ struct score {
 };
 
 struct ccanlint {
-       struct list_node list;
-
        /* More concise unique name of test. */
        const char *key;
 
@@ -91,12 +53,14 @@ 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.
-        * score is the result, and a talloc context freed after all our
+       /* 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 tal 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);
@@ -110,16 +74,12 @@ struct ccanlint {
        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. */
@@ -159,49 +119,6 @@ struct line_info {
        struct pp_conditions *cond;
 };
 
-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_contents 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;
-
-       /* If this file gets compiled (eg. .C file to .o file), result here. */
-       char *compiled[COMPILE_TYPES];
-
-       /* Filename containing output from valgrind. */
-       char *valgrind_log;
-
-       /* 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);
 
@@ -222,7 +139,7 @@ enum line_compiled get_ccan_line_pp(struct pp_conditions *cond,
 
 /* 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. */
+/* Tal copy of symbol token, or NULL.  Increment line. */
 char *get_symbol_token(void *ctx, const char **line);
 
 /* Similarly for ->doc_sections */
@@ -235,13 +152,27 @@ char **per_file_options(const struct ccanlint *test, struct ccan_file *f);
 void score_file_error(struct score *, struct ccan_file *f, unsigned line,
                      const char *errorfmt, ...);
 
+/* Append message to the score->error */
+void score_error(struct score *score, const char * source,
+                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);
 
+/* Find manifest for this dir and return compiled _info filename. */
+char *get_or_compile_info(const void *ctx, const char *dir);
+
 /* Normal tests. */
 extern struct ccanlint trailing_whitespace;
 
@@ -254,16 +185,25 @@ struct 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 manifest *m);
+
 /* 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;
+/* Did the user want to keep all the results? */
+extern bool keep_results;
+
+/* Did we find non-ccan dependencies? */
+extern bool non_ccan_deps;
 
-/* Compiler and CFLAGS, from config.h if available. */
-extern const char *compiler, *cflags;
+/* Did we fail to build? */
+extern bool build_failed;
 
 /* Contents of config.h (or NULL if not found) */
 extern const char *config_header;
 
+/* Where is the ccan dir?   */
+extern const char *ccan_dir;
+
 #endif /* CCAN_LINT_H */