ext/gitdll/gitdll.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2008-2015 - TortoiseGit
   4
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License
   7 // as published by the Free Software Foundation; either version 2
   8 // of the License, or (at your option) any later version.
   9
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software Foundation,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19
  20 // The following ifdef block is the standard way of creating macros which make exporting
  21 // from a DLL simpler. All files within this DLL are compiled with the GITDLL_EXPORTS
  22 // symbol defined on the command line. this symbol should not be defined on any project
  23 // that uses this DLL. This way any other project whose source files include this file see
  24 // GITDLL_API functions as being imported from a DLL, whereas this DLL sees symbols
  25 // defined with this macro as being exported.
  26
  27 #ifndef __GITDLL__
  28 #define __GITDLL__
  29
  30 #ifdef __cplusplus
  31 #define EXTERN extern "C"
  32 #else
  33 #define EXTERN
  34 #endif
  35
  36 #ifdef GITDLL_EXPORTS
  37 #define GITDLL_API EXTERN __declspec(dllexport)
  38 #else
  39 #define GITDLL_API EXTERN __declspec(dllimport)
  40 #endif
  41
  42 #if 0
  43 // This class is exported from the gitdll.dll
  44 class GITDLL_API Cgitdll {
  45 public:
  46         Cgitdll(void);
  47         // TODO: add your methods here.
  48 };
  49 #endif
  50
  51 #define GIT_HASH_SIZE 20
  52
  53 typedef unsigned char GIT_HASH[GIT_HASH_SIZE];
  54
  55 typedef void *  GIT_HANDLE;
  56 typedef void *  GIT_LOG;
  57
  58 typedef void * GIT_DIFF;
  59 typedef void * GIT_FILE;
  60 typedef void * GIT_COMMIT_LIST;
  61
  62 struct GIT_COMMIT_AUTHOR
  63 {
  64         const char* Name;
  65         int       NameSize;
  66         const char* Email;
  67         int       EmailSize;
  68         int       Date;
  69         int   TimeZone;
  70
  71 };
  72 typedef struct GIT_COMMIT_DATA
  73 {
  74         GIT_HASH m_hash;
  75         struct GIT_COMMIT_AUTHOR m_Author;
  76         struct GIT_COMMIT_AUTHOR m_Committer;
  77         const char* m_Subject;
  78         int              m_SubjectSize;
  79         const char* m_Body;
  80         int              m_BodySize;
  81         void *   m_pGitCommit; /** internal used */
  82         const char* m_Encode;
  83         int              m_EncodeSize;
  84         int              m_ignore;
  85         const void* buffer;
  86 } GIT_COMMIT;
  87
  88 /**
  89  *      Get hash value.
  90  *      @param  name    [IN] Reference name, such as HEAD, master, ...
  91  *      @param  sha1    [OUT] char[20] hash value. Caller prepare char[20] buffer.
  92  *      @return                 0       success.
  93  */
  94 GITDLL_API int git_get_sha1(const char *name, GIT_HASH sha1);
  95 /**
  96  *      Init git dll
  97  *  @remark, this function must be call before other function.
  98  *      @return                 0       success
  99  */
 100 GITDLL_API int git_init();
 101
 102 GITDLL_API int git_open_log(GIT_LOG * handle, char * arg);
 103 GITDLL_API int git_get_log_firstcommit(GIT_LOG handle);
 104 GITDLL_API int git_get_log_estimate_commit_count(GIT_LOG handle);
 105
 106 /**
 107  *      Get Next Commit
 108  *  @param handle       [IN]handle  Get handle from git_open_log
 109  *      @param commit   [OUT]commit     Caller need prepare buffer for this call
 110  *      @param follow   [IN]follow      Follow history beyond renames (see --follow)
 111  *  @return                     0       success
 112  *      @remark                 Caller need call git_free_commit to free internal buffer after use it;
 113  */
 114 GITDLL_API int git_get_log_nextcommit(GIT_LOG handle, GIT_COMMIT *commit, int follow);
 115
 116 GITDLL_API int git_close_log(GIT_LOG handle);
 117
 118 /**
 119  *      Get Commit information from commit hash
 120  *      @param  commit  [OUT] output commit information
 121  *  @param      hash    [in] hash
 122  *      @return         0       success
 123  */
 124 GITDLL_API int git_get_commit_from_hash(GIT_COMMIT *commit, GIT_HASH hash);
 125 GITDLL_API int git_parse_commit(GIT_COMMIT *commit);
 126
 127 GITDLL_API int git_get_commit_first_parent(GIT_COMMIT *commit,GIT_COMMIT_LIST *list);
 128 GITDLL_API int git_get_commit_next_parent(GIT_COMMIT_LIST *list, GIT_HASH hash);
 129
 130 GITDLL_API int git_free_commit(GIT_COMMIT *commit);
 131
 132 GITDLL_API int git_open_diff(GIT_DIFF *diff, char * arg);
 133 GITDLL_API int git_do_diff(GIT_DIFF diff, GIT_HASH hash1,GIT_HASH hash2, GIT_FILE * file, int *count, int isstat);
 134 GITDLL_API int git_root_diff(GIT_DIFF diff, GIT_HASH hash,GIT_FILE *file, int *count,int isstat);
 135 GITDLL_API int git_diff_flush(GIT_DIFF diff);
 136 GITDLL_API int git_close_diff(GIT_DIFF diff);
 137
 138
 139 GITDLL_API int git_get_diff_file(GIT_DIFF diff,GIT_FILE file, int i,char **newname, char **oldname,  int *mode, int *IsBin, int *inc, int *dec);
 140
 141 #define READ_TREE_RECURSIVE 1
 142 typedef int (*read_tree_fn_t)(const unsigned char*, struct strbuf*, const char*, unsigned int, int, void*);
 143
 144 GITDLL_API int git_read_tree(GIT_HASH hash,read_tree_fn_t fn, void *context);
 145
 146
 147 typedef void * EXCLUDE_LIST;
 148
 149 GITDLL_API int git_create_exclude_list(EXCLUDE_LIST *which);
 150
 151 GITDLL_API int git_add_exclude(const char *string, const char *base,
 152                                         int baselen, EXCLUDE_LIST which, int lineno);
 153
 154 GITDLL_API int git_check_excluded_1(const char *pathname,
 155                                                         int pathlen, const char *basename, int *dtype,
 156                                                         EXCLUDE_LIST el);
 157
 158 #define DT_UNKNOWN      0
 159 #define DT_DIR          1
 160 #define DT_REG          2
 161 #define DT_LNK          3
 162
 163 GITDLL_API int git_free_exclude_list(EXCLUDE_LIST which);
 164
 165 //caller need free p_note
 166 GITDLL_API int git_get_notes(GIT_HASH hash, char **p_note);
 167
 168 GITDLL_API int git_run_cmd(char *cmd, char *arg);
 169
 170 #define REF_ISSYMREF 01
 171 #define REF_ISPACKED 02
 172
 173 typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
 174 GITDLL_API int git_head_ref(each_ref_fn, void *);
 175
 176 typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
 177 GITDLL_API int git_for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
 178
 179 GITDLL_API int git_checkout_file(const char* ref, const char* path, char* outputpath);
 180
 181 GITDLL_API int git_get_config(const char *key, char *buffer, int size);
 182
 183 typedef enum
 184 {
 185         CONFIG_LOCAL,
 186         CONFIG_GLOBAL,
 187         CONFIG_XDGGLOBAL,
 188         CONFIG_SYSTEM,
 189
 190 }CONFIG_TYPE;
 191
 192 GITDLL_API int get_set_config(const char *key, const char *value, CONFIG_TYPE type);
 193
 194 const char *get_windows_home_directory(void);
 195
 196 GITDLL_API const wchar_t *wget_windows_home_directory(void);
 197 GITDLL_API const wchar_t *wget_msysgit_etc(void);
 198
 199 typedef void *GIT_MAILMAP;
 200
 201 GITDLL_API int git_read_mailmap(GIT_MAILMAP *mailmap);
 202 GITDLL_API const char * git_get_mailmap_author(GIT_MAILMAP mailmap, const char *email2, void *payload, const char *(*author2_cb)(void *));
 203 GITDLL_API void git_free_mailmap(GIT_MAILMAP mailmap);
 204
 205 #endif