/thirdparty/breakpad/common/string_conversion.h

 1// Copyright (c) 2006, Google Inc.
 2// All rights reserved.
 3//
 4// Redistribution and use in source and binary forms, with or without
 5// modification, are permitted provided that the following conditions are
 6// met:
 7//
 8//     * Redistributions of source code must retain the above copyright
 9// notice, this list of conditions and the following disclaimer.
10//     * Redistributions in binary form must reproduce the above
11// copyright notice, this list of conditions and the following disclaimer
12// in the documentation and/or other materials provided with the
13// distribution.
14//     * Neither the name of Google Inc. nor the names of its
15// contributors may be used to endorse or promote products derived from
16// this software without specific prior written permission.
17//
18// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30// string_conversion.h: Conversion between different UTF-8/16/32 encodings.
31
32#ifndef COMMON_STRING_CONVERSION_H__
33#define COMMON_STRING_CONVERSION_H__
34
35#include <string>
36#include <vector>
37#include "google_breakpad/common/breakpad_types.h"
38
39namespace google_breakpad {
40  
41using std::vector;
42
43// Convert |in| to UTF-16 into |out|.  Use platform byte ordering.  If the
44// conversion failed, |out| will be zero length.
45void UTF8ToUTF16(const char *in, vector<u_int16_t> *out);
46
47// Convert at least one character (up to a maximum of |in_length|) from |in|
48// to UTF-16 into |out|.  Return the number of characters consumed from |in|.
49// Any unused characters in |out| will be initialized to 0.  No memory will
50// be allocated by this routine.
51int UTF8ToUTF16Char(const char *in, int in_length, u_int16_t out[2]);
52
53// Convert |in| to UTF-16 into |out|.  Use platform byte ordering.  If the
54// conversion failed, |out| will be zero length.
55void UTF32ToUTF16(const wchar_t *in, vector<u_int16_t> *out);
56
57// Convert |in| to UTF-16 into |out|.  Any unused characters in |out| will be
58// initialized to 0.  No memory will be allocated by this routine.
59void UTF32ToUTF16Char(wchar_t in, u_int16_t out[2]);
60
61// Convert |in| to UTF-8.  If |swap| is true, swap bytes before converting.
62std::string UTF16ToUTF8(const vector<u_int16_t> &in, bool swap);
63
64}  // namespace google_breakpad
65
66#endif  // COMMON_STRING_CONVERSION_H__