source/lib/utf8.h

   1 /* Copyright (c) 2010 Wildfire Games
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining
   4  * a copy of this software and associated documentation files (the
   5  * "Software"), to deal in the Software without restriction, including
   6  * without limitation the rights to use, copy, modify, merge, publish,
   7  * distribute, sublicense, and/or sell copies of the Software, and to
   8  * permit persons to whom the Software is furnished to do so, subject to
   9  * the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included
  12  * in all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  15  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  18  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  19  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  20  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  */
  22
  23 #ifndef INCLUDED_UTF8
  24 #define INCLUDED_UTF8
  25
  26 // note: error codes are returned via optional output parameter.
  27 namespace ERR
  28 {
  29         const Status UTF8_SURROGATE     = -100700;
  30         const Status UTF8_OUTSIDE_BMP   = -100701;
  31         const Status UTF8_NONCHARACTER  = -100702;
  32         const Status UTF8_INVALID_UTF8  = -100703;
  33 }
  34
  35 /**
  36  * convert UTF-8 to a wide string (UTF-16 or UCS-4, depending on the
  37  * platform's wchar_t).
  38  *
  39  * @param s input string (UTF-8)
  40  * @param err if nonzero, this receives the first error encountered
  41  * (the rest may be subsequent faults) or INFO::OK if all went well.
  42  * otherwise, the function raises a warning dialog for every
  43  * error/warning.
  44  **/
  45 LIB_API std::wstring wstring_from_utf8(const std::string& s, Status* err = 0);
  46
  47 /**
  48  * opposite of wstring_from_utf8
  49  **/
  50 LIB_API std::string utf8_from_wstring(const std::wstring& s, Status* err = 0);
  51
  52 #endif  // #ifndef INCLUDED_UTF8