convert.hon commit Merge branch 'jh/partial-clone-doc' (6bbd103)
   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
  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
  17extern int global_conv_flags_eol;
  18
  19enum auto_crlf {
  20        AUTO_CRLF_FALSE = 0,
  21        AUTO_CRLF_TRUE = 1,
  22        AUTO_CRLF_INPUT = -1
  23};
  24
  25extern enum auto_crlf auto_crlf;
  26
  27enum 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
  38enum ce_delay_state {
  39        CE_NO_DELAY = 0,
  40        CE_CAN_DELAY = 1,
  41        CE_RETRY = 2
  42};
  43
  44struct 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
  58extern enum eol core_eol;
  59extern char *check_roundtrip_encoding;
  60const char *get_cached_convert_stats_ascii(const struct index_state *istate,
  61                                           const char *path);
  62const char *get_wt_convert_stats_ascii(const char *path);
  63const char *get_convert_attr_ascii(const struct index_state *istate,
  64                                   const char *path);
  65
  66/* returns 1 if *dst was used */
  67int convert_to_git(const struct index_state *istate,
  68                   const char *path, const char *src, size_t len,
  69                   struct strbuf *dst, int conv_flags);
  70int convert_to_working_tree(const struct index_state *istate,
  71                            const char *path, const char *src,
  72                            size_t len, struct strbuf *dst);
  73int async_convert_to_working_tree(const struct index_state *istate,
  74                                  const char *path, const char *src,
  75                                  size_t len, struct strbuf *dst,
  76                                  void *dco);
  77int async_query_available_blobs(const char *cmd,
  78                                struct string_list *available_paths);
  79int renormalize_buffer(const struct index_state *istate,
  80                       const char *path, const char *src, size_t len,
  81                       struct strbuf *dst);
  82static inline int would_convert_to_git(const struct index_state *istate,
  83                                       const char *path)
  84{
  85        return convert_to_git(istate, path, NULL, 0, NULL, 0);
  86}
  87/* Precondition: would_convert_to_git_filter_fd(path) == true */
  88void convert_to_git_filter_fd(const struct index_state *istate,
  89                              const char *path, int fd,
  90                              struct strbuf *dst,
  91                              int conv_flags);
  92int would_convert_to_git_filter_fd(const struct index_state *istate,
  93                                   const char *path);
  94
  95/*****************************************************************
  96 *
  97 * Streaming conversion support
  98 *
  99 *****************************************************************/
 100
 101struct stream_filter; /* opaque */
 102
 103struct stream_filter *get_stream_filter(const struct index_state *istate,
 104                                        const char *path,
 105                                        const struct object_id *);
 106void free_stream_filter(struct stream_filter *);
 107int is_null_stream_filter(struct stream_filter *);
 108
 109/*
 110 * Use as much input up to *isize_p and fill output up to *osize_p;
 111 * update isize_p and osize_p to indicate how much buffer space was
 112 * consumed and filled. Return 0 on success, non-zero on error.
 113 *
 114 * Some filters may need to buffer the input and look-ahead inside it
 115 * to decide what to output, and they may consume more than zero bytes
 116 * of input and still not produce any output. After feeding all the
 117 * input, pass NULL as input and keep calling this function, to let
 118 * such filters know there is no more input coming and it is time for
 119 * them to produce the remaining output based on the buffered input.
 120 */
 121int stream_filter(struct stream_filter *,
 122                  const char *input, size_t *isize_p,
 123                  char *output, size_t *osize_p);
 124
 125#endif /* CONVERT_H */