convert: convert crlf_to_git to take an index
[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
a7609c54
BW
7struct index_state;
8
d1bf0e08
JH
9enum safe_crlf {
10 SAFE_CRLF_FALSE = 0,
11 SAFE_CRLF_FAIL = 1,
65237284
TB
12 SAFE_CRLF_WARN = 2,
13 SAFE_CRLF_RENORMALIZE = 3
d1bf0e08
JH
14};
15
16extern enum safe_crlf safe_crlf;
17
18enum auto_crlf {
19 AUTO_CRLF_FALSE = 0,
20 AUTO_CRLF_TRUE = 1,
21 AUTO_CRLF_INPUT = -1
22};
23
24extern enum auto_crlf auto_crlf;
25
26enum eol {
27 EOL_UNSET,
28 EOL_CRLF,
29 EOL_LF,
30#ifdef NATIVE_CRLF
31 EOL_NATIVE = EOL_CRLF
32#else
33 EOL_NATIVE = EOL_LF
34#endif
35};
36
37extern enum eol core_eol;
a7609c54
BW
38extern const char *get_cached_convert_stats_ascii(const struct index_state *istate,
39 const char *path);
a7630bd4
TB
40extern const char *get_wt_convert_stats_ascii(const char *path);
41extern const char *get_convert_attr_ascii(const char *path);
d1bf0e08
JH
42
43/* returns 1 if *dst was used */
44extern int convert_to_git(const char *path, const char *src, size_t len,
45 struct strbuf *dst, enum safe_crlf checksafe);
46extern int convert_to_working_tree(const char *path, const char *src,
47 size_t len, struct strbuf *dst);
48extern int renormalize_buffer(const char *path, const char *src, size_t len,
49 struct strbuf *dst);
7ce7c760 50static inline int would_convert_to_git(const char *path)
92ac3197 51{
7ce7c760 52 return convert_to_git(path, NULL, 0, NULL, 0);
92ac3197 53}
9035d75a
SP
54/* Precondition: would_convert_to_git_filter_fd(path) == true */
55extern void convert_to_git_filter_fd(const char *path, int fd,
56 struct strbuf *dst,
57 enum safe_crlf checksafe);
58extern int would_convert_to_git_filter_fd(const char *path);
b6691092
JH
59
60/*****************************************************************
61 *
749f763d 62 * Streaming conversion support
b6691092
JH
63 *
64 *****************************************************************/
65
66struct stream_filter; /* opaque */
67
68extern struct stream_filter *get_stream_filter(const char *path, const unsigned char *);
69extern void free_stream_filter(struct stream_filter *);
70extern int is_null_stream_filter(struct stream_filter *);
71
72/*
73 * Use as much input up to *isize_p and fill output up to *osize_p;
74 * update isize_p and osize_p to indicate how much buffer space was
75 * consumed and filled. Return 0 on success, non-zero on error.
4ae66704
JH
76 *
77 * Some filters may need to buffer the input and look-ahead inside it
78 * to decide what to output, and they may consume more than zero bytes
79 * of input and still not produce any output. After feeding all the
80 * input, pass NULL as input and keep calling this function, to let
81 * such filters know there is no more input coming and it is time for
82 * them to produce the remaining output based on the buffered input.
b6691092
JH
83 */
84extern int stream_filter(struct stream_filter *,
85 const char *input, size_t *isize_p,
86 char *output, size_t *osize_p);
87
d1bf0e08 88#endif /* CONVERT_H */