Merge branch 'nd/completion-more-parameters'
[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 const char *get_cached_convert_stats_ascii(const struct index_state *istate,
63                                            const char *path);
64 const char *get_wt_convert_stats_ascii(const char *path);
65 const char *get_convert_attr_ascii(const struct index_state *istate,
66                                    const char *path);
67
68 /* returns 1 if *dst was used */
69 int convert_to_git(const struct index_state *istate,
70                    const char *path, const char *src, size_t len,
71                    struct strbuf *dst, int conv_flags);
72 int convert_to_working_tree(const struct index_state *istate,
73                             const char *path, const char *src,
74                             size_t len, struct strbuf *dst);
75 int async_convert_to_working_tree(const struct index_state *istate,
76                                   const char *path, const char *src,
77                                   size_t len, struct strbuf *dst,
78                                   void *dco);
79 int async_query_available_blobs(const char *cmd,
80                                 struct string_list *available_paths);
81 int renormalize_buffer(const struct index_state *istate,
82                        const char *path, const char *src, size_t len,
83                        struct strbuf *dst);
84 static inline int would_convert_to_git(const struct index_state *istate,
85                                        const char *path)
86 {
87         return convert_to_git(istate, path, NULL, 0, NULL, 0);
88 }
89 /* Precondition: would_convert_to_git_filter_fd(path) == true */
90 void convert_to_git_filter_fd(const struct index_state *istate,
91                               const char *path, int fd,
92                               struct strbuf *dst,
93                               int conv_flags);
94 int would_convert_to_git_filter_fd(const struct index_state *istate,
95                                    const char *path);
96
97 /*****************************************************************
98  *
99  * Streaming conversion support
100  *
101  *****************************************************************/
102
103 struct stream_filter; /* opaque */
104
105 struct stream_filter *get_stream_filter(const struct index_state *istate,
106                                         const char *path,
107                                         const struct object_id *);
108 void free_stream_filter(struct stream_filter *);
109 int is_null_stream_filter(struct stream_filter *);
110
111 /*
112  * Use as much input up to *isize_p and fill output up to *osize_p;
113  * update isize_p and osize_p to indicate how much buffer space was
114  * consumed and filled. Return 0 on success, non-zero on error.
115  *
116  * Some filters may need to buffer the input and look-ahead inside it
117  * to decide what to output, and they may consume more than zero bytes
118  * of input and still not produce any output. After feeding all the
119  * input, pass NULL as input and keep calling this function, to let
120  * such filters know there is no more input coming and it is time for
121  * them to produce the remaining output based on the buffered input.
122  */
123 int stream_filter(struct stream_filter *,
124                   const char *input, size_t *isize_p,
125                   char *output, size_t *osize_p);
126
127 #endif /* CONVERT_H */