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