convert.h

   1 /*
   2  * Copyright (c) 2011, Google Inc.
   3  */
   4 #ifndef CONVERT_H
   5 #define CONVERT_H
   6
   7 #include "string-list.h"
   8
   9 struct index_state;
  10
  11 #define CONV_EOL_RNDTRP_DIE   (1<<0) /* Die if CRLF to LF to CRLF is different */
  12 #define CONV_EOL_RNDTRP_WARN  (1<<1) /* Warn if CRLF to LF to CRLF is different */
  13 #define CONV_EOL_RENORMALIZE  (1<<2) /* Convert CRLF to LF */
  14 #define CONV_EOL_KEEP_CRLF    (1<<3) /* Keep CRLF line endings as is */
  15 #define CONV_WRITE_OBJECT     (1<<4) /* Content is written to the index */
  16
  17 extern int global_conv_flags_eol;
  18
  19 enum auto_crlf {
  20         AUTO_CRLF_FALSE = 0,
  21         AUTO_CRLF_TRUE = 1,
  22         AUTO_CRLF_INPUT = -1
  23 };
  24
  25 extern enum auto_crlf auto_crlf;
  26
  27 enum eol {
  28         EOL_UNSET,
  29         EOL_CRLF,
  30         EOL_LF,
  31 #ifdef NATIVE_CRLF
  32         EOL_NATIVE = EOL_CRLF
  33 #else
  34         EOL_NATIVE = EOL_LF
  35 #endif
  36 };
  37
  38 enum ce_delay_state {
  39         CE_NO_DELAY = 0,
  40         CE_CAN_DELAY = 1,
  41         CE_RETRY = 2
  42 };
  43
  44 struct delayed_checkout {
  45         /*
  46          * State of the currently processed cache entry. If the state is
  47          * CE_CAN_DELAY, then the filter can delay the current cache entry.
  48          * If the state is CE_RETRY, then this signals the filter that the
  49          * cache entry was requested before.
  50          */
  51         enum ce_delay_state state;
  52         /* List of filter drivers that signaled delayed blobs. */
  53         struct string_list filters;
  54         /* List of delayed blobs identified by their path. */
  55         struct string_list paths;
  56 };
  57
  58 extern enum eol core_eol;
  59 extern char *check_roundtrip_encoding;
  60 const char *get_cached_convert_stats_ascii(const struct index_state *istate,
  61                                            const char *path);
  62 const char *get_wt_convert_stats_ascii(const char *path);
  63 const char *get_convert_attr_ascii(const char *path);
  64
  65 /* returns 1 if *dst was used */
  66 int convert_to_git(const struct index_state *istate,
  67                    const char *path, const char *src, size_t len,
  68                    struct strbuf *dst, int conv_flags);
  69 int convert_to_working_tree(const char *path, const char *src,
  70                             size_t len, struct strbuf *dst);
  71 int async_convert_to_working_tree(const char *path, const char *src,
  72                                   size_t len, struct strbuf *dst,
  73                                   void *dco);
  74 int async_query_available_blobs(const char *cmd,
  75                                 struct string_list *available_paths);
  76 int renormalize_buffer(const struct index_state *istate,
  77                        const char *path, const char *src, size_t len,
  78                        struct strbuf *dst);
  79 static inline int would_convert_to_git(const struct index_state *istate,
  80                                        const char *path)
  81 {
  82         return convert_to_git(istate, path, NULL, 0, NULL, 0);
  83 }
  84 /* Precondition: would_convert_to_git_filter_fd(path) == true */
  85 void convert_to_git_filter_fd(const struct index_state *istate,
  86                               const char *path, int fd,
  87                               struct strbuf *dst,
  88                               int conv_flags);
  89 int would_convert_to_git_filter_fd(const char *path);
  90
  91 /*****************************************************************
  92  *
  93  * Streaming conversion support
  94  *
  95  *****************************************************************/
  96
  97 struct stream_filter; /* opaque */
  98
  99 struct stream_filter *get_stream_filter(const char *path,
 100                                         const struct object_id *);
 101 void free_stream_filter(struct stream_filter *);
 102 int is_null_stream_filter(struct stream_filter *);
 103
 104 /*
 105  * Use as much input up to *isize_p and fill output up to *osize_p;
 106  * update isize_p and osize_p to indicate how much buffer space was
 107  * consumed and filled. Return 0 on success, non-zero on error.
 108  *
 109  * Some filters may need to buffer the input and look-ahead inside it
 110  * to decide what to output, and they may consume more than zero bytes
 111  * of input and still not produce any output. After feeding all the
 112  * input, pass NULL as input and keep calling this function, to let
 113  * such filters know there is no more input coming and it is time for
 114  * them to produce the remaining output based on the buffered input.
 115  */
 116 int stream_filter(struct stream_filter *,
 117                   const char *input, size_t *isize_p,
 118                   char *output, size_t *osize_p);
 119
 120 #endif /* CONVERT_H */