xref: /aosp_15_r20/external/google-breakpad/src/common/using_std_string.h (revision 9712c20fc9bbfbac4935993a2ca0b3958c5adad2)
1 // -*- mode: C++ -*-
2 
3 // Copyright 2012 Google LLC
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 //     * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //     * Redistributions in binary form must reproduce the above
12 // copyright notice, this list of conditions and the following disclaimer
13 // in the documentation and/or other materials provided with the
14 // distribution.
15 //     * Neither the name of Google LLC nor the names of its
16 // contributors may be used to endorse or promote products derived from
17 // this software without specific prior written permission.
18 //
19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 // Original author: Ivan Penkov
32 
33 // using_std_string.h: Allows building this code in environments where
34 //                     global string (::string) exists.
35 //
36 // The problem:
37 // -------------
38 // Let's say you want to build this code in an environment where a global
39 // string type is defined (i.e. ::string).  Now, let's suppose that ::string
40 // is different that std::string and you'd like to have the option to easily
41 // choose between the two string types.  Ideally you'd like to control which
42 // string type is chosen by simply #defining an identifier.
43 //
44 // The solution:
45 // -------------
46 // #define HAS_GLOBAL_STRING somewhere in a global header file and then
47 // globally replace std::string with string.  Then include this header
48 // file everywhere where string is used.  If you want to revert back to
49 // using std::string, simply remove the #define (HAS_GLOBAL_STRING).
50 
51 #ifndef THIRD_PARTY_BREAKPAD_SRC_COMMON_USING_STD_STRING_H_
52 #define THIRD_PARTY_BREAKPAD_SRC_COMMON_USING_STD_STRING_H_
53 
54 #ifdef HAS_GLOBAL_STRING
55   typedef ::string google_breakpad_string;
56 #else
57 #include <string>
58   using std::string;
59   typedef std::string google_breakpad_string;
60 #endif
61 
62 // Inicates that type google_breakpad_string is defined
63 #define HAS_GOOGLE_BREAKPAD_STRING
64 
65 #endif  // THIRD_PARTY_BREAKPAD_SRC_COMMON_USING_STD_STRING_H_
66