doc: use consistent id's when generating html files

[cgit.git] / cgit.h

diff --git a/cgit.h b/cgit.h
index c655bd8eb54266150a0f80bd35e11ec2ed184e38..005ae63017050f0e6d5821fd51515ca0775f4469 100644 (file)
--- a/cgit.h
+++ b/cgit.h
@@ -3,6 +3,8 @@
 
 
 #include <git-compat-util.h>
 
 
 #include <git-compat-util.h>

+#include <stdbool.h>
+

 #include <cache.h>
 #include <grep.h>
 #include <object.h>
 #include <cache.h>
 #include <grep.h>
 #include <object.h>


@@ -23,13 +25,9 @@
 #include <notes.h>
 #include <graph.h>
 
 #include <notes.h>
 #include <graph.h>
 

-
-/*
- * Dateformats used on misc. pages
- */
-#define FMT_LONGDATE "%Y-%m-%d %H:%M:%S (%Z)"
-#define FMT_SHORTDATE "%Y-%m-%d"
-#define FMT_ATOMDATE "%Y-%m-%dT%H:%M:%SZ"
+/* Add isgraph(x) to Git's sane ctype support (see git-compat-util.h) */
+#undef isgraph
+#define isgraph(x) (isprint((x)) && !isspace((x)))

 
 
 /*
 
 
 /*


@@ -53,16 +51,27 @@ typedef void (*filepair_fn)(struct diff_filepair *pair);
 typedef void (*linediff_fn)(char *line, int len);
 
 typedef enum {
 typedef void (*linediff_fn)(char *line, int len);
 
 typedef enum {

-       ABOUT, COMMIT, SOURCE
+       DIFF_UNIFIED, DIFF_SSDIFF, DIFF_STATONLY
+} diff_type;
+
+typedef enum {
+       ABOUT, COMMIT, SOURCE, EMAIL, AUTH, OWNER

 } filter_type;
 
 struct cgit_filter {
 } filter_type;
 
 struct cgit_filter {

+       int (*open)(struct cgit_filter *, va_list ap);
+       int (*close)(struct cgit_filter *);
+       void (*fprintf)(struct cgit_filter *, FILE *, const char *prefix);
+       void (*cleanup)(struct cgit_filter *);
+       int argument_count;
+};
+
+struct cgit_exec_filter {
+       struct cgit_filter base;

        char *cmd;
        char **argv;
        int old_stdout;
        char *cmd;
        char **argv;
        int old_stdout;

-       int pipe_fh[2];

        int pid;
        int pid;

-       int exitstatus;

 };
 
 struct cgit_repo {
 };
 
 struct cgit_repo {


@@ -71,9 +80,10 @@ struct cgit_repo {
        char *path;
        char *desc;
        char *owner;
        char *path;
        char *desc;
        char *owner;

+       char *homepage;

        char *defbranch;
        char *module_link;
        char *defbranch;
        char *module_link;

-       char *readme;
+       struct string_list readme;

        char *section;
        char *clone_url;
        char *logo;
        char *section;
        char *clone_url;
        char *logo;


@@ -84,13 +94,19 @@ struct cgit_repo {
        int enable_log_linecount;
        int enable_remote_branches;
        int enable_subject_links;
        int enable_log_linecount;
        int enable_remote_branches;
        int enable_subject_links;

+       int enable_html_serving;

        int max_stats;
        int max_stats;

+       int branch_sort;

        int commit_sort;
        time_t mtime;
        struct cgit_filter *about_filter;
        struct cgit_filter *commit_filter;
        struct cgit_filter *source_filter;
        int commit_sort;
        time_t mtime;
        struct cgit_filter *about_filter;
        struct cgit_filter *commit_filter;
        struct cgit_filter *source_filter;

+       struct cgit_filter *email_filter;
+       struct cgit_filter *owner_filter;

        struct string_list submodules;
        struct string_list submodules;

+       int hide;
+       int ignore;

 };
 
 typedef void (*repo_config_fn)(struct cgit_repo *repo, const char *name,
 };
 
 typedef void (*repo_config_fn)(struct cgit_repo *repo, const char *name,


@@ -107,9 +123,11 @@ struct commitinfo {
        char *author;
        char *author_email;
        unsigned long author_date;
        char *author;
        char *author_email;
        unsigned long author_date;

+       int author_tz;

        char *committer;
        char *committer_email;
        unsigned long committer_date;
        char *committer;
        char *committer_email;
        unsigned long committer_date;

+       int committer_tz;

        char *subject;
        char *msg;
        char *msg_encoding;
        char *subject;
        char *msg;
        char *msg_encoding;


@@ -119,6 +137,7 @@ struct taginfo {
        char *tagger;
        char *tagger_email;
        unsigned long tagger_date;
        char *tagger;
        char *tagger_email;
        unsigned long tagger_date;

+       int tagger_tz;

        char *msg;
 };
 
        char *msg;
 };
 


@@ -140,7 +159,7 @@ struct reflist {
 struct cgit_query {
        int has_symref;
        int has_sha1;
 struct cgit_query {
        int has_symref;
        int has_sha1;

-       int has_ssdiff;
+       int has_difftype;

        char *raw;
        char *repo;
        char *page;
        char *raw;
        char *repo;
        char *page;


@@ -151,17 +170,17 @@ struct cgit_query {
        char *sha2;
        char *path;
        char *name;
        char *sha2;
        char *path;
        char *name;

-       char *mimetype;

        char *url;
        char *period;
        int   ofs;
        int nohead;
        char *sort;
        int showmsg;
        char *url;
        char *period;
        int   ofs;
        int nohead;
        char *sort;
        int showmsg;

-       int ssdiff;
+       diff_type difftype;

        int show_all;
        int context;
        int ignorews;
        int show_all;
        int context;
        int ignorews;

+       int follow;

        char *vpath;
 };
 
        char *vpath;
 };
 


@@ -182,7 +201,7 @@ struct cgit_config {
        char *mimetype_file;
        char *module_link;
        char *project_list;
        char *mimetype_file;
        char *module_link;
        char *project_list;

-       char *readme;
+       struct string_list readme;

        char *robots;
        char *root_title;
        char *root_desc;
        char *robots;
        char *root_title;
        char *root_desc;


@@ -190,7 +209,7 @@ struct cgit_config {
        char *script_name;
        char *section;
        char *repository_sort;
        char *script_name;
        char *section;
        char *repository_sort;

-       char *virtual_root;
+       char *virtual_root;     /* Always ends with '/'. */

        char *strict_export;
        int cache_size;
        int cache_dynamic_ttl;
        char *strict_export;
        int cache_size;
        int cache_dynamic_ttl;


