diff.h

   1 /*
   2  * Copyright (C) 2005 Junio C Hamano
   3  */
   4 #ifndef DIFF_H
   5 #define DIFF_H
   6
   7 #include "tree-walk.h"
   8
   9 struct rev_info;
  10 struct diff_options;
  11 struct diff_queue_struct;
  12 struct strbuf;
  13 struct diff_filespec;
  14 struct userdiff_driver;
  15 struct diff_filepair;
  16
  17 typedef void (*change_fn_t)(struct diff_options *options,
  18                  unsigned old_mode, unsigned new_mode,
  19                  const unsigned char *old_sha1,
  20                  const unsigned char *new_sha1,
  21                  const char *fullpath,
  22                  unsigned old_dirty_submodule, unsigned new_dirty_submodule);
  23
  24 typedef void (*add_remove_fn_t)(struct diff_options *options,
  25                     int addremove, unsigned mode,
  26                     const unsigned char *sha1,
  27                     const char *fullpath, unsigned dirty_submodule);
  28
  29 typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
  30                 struct diff_options *options, void *data);
  31
  32 typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
  33
  34 #define DIFF_FORMAT_RAW         0x0001
  35 #define DIFF_FORMAT_DIFFSTAT    0x0002
  36 #define DIFF_FORMAT_NUMSTAT     0x0004
  37 #define DIFF_FORMAT_SUMMARY     0x0008
  38 #define DIFF_FORMAT_PATCH       0x0010
  39 #define DIFF_FORMAT_SHORTSTAT   0x0020
  40 #define DIFF_FORMAT_DIRSTAT     0x0040
  41
  42 /* These override all above */
  43 #define DIFF_FORMAT_NAME        0x0100
  44 #define DIFF_FORMAT_NAME_STATUS 0x0200
  45 #define DIFF_FORMAT_CHECKDIFF   0x0400
  46
  47 /* Same as output_format = 0 but we know that -s flag was given
  48  * and we should not give default value to output_format.
  49  */
  50 #define DIFF_FORMAT_NO_OUTPUT   0x0800
  51
  52 #define DIFF_FORMAT_CALLBACK    0x1000
  53
  54 #define DIFF_OPT_RECURSIVE           (1 <<  0)
  55 #define DIFF_OPT_TREE_IN_RECURSIVE   (1 <<  1)
  56 #define DIFF_OPT_BINARY              (1 <<  2)
  57 #define DIFF_OPT_TEXT                (1 <<  3)
  58 #define DIFF_OPT_FULL_INDEX          (1 <<  4)
  59 #define DIFF_OPT_SILENT_ON_REMOVE    (1 <<  5)
  60 #define DIFF_OPT_FIND_COPIES_HARDER  (1 <<  6)
  61 #define DIFF_OPT_FOLLOW_RENAMES      (1 <<  7)
  62 #define DIFF_OPT_COLOR_DIFF          (1 <<  8)
  63 /* (1 <<  9) unused */
  64 #define DIFF_OPT_HAS_CHANGES         (1 << 10)
  65 #define DIFF_OPT_QUICK               (1 << 11)
  66 #define DIFF_OPT_NO_INDEX            (1 << 12)
  67 #define DIFF_OPT_ALLOW_EXTERNAL      (1 << 13)
  68 #define DIFF_OPT_EXIT_WITH_STATUS    (1 << 14)
  69 #define DIFF_OPT_REVERSE_DIFF        (1 << 15)
  70 #define DIFF_OPT_CHECK_FAILED        (1 << 16)
  71 #define DIFF_OPT_RELATIVE_NAME       (1 << 17)
  72 #define DIFF_OPT_IGNORE_SUBMODULES   (1 << 18)
  73 #define DIFF_OPT_DIRSTAT_CUMULATIVE  (1 << 19)
  74 #define DIFF_OPT_DIRSTAT_BY_FILE     (1 << 20)
  75 #define DIFF_OPT_ALLOW_TEXTCONV      (1 << 21)
  76 #define DIFF_OPT_DIFF_FROM_CONTENTS  (1 << 22)
  77 #define DIFF_OPT_SUBMODULE_LOG       (1 << 23)
  78 #define DIFF_OPT_DIRTY_SUBMODULES    (1 << 24)
  79 #define DIFF_OPT_IGNORE_UNTRACKED_IN_SUBMODULES (1 << 25)
  80 #define DIFF_OPT_IGNORE_DIRTY_SUBMODULES (1 << 26)
  81 #define DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG (1 << 27)
  82
  83 #define DIFF_OPT_TST(opts, flag)    ((opts)->flags & DIFF_OPT_##flag)
  84 #define DIFF_OPT_SET(opts, flag)    ((opts)->flags |= DIFF_OPT_##flag)
  85 #define DIFF_OPT_CLR(opts, flag)    ((opts)->flags &= ~DIFF_OPT_##flag)
  86 #define DIFF_XDL_TST(opts, flag)    ((opts)->xdl_opts & XDF_##flag)
  87 #define DIFF_XDL_SET(opts, flag)    ((opts)->xdl_opts |= XDF_##flag)
  88 #define DIFF_XDL_CLR(opts, flag)    ((opts)->xdl_opts &= ~XDF_##flag)
  89
  90 enum diff_words_type {
  91         DIFF_WORDS_NONE = 0,
  92         DIFF_WORDS_PORCELAIN,
  93         DIFF_WORDS_PLAIN,
  94         DIFF_WORDS_COLOR
  95 };
  96
  97 struct diff_options {
  98         const char *filter;
  99         const char *orderfile;
 100         const char *pickaxe;
 101         const char *single_follow;
 102         const char *a_prefix, *b_prefix;
 103         unsigned flags;
 104         int context;
 105         int interhunkcontext;
 106         int break_opt;
 107         int detect_rename;
 108         int skip_stat_unmatch;
 109         int line_termination;
 110         int output_format;
 111         int pickaxe_opts;
 112         int rename_score;
 113         int rename_limit;
 114         int warn_on_too_large_rename;
 115         int dirstat_percent;
 116         int setup;
 117         int abbrev;
 118         const char *prefix;
 119         int prefix_length;
 120         const char *stat_sep;
 121         long xdl_opts;
 122
 123         int stat_width;
 124         int stat_name_width;
 125         const char *word_regex;
 126         enum diff_words_type word_diff;
 127
 128         /* this is set by diffcore for DIFF_FORMAT_PATCH */
 129         int found_changes;
 130
 131         /* to support internal diff recursion by --follow hack*/
 132         int found_follow;
 133
 134         FILE *file;
 135         int close_file;
 136
 137         int nr_paths;
 138         const char **paths;
 139         int *pathlens;
 140         change_fn_t change;
 141         add_remove_fn_t add_remove;
 142         diff_format_fn_t format_callback;
 143         void *format_callback_data;
 144         diff_prefix_fn_t output_prefix;
 145         void *output_prefix_data;
 146 };
 147
 148 enum color_diff {
 149         DIFF_RESET = 0,
 150         DIFF_PLAIN = 1,
 151         DIFF_METAINFO = 2,
 152         DIFF_FRAGINFO = 3,
 153         DIFF_FILE_OLD = 4,
 154         DIFF_FILE_NEW = 5,
 155         DIFF_COMMIT = 6,
 156         DIFF_WHITESPACE = 7,
 157         DIFF_FUNCINFO = 8
 158 };
 159 const char *diff_get_color(int diff_use_color, enum color_diff ix);
 160 #define diff_get_color_opt(o, ix) \
 161         diff_get_color(DIFF_OPT_TST((o), COLOR_DIFF), ix)
 162
 163
 164 extern const char mime_boundary_leader[];
 165
 166 extern void diff_tree_setup_paths(const char **paths, struct diff_options *);
 167 extern void diff_tree_release_paths(struct diff_options *);
 168 extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
 169                      const char *base, struct diff_options *opt);
 170 extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
 171                           const char *base, struct diff_options *opt);
 172 extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
 173                                struct diff_options *opt);
 174
 175 struct combine_diff_path {
 176         struct combine_diff_path *next;
 177         int len;
 178         char *path;
 179         unsigned int mode;
 180         unsigned char sha1[20];
 181         struct combine_diff_parent {
 182                 char status;
 183                 unsigned int mode;
 184                 unsigned char sha1[20];
 185         } parent[FLEX_ARRAY];
 186 };
 187 #define combine_diff_path_size(n, l) \
 188         (sizeof(struct combine_diff_path) + \
 189          sizeof(struct combine_diff_parent) * (n) + (l) + 1)
 190
 191 extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
 192                               int dense, struct rev_info *);
 193
 194 extern void diff_tree_combined(const unsigned char *sha1, const unsigned char parent[][20], int num_parent, int dense, struct rev_info *rev);
 195
 196 extern void diff_tree_combined_merge(const unsigned char *sha1, int, struct rev_info *);
 197
 198 void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
 199
 200 extern void diff_addremove(struct diff_options *,
 201                            int addremove,
 202                            unsigned mode,
 203                            const unsigned char *sha1,
 204                            const char *fullpath, unsigned dirty_submodule);
 205
 206 extern void diff_change(struct diff_options *,
 207                         unsigned mode1, unsigned mode2,
 208                         const unsigned char *sha1,
 209                         const unsigned char *sha2,
 210                         const char *fullpath,
 211                         unsigned dirty_submodule1, unsigned dirty_submodule2);
 212
 213 extern void diff_unmerge(struct diff_options *,
 214                          const char *path,
 215                          unsigned mode,
 216                          const unsigned char *sha1);
 217
 218 #define DIFF_SETUP_REVERSE              1
 219 #define DIFF_SETUP_USE_CACHE            2
 220 #define DIFF_SETUP_USE_SIZE_CACHE       4
 221
 222 /*
 223  * Poor man's alternative to parse-option, to allow both sticked form
 224  * (--option=value) and separate form (--option value).
 225  */
 226 extern int parse_long_opt(const char *opt, const char **argv,
 227                          const char **optarg);
 228
 229 extern int git_diff_basic_config(const char *var, const char *value, void *cb);
 230 extern int git_diff_ui_config(const char *var, const char *value, void *cb);
 231 extern int diff_use_color_default;
 232 extern void diff_setup(struct diff_options *);
 233 extern int diff_opt_parse(struct diff_options *, const char **, int);
 234 extern int diff_setup_done(struct diff_options *);
 235
 236 #define DIFF_DETECT_RENAME      1
 237 #define DIFF_DETECT_COPY        2
 238
 239 #define DIFF_PICKAXE_ALL        1
 240 #define DIFF_PICKAXE_REGEX      2
 241
 242 extern void diffcore_std(struct diff_options *);
 243 extern void diffcore_fix_diff_index(struct diff_options *);
 244
 245 #define COMMON_DIFF_OPTIONS_HELP \
 246 "\ncommon diff options:\n" \
 247 "  -z            output diff-raw with lines terminated with NUL.\n" \
 248 "  -p            output patch format.\n" \
 249 "  -u            synonym for -p.\n" \
 250 "  --patch-with-raw\n" \
 251 "                output both a patch and the diff-raw format.\n" \
 252 "  --stat        show diffstat instead of patch.\n" \
 253 "  --numstat     show numeric diffstat instead of patch.\n" \
 254 "  --patch-with-stat\n" \
 255 "                output a patch and prepend its diffstat.\n" \
 256 "  --name-only   show only names of changed files.\n" \
 257 "  --name-status show names and status of changed files.\n" \
 258 "  --full-index  show full object name on index lines.\n" \
 259 "  --abbrev=<n>  abbreviate object names in diff-tree header and diff-raw.\n" \
 260 "  -R            swap input file pairs.\n" \
 261 "  -B            detect complete rewrites.\n" \
 262 "  -M            detect renames.\n" \
 263 "  -C            detect copies.\n" \
 264 "  --find-copies-harder\n" \
 265 "                try unchanged files as candidate for copy detection.\n" \
 266 "  -l<n>         limit rename attempts up to <n> paths.\n" \
 267 "  -O<file>      reorder diffs according to the <file>.\n" \
 268 "  -S<string>    find filepair whose only one side contains the string.\n" \
 269 "  --pickaxe-all\n" \
 270 "                show all files diff when -S is used and hit is found.\n" \
 271 "  -a  --text    treat all files as text.\n"
 272
 273 extern int diff_queue_is_empty(void);
 274 extern void diff_flush(struct diff_options*);
 275
 276 /* diff-raw status letters */
 277 #define DIFF_STATUS_ADDED               'A'
 278 #define DIFF_STATUS_COPIED              'C'
 279 #define DIFF_STATUS_DELETED             'D'
 280 #define DIFF_STATUS_MODIFIED            'M'
 281 #define DIFF_STATUS_RENAMED             'R'
 282 #define DIFF_STATUS_TYPE_CHANGED        'T'
 283 #define DIFF_STATUS_UNKNOWN             'X'
 284 #define DIFF_STATUS_UNMERGED            'U'
 285
 286 /* these are not diff-raw status letters proper, but used by
 287  * diffcore-filter insn to specify additional restrictions.
 288  */
 289 #define DIFF_STATUS_FILTER_AON          '*'
 290 #define DIFF_STATUS_FILTER_BROKEN       'B'
 291
 292 extern const char *diff_unique_abbrev(const unsigned char *, int);
 293
 294 /* do not report anything on removed paths */
 295 #define DIFF_SILENT_ON_REMOVED 01
 296 /* report racily-clean paths as modified */
 297 #define DIFF_RACY_IS_MODIFIED 02
 298 extern int run_diff_files(struct rev_info *revs, unsigned int option);
 299 extern int run_diff_index(struct rev_info *revs, int cached);
 300
 301 extern int do_diff_cache(const unsigned char *, struct diff_options *);
 302 extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
 303
 304 extern int diff_result_code(struct diff_options *, int);
 305
 306 extern void diff_no_index(struct rev_info *, int, const char **, int, const char *);
 307
 308 extern int index_differs_from(const char *def, int diff_flags);
 309
 310 extern size_t fill_textconv(struct userdiff_driver *driver,
 311                             struct diff_filespec *df,
 312                             char **outbuf);
 313
 314 extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
 315
 316 /* some output functions line.c need */
 317 extern void fill_metainfo(struct strbuf *msg,
 318                           const char *name,
 319                           const char *other,
 320                           struct diff_filespec *one,
 321                           struct diff_filespec *two,
 322                           struct diff_options *o,
 323                           struct diff_filepair *p,
 324                           int *must_show_header,
 325                           int use_color);
 326
 327 extern void emit_line(struct diff_options *o, const char *set, const char *reset,
 328                       const char *line, int len);
 329
 330 extern char *quote_two(const char *one, const char *two);
 331
 332 #endif /* DIFF_H */