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