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