convert.h

   1 /*
   2  * Copyright (c) 2011, Google Inc.
   3  */
   4 #ifndef CONVERT_H
   5 #define CONVERT_H
   6
   7 struct index_state;
   8
   9 enum safe_crlf {
  10         SAFE_CRLF_FALSE = 0,
  11         SAFE_CRLF_FAIL = 1,
  12         SAFE_CRLF_WARN = 2,
  13         SAFE_CRLF_RENORMALIZE = 3
  14 };
  15
  16 extern enum safe_crlf safe_crlf;
  17
  18 enum auto_crlf {
  19         AUTO_CRLF_FALSE = 0,
  20         AUTO_CRLF_TRUE = 1,
  21         AUTO_CRLF_INPUT = -1
  22 };
  23
  24 extern enum auto_crlf auto_crlf;
  25
  26 enum eol {
  27         EOL_UNSET,
  28         EOL_CRLF,
  29         EOL_LF,
  30 #ifdef NATIVE_CRLF
  31         EOL_NATIVE = EOL_CRLF
  32 #else
  33         EOL_NATIVE = EOL_LF
  34 #endif
  35 };
  36
  37 extern enum eol core_eol;
  38 extern const char *get_cached_convert_stats_ascii(const struct index_state *istate,
  39                                                   const char *path);
  40 extern const char *get_wt_convert_stats_ascii(const char *path);
  41 extern const char *get_convert_attr_ascii(const char *path);
  42
  43 /* returns 1 if *dst was used */
  44 extern int convert_to_git(const struct index_state *istate,
  45                           const char *path, const char *src, size_t len,
  46                           struct strbuf *dst, enum safe_crlf checksafe);
  47 extern int convert_to_working_tree(const char *path, const char *src,
  48                                    size_t len, struct strbuf *dst);
  49 extern int renormalize_buffer(const struct index_state *istate,
  50                               const char *path, const char *src, size_t len,
  51                               struct strbuf *dst);
  52 static inline int would_convert_to_git(const struct index_state *istate,
  53                                        const char *path)
  54 {
  55         return convert_to_git(istate, path, NULL, 0, NULL, 0);
  56 }
  57 /* Precondition: would_convert_to_git_filter_fd(path) == true */
  58 extern void convert_to_git_filter_fd(const struct index_state *istate,
  59                                      const char *path, int fd,
  60                                      struct strbuf *dst,
  61                                      enum safe_crlf checksafe);
  62 extern int would_convert_to_git_filter_fd(const char *path);
  63
  64 /*****************************************************************
  65  *
  66  * Streaming conversion support
  67  *
  68  *****************************************************************/
  69
  70 struct stream_filter; /* opaque */
  71
  72 extern struct stream_filter *get_stream_filter(const char *path, const unsigned char *);
  73 extern void free_stream_filter(struct stream_filter *);
  74 extern int is_null_stream_filter(struct stream_filter *);
  75
  76 /*
  77  * Use as much input up to *isize_p and fill output up to *osize_p;
  78  * update isize_p and osize_p to indicate how much buffer space was
  79  * consumed and filled. Return 0 on success, non-zero on error.
  80  *
  81  * Some filters may need to buffer the input and look-ahead inside it
  82  * to decide what to output, and they may consume more than zero bytes
  83  * of input and still not produce any output. After feeding all the
  84  * input, pass NULL as input and keep calling this function, to let
  85  * such filters know there is no more input coming and it is time for
  86  * them to produce the remaining output based on the buffered input.
  87  */
  88 extern int stream_filter(struct stream_filter *,
  89                          const char *input, size_t *isize_p,
  90                          char *output, size_t *osize_p);
  91
  92 #endif /* CONVERT_H */