godot/core/string_name.h

165 lines
5.0 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* string_name.h */
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
2014-02-10 01:10:30 +00:00
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
#ifndef STRING_NAME_H
#define STRING_NAME_H
2014-02-10 01:10:30 +00:00
#include "core/os/mutex.h"
#include "core/safe_refcount.h"
#include "core/ustring.h"
2014-02-10 01:10:30 +00:00
struct StaticCString {
const char *ptr;
static StaticCString create(const char *p_ptr);
};
class StringName {
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
enum {
2016-03-08 23:00:52 +00:00
STRING_TABLE_BITS = 12,
STRING_TABLE_LEN = 1 << STRING_TABLE_BITS,
STRING_TABLE_MASK = STRING_TABLE_LEN - 1
2014-02-10 01:10:30 +00:00
};
2016-03-08 23:00:52 +00:00
struct _Data {
2014-02-10 01:10:30 +00:00
SafeRefCount refcount;
const char *cname = nullptr;
2014-02-10 01:10:30 +00:00
String name;
String get_name() const { return cname ? String(cname) : name; }
int idx = 0;
uint32_t hash = 0;
_Data *prev = nullptr;
_Data *next = nullptr;
_Data() {}
2014-02-10 01:10:30 +00:00
};
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
static _Data *_table[STRING_TABLE_LEN];
2016-03-08 23:00:52 +00:00
_Data *_data = nullptr;
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
union _HashUnion {
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
_Data *ptr;
uint32_t hash;
};
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
void unref();
friend void register_core_types();
friend void unregister_core_types();
2016-03-08 23:00:52 +00:00
2020-02-28 10:02:20 +00:00
static Mutex mutex;
2014-02-10 01:10:30 +00:00
static void setup();
static void cleanup();
static bool configured;
2016-03-08 23:00:52 +00:00
StringName(_Data *p_data) { _data = p_data; }
2014-02-10 01:10:30 +00:00
public:
operator const void *() const { return (_data && (_data->cname || !_data->name.empty())) ? (void *)1 : nullptr; }
2016-03-08 23:00:52 +00:00
bool operator==(const String &p_name) const;
bool operator==(const char *p_name) const;
bool operator!=(const String &p_name) const;
_FORCE_INLINE_ bool operator<(const StringName &p_name) const {
2014-02-10 01:10:30 +00:00
return _data < p_name._data;
2014-02-10 01:10:30 +00:00
}
_FORCE_INLINE_ bool operator==(const StringName &p_name) const {
2016-03-08 23:00:52 +00:00
// the real magic of all this mess happens here.
2014-02-10 01:10:30 +00:00
// this is why path comparisons are very fast
return _data == p_name._data;
2016-03-08 23:00:52 +00:00
}
2014-02-10 01:10:30 +00:00
_FORCE_INLINE_ uint32_t hash() const {
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
if (_data)
return _data->hash;
else
return 0;
}
2017-09-05 16:07:13 +00:00
_FORCE_INLINE_ const void *data_unique_pointer() const {
return (void *)_data;
}
bool operator!=(const StringName &p_name) const;
2016-03-08 23:00:52 +00:00
_FORCE_INLINE_ operator String() const {
if (_data) {
if (_data->cname)
return String(_data->cname);
else
return _data->name;
}
return String();
}
2014-02-10 01:10:30 +00:00
static StringName search(const char *p_name);
static StringName search(const CharType *p_name);
static StringName search(const String &p_name);
struct AlphCompare {
_FORCE_INLINE_ bool operator()(const StringName &l, const StringName &r) const {
2014-02-10 01:10:30 +00:00
const char *l_cname = l._data ? l._data->cname : "";
const char *r_cname = r._data ? r._data->cname : "";
if (l_cname) {
if (r_cname)
return is_str_less(l_cname, r_cname);
else
return is_str_less(l_cname, r._data->name.ptr());
} else {
if (r_cname)
return is_str_less(l._data->name.ptr(), r_cname);
else
return is_str_less(l._data->name.ptr(), r._data->name.ptr());
}
2014-02-10 01:10:30 +00:00
}
};
void operator=(const StringName &p_name);
2014-02-10 01:10:30 +00:00
StringName(const char *p_name);
StringName(const StringName &p_name);
StringName(const String &p_name);
StringName(const StaticCString &p_static_string);
StringName() {}
2014-02-10 01:10:30 +00:00
~StringName();
};
StringName _scs_create(const char *p_chr);
#endif // STRING_NAME_H