cgitrc.5.txt: reformat the "FILTER API" section

[ps-cgit] / cgit.h

diff --git a/cgit.h b/cgit.h
index 1e084d4cb02f743d2b4c014ce69b9a8cacad491f..caa9d8e91853ae626f96ff939896f0dfb83a2e31 100644 (file)
--- a/cgit.h
+++ b/cgit.h
@@ -1,64 +1,329 @@
 #ifndef CGIT_H
 #define CGIT_H
 
 #ifndef CGIT_H
 #define CGIT_H
 

-#include "git.h"
-#include <openssl/sha.h>
-#include <ctype.h>
-#include <sched.h>
+
+#include <git-compat-util.h>
+#include <cache.h>
+#include <grep.h>
+#include <object.h>
+#include <tree.h>
+#include <commit.h>
+#include <tag.h>
+#include <diff.h>
+#include <diffcore.h>
+#include <refs.h>
+#include <revision.h>
+#include <log-tree.h>
+#include <archive.h>
+#include <string-list.h>
+#include <xdiff-interface.h>
+#include <xdiff/xdiff.h>
+#include <utf8.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"
+
+
+/*
+ * Limits used for relative dates
+ */
+#define TM_MIN    60
+#define TM_HOUR  (TM_MIN * 60)
+#define TM_DAY   (TM_HOUR * 24)
+#define TM_WEEK  (TM_DAY * 7)
+#define TM_YEAR  (TM_DAY * 365)
+#define TM_MONTH (TM_YEAR / 12.0)
+
+
+/*
+ * Default encoding
+ */
+#define PAGE_ENCODING "UTF-8"

 
 typedef void (*configfn)(const char *name, const char *value);
 
 typedef void (*configfn)(const char *name, const char *value);

+typedef void (*filepair_fn)(struct diff_filepair *pair);
+typedef void (*linediff_fn)(char *line, int len);
+
+typedef enum {
+       ABOUT, COMMIT, SOURCE
+} filter_type;
+
+struct cgit_filter {
+       char *cmd;
+       char **argv;
+       int old_stdout;
+       int pipe_fh[2];
+       int pid;
+       int exitstatus;
+};
+
+struct cgit_repo {
+       char *url;
+       char *name;
+       char *path;
+       char *desc;
+       char *owner;
+       char *defbranch;
+       char *module_link;
+       char *readme;
+       char *section;
+       char *clone_url;
+       char *logo;
+       char *logo_link;
+       int snapshots;
+       int enable_commit_graph;
+       int enable_log_filecount;
+       int enable_log_linecount;
+       int enable_remote_branches;
+       int enable_subject_links;
+       int max_stats;
+       time_t mtime;
+       struct cgit_filter *about_filter;
+       struct cgit_filter *commit_filter;
+       struct cgit_filter *source_filter;
+};
+
+typedef void (*repo_config_fn)(struct cgit_repo *repo, const char *name,
+             const char *value);
+
+struct cgit_repolist {
+       int length;
+       int count;
+       struct cgit_repo *repos;
+};
+
+struct commitinfo {
+       struct commit *commit;
+       char *author;
+       char *author_email;
+       unsigned long author_date;
+       char *committer;
+       char *committer_email;
+       unsigned long committer_date;
+       char *subject;
+       char *msg;
+       char *msg_encoding;
+};
+
+struct taginfo {
+       char *tagger;
+       char *tagger_email;
+       unsigned long tagger_date;
+       char *msg;
+};

 
 

