jkxr/Projects/Android/jni/OpenJK/code/Rufl/hstring.h
Simon 4597b03873 Initial Commit
Opens in Android Studio but haven't even tried to build it yet (it won't.. I know that much!)
2022-09-18 16:37:21 +01:00

118 lines
No EOL
4.1 KiB
C++

/*
===========================================================================
Copyright (C) 2000 - 2013, Raven Software, Inc.
Copyright (C) 2001 - 2013, Activision, Inc.
Copyright (C) 2013 - 2015, OpenJK contributors
This file is part of the OpenJK source code.
OpenJK is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 as
published by the Free Software Foundation.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, see <http://www.gnu.org/licenses/>.
===========================================================================
*/
////////////////////////////////////////////////////////////////////////////////////////
// RAVEN STANDARD USEFUL FUNCTION LIBRARY
// (c) 2002 Activision
//
//
// Handle String
// -------------
// Handle strings are allocated once in a static buffer (with a hash index), and are
// never cleared out. You should use these for very common string names which are
// redundant or intended to last a long time.
//
// Handle strings are also good for comparison and storage because they compare only
// the handles, which are simple unique integers.
//
////////////////////////////////////////////////////////////////////////////////////////
#if !defined(RUFL_HSTRING_INC)
#define RUFL_HSTRING_INC
////////////////////////////////////////////////////////////////////////////////////////
// The Handle String Class
////////////////////////////////////////////////////////////////////////////////////////
class hstring
{
public:
////////////////////////////////////////////////////////////////////////////////////
// Constructors
////////////////////////////////////////////////////////////////////////////////////
hstring();
hstring(const char *str);
hstring(const hstring &str);
////////////////////////////////////////////////////////////////////////////////////
// Assignment
////////////////////////////////////////////////////////////////////////////////////
hstring& operator= (const char *str);
hstring& operator= (const hstring &str);
////////////////////////////////////////////////////////////////////////////////////
// Comparison
////////////////////////////////////////////////////////////////////////////////////
bool operator== (const hstring &str) const {return (mHandle==str.mHandle);}
bool operator< (const hstring &str) const {return (mHandle< str.mHandle);}
bool operator! () const {return (mHandle==0);}
////////////////////////////////////////////////////////////////////////////////////
// Conversion
////////////////////////////////////////////////////////////////////////////////////
const char* c_str(void) const;
const char* operator *(void) const;
////////////////////////////////////////////////////////////////////////////////////
// Access Functions
////////////////////////////////////////////////////////////////////////////////////
int length(void) const;
int handle(void) const;
bool empty() const {return handle()==0;}
////////////////////////////////////////////////////////////////////////////////////
// Debug Statistics Routines
////////////////////////////////////////////////////////////////////////////////////
#ifdef _DEBUG
static float ave_collisions();
static int total_strings();
static int total_bytes();
static int total_finds();
static int total_collisions();
#endif
private:
////////////////////////////////////////////////////////////////////////////////////
// Helper Functions
////////////////////////////////////////////////////////////////////////////////////
void init(const char *str);
////////////////////////////////////////////////////////////////////////////////////
// Data
////////////////////////////////////////////////////////////////////////////////////
int mHandle;
#ifdef _DEBUG
char* mStr;
#endif
};
#endif // HSTRING_H