convert: add tracing for 'working-tree-encoding' attribute
[git/git.git] / convert.h
CommitLineData
d1bf0e08
JH
1/*
2 * Copyright (c) 2011, Google Inc.
3 */
4#ifndef CONVERT_H
5#define CONVERT_H
6
2841e8f8
LS
7#include "string-list.h"
8
a7609c54
BW
9struct index_state;
10
8462ff43
TB
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 */
107642fe 15#define CONV_WRITE_OBJECT (1<<4) /* Content is written to the index */
d1bf0e08 16
8462ff43 17extern int global_conv_flags_eol;
d1bf0e08
JH
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
2841e8f8
LS
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
d1bf0e08 58extern enum eol core_eol;
a7609c54
BW
59extern const char *get_cached_convert_stats_ascii(const struct index_state *istate,
60 const char *path);
a7630bd4
TB
61extern const char *get_wt_convert_stats_ascii(const char *path);
62extern const char *get_convert_attr_ascii(const char *path);
d1bf0e08
JH
63
64/* returns 1 if *dst was used */
82b474e0
BW
65extern int convert_to_git(const struct index_state *istate,
66 const char *path, const char *src, size_t len,
8462ff43 67 struct strbuf *dst, int conv_flags);
d1bf0e08
JH
68extern int convert_to_working_tree(const char *path, const char *src,
69 size_t len, struct strbuf *dst);
2841e8f8
LS
70extern int async_convert_to_working_tree(const char *path, const char *src,
71 size_t len, struct strbuf *dst,
72 void *dco);
73extern int async_query_available_blobs(const char *cmd, struct string_list *available_paths);
a33e0b2a
BW
74extern int renormalize_buffer(const struct index_state *istate,
75 const char *path, const char *src, size_t len,
d1bf0e08 76 struct strbuf *dst);
82b474e0
BW
77static inline int would_convert_to_git(const struct index_state *istate,
78 const char *path)
92ac3197 79{
82b474e0 80 return convert_to_git(istate, path, NULL, 0, NULL, 0);
92ac3197 81}
9035d75a 82/* Precondition: would_convert_to_git_filter_fd(path) == true */
d6c41c20
BW
83extern void convert_to_git_filter_fd(const struct index_state *istate,
84 const char *path, int fd,
9035d75a 85 struct strbuf *dst,
8462ff43 86 int conv_flags);
9035d75a 87extern int would_convert_to_git_filter_fd(const char *path);
b6691092
JH
88
89/*****************************************************************
90 *
749f763d 91 * Streaming conversion support
b6691092
JH
92 *
93 *****************************************************************/
94
95struct stream_filter; /* opaque */
96
97extern struct stream_filter *get_stream_filter(const char *path, const unsigned char *);
98extern void free_stream_filter(struct stream_filter *);
99extern int is_null_stream_filter(struct stream_filter *);
100
101/*
102 * Use as much input up to *isize_p and fill output up to *osize_p;
103 * update isize_p and osize_p to indicate how much buffer space was
104 * consumed and filled. Return 0 on success, non-zero on error.
4ae66704
JH
105 *
106 * Some filters may need to buffer the input and look-ahead inside it
107 * to decide what to output, and they may consume more than zero bytes
108 * of input and still not produce any output. After feeding all the
109 * input, pass NULL as input and keep calling this function, to let
110 * such filters know there is no more input coming and it is time for
111 * them to produce the remaining output based on the buffered input.
b6691092
JH
112 */
113extern int stream_filter(struct stream_filter *,
114 const char *input, size_t *isize_p,
115 char *output, size_t *osize_p);
116
d1bf0e08 117#endif /* CONVERT_H */