-struct cacheitem {
+struct refinfo {
+       const char *refname;
+       struct object *object;
+       union {
+               struct taginfo *tag;
+               struct commitinfo *commit;
+       };
+};
+
+struct reflist {
+       struct refinfo **refs;
+       int alloc;
+       int count;
+};
+
+struct cgit_query {
+       int has_symref;
+       int has_sha1;
+       char *raw;
+       char *repo;
+       char *page;
+       char *search;
+       char *grep;
+       char *head;
+       char *sha1;
+       char *sha2;
+       char *path;

        char *name;
        char *name;

-       struct stat st;
-       int ttl;
-       int fd;
+       char *mimetype;
+       char *url;
+       char *period;
+       int   ofs;
+       int nohead;
+       char *sort;
+       int showmsg;
+       int ssdiff;
+       int show_all;
+       int context;
+       int ignorews;
+       char *vpath;
+};
+
+struct cgit_config {
+       char *agefile;
+       char *cache_root;
+       char *clone_prefix;
+       char *css;
+       char *favicon;
+       char *footer;
+       char *head_include;
+       char *header;
+       char *index_header;
+       char *index_info;
+       char *logo;
+       char *logo_link;
+       char *module_link;
+       char *project_list;
+       char *readme;
+       char *robots;
+       char *root_title;
+       char *root_desc;
+       char *root_readme;
+       char *script_name;
+       char *section;
+       char *virtual_root;
+       char *strict_export;
+       int cache_size;
+       int cache_dynamic_ttl;
+       int cache_max_create_time;
+       int cache_repo_ttl;
+       int cache_root_ttl;
+       int cache_scanrc_ttl;
+       int cache_static_ttl;
+       int embedded;
+       int enable_filter_overrides;
+       int enable_gitweb_owner;
+       int enable_http_clone;
+       int enable_index_links;
+       int enable_commit_graph;
+       int enable_log_filecount;
+       int enable_log_linecount;
+       int enable_remote_branches;
+       int enable_subject_links;
+       int enable_tree_linenumbers;
+       int local_time;
+       int max_atom_items;
+       int max_repo_count;
+       int max_commit_count;
+       int max_lock_attempts;
+       int max_msg_len;
+       int max_repodesc_len;
+       int max_blob_size;
+       int max_stats;
+       int nocache;
+       int noplainemail;
+       int noheader;
+       int renamelimit;
+       int remove_suffix;
+       int scan_hidden_path;
+       int section_from_path;
+       int snapshots;
+       int summary_branches;
+       int summary_log;
+       int summary_tags;
+       int ssdiff;
+       struct string_list mimetypes;
+       struct cgit_filter *about_filter;
+       struct cgit_filter *commit_filter;
+       struct cgit_filter *source_filter;
+};
+
+struct cgit_page {
+       time_t modified;
+       time_t expires;
+       size_t size;
+       char *mimetype;
+       char *charset;
+       char *filename;
+       char *etag;
+       char *title;
+       int status;
+       char *statusmsg;
+};
+
+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;

 };
 
 };
 

-extern char *cgit_root;
-extern char *cgit_root_title;
-extern char *cgit_css;
-extern char *cgit_logo;
-extern char *cgit_logo_link;
-extern char *cgit_virtual_root;
-extern char *cgit_cache_root;
+struct cgit_context {
+       struct cgit_environment env;
+       struct cgit_query qry;
+       struct cgit_config cfg;
+       struct cgit_repo *repo;
+       struct cgit_page page;
+};
+
+struct cgit_snapshot_format {
+       const char *suffix;
+       const char *mimetype;
+       write_archive_fn_t write_func;
+       int bit;
+};
+
+extern const char *cgit_version;
+
+extern struct cgit_repolist cgit_repolist;
+extern struct cgit_context ctx;
+extern const struct cgit_snapshot_format cgit_snapshot_formats[];

 
 

-extern int cgit_cache_root_ttl;
-extern int cgit_cache_repo_ttl;
-extern int cgit_cache_dynamic_ttl;
-extern int cgit_cache_static_ttl;
-extern int cgit_cache_max_create_time;
+extern struct cgit_repo *cgit_add_repo(const char *url);
+extern struct cgit_repo *cgit_get_repoinfo(const char *url);
+extern void cgit_repo_config_cb(const char *name, const char *value);

 
 

-extern char *cgit_repo_name;
-extern char *cgit_repo_desc;
-extern char *cgit_repo_owner;
+extern int chk_zero(int result, char *msg);
+extern int chk_positive(int result, char *msg);
+extern int chk_non_negative(int result, char *msg);

 
 

-extern int cgit_query_has_symref;
-extern int cgit_query_has_sha1;
+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 *cgit_querystring;
-extern char *cgit_query_repo;
-extern char *cgit_query_page;
-extern char *cgit_query_head;
-extern char *cgit_query_sha1;
+extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
+extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
+                       int flags, void *cb_data);

 
 

-extern int htmlfd;
+extern void *cgit_free_commitinfo(struct commitinfo *info);

 
 

+extern int cgit_diff_files(const unsigned char *old_sha1,
+                          const unsigned char *new_sha1,
+                          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,
+                          filepair_fn fn, const char *prefix, int ignorews);
+
+extern void cgit_diff_commit(struct commit *commit, filepair_fn fn,
+                            const char *prefix);
+
+__attribute__((format (printf,1,2)))

 extern char *fmt(const char *format,...);
 
 extern char *fmt(const char *format,...);
 

-extern void html(const char *txt);
-extern void htmlf(const char *format,...);
-extern void html_txt(char *txt);
-extern void html_attr(char *txt);
-extern void html_link_open(char *url, char *title, char *class);
-extern void html_link_close(void);
+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 const char *cgit_repobasename(const char *reponame);
+
+extern int cgit_parse_snapshots_mask(const char *str);

 
 

+extern int cgit_open_filter(struct cgit_filter *filter, struct cgit_repo * repo);
+extern int cgit_close_filter(struct cgit_filter *filter);

 
 

-extern int cgit_read_config(const char *filename, configfn fn);
+extern int readfile(const char *path, char **buf, size_t *size);

 
 

-extern int cache_lookup(struct cacheitem *item);
-extern int cache_lock(struct cacheitem *item);
-extern int cache_unlock(struct cacheitem *item);
-extern int cache_expired(struct cacheitem *item);
+extern char *expand_macros(const char *txt);

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