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