1 | // |
2 | // Redistribution and use in source and binary forms, with or without |
3 | // modification, are permitted provided that the following conditions |
4 | // are met: |
5 | // * Redistributions of source code must retain the above copyright |
6 | // notice, this list of conditions and the following disclaimer. |
7 | // * Redistributions in binary form must reproduce the above copyright |
8 | // notice, this list of conditions and the following disclaimer in the |
9 | // documentation and/or other materials provided with the distribution. |
10 | // * Neither the name of NVIDIA CORPORATION nor the names of its |
11 | // contributors may be used to endorse or promote products derived |
12 | // from this software without specific prior written permission. |
13 | // |
14 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY |
15 | // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
16 | // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
17 | // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
18 | // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
19 | // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
20 | // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
21 | // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY |
22 | // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
23 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
24 | // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
25 | // |
26 | // Copyright (c) 2008-2021 NVIDIA Corporation. All rights reserved. |
27 | // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved. |
28 | // Copyright (c) 2001-2004 NovodeX AG. All rights reserved. |
29 | |
30 | |
31 | #ifndef PX_STRING_TABLE_H |
32 | #define PX_STRING_TABLE_H |
33 | |
34 | #include "foundation/PxPreprocessor.h" |
35 | |
36 | /** \addtogroup physics |
37 | @{ |
38 | */ |
39 | |
40 | #if !PX_DOXYGEN |
41 | namespace physx |
42 | { |
43 | #endif |
44 | |
45 | /** |
46 | * \brief a table to manage strings. Strings allocated through this object are expected to be owned by this object. |
47 | */ |
48 | class PxStringTable |
49 | { |
50 | protected: |
51 | virtual ~PxStringTable(){} |
52 | public: |
53 | /** |
54 | * \brief Allocate a new string. |
55 | * |
56 | * \param[in] inSrc Source string, null terminated or null. |
57 | * |
58 | * \return *Always* a valid null terminated string. "" is returned if "" or null is passed in. |
59 | */ |
60 | virtual const char* allocateStr( const char* inSrc ) = 0; |
61 | |
62 | /** |
63 | * Release the string table and all the strings associated with it. |
64 | */ |
65 | virtual void release() = 0; |
66 | }; |
67 | |
68 | #if !PX_DOXYGEN |
69 | } // namespace physx |
70 | #endif |
71 | |
72 | /** @} */ |
73 | #endif |
74 | |