@@ -199,17 +218,22 @@ struct cgit_config {
        int cache_root_ttl;
        int cache_scanrc_ttl;
        int cache_static_ttl;
        int cache_root_ttl;
        int cache_scanrc_ttl;
        int cache_static_ttl;

+       int cache_about_ttl;
+       int cache_snapshot_ttl;

        int case_sensitive_sort;
        int embedded;
        int enable_filter_overrides;
        int case_sensitive_sort;
        int embedded;
        int enable_filter_overrides;

+       int enable_follow_links;

        int enable_http_clone;
        int enable_index_links;
        int enable_index_owner;
        int enable_http_clone;
        int enable_index_links;
        int enable_index_owner;

+       int enable_blame;

        int enable_commit_graph;
        int enable_log_filecount;
        int enable_log_linecount;
        int enable_remote_branches;
        int enable_subject_links;
        int enable_commit_graph;
        int enable_log_filecount;
        int enable_log_linecount;
        int enable_remote_branches;
        int enable_subject_links;

+       int enable_html_serving;

        int enable_tree_linenumbers;
        int enable_git_config;
        int local_time;
        int enable_tree_linenumbers;
        int enable_git_config;
        int local_time;


@@ -233,38 +257,46 @@ struct cgit_config {
        int summary_branches;
        int summary_log;
        int summary_tags;
        int summary_branches;
        int summary_log;
        int summary_tags;

-       int ssdiff;
+       diff_type difftype;
+       int branch_sort;

        int commit_sort;
        struct string_list mimetypes;
        struct cgit_filter *about_filter;
        struct cgit_filter *commit_filter;
        struct cgit_filter *source_filter;
        int commit_sort;
        struct string_list mimetypes;
        struct cgit_filter *about_filter;
        struct cgit_filter *commit_filter;
        struct cgit_filter *source_filter;

+       struct cgit_filter *email_filter;
+       struct cgit_filter *owner_filter;
+       struct cgit_filter *auth_filter;

 };
 
 struct cgit_page {
        time_t modified;
        time_t expires;
        size_t size;
 };
 
 struct cgit_page {
        time_t modified;
        time_t expires;
        size_t size;

-       char *mimetype;
-       char *charset;
-       char *filename;
-       char *etag;
-       char *title;
+       const char *mimetype;
+       const char *charset;
+       const char *filename;
+       const char *etag;
+       const char *title;

        int status;
        int status;

-       char *statusmsg;
+       const char *statusmsg;

 };
 
 struct cgit_environment {
 };
 
 struct cgit_environment {

-       char *cgit_config;
-       char *http_host;
-       char *https;
-       char *no_http;
-       char *path_info;
-       char *query_string;
-       char *request_method;
-       char *script_name;
-       char *server_name;
-       char *server_port;
+       const char *cgit_config;
+       const char *http_host;
+       const char *https;
+       const char *no_http;
+       const char *path_info;
+       const char *query_string;
+       const char *request_method;
+       const char *script_name;
+       const char *server_name;
+       const char *server_port;
+       const char *http_cookie;
+       const char *http_referer;
+       unsigned int content_length;
+       int authenticated;

 };
 
 struct cgit_context {
 };
 
 struct cgit_context {


@@ -300,23 +332,29 @@ extern int chk_positive(int result, char *msg);
 extern int chk_non_negative(int result, char *msg);
 
 extern char *trim_end(const char *str, char c);
 extern int chk_non_negative(int result, char *msg);
 
 extern char *trim_end(const char *str, char c);

-extern char *strlpart(char *txt, int maxlen);
-extern char *strrpart(char *txt, int maxlen);
+extern char *ensure_end(const char *str, char c);
+
+extern void strbuf_ensure_end(struct strbuf *sb, char c);

 
 extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
 
 extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);

-extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
+extern void cgit_free_reflist_inner(struct reflist *list);
+extern int cgit_refs_cb(const char *refname, const struct object_id *oid,

                        int flags, void *cb_data);
 
                        int flags, void *cb_data);
 

