1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/**************************************************************************/
/* theme_db.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2024-present Redot Engine contributors */
/* (see REDOT_AUTHORS.md) */
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* 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 THEME_DB_H
#define THEME_DB_H
#include "core/object/class_db.h"
#include "core/object/ref_counted.h"
#include "scene/resources/theme.h"
#include <functional>
class Font;
class Node;
class StyleBox;
class Texture2D;
class ThemeContext;
// Macros for binding theme items of this class. This information is used for the documentation, theme
// overrides, etc. This is also the basis for theme cache.
#define BIND_THEME_ITEM(m_data_type, m_class, m_prop) \
ThemeDB::get_singleton()->bind_class_item(m_data_type, get_class_static(), #m_prop, #m_prop, \
[](Node *p_instance, const StringName &p_item_name, const StringName &p_type_name) { \
m_class *p_cast = Object::cast_to<m_class>(p_instance); \
p_cast->theme_cache.m_prop = p_cast->get_theme_item(m_data_type, p_item_name, p_type_name); \
})
#define BIND_THEME_ITEM_CUSTOM(m_data_type, m_class, m_prop, m_item_name) \
ThemeDB::get_singleton()->bind_class_item(m_data_type, get_class_static(), #m_prop, m_item_name, \
[](Node *p_instance, const StringName &p_item_name, const StringName &p_type_name) { \
m_class *p_cast = Object::cast_to<m_class>(p_instance); \
p_cast->theme_cache.m_prop = p_cast->get_theme_item(m_data_type, p_item_name, p_type_name); \
})
// Macro for binding theme items used by this class, but defined/binded by other classes. This is primarily used for
// the theme cache. Can also be used to list such items in documentation.
#define BIND_THEME_ITEM_EXT(m_data_type, m_class, m_prop, m_item_name, m_type_name) \
ThemeDB::get_singleton()->bind_class_external_item(m_data_type, get_class_static(), #m_prop, m_item_name, m_type_name, \
[](Node *p_instance, const StringName &p_item_name, const StringName &p_type_name) { \
m_class *p_cast = Object::cast_to<m_class>(p_instance); \
p_cast->theme_cache.m_prop = p_cast->get_theme_item(m_data_type, p_item_name, p_type_name); \
})
class ThemeDB : public Object {
GDCLASS(ThemeDB, Object);
static ThemeDB *singleton;
// Global Theme resources used by the default theme context.
Ref<Theme> default_theme;
Ref<Theme> project_theme;
// Universal default values, final fallback for every theme.
float fallback_base_scale = 1.0;
Ref<Font> fallback_font;
int fallback_font_size = 16;
Ref<Texture2D> fallback_icon;
Ref<StyleBox> fallback_stylebox;
// Global theme contexts used to scope global Theme resources.
ThemeContext *default_theme_context = nullptr;
HashMap<Node *, ThemeContext *> theme_contexts;
void _propagate_theme_context(Node *p_from_node, ThemeContext *p_context);
void _init_default_theme_context();
void _finalize_theme_contexts();
// Binding of theme items to Node classes.
public:
typedef std::function<void(Node *, const StringName &, const StringName &)> ThemeItemSetter;
struct ThemeItemBind {
Theme::DataType data_type;
StringName class_name;
StringName item_name;
StringName type_name;
bool external = false;
ThemeItemSetter setter;
struct SortByType {
_FORCE_INLINE_ bool operator()(const ThemeItemBind &l, const ThemeItemBind &r) const {
return l.data_type < r.data_type;
}
};
};
private:
HashMap<StringName, HashMap<StringName, ThemeItemBind>> theme_item_binds;
HashMap<StringName, List<ThemeItemBind>> theme_item_binds_list; // Used for listing purposes.
void _sort_theme_items();
protected:
static void _bind_methods();
public:
void initialize_theme();
void initialize_theme_noproject();
void finalize_theme();
// Global Theme resources.
void set_default_theme(const Ref<Theme> &p_default);
Ref<Theme> get_default_theme();
void set_project_theme(const Ref<Theme> &p_project_default);
Ref<Theme> get_project_theme();
// Universal fallback values.
void set_fallback_base_scale(float p_base_scale);
float get_fallback_base_scale();
void set_fallback_font(const Ref<Font> &p_font);
Ref<Font> get_fallback_font();
void set_fallback_font_size(int p_font_size);
int get_fallback_font_size();
void set_fallback_icon(const Ref<Texture2D> &p_icon);
Ref<Texture2D> get_fallback_icon();
void set_fallback_stylebox(const Ref<StyleBox> &p_stylebox);
Ref<StyleBox> get_fallback_stylebox();
void get_native_type_dependencies(const StringName &p_base_type, Vector<StringName> &r_result);
// Global theme contexts.
ThemeContext *create_theme_context(Node *p_node, Vector<Ref<Theme>> &p_themes);
void destroy_theme_context(Node *p_node);
ThemeContext *get_theme_context(Node *p_node) const;
ThemeContext *get_default_theme_context() const;
ThemeContext *get_nearest_theme_context(Node *p_for_node) const;
// Theme item binding.
void bind_class_item(Theme::DataType p_data_type, const StringName &p_class_name, const StringName &p_prop_name, const StringName &p_item_name, ThemeItemSetter p_setter);
void bind_class_external_item(Theme::DataType p_data_type, const StringName &p_class_name, const StringName &p_prop_name, const StringName &p_item_name, const StringName &p_type_name, ThemeItemSetter p_setter);
void update_class_instance_items(Node *p_instance);
void get_class_items(const StringName &p_class_name, List<ThemeItemBind> *r_list, bool p_include_inherited = false, Theme::DataType p_filter_type = Theme::DATA_TYPE_MAX);
// Memory management, reference, and initialization.
static ThemeDB *get_singleton();
ThemeDB();
~ThemeDB();
};
class ThemeContext : public Object {
GDCLASS(ThemeContext, Object);
friend class ThemeDB;
Node *node = nullptr;
ThemeContext *parent = nullptr;
// Themes are stacked in the order of relevance, for easy iteration.
// This means that the first theme is the one you should check first,
// and the last theme is the fallback theme where every lookup ends.
Vector<Ref<Theme>> themes;
void _emit_changed();
protected:
static void _bind_methods();
public:
void set_themes(Vector<Ref<Theme>> &p_themes);
const Vector<Ref<Theme>> get_themes() const;
Ref<Theme> get_fallback_theme() const;
};
#endif // THEME_DB_H
|
