reencode_string: use st_add/st_mult helpers
[git/git.git] / utf8.h
CommitLineData
9e832665
JS
1#ifndef GIT_UTF8_H
2#define GIT_UTF8_H
3
396ccf1f
JH
4typedef unsigned int ucs_char_t; /* assuming 32bit int */
5
1640632b 6size_t display_mode_esc_sequence_len(const char *s);
44b25b87 7int utf8_width(const char **start, size_t *remainder_p);
2bc1e7ec 8int utf8_strnwidth(const char *string, int len, int skip_ansi);
8a9391e9 9int utf8_strwidth(const char *string);
9e832665 10int is_utf8(const char *text);
677cfed5 11int is_encoding_utf8(const char *name);
0e18bcd5 12int same_encoding(const char *, const char *);
4621085b 13__attribute__((format (printf, 2, 3)))
c0821965 14int utf8_fprintf(FILE *, const char *, ...);
677cfed5 15
dde843e7
JH
16extern const char utf8_bom[];
17extern int skip_utf8_bom(char **, size_t);
18
e0db1765 19void strbuf_add_wrapped_text(struct strbuf *buf,
a94410c8 20 const char *text, int indent, int indent2, int width);
e0db1765 21void strbuf_add_wrapped_bytes(struct strbuf *buf, const char *data, int len,
98acc837 22 int indent, int indent2, int width);
a7f01c6b
NTND
23void strbuf_utf8_replace(struct strbuf *sb, int pos, int width,
24 const char *subst);
9e832665 25
b45974a6 26#ifndef NO_ICONV
b782bbab
NTND
27char *reencode_string_iconv(const char *in, size_t insz,
28 iconv_t conv, int *outsz);
29char *reencode_string_len(const char *in, int insz,
30 const char *out_encoding,
31 const char *in_encoding,
32 int *outsz);
b45974a6 33#else
e654eb29
ES
34static inline char *reencode_string_len(const char *a, int b,
35 const char *c, const char *d, int *e)
36{ if (e) *e = 0; return NULL; }
b45974a6
JH
37#endif
38
b782bbab
NTND
39static inline char *reencode_string(const char *in,
40 const char *out_encoding,
41 const char *in_encoding)
42{
43 return reencode_string_len(in, strlen(in),
44 out_encoding, in_encoding,
45 NULL);
46}
47
6cd3c053
KS
48int mbs_chrlen(const char **text, size_t *remainder_p, const char *encoding);
49
6162a1d3 50/*
832c0e5e 51 * Returns true if the path would match ".git" after HFS case-folding.
6162a1d3
JK
52 * The path should be NUL-terminated, but we will match variants of both ".git\0"
53 * and ".git/..." (but _not_ ".../.git"). This makes it suitable for both fsck
54 * and verify_path().
0fc333ba
JK
55 *
56 * Likewise, the is_hfs_dotgitfoo() variants look for ".gitfoo".
6162a1d3
JK
57 */
58int is_hfs_dotgit(const char *path);
0fc333ba
JK
59int is_hfs_dotgitmodules(const char *path);
60int is_hfs_dotgitignore(const char *path);
61int is_hfs_dotgitattributes(const char *path);
6162a1d3 62
110dcda5
KN
63typedef enum {
64 ALIGN_LEFT,
65 ALIGN_MIDDLE,
66 ALIGN_RIGHT
67} align_type;
68
69/*
70 * Align the string given and store it into a strbuf as per the
71 * 'position' and 'width'. If the given string length is larger than
72 * 'width' than then the input string is not truncated and no
73 * alignment is done.
74 */
75void strbuf_utf8_align(struct strbuf *buf, align_type position, unsigned int width,
76 const char *s);
77
10ecb82e
LS
78/*
79 * If a data stream is declared as UTF-16BE or UTF-16LE, then a UTF-16
80 * BOM must not be used [1]. The same applies for the UTF-32 equivalents.
81 * The function returns true if this rule is violated.
82 *
83 * [1] http://unicode.org/faq/utf_bom.html#bom10
84 */
85int has_prohibited_utf_bom(const char *enc, const char *data, size_t len);
86
c6e48652
LS
87/*
88 * If the endianness is not defined in the encoding name, then we
89 * require a BOM. The function returns true if a required BOM is missing.
90 *
91 * The Unicode standard instructs to assume big-endian if there in no
92 * BOM for UTF-16/32 [1][2]. However, the W3C/WHATWG encoding standard
93 * used in HTML5 recommends to assume little-endian to "deal with
94 * deployed content" [3].
95 *
96 * Therefore, strictly requiring a BOM seems to be the safest option for
97 * content in Git.
98 *
99 * [1] http://unicode.org/faq/utf_bom.html#gen6
100 * [2] http://www.unicode.org/versions/Unicode10.0.0/ch03.pdf
101 * Section 3.10, D98, page 132
102 * [3] https://encoding.spec.whatwg.org/#utf-16le
103 */
104int is_missing_required_utf_bom(const char *enc, const char *data, size_t len);
105
9e832665 106#endif