-
Notifications
You must be signed in to change notification settings - Fork 47
/
EntityClassChooser.cpp
378 lines (304 loc) · 10.9 KB
/
EntityClassChooser.cpp
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
#include "EntityClassChooser.h"
#include <stdexcept>
#include "dataview/TreeModel.h"
#include "dataview/TreeViewItemStyle.h"
#include "dataview/ThreadedResourceTreePopulator.h"
#include "dataview/VFSTreePopulator.h"
#include "decl/DeclarationSelector.h"
#include "i18n.h"
#include "ifavourites.h"
#include "ideclmanager.h"
#include "ui/iuserinterface.h"
#include "gamelib.h"
#include <wx/button.h>
#include <wx/panel.h>
#include <wx/splitter.h>
#include "wxutil/Bitmap.h"
#include "wxutil/Icon.h"
#include "eclass.h"
#include "debugging/ScopedDebugTimer.h"
#include "preview/EntityClassPreview.h"
namespace wxutil
{
namespace
{
constexpr const char* const TITLE_ADD_ENTITY = N_("Create Entity");
constexpr const char* const TITLE_CONVERT_TO_ENTITY = N_("Convert to Entity");
constexpr const char* const TITLE_SELECT_ENTITY = N_("Select Entity Class");
constexpr const char* const RKEY_SPLIT_POS = "user/ui/entityClassChooser/splitPos";
constexpr const char* const RKEY_WINDOW_STATE = "user/ui/entityClassChooser/window";
constexpr const char* const RKEY_LAST_SELECTED_ECLASS = "user/ui/entityClassChooser/lastSelectedEclass";
constexpr const char* const FOLDER_ICON = "folder16.png";
constexpr const char* const ENTITY_ICON = "cmenu_add_entity.png";
// Registry XPath to lookup key that specifies the display folder
constexpr const char* const FOLDER_KEY_PATH = "/entityChooser/displayFolderKey";
std::string getDialogTitle(EntityClassChooser::Purpose purpose)
{
switch (purpose)
{
case EntityClassChooser::Purpose::AddEntity: return _(TITLE_ADD_ENTITY);
case EntityClassChooser::Purpose::ConvertEntity: return _(TITLE_CONVERT_TO_ENTITY);
case EntityClassChooser::Purpose::SelectClassname: return _(TITLE_SELECT_ENTITY);
default:
throw std::logic_error("Unknown entity class chooser purpose");
}
}
}
/*
* EntityClassVisitor which populates a treeStore with entity classnames
* taking account of display folders and mod names.
*/
class EntityClassTreePopulator:
public VFSTreePopulator,
public EntityClassVisitor
{
// TreeStore to populate
TreeModel::Ptr _store;
// Column definition
const DeclarationTreeView::Columns& _columns;
// Key that specifies the display folder
std::string _folderKey;
Icon _folderIcon;
Icon _entityIcon;
std::set<std::string> _favourites;
public:
// Constructor
EntityClassTreePopulator(const TreeModel::Ptr& store,
const DeclarationTreeView::Columns& columns)
: VFSTreePopulator(store),
_store(store),
_columns(columns),
_folderKey(game::current::getValue<std::string>(FOLDER_KEY_PATH)),
_folderIcon(GetLocalBitmap(FOLDER_ICON)),
_entityIcon(GetLocalBitmap(ENTITY_ICON))
{
// Get the list of favourite eclasses
_favourites = GlobalFavouritesManager().getFavourites(decl::getTypeName(decl::Type::EntityDef));
}
// EntityClassVisitor implementation
void visit(const IEntityClassPtr& eclass)
{
// Skip hidden entity classes
if (eclass->getVisibility() == vfs::Visibility::HIDDEN)
return;
std::string folderPath = eclass->getAttributeValue(_folderKey);
if (!folderPath.empty())
{
folderPath = "/" + folderPath;
}
// Create the folder to put this EntityClass in, depending on the value
// of the DISPLAY_FOLDER_KEY.
addPath(
eclass->getModName() + folderPath + "/" + eclass->getDeclName(),
[&](TreeModel::Row& row, const std::string& path,
const std::string& leafName, bool isFolder)
{
bool isFavourite = !isFolder && _favourites.count(leafName) > 0;
// Get the display name by stripping off everything before the
// last slash
row[_columns.iconAndName] = wxVariant(
wxDataViewIconText(leafName, !isFolder ? _entityIcon : _folderIcon)
);
row[_columns.fullName] = leafName;
row[_columns.leafName] = leafName;
row[_columns.declName] = eclass->getDeclName();
row[_columns.isFolder] = isFolder;
row[_columns.isFavourite] = isFavourite;
row[_columns.iconAndName] = TreeViewItemStyle::Declaration(isFavourite); // assign attributes
row.SendItemAdded();
}
);
}
};
// Local class for loading entity class definitions in a separate thread
class ThreadedEntityClassLoader final :
public ThreadedResourceTreePopulator
{
private:
// Column specification struct
const DeclarationTreeView::Columns& _columns;
public:
ThreadedEntityClassLoader(const DeclarationTreeView::Columns& cols) :
ThreadedResourceTreePopulator(cols),
_columns(cols)
{}
~ThreadedEntityClassLoader()
{
EnsureStopped();
}
void PopulateModel(const TreeModel::Ptr& model) override
{
// Populate it with the list of entity classes by using a visitor class.
EntityClassTreePopulator visitor(model, _columns);
GlobalEntityClassManager().forEachEntityClass(visitor);
}
void SortModel(const TreeModel::Ptr& model) override
{
model->SortModelFoldersFirst(_columns.leafName, _columns.isFolder);
}
};
class EntityClassDescription :
public wxPanel,
public ui::IDeclarationPreview
{
private:
wxTextCtrl* _textCtrl;
public:
EntityClassDescription(wxWindow* parent) :
wxPanel(parent)
{
SetSizer(new wxBoxSizer(wxVERTICAL));
_textCtrl = new wxTextCtrl(this, wxID_ANY, wxEmptyString, wxDefaultPosition,
wxSize(-1, 90), wxTE_MULTILINE | wxTE_READONLY | wxTE_WORDWRAP);
_textCtrl->SetMinSize(wxSize(-1, 90));
auto descriptionLabel = new wxStaticText(this, wxID_ANY, _("Description"));
descriptionLabel->SetFont(descriptionLabel->GetFont().Bold());
GetSizer()->Add(descriptionLabel, 0, wxEXPAND | wxALIGN_LEFT, 0);
GetSizer()->Add(_textCtrl, 1, wxEXPAND | wxTOP, 6);
Disable();
}
wxWindow* GetPreviewWidget() override
{
return this;
}
void ClearPreview() override
{
_textCtrl->SetValue("");
Enable(false);
}
void SetPreviewDeclName(const std::string& declName) override
{
// Lookup the IEntityClass instance
auto eclass = GlobalEntityClassManager().findClass(declName);
_textCtrl->SetValue(eclass ? eclass::getUsage(eclass) : "");
Enable(!declName.empty() && eclass);
}
};
class EntityClassSelector :
public DeclarationSelector
{
private:
// Model preview widget
std::unique_ptr<EntityClassPreview> _preview;
public:
EntityClassSelector(wxWindow* parent) :
DeclarationSelector(parent, decl::Type::EntityDef),
_preview(new EntityClassPreview(this))
{
GetTreeView()->SetExpandTopLevelItemsAfterPopulation(true);
AddPreviewToRightPane(_preview.get());
AddPreviewToBottom(new EntityClassDescription(this));
}
void LoadEntityClasses()
{
PopulateTreeView(std::make_shared<ThreadedEntityClassLoader>(GetColumns()));
}
};
EntityClassChooser::EntityClassChooser(Purpose purpose) :
DialogBase(getDialogTitle(purpose), "EntityClassChooser"),
_selector(nullptr)
{
SetSizer(new wxBoxSizer(wxVERTICAL));
auto mainSizer = new wxBoxSizer(wxVERTICAL);
GetSizer()->Add(mainSizer, 1, wxEXPAND | wxALL, 12);
auto buttonSizer = CreateStdDialogButtonSizer(wxOK | wxCANCEL);
_affirmativeButton = buttonSizer->GetAffirmativeButton();
switch (purpose)
{
case Purpose::AddEntity:
_affirmativeButton->SetLabelText(_("Create"));
break;
case Purpose::ConvertEntity:
_affirmativeButton->SetLabelText(_("Convert"));
break;
case Purpose::SelectClassname:
_affirmativeButton->SetLabelText(_("Select"));
break;
default:
throw std::logic_error("Unknown entity class chooser purpose");
}
// Listen for defs-reloaded signal (cannot bind directly to
// ThreadedEntityClassLoader method because it is not sigc::trackable)
_defsReloaded = GlobalDeclarationManager().signal_DeclsReloaded(decl::Type::EntityDef).connect(
[this]() { GlobalUserInterface().dispatch([this]() { loadEntityClasses(); }); }
);
Bind(wxEVT_CLOSE_WINDOW, &EntityClassChooser::onDeleteEvent, this);
mainSizer->Add(setupSelector(this), 1, wxEXPAND | wxBOTTOM, 12);
mainSizer->Add(buttonSizer, 0, wxALIGN_RIGHT, 12);
loadEntityClasses();
}
EntityClassChooser::~EntityClassChooser()
{
_defsReloaded.disconnect();
}
std::string EntityClassChooser::ChooseEntityClass(Purpose purpose, const std::string& eclassToSelect)
{
EntityClassChooser instance{ purpose };
// Fall back to the value we saved in the registry if we didn't get any other instructions
auto preselectEclass = !eclassToSelect.empty() ? eclassToSelect :
registry::getValue<std::string>(RKEY_LAST_SELECTED_ECLASS);
if (!preselectEclass.empty())
{
instance.setSelectedEntityClass(preselectEclass);
}
if (instance.ShowModal() == wxID_OK)
{
auto selection = instance.getSelectedEntityClass();
// Remember this selection on OK
if (!selection.empty())
{
registry::setValue(RKEY_LAST_SELECTED_ECLASS, selection);
}
return selection;
}
return ""; // Empty selection on cancel
}
void EntityClassChooser::loadEntityClasses()
{
_selector->LoadEntityClasses();
}
void EntityClassChooser::setSelectedEntityClass(const std::string& eclass)
{
_selector->SetSelectedDeclName(eclass);
}
std::string EntityClassChooser::getSelectedEntityClass() const
{
return _selector->GetSelectedDeclName();
}
void EntityClassChooser::onDeleteEvent(wxCloseEvent& ev)
{
EndModal(wxID_CANCEL); // break main loop
}
int EntityClassChooser::ShowModal()
{
// Update the member variables
updateSelection();
_selector->FocusTreeView();
int returnCode = DialogBase::ShowModal();
_panedPosition.saveToPath(RKEY_SPLIT_POS);
return returnCode;
}
wxWindow* EntityClassChooser::setupSelector(wxWindow* parent)
{
_selector = new EntityClassSelector(parent);
_selector->Bind(wxEVT_DATAVIEW_SELECTION_CHANGED, &EntityClassChooser::onSelectionChanged, this);
_selector->Bind( wxEVT_DATAVIEW_ITEM_ACTIVATED, &EntityClassChooser::_onItemActivated, this );
return _selector;
}
void EntityClassChooser::_onItemActivated( wxDataViewEvent& ev )
{
auto selectedEclass = _selector->GetSelectedDeclName();
if (!selectedEclass.empty())
{
EndModal(wxID_OK);
}
}
void EntityClassChooser::updateSelection()
{
_affirmativeButton->Enable(!_selector->GetSelectedDeclName().empty());
}
void EntityClassChooser::onSelectionChanged(wxDataViewEvent& ev)
{
updateSelection();
}
} // namespace ui