60cb41d6a47be20aed5bce3692d6ed35cd9cede0
1/*
2 * Copyright (c) 2011, Google Inc.
3 */
4#ifndef CONVERT_H
5#define CONVERT_H
6
7struct index_state;
8
9enum safe_crlf {
10 SAFE_CRLF_FALSE = 0,
11 SAFE_CRLF_FAIL = 1,
12 SAFE_CRLF_WARN = 2,
13 SAFE_CRLF_RENORMALIZE = 3
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;
38extern const char *get_cached_convert_stats_ascii(const struct index_state *istate,
39 const char *path);
40extern const char *get_wt_convert_stats_ascii(const char *path);
41extern const char *get_convert_attr_ascii(const char *path);
42
43/* returns 1 if *dst was used */
44extern int convert_to_git(const struct index_state *istate,
45 const char *path, const char *src, size_t len,
46 struct strbuf *dst, enum safe_crlf checksafe);
47extern int convert_to_working_tree(const char *path, const char *src,
48 size_t len, struct strbuf *dst);
49extern int renormalize_buffer(const char *path, const char *src, size_t len,
50 struct strbuf *dst);
51static inline int would_convert_to_git(const struct index_state *istate,
52 const char *path)
53{
54 return convert_to_git(istate, path, NULL, 0, NULL, 0);
55}
56/* Precondition: would_convert_to_git_filter_fd(path) == true */
57extern void convert_to_git_filter_fd(const struct index_state *istate,
58 const char *path, int fd,
59 struct strbuf *dst,
60 enum safe_crlf checksafe);
61extern int would_convert_to_git_filter_fd(const char *path);
62
63/*****************************************************************
64 *
65 * Streaming conversion support
66 *
67 *****************************************************************/
68
69struct stream_filter; /* opaque */
70
71extern struct stream_filter *get_stream_filter(const char *path, const unsigned char *);
72extern void free_stream_filter(struct stream_filter *);
73extern int is_null_stream_filter(struct stream_filter *);
74
75/*
76 * Use as much input up to *isize_p and fill output up to *osize_p;
77 * update isize_p and osize_p to indicate how much buffer space was
78 * consumed and filled. Return 0 on success, non-zero on error.
79 *
80 * Some filters may need to buffer the input and look-ahead inside it
81 * to decide what to output, and they may consume more than zero bytes
82 * of input and still not produce any output. After feeding all the
83 * input, pass NULL as input and keep calling this function, to let
84 * such filters know there is no more input coming and it is time for
85 * them to produce the remaining output based on the buffered input.
86 */
87extern int stream_filter(struct stream_filter *,
88 const char *input, size_t *isize_p,
89 char *output, size_t *osize_p);
90
91#endif /* CONVERT_H */