Updated changelog
[ncmpc-debian.git] / src / util / LocaleString.hxx
1 /*
2  * Copyright 2018 Max Kellermann <max.kellermann@gmail.com>
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * - Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * - Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the
14  * distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
19  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
20  * FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
27  * OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef LOCALE_STRING_HXX
31 #define LOCALE_STRING_HXX
32
33 #include "Compiler.h"
34
35 #include <cstddef>
36
37 /**
38  * Is the given character incomplete?
39  */
40 gcc_pure
41 bool
42 IsIncompleteCharMB(const char *s, size_t n) noexcept;
43
44 /**
45  * Returns the length of the given locale (multi-byte) string in
46  * characters.
47  */
48 gcc_pure
49 std::size_t
50 StringLengthMB(const char *s, size_t n) noexcept;
51
52 /**
53  * Wrapper for std::mbrlen() which attempts to recover with a best
54  * effort from invalid or incomplete sequences.
55  */
56 gcc_pure
57 std::size_t
58 CharSizeMB(const char *s, size_t n) noexcept;
59
60 /**
61  * Determine the start of the character preceding the given reference.
62  *
63  * @param s the start of the string
64  */
65 gcc_pure
66 const char *
67 PrevCharMB(const char *start, const char *reference) noexcept;
68
69 /**
70  * Find the `i`th character of the given string.  Returns the end of
71  * the string if the string is shorter than `i` characters.
72  *
73  * @param s the start of the string
74  */
75 gcc_pure
76 const char *
77 AtCharMB(const char *s, size_t length, size_t i) noexcept;
78
79 /**
80  * Returns the number of terminal cells occupied by this multi-byte
81  * string.
82  */
83 gcc_pure
84 size_t
85 StringWidthMB(const char *s, size_t length) noexcept;
86
87 gcc_pure
88 size_t
89 StringWidthMB(const char *s) noexcept;
90
91 /**
92  * Find the first character which doesn't fully fit into the given width.
93  *
94  * @param s the start of the string
95  */
96 gcc_pure
97 const char *
98 AtWidthMB(const char *s, size_t length, size_t width) noexcept;
99
100 #endif