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 #include "pathspec.h"
   9 #include "object.h"
  10
  11 struct rev_info;
  12 struct diff_options;
  13 struct diff_queue_struct;
  14 struct strbuf;
  15 struct diff_filespec;
  16 struct userdiff_driver;
  17 struct oid_array;
  18 struct commit;
  19 struct combine_diff_path;
  20
  21 typedef int (*pathchange_fn_t)(struct diff_options *options,
  22                  struct combine_diff_path *path);
  23
  24 typedef void (*change_fn_t)(struct diff_options *options,
  25                  unsigned old_mode, unsigned new_mode,
  26                  const struct object_id *old_oid,
  27                  const struct object_id *new_oid,
  28                  int old_oid_valid, int new_oid_valid,
  29                  const char *fullpath,
  30                  unsigned old_dirty_submodule, unsigned new_dirty_submodule);
  31
  32 typedef void (*add_remove_fn_t)(struct diff_options *options,
  33                     int addremove, unsigned mode,
  34                     const struct object_id *oid,
  35                     int oid_valid,
  36                     const char *fullpath, unsigned dirty_submodule);
  37
  38 typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
  39                 struct diff_options *options, void *data);
  40
  41 typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
  42
  43 #define DIFF_FORMAT_RAW         0x0001
  44 #define DIFF_FORMAT_DIFFSTAT    0x0002
  45 #define DIFF_FORMAT_NUMSTAT     0x0004
  46 #define DIFF_FORMAT_SUMMARY     0x0008
  47 #define DIFF_FORMAT_PATCH       0x0010
  48 #define DIFF_FORMAT_SHORTSTAT   0x0020
  49 #define DIFF_FORMAT_DIRSTAT     0x0040
  50
  51 /* These override all above */
  52 #define DIFF_FORMAT_NAME        0x0100
  53 #define DIFF_FORMAT_NAME_STATUS 0x0200
  54 #define DIFF_FORMAT_CHECKDIFF   0x0400
  55
  56 /* Same as output_format = 0 but we know that -s flag was given
  57  * and we should not give default value to output_format.
  58  */
  59 #define DIFF_FORMAT_NO_OUTPUT   0x0800
  60
  61 #define DIFF_FORMAT_CALLBACK    0x1000
  62
  63 #define DIFF_OPT_RECURSIVE           (1 <<  0)
  64 #define DIFF_OPT_TREE_IN_RECURSIVE   (1 <<  1)
  65 #define DIFF_OPT_BINARY              (1 <<  2)
  66 #define DIFF_OPT_TEXT                (1 <<  3)
  67 #define DIFF_OPT_FULL_INDEX          (1 <<  4)
  68 #define DIFF_OPT_SILENT_ON_REMOVE    (1 <<  5)
  69 #define DIFF_OPT_FIND_COPIES_HARDER  (1 <<  6)
  70 #define DIFF_OPT_FOLLOW_RENAMES      (1 <<  7)
  71 #define DIFF_OPT_RENAME_EMPTY        (1 <<  8)
  72 /* (1 <<  9) unused */
  73 #define DIFF_OPT_HAS_CHANGES         (1 << 10)
  74 #define DIFF_OPT_QUICK               (1 << 11)
  75 #define DIFF_OPT_NO_INDEX            (1 << 12)
  76 #define DIFF_OPT_ALLOW_EXTERNAL      (1 << 13)
  77 #define DIFF_OPT_EXIT_WITH_STATUS    (1 << 14)
  78 #define DIFF_OPT_REVERSE_DIFF        (1 << 15)
  79 #define DIFF_OPT_CHECK_FAILED        (1 << 16)
  80 #define DIFF_OPT_RELATIVE_NAME       (1 << 17)
  81 #define DIFF_OPT_IGNORE_SUBMODULES   (1 << 18)
  82 #define DIFF_OPT_DIRSTAT_CUMULATIVE  (1 << 19)
  83 #define DIFF_OPT_DIRSTAT_BY_FILE     (1 << 20)
  84 #define DIFF_OPT_ALLOW_TEXTCONV      (1 << 21)
  85 #define DIFF_OPT_DIFF_FROM_CONTENTS  (1 << 22)
  86 #define DIFF_OPT_DIRTY_SUBMODULES    (1 << 24)
  87 #define DIFF_OPT_IGNORE_UNTRACKED_IN_SUBMODULES (1 << 25)
  88 #define DIFF_OPT_IGNORE_DIRTY_SUBMODULES (1 << 26)
  89 #define DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG (1 << 27)
  90 #define DIFF_OPT_DIRSTAT_BY_LINE     (1 << 28)
  91 #define DIFF_OPT_FUNCCONTEXT         (1 << 29)
  92 #define DIFF_OPT_PICKAXE_IGNORE_CASE (1 << 30)
  93 #define DIFF_OPT_DEFAULT_FOLLOW_RENAMES (1U << 31)
  94
  95 #define DIFF_OPT_TST(opts, flag)    ((opts)->flags & DIFF_OPT_##flag)
  96 #define DIFF_OPT_TOUCHED(opts, flag)    ((opts)->touched_flags & DIFF_OPT_##flag)
  97 #define DIFF_OPT_SET(opts, flag)    (((opts)->flags |= DIFF_OPT_##flag),((opts)->touched_flags |= DIFF_OPT_##flag))
  98 #define DIFF_OPT_CLR(opts, flag)    (((opts)->flags &= ~DIFF_OPT_##flag),((opts)->touched_flags |= DIFF_OPT_##flag))
  99 #define DIFF_XDL_TST(opts, flag)    ((opts)->xdl_opts & XDF_##flag)
 100 #define DIFF_XDL_SET(opts, flag)    ((opts)->xdl_opts |= XDF_##flag)
 101 #define DIFF_XDL_CLR(opts, flag)    ((opts)->xdl_opts &= ~XDF_##flag)
 102
 103 #define DIFF_WITH_ALG(opts, flag)   (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
 104
 105 enum diff_words_type {
 106         DIFF_WORDS_NONE = 0,
 107         DIFF_WORDS_PORCELAIN,
 108         DIFF_WORDS_PLAIN,
 109         DIFF_WORDS_COLOR
 110 };
 111
 112 enum diff_submodule_format {
 113         DIFF_SUBMODULE_SHORT = 0,
 114         DIFF_SUBMODULE_LOG,
 115         DIFF_SUBMODULE_INLINE_DIFF
 116 };
 117
 118 struct diff_options {
 119         const char *orderfile;
 120         const char *pickaxe;
 121         const char *single_follow;
 122         const char *a_prefix, *b_prefix;
 123         const char *line_prefix;
 124         size_t line_prefix_length;
 125         unsigned flags;
 126         unsigned touched_flags;
 127
 128         /* diff-filter bits */
 129         unsigned int filter;
 130
 131         int use_color;
 132         int context;
 133         int interhunkcontext;
 134         int break_opt;
 135         int detect_rename;
 136         int irreversible_delete;
 137         int skip_stat_unmatch;
 138         int line_termination;
 139         int output_format;
 140         int pickaxe_opts;
 141         int rename_score;
 142         int rename_limit;
 143         int needed_rename_limit;
 144         int degraded_cc_to_c;
 145         int show_rename_progress;
 146         int dirstat_permille;
 147         int setup;
 148         int abbrev;
 149         int ita_invisible_in_index;
 150 /* white-space error highlighting */
 151 #define WSEH_NEW 1
 152 #define WSEH_CONTEXT 2
 153 #define WSEH_OLD 4
 154         unsigned ws_error_highlight;
 155         const char *prefix;
 156         int prefix_length;
 157         const char *stat_sep;
 158         long xdl_opts;
 159
 160         int stat_width;
 161         int stat_name_width;
 162         int stat_graph_width;
 163         int stat_count;
 164         const char *word_regex;
 165         enum diff_words_type word_diff;
 166         enum diff_submodule_format submodule_format;
 167
 168         /* this is set by diffcore for DIFF_FORMAT_PATCH */
 169         int found_changes;
 170
 171         /* to support internal diff recursion by --follow hack*/
 172         int found_follow;
 173
 174         void (*set_default)(struct diff_options *);
 175
 176         FILE *file;
 177         int close_file;
 178
 179         struct pathspec pathspec;
 180         pathchange_fn_t pathchange;
 181         change_fn_t change;
 182         add_remove_fn_t add_remove;
 183         diff_format_fn_t format_callback;
 184         void *format_callback_data;
 185         diff_prefix_fn_t output_prefix;
 186         void *output_prefix_data;
 187
 188         int diff_path_counter;
 189 };
 190
 191 enum color_diff {
 192         DIFF_RESET = 0,
 193         DIFF_CONTEXT = 1,
 194         DIFF_METAINFO = 2,
 195         DIFF_FRAGINFO = 3,
 196         DIFF_FILE_OLD = 4,
 197         DIFF_FILE_NEW = 5,
 198         DIFF_COMMIT = 6,
 199         DIFF_WHITESPACE = 7,
 200         DIFF_FUNCINFO = 8
 201 };
 202 const char *diff_get_color(int diff_use_color, enum color_diff ix);
 203 #define diff_get_color_opt(o, ix) \
 204         diff_get_color((o)->use_color, ix)
 205
 206
 207 const char *diff_line_prefix(struct diff_options *);
 208
 209
 210 extern const char mime_boundary_leader[];
 211
 212 extern struct combine_diff_path *diff_tree_paths(
 213         struct combine_diff_path *p, const struct object_id *oid,
 214         const struct object_id **parents_oid, int nparent,
 215         struct strbuf *base, struct diff_options *opt);
 216 extern int diff_tree_oid(const struct object_id *old_oid,
 217                          const struct object_id *new_oid,
 218                          const char *base, struct diff_options *opt);
 219 extern int diff_root_tree_oid(const struct object_id *new_oid, const char *base,
 220                               struct diff_options *opt);
 221
 222 struct combine_diff_path {
 223         struct combine_diff_path *next;
 224         char *path;
 225         unsigned int mode;
 226         struct object_id oid;
 227         struct combine_diff_parent {
 228                 char status;
 229                 unsigned int mode;
 230                 struct object_id oid;
 231         } parent[FLEX_ARRAY];
 232 };
 233 #define combine_diff_path_size(n, l) \
 234         st_add4(sizeof(struct combine_diff_path), (l), 1, \
 235                 st_mult(sizeof(struct combine_diff_parent), (n)))
 236
 237 extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
 238                               int dense, struct rev_info *);
 239
 240 extern void diff_tree_combined(const struct object_id *oid, const struct oid_array *parents, int dense, struct rev_info *rev);
 241
 242 extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
 243
 244 void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
 245
 246 extern int diff_can_quit_early(struct diff_options *);
 247
 248 extern void diff_addremove(struct diff_options *,
 249                            int addremove,
 250                            unsigned mode,
 251                            const struct object_id *oid,
 252                            int oid_valid,
 253                            const char *fullpath, unsigned dirty_submodule);
 254
 255 extern void diff_change(struct diff_options *,
 256                         unsigned mode1, unsigned mode2,
 257                         const struct object_id *old_oid,
 258                         const struct object_id *new_oid,
 259                         int old_oid_valid, int new_oid_valid,
 260                         const char *fullpath,
 261                         unsigned dirty_submodule1, unsigned dirty_submodule2);
 262
 263 extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
 264
 265 #define DIFF_SETUP_REVERSE              1
 266 #define DIFF_SETUP_USE_CACHE            2
 267 #define DIFF_SETUP_USE_SIZE_CACHE       4
 268
 269 /*
 270  * Poor man's alternative to parse-option, to allow both stuck form
 271  * (--option=value) and separate form (--option value).
 272  */
 273 extern int parse_long_opt(const char *opt, const char **argv,
 274                          const char **optarg);
 275
 276 extern int git_diff_basic_config(const char *var, const char *value, void *cb);
 277 extern int git_diff_heuristic_config(const char *var, const char *value, void *cb);
 278 extern void init_diff_ui_defaults(void);
 279 extern int git_diff_ui_config(const char *var, const char *value, void *cb);
 280 extern void diff_setup(struct diff_options *);
 281 extern int diff_opt_parse(struct diff_options *, const char **, int, const char *);
 282 extern void diff_setup_done(struct diff_options *);
 283
 284 #define DIFF_DETECT_RENAME      1
 285 #define DIFF_DETECT_COPY        2
 286
 287 #define DIFF_PICKAXE_ALL        1
 288 #define DIFF_PICKAXE_REGEX      2
 289
 290 #define DIFF_PICKAXE_KIND_S     4 /* traditional plumbing counter */
 291 #define DIFF_PICKAXE_KIND_G     8 /* grep in the patch */
 292
 293 extern void diffcore_std(struct diff_options *);
 294 extern void diffcore_fix_diff_index(struct diff_options *);
 295
 296 #define COMMON_DIFF_OPTIONS_HELP \
 297 "\ncommon diff options:\n" \
 298 "  -z            output diff-raw with lines terminated with NUL.\n" \
 299 "  -p            output patch format.\n" \
 300 "  -u            synonym for -p.\n" \
 301 "  --patch-with-raw\n" \
 302 "                output both a patch and the diff-raw format.\n" \
 303 "  --stat        show diffstat instead of patch.\n" \
 304 "  --numstat     show numeric diffstat instead of patch.\n" \
 305 "  --patch-with-stat\n" \
 306 "                output a patch and prepend its diffstat.\n" \
 307 "  --name-only   show only names of changed files.\n" \
 308 "  --name-status show names and status of changed files.\n" \
 309 "  --full-index  show full object name on index lines.\n" \
 310 "  --abbrev=<n>  abbreviate object names in diff-tree header and diff-raw.\n" \
 311 "  -R            swap input file pairs.\n" \
 312 "  -B            detect complete rewrites.\n" \
 313 "  -M            detect renames.\n" \
 314 "  -C            detect copies.\n" \
 315 "  --find-copies-harder\n" \
 316 "                try unchanged files as candidate for copy detection.\n" \
 317 "  -l<n>         limit rename attempts up to <n> paths.\n" \
 318 "  -O<file>      reorder diffs according to the <file>.\n" \
 319 "  -S<string>    find filepair whose only one side contains the string.\n" \
 320 "  --pickaxe-all\n" \
 321 "                show all files diff when -S is used and hit is found.\n" \
 322 "  -a  --text    treat all files as text.\n"
 323
 324 extern int diff_queue_is_empty(void);
 325 extern void diff_flush(struct diff_options*);
 326 extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
 327
 328 /* diff-raw status letters */
 329 #define DIFF_STATUS_ADDED               'A'
 330 #define DIFF_STATUS_COPIED              'C'
 331 #define DIFF_STATUS_DELETED             'D'
 332 #define DIFF_STATUS_MODIFIED            'M'
 333 #define DIFF_STATUS_RENAMED             'R'
 334 #define DIFF_STATUS_TYPE_CHANGED        'T'
 335 #define DIFF_STATUS_UNKNOWN             'X'
 336 #define DIFF_STATUS_UNMERGED            'U'
 337
 338 /* these are not diff-raw status letters proper, but used by
 339  * diffcore-filter insn to specify additional restrictions.
 340  */
 341 #define DIFF_STATUS_FILTER_AON          '*'
 342 #define DIFF_STATUS_FILTER_BROKEN       'B'
 343
 344 /*
 345  * This is different from find_unique_abbrev() in that
 346  * it stuffs the result with dots for alignment.
 347  */
 348 extern const char *diff_aligned_abbrev(const struct object_id *sha1, int);
 349
 350 /* do not report anything on removed paths */
 351 #define DIFF_SILENT_ON_REMOVED 01
 352 /* report racily-clean paths as modified */
 353 #define DIFF_RACY_IS_MODIFIED 02
 354 extern int run_diff_files(struct rev_info *revs, unsigned int option);
 355 extern int run_diff_index(struct rev_info *revs, int cached);
 356
 357 extern int do_diff_cache(const struct object_id *, struct diff_options *);
 358 extern int diff_flush_patch_id(struct diff_options *, struct object_id *, int);
 359
 360 extern int diff_result_code(struct diff_options *, int);
 361
 362 extern void diff_no_index(struct rev_info *, int, const char **);
 363
 364 extern int index_differs_from(const char *def, int diff_flags, int ita_invisible_in_index);
 365
 366 /*
 367  * Fill the contents of the filespec "df", respecting any textconv defined by
 368  * its userdiff driver.  The "driver" parameter must come from a
 369  * previous call to get_textconv(), and therefore should either be NULL or have
 370  * textconv enabled.
 371  *
 372  * Note that the memory ownership of the resulting buffer depends on whether
 373  * the driver field is NULL. If it is, then the memory belongs to the filespec
 374  * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
 375  * that should be freed by the caller.
 376  */
 377 extern size_t fill_textconv(struct userdiff_driver *driver,
 378                             struct diff_filespec *df,
 379                             char **outbuf);
 380
 381 /*
 382  * Look up the userdiff driver for the given filespec, and return it if
 383  * and only if it has textconv enabled (otherwise return NULL). The result
 384  * can be passed to fill_textconv().
 385  */
 386 extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
 387
 388 /*
 389  * Prepare diff_filespec and convert it using diff textconv API
 390  * if the textconv driver exists.
 391  * Return 1 if the conversion succeeds, 0 otherwise.
 392  */
 393 extern int textconv_object(const char *path, unsigned mode, const struct object_id *oid, int oid_valid, char **buf, unsigned long *buf_size);
 394
 395 extern int parse_rename_score(const char **cp_p);
 396
 397 extern long parse_algorithm_value(const char *value);
 398
 399 extern int print_stat_summary(FILE *fp, int files,
 400                               int insertions, int deletions);
 401 extern void setup_diff_pager(struct diff_options *);
 402
 403 #endif /* DIFF_H */