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 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 enum ce_delay_state {
  38         CE_NO_DELAY = 0,
  39         CE_CAN_DELAY = 1,
  40         CE_RETRY = 2
  41 };
  42
  43 struct delayed_checkout {
  44         /*
  45          * State of the currently processed cache entry. If the state is
  46          * CE_CAN_DELAY, then the filter can delay the current cache entry.
  47          * If the state is CE_RETRY, then this signals the filter that the
  48          * cache entry was requested before.
  49          */
  50         enum ce_delay_state state;
  51         /* List of filter drivers that signaled delayed blobs. */
  52         struct string_list filters;
  53         /* List of delayed blobs identified by their path. */
  54         struct string_list paths;
  55 };
  56
  57 extern enum eol core_eol;
  58 extern const char *get_cached_convert_stats_ascii(const char *path);
  59 extern const char *get_wt_convert_stats_ascii(const char *path);
  60 extern const char *get_convert_attr_ascii(const char *path);
  61
  62 /* returns 1 if *dst was used */
  63 extern int convert_to_git(const char *path, const char *src, size_t len,
  64                           struct strbuf *dst, enum safe_crlf checksafe);
  65 extern int convert_to_working_tree(const char *path, const char *src,
  66                                    size_t len, struct strbuf *dst);
  67 extern int async_convert_to_working_tree(const char *path, const char *src,
  68                                          size_t len, struct strbuf *dst,
  69                                          void *dco);
  70 extern int async_query_available_blobs(const char *cmd, struct string_list *available_paths);
  71 extern int renormalize_buffer(const char *path, const char *src, size_t len,
  72                               struct strbuf *dst);
  73 static inline int would_convert_to_git(const char *path)
  74 {
  75         return convert_to_git(path, NULL, 0, NULL, 0);
  76 }
  77 /* Precondition: would_convert_to_git_filter_fd(path) == true */
  78 extern void convert_to_git_filter_fd(const char *path, int fd,
  79                                      struct strbuf *dst,
  80                                      enum safe_crlf checksafe);
  81 extern int would_convert_to_git_filter_fd(const char *path);
  82
  83 /*****************************************************************
  84  *
  85  * Streaming conversion support
  86  *
  87  *****************************************************************/
  88
  89 struct stream_filter; /* opaque */
  90
  91 extern struct stream_filter *get_stream_filter(const char *path, const unsigned char *);
  92 extern void free_stream_filter(struct stream_filter *);
  93 extern int is_null_stream_filter(struct stream_filter *);
  94
  95 /*
  96  * Use as much input up to *isize_p and fill output up to *osize_p;
  97  * update isize_p and osize_p to indicate how much buffer space was
  98  * consumed and filled. Return 0 on success, non-zero on error.
  99  *
 100  * Some filters may need to buffer the input and look-ahead inside it
 101  * to decide what to output, and they may consume more than zero bytes
 102  * of input and still not produce any output. After feeding all the
 103  * input, pass NULL as input and keep calling this function, to let
 104  * such filters know there is no more input coming and it is time for
 105  * them to produce the remaining output based on the buffered input.
 106  */
 107 extern int stream_filter(struct stream_filter *,
 108                          const char *input, size_t *isize_p,
 109                          char *output, size_t *osize_p);
 110
 111 #endif /* CONVERT_H */