diffcore.h

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