7f1c010084534ee688b26d0e962a4dca149f1eec
[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  * Wrapper for std::mbrlen() which attempts to recover with a best
39  * effort from invalid or incomplete sequences.
40  */
41 gcc_pure
42 std::size_t
43 CharSizeMB(const char *s, size_t n);
44
45 /**
46  * Determine the start of the character preceding the given reference.
47  *
48  * @param s the start of the string
49  */
50 gcc_pure
51 const char *
52 PrevCharMB(const char *start, const char *reference);
53
54 /**
55  * Returns the number of terminal cells occupied by this multi-byte
56  * string.
57  */
58 gcc_pure
59 size_t
60 StringWidthMB(const char *s, size_t length);
61
62 size_t
63 StringWidthMB(const char *s);
64
65 #endif