src/pulse/utf8.h

   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, write to the Free Software
  22   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23   USA.
  24 ***/
  25
  26 #include <pulse/cdecl.h>
  27 #include <pulse/gccmacro.h>
  28 #include <pulse/version.h>
  29
  30 /** \file
  31  * UTF8 Validation functions
  32  */
  33
  34 PA_C_DECL_BEGIN
  35
  36 /** Test if the specified strings qualifies as valid UTF8. Return the string if so, otherwise NULL */
  37 char *pa_utf8_valid(const char *str) PA_GCC_PURE;
  38
  39 /** Test if the specified strings qualifies as valid 7-bit ASCII. Return the string if so, otherwise NULL. \since 0.9.15 */
  40 char *pa_ascii_valid(const char *str) PA_GCC_PURE;
  41
  42 /** 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() */
  43 char *pa_utf8_filter(const char *str);
  44
  45 /** 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 */
  46 char *pa_ascii_filter(const char *str);
  47
  48 /** Convert a UTF-8 string to the current locale. Free the string using pa_xfree(). */
  49 char* pa_utf8_to_locale (const char *str);
  50
  51 /** Convert a string in the current locale to UTF-8. Free the string using pa_xfree(). */
  52 char* pa_locale_to_utf8 (const char *str);
  53
  54 PA_C_DECL_END
  55
  56 #endif