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
|
/* Copyright (C) 2025 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_CGUISETTINGS
#define INCLUDED_CGUISETTINGS
#include "lib/code_annotation.h"
#include "ps/CStr.h"
#include <js/TypeDecls.h>
#include <utility>
class IGUIObject;
class ScriptRequest;
/**
* This setting interface allows GUI objects to call setting function functions without having to know the setting type.
* This is fact is used for setting the value from a JS value or XML value (string) and when deleting the setting,
* when the type of the setting value is not known in advance.
*/
class IGUISetting
{
public:
NONCOPYABLE(IGUISetting);
IGUISetting(const CStr& name, IGUIObject* owner);
/**
* Parses the given string and assigns to the setting value. Used for parsing XML attributes.
*/
bool FromString(const CStrW& value, const bool sendMessage);
/**
* Parses the given JS::Value using Script::FromJSVal and assigns it to the setting data.
*/
bool FromJSVal(const ScriptRequest& rq, JS::HandleValue value, const bool sendMessage);
/**
* Converts the setting data to a JS::Value using Script::ToJSVal.
*/
virtual void ToJSVal(const ScriptRequest& rq, JS::MutableHandleValue value) = 0;
void DeferSettingChange()
{
delayNotification = true;
}
void DispatchDelayedSettingChange()
{
if (!std::exchange(delayNotification, false))
return;
OnSettingChange(GetName(), true);
}
protected:
IGUISetting(IGUISetting&& other);
IGUISetting& operator=(IGUISetting&& other) = delete;
virtual ~IGUISetting() = default;
virtual bool DoFromString(const CStrW& value) = 0;
virtual bool DoFromJSVal(const ScriptRequest& rq, JS::HandleValue value) = 0;
/**
* Triggers the IGUIObject logic when a setting changes.
* This should be called by derived classes when something externally visible changes,
* unless overloaded to provide similar behaviour.
*/
virtual void OnSettingChange(const CStr& setting, bool sendMessage);
/**
* Return the name of the setting, from JS.
*/
const CStr& GetName() const
{
return m_Name;
}
/**
* The object that stores this setting.
*/
IGUIObject& m_Object;
bool delayNotification{false};
private:
CStr m_Name;
};
/**
* Wraps a T. Makes sure the appropriate setting functions are called when modifying T,
* and likewise makes sure that JS/xml settings affect T appropriately,
* while being as transparent as possible to use from C++ code.
*/
template<typename T>
class CGUISimpleSetting : public IGUISetting
{
public:
template<typename... Args>
CGUISimpleSetting(IGUIObject* pObject, const CStr& name, Args&&... args)
: IGUISetting(name, pObject), m_Setting(args...)
{}
NONCOPYABLE(CGUISimpleSetting);
CGUISimpleSetting(CGUISimpleSetting&&) = default;
CGUISimpleSetting& operator=(CGUISimpleSetting&&) = delete;
operator const T&() const { return m_Setting; }
const T& operator*() const { return m_Setting; }
const T* operator->() const { return &m_Setting; }
/**
* 'Uglified' getter when you want direct access without triggering messages.
*/
T& GetMutable() { return m_Setting; }
/**
* 'Uglified' operator=, so that SendMessage is explicit.
*/
void Set(T value, bool sendMessage)
{
m_Setting = std::move(value);
OnSettingChange(GetName(), sendMessage);
}
protected:
bool DoFromString(const CStrW& value) override;
bool DoFromJSVal(const ScriptRequest& rq, JS::HandleValue value) override;
void ToJSVal(const ScriptRequest& rq, JS::MutableHandleValue value) override;
T m_Setting;
};
#endif // INCLUDED_CGUISETTINGS
|
