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