0ad/source/ps/CStrIntern.h
bb 157c6af18e Make the space in 0 A.D. non-breaking throughout the codebase.
Avoid cases of filenames
Update years in terms and other legal(ish) documents
Don't update years in license headers, since change is not meaningful

Will add linter rule in seperate commit

Happy recompiling everyone!

Original Patch By: Nescio
Comment By: Gallaecio
Differential Revision: D2620
This was SVN commit r27786.
2023-07-27 20:54:46 +00:00

105 lines
2.4 KiB
C++
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/* Copyright (C) 2021 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* 0 A.D. 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 0 A.D. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef INCLUDED_CSTRINTERN
#define INCLUDED_CSTRINTERN
class CStrInternInternals;
/**
* Interned 8-bit strings.
* Each instance with the same string content is a pointer to the same piece of
* memory, allowing very fast string comparisons.
*
* Since a CStrIntern is just a dumb pointer, copying is very fast,
* and pass-by-value should be preferred over pass-by-reference.
*
* Memory allocated for strings will never be freed, so don't use this for
* unbounded numbers of strings (e.g. text rendered by gameplay scripts) -
* it's intended for a small number of short frequently-used strings.
*
* Not thread-safe - only allocate these strings from the main thread.
*/
class CStrIntern
{
public:
CStrIntern();
explicit CStrIntern(const char* str);
explicit CStrIntern(const std::string& str);
/**
* Returns cached FNV1-A hash of the string.
*/
u32 GetHash() const;
/**
* Returns null-terminated string.
*/
const char* c_str() const;
/**
* Returns length of string in bytes.
*/
size_t length() const;
bool empty() const;
/**
* Returns as std::string.
*/
const std::string& string() const;
/**
* String equality.
*/
bool operator==(const CStrIntern& b) const
{
return m == b.m;
}
bool operator!=(const CStrIntern& b) const
{
return m != b.m;
}
/**
* Compare with some arbitrary total order.
* (In particular, this is not alphabetic order,
* and is not consistent between runs of the game.)
*/
bool operator<(const CStrIntern& b) const
{
return m < b.m;
}
private:
CStrInternInternals* m;
};
namespace std
{
template<>
struct hash<CStrIntern>
{
std::size_t operator()(const CStrIntern& str) const
{
return str.GetHash();
}
};
}
#endif // INCLUDED_CSTRINTERN