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