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