xref: /third_party/pulseaudio/src/pulse/utf8.h (revision 53a5a1b3)
1#ifndef fooutf8hfoo
2#define fooutf8hfoo
3
4/***
5  This file is part of PulseAudio.
6
7  Copyright 2006 Lennart Poettering
8  Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9
10  PulseAudio is free software; you can redistribute it and/or modify
11  it under the terms of the GNU Lesser General Public License as
12  published by the Free Software Foundation; either version 2.1 of the
13  License, or (at your option) any later version.
14
15  PulseAudio is distributed in the hope that it will be useful, but
16  WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  Lesser General Public License for more details.
19
20  You should have received a copy of the GNU Lesser General Public
21  License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
22***/
23
24#include <pulse/cdecl.h>
25#include <pulse/gccmacro.h>
26#include <pulse/version.h>
27
28/** \file
29 * UTF-8 validation functions
30 */
31
32PA_C_DECL_BEGIN
33
34/** Test if the specified strings qualifies as valid UTF8. Return the string if so, otherwise NULL */
35char *pa_utf8_valid(const char *str) PA_GCC_PURE;
36
37/** Test if the specified strings qualifies as valid 7-bit ASCII. Return the string if so, otherwise NULL. \since 0.9.15 */
38char *pa_ascii_valid(const char *str) PA_GCC_PURE;
39
40/** Filter all invalid UTF8 characters from the specified string, returning a new fully UTF8 valid string. Don't forget to free the returned string with pa_xfree() */
41char *pa_utf8_filter(const char *str);
42
43/** Filter all invalid ASCII characters from the specified string, returning a new fully ASCII valid string. Don't forget to free the returned string with pa_xfree(). \since 0.9.15 */
44char *pa_ascii_filter(const char *str);
45
46/** Convert a UTF-8 string to the current locale. Free the string using pa_xfree(). */
47char* pa_utf8_to_locale (const char *str);
48
49/** Convert a string in the current locale to UTF-8. Free the string using pa_xfree(). */
50char* pa_locale_to_utf8 (const char *str);
51
52PA_C_DECL_END
53
54#endif
55