michael@0: // -*- mode: C++ -*- michael@0: michael@0: // Copyright (c) 2012, Google Inc. michael@0: // All rights reserved. michael@0: // michael@0: // Redistribution and use in source and binary forms, with or without michael@0: // modification, are permitted provided that the following conditions are michael@0: // met: michael@0: // michael@0: // * Redistributions of source code must retain the above copyright michael@0: // notice, this list of conditions and the following disclaimer. michael@0: // * Redistributions in binary form must reproduce the above michael@0: // copyright notice, this list of conditions and the following disclaimer michael@0: // in the documentation and/or other materials provided with the michael@0: // distribution. michael@0: // * Neither the name of Google Inc. nor the names of its michael@0: // contributors may be used to endorse or promote products derived from michael@0: // this software without specific prior written permission. michael@0: // michael@0: // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS michael@0: // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT michael@0: // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR michael@0: // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT michael@0: // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, michael@0: // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT michael@0: // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, michael@0: // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY michael@0: // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT michael@0: // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE michael@0: // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. michael@0: michael@0: // Original author: Ivan Penkov michael@0: michael@0: // using_std_string.h: Allows building this code in environments where michael@0: // global string (::string) exists. michael@0: // michael@0: // The problem: michael@0: // ------------- michael@0: // Let's say you want to build this code in an environment where a global michael@0: // string type is defined (i.e. ::string). Now, let's suppose that ::string michael@0: // is different that std::string and you'd like to have the option to easily michael@0: // choose between the two string types. Ideally you'd like to control which michael@0: // string type is chosen by simply #defining an identifier. michael@0: // michael@0: // The solution: michael@0: // ------------- michael@0: // #define HAS_GLOBAL_STRING somewhere in a global header file and then michael@0: // globally replace std::string with string. Then include this header michael@0: // file everywhere where string is used. If you want to revert back to michael@0: // using std::string, simply remove the #define (HAS_GLOBAL_STRING). michael@0: michael@0: #ifndef THIRD_PARTY_BREAKPAD_SRC_COMMON_USING_STD_STRING_H_ michael@0: #define THIRD_PARTY_BREAKPAD_SRC_COMMON_USING_STD_STRING_H_ michael@0: michael@0: #ifdef HAS_GLOBAL_STRING michael@0: typedef ::string google_breakpad_string; michael@0: #else michael@0: using std::string; michael@0: typedef std::string google_breakpad_string; michael@0: #endif michael@0: michael@0: // Inicates that type google_breakpad_string is defined michael@0: #define HAS_GOOGLE_BREAKPAD_STRING michael@0: michael@0: #endif // THIRD_PARTY_BREAKPAD_SRC_COMMON_USING_STD_STRING_H_