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 enum safe_crlf {
  12         SAFE_CRLF_FALSE = 0,
  13         SAFE_CRLF_FAIL = 1,
  14         SAFE_CRLF_WARN = 2,
  15         SAFE_CRLF_RENORMALIZE = 3,
  16         SAFE_CRLF_KEEP_CRLF = 4
  17 };
  18
  19 extern enum safe_crlf safe_crlf;
  20
  21 enum auto_crlf {
  22         AUTO_CRLF_FALSE = 0,
  23         AUTO_CRLF_TRUE = 1,
  24         AUTO_CRLF_INPUT = -1
  25 };
  26
  27 extern enum auto_crlf auto_crlf;
  28
  29 enum eol {
  30         EOL_UNSET,
  31         EOL_CRLF,
  32         EOL_LF,
  33 #ifdef NATIVE_CRLF
  34         EOL_NATIVE = EOL_CRLF
  35 #else
  36         EOL_NATIVE = EOL_LF
  37 #endif
  38 };
  39
  40 enum ce_delay_state {
  41         CE_NO_DELAY = 0,
  42         CE_CAN_DELAY = 1,
  43         CE_RETRY = 2
  44 };
  45
  46 struct delayed_checkout {
  47         /*
  48          * State of the currently processed cache entry. If the state is
  49          * CE_CAN_DELAY, then the filter can delay the current cache entry.
  50          * If the state is CE_RETRY, then this signals the filter that the
  51          * cache entry was requested before.
  52          */
  53         enum ce_delay_state state;
  54         /* List of filter drivers that signaled delayed blobs. */
  55         struct string_list filters;
  56         /* List of delayed blobs identified by their path. */
  57         struct string_list paths;
  58 };
  59
  60 extern enum eol core_eol;
  61 extern const char *get_cached_convert_stats_ascii(const struct index_state *istate,
  62                                                   const char *path);
  63 extern const char *get_wt_convert_stats_ascii(const char *path);
  64 extern const char *get_convert_attr_ascii(const char *path);
  65
  66 /* returns 1 if *dst was used */
  67 extern int convert_to_git(const struct index_state *istate,
  68                           const char *path, const char *src, size_t len,
  69                           struct strbuf *dst, enum safe_crlf checksafe);
  70 extern int convert_to_working_tree(const char *path, const char *src,
  71                                    size_t len, struct strbuf *dst);
  72 extern int async_convert_to_working_tree(const char *path, const char *src,
  73                                          size_t len, struct strbuf *dst,
  74                                          void *dco);
  75 extern int async_query_available_blobs(const char *cmd, struct string_list *available_paths);
  76 extern 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 extern void convert_to_git_filter_fd(const struct index_state *istate,
  86                                      const char *path, int fd,
  87                                      struct strbuf *dst,
  88                                      enum safe_crlf checksafe);
  89 extern 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 extern struct stream_filter *get_stream_filter(const char *path, const unsigned char *);
 100 extern void free_stream_filter(struct stream_filter *);
 101 extern int is_null_stream_filter(struct stream_filter *);
 102
 103 /*
 104  * Use as much input up to *isize_p and fill output up to *osize_p;
 105  * update isize_p and osize_p to indicate how much buffer space was
 106  * consumed and filled. Return 0 on success, non-zero on error.
 107  *
 108  * Some filters may need to buffer the input and look-ahead inside it
 109  * to decide what to output, and they may consume more than zero bytes
 110  * of input and still not produce any output. After feeding all the
 111  * input, pass NULL as input and keep calling this function, to let
 112  * such filters know there is no more input coming and it is time for
 113  * them to produce the remaining output based on the buffered input.
 114  */
 115 extern int stream_filter(struct stream_filter *,
 116                          const char *input, size_t *isize_p,
 117                          char *output, size_t *osize_p);
 118
 119 #endif /* CONVERT_H */