diffcore.h

   1 /*
   2  * Copyright (C) 2005 Junio C Hamano
   3  */
   4 #ifndef DIFFCORE_H
   5 #define DIFFCORE_H
   6
   7 #include "cache.h"
   8
   9 struct diff_options;
  10
  11 /* This header file is internal between diff.c and its diff transformers
  12  * (e.g. diffcore-rename, diffcore-pickaxe).  Never include this header
  13  * in anything else.
  14  */
  15
  16 /* We internally use unsigned short as the score value,
  17  * and rely on an int capable to hold 32-bits.  -B can take
  18  * -Bmerge_score/break_score format and the two scores are
  19  * passed around in one int (high 16-bit for merge and low 16-bit
  20  * for break).
  21  */
  22 #define MAX_SCORE 60000.0
  23 #define DEFAULT_RENAME_SCORE 30000 /* rename/copy similarity minimum (50%) */
  24 #define DEFAULT_BREAK_SCORE  30000 /* minimum for break to happen (50%) */
  25 #define DEFAULT_MERGE_SCORE  36000 /* maximum for break-merge to happen (60%) */
  26
  27 #define MINIMUM_BREAK_SIZE     400 /* do not break a file smaller than this */
  28
  29 struct userdiff_driver;
  30
  31 struct diff_filespec {
  32         struct object_id oid;
  33         char *path;
  34         void *data;
  35         void *cnt_data;
  36         unsigned long size;
  37         int count;               /* Reference count */
  38         int rename_used;         /* Count of rename users */
  39         unsigned short mode;     /* file mode */
  40         unsigned oid_valid : 1;  /* if true, use oid and trust mode;
  41                                   * if false, use the name and read from
  42                                   * the filesystem.
  43                                   */
  44 #define DIFF_FILE_VALID(spec) (((spec)->mode) != 0)
  45         unsigned should_free : 1; /* data should be free()'ed */
  46         unsigned should_munmap : 1; /* data should be munmap()'ed */
  47         unsigned dirty_submodule : 2;  /* For submodules: its work tree is dirty */
  48 #define DIRTY_SUBMODULE_UNTRACKED 1
  49 #define DIRTY_SUBMODULE_MODIFIED  2
  50         unsigned is_stdin : 1;
  51         unsigned has_more_entries : 1; /* only appear in combined diff */
  52         /* data should be considered "binary"; -1 means "don't know yet" */
  53         signed int is_binary : 2;
  54         struct userdiff_driver *driver;
  55 };
  56
  57 struct diff_filespec *alloc_filespec(const char *);
  58 void free_filespec(struct diff_filespec *);
  59 void fill_filespec(struct diff_filespec *, const struct object_id *,
  60                    int, unsigned short);
  61
  62 #define CHECK_SIZE_ONLY 1
  63 #define CHECK_BINARY    2
  64 int diff_populate_filespec(struct diff_filespec *, unsigned int);
  65 void diff_free_filespec_data(struct diff_filespec *);
  66 void diff_free_filespec_blob(struct diff_filespec *);
  67 int diff_filespec_is_binary(struct diff_filespec *);
  68
  69 struct diff_filepair {
  70         struct diff_filespec *one;
  71         struct diff_filespec *two;
  72         unsigned short int score;
  73         char status; /* M C R A D U etc. (see Documentation/diff-format.txt or DIFF_STATUS_* in diff.h) */
  74         unsigned broken_pair : 1;
  75         unsigned renamed_pair : 1;
  76         unsigned is_unmerged : 1;
  77         unsigned done_skip_stat_unmatch : 1;
  78         unsigned skip_stat_unmatch_result : 1;
  79 };
  80 #define DIFF_PAIR_UNMERGED(p) ((p)->is_unmerged)
  81
  82 #define DIFF_PAIR_RENAME(p) ((p)->renamed_pair)
  83
  84 #define DIFF_PAIR_BROKEN(p) \
  85         ( (!DIFF_FILE_VALID((p)->one) != !DIFF_FILE_VALID((p)->two)) && \
  86           ((p)->broken_pair != 0) )
  87
  88 #define DIFF_PAIR_TYPE_CHANGED(p) \
  89         ((S_IFMT & (p)->one->mode) != (S_IFMT & (p)->two->mode))
  90
  91 #define DIFF_PAIR_MODE_CHANGED(p) ((p)->one->mode != (p)->two->mode)
  92
  93 void diff_free_filepair(struct diff_filepair *);
  94
  95 int diff_unmodified_pair(struct diff_filepair *);
  96
  97 struct diff_queue_struct {
  98         struct diff_filepair **queue;
  99         int alloc;
 100         int nr;
 101 };
 102 #define DIFF_QUEUE_CLEAR(q) \
 103         do { \
 104                 (q)->queue = NULL; \
 105                 (q)->nr = (q)->alloc = 0; \
 106         } while (0)
 107
 108 extern struct diff_queue_struct diff_queued_diff;
 109 struct diff_filepair *diff_queue(struct diff_queue_struct *,
 110                                  struct diff_filespec *,
 111                                  struct diff_filespec *);
 112 void diff_q(struct diff_queue_struct *, struct diff_filepair *);
 113
 114 void diffcore_break(int);
 115 void diffcore_rename(struct diff_options *);
 116 void diffcore_merge_broken(void);
 117 void diffcore_pickaxe(struct diff_options *);
 118 void diffcore_order(const char *orderfile);
 119
 120 /* low-level interface to diffcore_order */
 121 struct obj_order {
 122         void *obj;      /* setup by caller */
 123
 124         /* setup/used by order_objects() */
 125         int orig_order;
 126         int order;
 127 };
 128
 129 typedef const char *(*obj_path_fn_t)(void *obj);
 130
 131 void order_objects(const char *orderfile, obj_path_fn_t obj_path,
 132                    struct obj_order *objs, int nr);
 133
 134 #define DIFF_DEBUG 0
 135 #if DIFF_DEBUG
 136 void diff_debug_filespec(struct diff_filespec *, int, const char *);
 137 void diff_debug_filepair(const struct diff_filepair *, int);
 138 void diff_debug_queue(const char *, struct diff_queue_struct *);
 139 #else
 140 #define diff_debug_filespec(a,b,c) do { /* nothing */ } while (0)
 141 #define diff_debug_filepair(a,b) do { /* nothing */ } while (0)
 142 #define diff_debug_queue(a,b) do { /* nothing */ } while (0)
 143 #endif
 144
 145 int diffcore_count_changes(struct diff_filespec *src,
 146                            struct diff_filespec *dst,
 147                            void **src_count_p,
 148                            void **dst_count_p,
 149                            unsigned long *src_copied,
 150                            unsigned long *literal_added);
 151
 152 #endif