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