refs DWIMmery: use the same rule for both "git fetch" and others
[git] / convert.h
1 /*
2  * Copyright (c) 2011, Google Inc.
3  */
4 #ifndef CONVERT_H
5 #define CONVERT_H
6
7 enum safe_crlf {
8         SAFE_CRLF_FALSE = 0,
9         SAFE_CRLF_FAIL = 1,
10         SAFE_CRLF_WARN = 2
11 };
12
13 extern enum safe_crlf safe_crlf;
14
15 enum auto_crlf {
16         AUTO_CRLF_FALSE = 0,
17         AUTO_CRLF_TRUE = 1,
18         AUTO_CRLF_INPUT = -1
19 };
20
21 extern enum auto_crlf auto_crlf;
22
23 enum eol {
24         EOL_UNSET,
25         EOL_CRLF,
26         EOL_LF,
27 #ifdef NATIVE_CRLF
28         EOL_NATIVE = EOL_CRLF
29 #else
30         EOL_NATIVE = EOL_LF
31 #endif
32 };
33
34 extern enum eol core_eol;
35
36 /* returns 1 if *dst was used */
37 extern int convert_to_git(const char *path, const char *src, size_t len,
38                           struct strbuf *dst, enum safe_crlf checksafe);
39 extern int convert_to_working_tree(const char *path, const char *src,
40                                    size_t len, struct strbuf *dst);
41 extern int renormalize_buffer(const char *path, const char *src, size_t len,
42                               struct strbuf *dst);
43
44 /*****************************************************************
45  *
46  * Streaming converison support
47  *
48  *****************************************************************/
49
50 struct stream_filter; /* opaque */
51
52 extern struct stream_filter *get_stream_filter(const char *path, const unsigned char *);
53 extern void free_stream_filter(struct stream_filter *);
54 extern int is_null_stream_filter(struct stream_filter *);
55
56 /*
57  * Use as much input up to *isize_p and fill output up to *osize_p;
58  * update isize_p and osize_p to indicate how much buffer space was
59  * consumed and filled. Return 0 on success, non-zero on error.
60  *
61  * Some filters may need to buffer the input and look-ahead inside it
62  * to decide what to output, and they may consume more than zero bytes
63  * of input and still not produce any output. After feeding all the
64  * input, pass NULL as input and keep calling this function, to let
65  * such filters know there is no more input coming and it is time for
66  * them to produce the remaining output based on the buffered input.
67  */
68 extern int stream_filter(struct stream_filter *,
69                          const char *input, size_t *isize_p,
70                          char *output, size_t *osize_p);
71
72 #endif /* CONVERT_H */