-extern void *cgit_free_commitinfo(struct commitinfo *info);
+extern void cgit_free_commitinfo(struct commitinfo *info);
+extern void cgit_free_taginfo(struct taginfo *info);
+
+void cgit_diff_tree_cb(struct diff_queue_struct *q,
+                      struct diff_options *options, void *data);

 
 

-extern int cgit_diff_files(const unsigned char *old_sha1,
-                          const unsigned char *new_sha1,
+extern int cgit_diff_files(const struct object_id *old_oid,
+                          const struct object_id *new_oid,

                           unsigned long *old_size, unsigned long *new_size,
                           int *binary, int context, int ignorews,
                           linediff_fn fn);
 
                           unsigned long *old_size, unsigned long *new_size,
                           int *binary, int context, int ignorews,
                           linediff_fn fn);
 

-extern void cgit_diff_tree(const unsigned char *old_sha1,
-                          const unsigned char *new_sha1,
+extern void cgit_diff_tree(const struct object_id *old_oid,
+                          const struct object_id *new_oid,

                           filepair_fn fn, const char *prefix, int ignorews);
 
 extern void cgit_diff_commit(struct commit *commit, filepair_fn fn,
                           filepair_fn fn, const char *prefix, int ignorews);
 
 extern void cgit_diff_commit(struct commit *commit, filepair_fn fn,


@@ -325,6 +363,9 @@ extern void cgit_diff_commit(struct commit *commit, filepair_fn fn,
 __attribute__((format (printf,1,2)))
 extern char *fmt(const char *format,...);
 
 __attribute__((format (printf,1,2)))
 extern char *fmt(const char *format,...);
 

+__attribute__((format (printf,1,2)))
+extern char *fmtalloc(const char *format,...);
+

 extern struct commitinfo *cgit_parse_commit(struct commit *commit);
 extern struct taginfo *cgit_parse_tag(struct tag *tag);
 extern void cgit_parse_url(const char *url);
 extern struct commitinfo *cgit_parse_commit(struct commit *commit);
 extern struct taginfo *cgit_parse_tag(struct tag *tag);
 extern void cgit_parse_url(const char *url);


@@ -333,8 +374,13 @@ extern const char *cgit_repobasename(const char *reponame);
 
 extern int cgit_parse_snapshots_mask(const char *str);
 
 
 extern int cgit_parse_snapshots_mask(const char *str);
 

-extern int cgit_open_filter(struct cgit_filter *filter);
+extern int cgit_open_filter(struct cgit_filter *filter, ...);

 extern int cgit_close_filter(struct cgit_filter *filter);
 extern int cgit_close_filter(struct cgit_filter *filter);

+extern void cgit_fprintf_filter(struct cgit_filter *filter, FILE *f, const char *prefix);
+extern void cgit_exec_filter_init(struct cgit_exec_filter *filter, char *cmd, char **argv);
+extern struct cgit_filter *cgit_new_filter(const char *cmd, filter_type filtertype);
+extern void cgit_cleanup_filters(void);
+extern void cgit_init_filters(void);

 
 extern void cgit_prepare_repo_env(struct cgit_repo * repo);
 
 
 extern void cgit_prepare_repo_env(struct cgit_repo * repo);
 


@@ -342,4 +388,6 @@ extern int readfile(const char *path, char **buf, size_t *size);
 
 extern char *expand_macros(const char *txt);
 
 
 extern char *expand_macros(const char *txt);
 

+extern char *get_mimetype_for_filename(const char *filename);
+

 #endif /* CGIT_H */
 #endif /* CGIT_H */