convert_to_git(): safe_crlf/checksafe becomes int conv_flags
[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
2841e8f8
LS
7#include "string-list.h"
8
a7609c54
BW
9struct index_state;
10
8462ff43
TB
11#define CONV_EOL_RNDTRP_DIE (1<<0) /* Die if CRLF to LF to CRLF is different */
12#define CONV_EOL_RNDTRP_WARN (1<<1) /* Warn if CRLF to LF to CRLF is different */
13#define CONV_EOL_RENORMALIZE (1<<2) /* Convert CRLF to LF */
14#define CONV_EOL_KEEP_CRLF (1<<3) /* Keep CRLF line endings as is */
d1bf0e08 15
8462ff43 16extern int global_conv_flags_eol;
d1bf0e08
JH
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
2841e8f8
LS
37enum ce_delay_state {
38 CE_NO_DELAY = 0,
39 CE_CAN_DELAY = 1,
40 CE_RETRY = 2
41};
42
43struct delayed_checkout {
44 /*
45 * State of the currently processed cache entry. If the state is
46 * CE_CAN_DELAY, then the filter can delay the current cache entry.
47 * If the state is CE_RETRY, then this signals the filter that the
48 * cache entry was requested before.
49 */
50 enum ce_delay_state state;
51 /* List of filter drivers that signaled delayed blobs. */
52 struct string_list filters;
53 /* List of delayed blobs identified by their path. */
54 struct string_list paths;
55};
56
d1bf0e08 57extern enum eol core_eol;
a7609c54
BW
58extern const char *get_cached_convert_stats_ascii(const struct index_state *istate,
59 const char *path);
a7630bd4
TB
60extern const char *get_wt_convert_stats_ascii(const char *path);
61extern const char *get_convert_attr_ascii(const char *path);
d1bf0e08
JH
62
63/* returns 1 if *dst was used */
82b474e0
BW
64extern int convert_to_git(const struct index_state *istate,
65 const char *path, const char *src, size_t len,
8462ff43 66 struct strbuf *dst, int conv_flags);
d1bf0e08
JH
67extern int convert_to_working_tree(const char *path, const char *src,
68 size_t len, struct strbuf *dst);
2841e8f8
LS
69extern int async_convert_to_working_tree(const char *path, const char *src,
70 size_t len, struct strbuf *dst,
71 void *dco);
72extern int async_query_available_blobs(const char *cmd, struct string_list *available_paths);
a33e0b2a
BW
73extern int renormalize_buffer(const struct index_state *istate,
74 const char *path, const char *src, size_t len,
d1bf0e08 75 struct strbuf *dst);
82b474e0
BW
76static inline int would_convert_to_git(const struct index_state *istate,
77 const char *path)
92ac3197 78{
82b474e0 79 return convert_to_git(istate, path, NULL, 0, NULL, 0);
92ac3197 80}
9035d75a 81/* Precondition: would_convert_to_git_filter_fd(path) == true */
d6c41c20
BW
82extern void convert_to_git_filter_fd(const struct index_state *istate,
83 const char *path, int fd,
9035d75a 84 struct strbuf *dst,
8462ff43 85 int conv_flags);
9035d75a 86extern int would_convert_to_git_filter_fd(const char *path);
b6691092
JH
87
88/*****************************************************************
89 *
749f763d 90 * Streaming conversion support
b6691092
JH
91 *
92 *****************************************************************/
93
94struct stream_filter; /* opaque */
95
96extern struct stream_filter *get_stream_filter(const char *path, const unsigned char *);
97extern void free_stream_filter(struct stream_filter *);
98extern int is_null_stream_filter(struct stream_filter *);
99
100/*
101 * Use as much input up to *isize_p and fill output up to *osize_p;
102 * update isize_p and osize_p to indicate how much buffer space was
103 * consumed and filled. Return 0 on success, non-zero on error.
4ae66704
JH
104 *
105 * Some filters may need to buffer the input and look-ahead inside it
106 * to decide what to output, and they may consume more than zero bytes
107 * of input and still not produce any output. After feeding all the
108 * input, pass NULL as input and keep calling this function, to let
109 * such filters know there is no more input coming and it is time for
110 * them to produce the remaining output based on the buffered input.
b6691092
JH
111 */
112extern int stream_filter(struct stream_filter *,
113 const char *input, size_t *isize_p,
114 char *output, size_t *osize_p);
115
d1bf0e08 116#endif /* CONVERT_H */