Cortex  10.0.0-a4
InternedString.h
1 //
3 // Copyright (c) 2008-2013, Image Engine Design Inc. All rights reserved.
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 //
12 // * Redistributions in binary form must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // * Neither the name of Image Engine Design nor the names of any
17 // other contributors to this software may be used to endorse or
18 // promote products derived from this software without specific prior
19 // written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
22 // IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
34 
35 #ifndef IECORE_INTERNEDSTRING_H
36 #define IECORE_INTERNEDSTRING_H
37 
38 #include <string>
39 
40 #include "IECore/Export.h"
41 
45 #define IECORE_INTERNEDSTRING_RANGECONSTRUCTOR
46 
47 namespace IECore
48 {
49 
55 class IECORE_API InternedString
56 {
57  public :
58 
59  inline InternedString();
60  inline InternedString( const std::string &value );
61  inline InternedString( const InternedString &other );
62  inline InternedString( const char *value );
63  inline InternedString( const char *value, size_t length );
64  inline InternedString( int64_t number );
65 
66  inline ~InternedString();
67 
68  // The equality operators are extremely fast because they
69  // need only compare the address of the internal string,
70  // because it was made unique upon construction.
71  inline bool operator != ( const InternedString &other ) const;
72  inline bool operator == ( const InternedString &other ) const;
79  inline bool operator < ( const InternedString &other ) const;
80 
81  inline operator const std::string & () const;
82 
83  inline const std::string &value() const;
84  inline const std::string &string() const;
85  inline const char *c_str() const;
86 
87  static size_t numUniqueStrings();
88 
89  private :
90 
91  static const std::string *internedString( const char *value );
92  static const std::string *internedString( const char *value, size_t length );
93 
94  const std::string *m_value;
95 
96  static const InternedString &emptyString();
97  static const InternedString &numberString( int64_t number );
98 
99 };
100 
101 IECORE_API std::ostream &operator << ( std::ostream &o, const InternedString &str );
102 
103 } // namespace IECore
104 
105 #include "IECore/InternedString.inl"
106 
107 #endif // IECORE_INTERNEDSTRING_H
std::ostream & operator<<(std::ostream &os, const Imath::Box< T > &obj)
Streaming for Imath::Box types.
Definition: InternedString.h:55
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43