/
ReadableEditorDialog.cpp
1721 lines (1457 loc) · 46.1 KB
/
ReadableEditorDialog.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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Project related
#include "ReadableEditorDialog.h"
#include "XdFileChooserDialog.h"
#include "XDataSelector.h"
#include "GuiSelector.h"
#include "gui/GuiManager.h"
#include "TextViewInfoDialog.h"
#include "ReadableGuiView.h"
// General
#include "selectionlib.h"
#include "wxutil/dialog/MessageBox.h"
#include "registry/registry.h"
#include "string/string.h"
#include "string/convert.h"
#include "os/file.h"
#include "os/path.h"
#include "i18n.h"
#include "itextstream.h"
// Modules
#include "iundo.h"
#include "imainframe.h"
#include "ientity.h"
#include "imap.h"
#include "igame.h"
#include "idialogmanager.h"
#include <wx/sizer.h>
#include <wx/textctrl.h>
#include <wx/button.h>
#include <wx/spinctrl.h>
#include <wx/radiobut.h>
#include <wx/menu.h>
namespace ui
{
// consts:
namespace
{
const char* const WINDOW_TITLE = N_("Readable Editor");
const char* const NO_ENTITY_ERROR = N_("Cannot run Readable Editor on this selection.\n"
"Please select a single XData entity.");
enum MenuItemId
{
InsertWholePage = 1,
InsertLeft,
InsertRight,
DeleteWholePage,
DeleteLeft,
DeleteRight,
AppendPage,
PrependPage,
ShowXDataSummary,
ShowDuplicatedDefs,
ShowGuiImportSummary,
};
} // namespace
//////////////////////////////////////////////////////////////////////////////
// Public and protected methods:
ReadableEditorDialog::ReadableEditorDialog(Entity* entity) :
DialogBase(_(WINDOW_TITLE)),
_guiView(NULL),
_entity(entity),
_xdLoader(new XData::XDataLoader()),
_currentPageIndex(0),
_xdNameSpecified(false),
_runningGuiLayoutCheck(false),
_runningXDataUniquenessCheck(false),
_useDefaultFilename(true),
_saveInProgress(false)
{
wxPanel* mainPanel = loadNamedPanel(this, "ReadableEditorMainPanel");
wxPanel* previewPanel = findNamedObject<wxPanel>(this, "ReadableEditorPreviewPanel");
_guiView = new gui::ReadableGuiView(previewPanel);
previewPanel->GetSizer()->Add(_guiView, 1, wxEXPAND);
setupGeneralPropertiesInterface();
setupPageRelatedInterface();
setupButtonPanel();
createMenus();
mainPanel->Layout();
mainPanel->Fit();
Fit();
CenterOnParent();
}
int ReadableEditorDialog::ShowModal()
{
// Load the initial values from the entity
if (!initControlsFromEntity())
{
// User clicked cancel, so destroy the window.
return wxID_CANCEL;
}
// Initialize proper editing controls.
populateControlsFromXData();
// Initialise the GL widget after the widgets have been shown
_guiView->initialiseView();
return DialogBase::ShowModal();
}
void ReadableEditorDialog::RunDialog(const cmd::ArgumentList& args)
{
// Check prerequisites
const SelectionInfo& info = GlobalSelectionSystem().getSelectionInfo();
if (info.entityCount == 1 && info.totalCount == info.entityCount)
{
// Check the entity type
Entity* entity = Node_getEntity(GlobalSelectionSystem().ultimateSelected());
if (entity != NULL && entity->getKeyValue("editor_readable") == "1")
{
// Show the dialog
ReadableEditorDialog* dialog = new ReadableEditorDialog(entity);
dialog->ShowModal();
dialog->Destroy();
return;
}
}
// Exactly one redable entity must be selected.
wxutil::Messagebox::ShowError(_(NO_ENTITY_ERROR));
}
// UI Creation
void ReadableEditorDialog::setupGeneralPropertiesInterface()
{
makeLabelBold(this, "ReadableEditorGeneralLabel");
makeLabelBold(this, "ReadableEditorPageLabel");
// Readable Name
_nameEntry = findNamedObject<wxTextCtrl>(this, "ReadableEditorInventoryName");
_nameEntry->Connect(wxEVT_CHAR, wxKeyEventHandler(ReadableEditorDialog::onChar), NULL, this);
// XData Name
_xDataNameEntry = findNamedObject<wxTextCtrl>(this, "ReadableEditorXDataName");
_xDataNameEntry->Connect(wxEVT_CHAR, wxKeyEventHandler(ReadableEditorDialog::onChar), NULL, this);
_xDataNameEntry->Connect(wxEVT_KILL_FOCUS, wxFocusEventHandler(ReadableEditorDialog::onFocusOut), NULL, this);
// Add a browse-button.
findNamedObject<wxButton>(this, "ReadableEditorXDBrowseButton")->Connect(wxEVT_BUTTON,
wxCommandEventHandler(ReadableEditorDialog::onBrowseXd), NULL, this);
// Page count
_numPages = findNamedObject<wxSpinCtrl>(this, "ReadableEditorNumPages");
_numPages->SetRange(1, 20);
_numPages->Connect(wxEVT_SPINCTRL, wxSpinEventHandler(ReadableEditorDialog::onNumPagesChanged), NULL, this);
_numPages->Connect(wxEVT_CHAR, wxKeyEventHandler(ReadableEditorDialog::onChar), NULL, this);
// Page Layout:
_oneSidedButton = findNamedObject<wxRadioButton>(this, "ReadableEditorOneSided");
_oneSidedButton->Connect(wxEVT_RADIOBUTTON, wxCommandEventHandler(ReadableEditorDialog::onOneSided), NULL, this);
_twoSidedButton = findNamedObject<wxRadioButton>(this, "ReadableEditorTwoSided");
_twoSidedButton->Connect(wxEVT_RADIOBUTTON, wxCommandEventHandler(ReadableEditorDialog::onTwoSided), NULL, this);
// Pageturn Sound
_pageTurnEntry = findNamedObject<wxTextCtrl>(this, "ReadableEditorPageTurnSound");
}
void ReadableEditorDialog::setupPageRelatedInterface()
{
// Insert Button
findNamedObject<wxButton>(this, "ReadableEditorInsertPage")->Connect(wxEVT_BUTTON,
wxCommandEventHandler(ReadableEditorDialog::onInsert), NULL, this);
// Delete Button
findNamedObject<wxButton>(this, "ReadableEditorDeletePage")->Connect(wxEVT_BUTTON,
wxCommandEventHandler(ReadableEditorDialog::onDelete), NULL, this);
// Page Switcher
findNamedObject<wxButton>(this, "ReadableEditorGotoFirstPage")->Connect(wxEVT_BUTTON,
wxCommandEventHandler(ReadableEditorDialog::onFirstPage), NULL, this);
findNamedObject<wxButton>(this, "ReadableEditorGotoPreviousPage")->Connect(wxEVT_BUTTON,
wxCommandEventHandler(ReadableEditorDialog::onPrevPage), NULL, this);
findNamedObject<wxButton>(this, "ReadableEditorGotoNextPage")->Connect(wxEVT_BUTTON,
wxCommandEventHandler(ReadableEditorDialog::onNextPage), NULL, this);
findNamedObject<wxButton>(this, "ReadableEditorGotoLastPage")->Connect(wxEVT_BUTTON,
wxCommandEventHandler(ReadableEditorDialog::onLastPage), NULL, this);
_curPageDisplay = findNamedObject<wxStaticText>(this, "ReadableEditorCurPage");
// Add a gui chooser with a browse-button
_guiEntry = findNamedObject<wxTextCtrl>(this, "ReadableEditorGuiDefinition");
_guiEntry->Connect(wxEVT_CHAR, wxKeyEventHandler(ReadableEditorDialog::onChar), NULL, this);
_guiEntry->Connect(wxEVT_KILL_FOCUS, wxFocusEventHandler(ReadableEditorDialog::onFocusOut), NULL, this);
findNamedObject<wxButton>(this, "ReadableEditorGuiBrowseButton")->Connect(wxEVT_BUTTON,
wxCommandEventHandler(ReadableEditorDialog::onBrowseGui), NULL, this);
// Create "left" and "right" labels and add them to the first row of the table
_pageLeftLabel = findNamedObject<wxStaticText>(this, "ReadableEditorPageLeftLabel");
_pageRightLabel = findNamedObject<wxStaticText>(this, "ReadableEditorPageRightLabel");
_textViewTitle = findNamedObject<wxTextCtrl>(this, "ReadableEditorTitleLeft");
_textViewTitle->Connect(wxEVT_TEXT, wxCommandEventHandler(ReadableEditorDialog::onTextChanged), NULL, this);
_textViewRightTitle = findNamedObject<wxTextCtrl>(this, "ReadableEditorTitleRight");
_textViewRightTitle->Connect(wxEVT_TEXT, wxCommandEventHandler(ReadableEditorDialog::onTextChanged), NULL, this);
// Create "body" label and body-textViews and add them to the third row of the table. Add the key-press-event.
_textViewBody = findNamedObject<wxTextCtrl>(this, "ReadableEditorBodyLeft");
_textViewBody->Connect(wxEVT_TEXT, wxCommandEventHandler(ReadableEditorDialog::onTextChanged), NULL, this);
_textViewRightBody = findNamedObject<wxTextCtrl>(this, "ReadableEditorBodyRight");
_textViewRightBody->Connect(wxEVT_TEXT, wxCommandEventHandler(ReadableEditorDialog::onTextChanged), NULL, this);
}
void ReadableEditorDialog::createMenus()
{
// Insert menu
_insertMenu.reset(new wxMenu);
_insertMenu->Append(InsertWholePage, _("Insert whole Page"), "");
_insertMenu->Append(InsertLeft, _("Insert on left Side"), "");
_insertMenu->Append(InsertRight, _("Insert on right Side"), "");
_insertMenu->Connect(wxEVT_MENU, wxCommandEventHandler(ReadableEditorDialog::onMenuItemClick), NULL, this);
// Delete Menu
_deleteMenu.reset(new wxMenu);
_deleteMenu->Append(DeleteWholePage, _("Delete whole Page"), "");
_deleteMenu->Append(DeleteLeft, _("Delete on left Side"), "");
_deleteMenu->Append(DeleteRight, _("Delete on right Side"), "");
_deleteMenu->Connect(wxEVT_MENU, wxCommandEventHandler(ReadableEditorDialog::onMenuItemClick), NULL, this);
// Append Menu
_appendMenu.reset(new wxMenu);
_appendMenu->Append(AppendPage, _("Append Page"), "");
_appendMenu->Connect(wxEVT_MENU, wxCommandEventHandler(ReadableEditorDialog::onMenuItemClick), NULL, this);
// Prepend Menu
_prependMenu.reset(new wxMenu);
_prependMenu->Append(PrependPage, _("Prepend Page"), "");
_prependMenu->Connect(wxEVT_MENU, wxCommandEventHandler(ReadableEditorDialog::onMenuItemClick), NULL, this);
// Tools Menu
_toolsMenu.reset(new wxMenu);
_toolsMenu->Append(ShowXDataSummary, _("Show last XData import summary"), "");
_toolsMenu->Append(ShowDuplicatedDefs, _("Show duplicated definitions"), "");
_toolsMenu->Append(ShowGuiImportSummary, _("Show Gui import summary"), "");
_toolsMenu->Connect(wxEVT_MENU, wxCommandEventHandler(ReadableEditorDialog::onMenuItemClick), NULL, this);
}
void ReadableEditorDialog::setupButtonPanel()
{
findNamedObject<wxButton>(this, "ReadableEditorSave")->Connect(wxEVT_BUTTON,
wxCommandEventHandler(ReadableEditorDialog::onSave), NULL, this);
findNamedObject<wxButton>(this, "ReadableEditorCancel")->Connect(wxEVT_BUTTON,
wxCommandEventHandler(ReadableEditorDialog::onCancel), NULL, this);
findNamedObject<wxButton>(this, "ReadableEditorSaveAndClose")->Connect(wxEVT_BUTTON,
wxCommandEventHandler(ReadableEditorDialog::onSaveClose), NULL, this);
findNamedObject<wxButton>(this, "ReadableEditorTools")->Connect(wxEVT_BUTTON,
wxCommandEventHandler(ReadableEditorDialog::onToolsClicked), NULL, this);
}
//////////////////////////////////////////////////////////////////////////////
// Private Methods:
bool ReadableEditorDialog::initControlsFromEntity()
{
// Inv_name
_nameEntry->SetValue(_entity->getKeyValue("inv_name"));
// Xdata contents
_xDataNameEntry->SetValue(_entity->getKeyValue("xdata_contents"));
// Construct the map-based Filename
_mapBasedFilename = GlobalMapModule().getMapName();
std::size_t nameStartPos = _mapBasedFilename.rfind("/") + 1;
if (nameStartPos != std::string::npos)
{
_mapBasedFilename = _mapBasedFilename.substr(nameStartPos, _mapBasedFilename.rfind(".") - nameStartPos);
}
std::string defaultXdName = "readables/" + _mapBasedFilename + "/" + _("<Name_Here>");
_mapBasedFilename += ".xd";
// Load xdata
if (!_entity->getKeyValue("xdata_contents").empty())
{
_xdNameSpecified = true;
try
{
int result = XdFileChooserDialog::Import(
_entity->getKeyValue("xdata_contents"), _xData, _xdFilename, _xdLoader, this
);
if (result == wxID_OK)
{
_useDefaultFilename = false;
refreshWindowTitle();
return true;
}
return false; // cancelled
}
catch (XdFileChooserDialog::ImportFailedException&)
{
std::string msg = fmt::format(_("Failed to import {0}."), _entity->getKeyValue("xdata_contents"));
msg += "\n";
msg += _("Creating a new XData definition...");
msg += "\n\n";
msg += _("Do you want to open the import summary?");
wxutil::Messagebox dialog(_("Import failed"),
msg, ui::IDialog::MESSAGE_ASK, this);
if (dialog.run() == ui::IDialog::RESULT_YES)
{
showXdImportSummary();
}
updateGuiView();
}
}
//No Xdata definition was defined or failed to import. Use default filename and create a OneSidedXData-object
if (_entity->getKeyValue("name").find("book") == std::string::npos)
{
if (!_xdNameSpecified)
_xData.reset(new XData::OneSidedXData(defaultXdName));
else
_xData.reset(new XData::OneSidedXData(_entity->getKeyValue("xdata_contents")));
}
else
{
if (!_xdNameSpecified)
_xData.reset(new XData::TwoSidedXData(defaultXdName));
else
_xData.reset(new XData::OneSidedXData(_entity->getKeyValue("xdata_contents")));
}
_xData->setNumPages(1);
refreshWindowTitle();
return true;
}
bool ReadableEditorDialog::save()
{
_saveInProgress = true;
UndoableCommand cmd("editReadable");
// Name
_entity->setKeyValue("inv_name", _nameEntry->GetValue().ToStdString());
// Xdata contents
_entity->setKeyValue("xdata_contents", _xDataNameEntry->GetValue().ToStdString());
// Current content to XData Object
storeXData();
// Get the storage path and check its validity
std::string storagePath = constructStoragePath();
if (!_useDefaultFilename && !os::fileOrDirExists(storagePath))
{
// The file does not exist, so we have imported a definition contained inside a PK4.
wxutil::Messagebox::ShowError(
_("You have imported an XData definition that is contained in a PK4, which can't be accessed for saving.") +
std::string("\n\n") +
_("Please rename your XData definition, so that it is stored under a different filename."),
this
);
_saveInProgress = false;
return false;
}
// Start exporting
XData::FileStatus fst = _xData->xport(storagePath, XData::Merge);
if (fst == XData::DefinitionExists)
{
switch (_xData->xport( storagePath, XData::MergeOverwriteExisting))
{
case XData::OpenFailed:
wxutil::Messagebox::ShowError(
fmt::format(_("Failed to open {0} for saving."), _xdFilename),
this
);
_saveInProgress = false;
return false;
case XData::MergeFailed:
wxutil::Messagebox::ShowError(
_("Merging failed, because the length of the definition to be overwritten could not be retrieved."),
this
);
_saveInProgress = false;
return false;
default:
//success!
_saveInProgress = false;
return true;
}
}
else if (fst == XData::OpenFailed)
{
wxutil::Messagebox::ShowError(
fmt::format(_("Failed to open {0} for saving."), _xdFilename),
this
);
}
_saveInProgress = false;
return false;
}
std::string ReadableEditorDialog::constructStoragePath()
{
// Construct the storage path from Registry keys.
std::string storagePath;
if (_useDefaultFilename)
{
bool checkVFS = true;
switch (registry::getValue<int>(RKEY_READABLES_STORAGE_FOLDER))
{
case 0: // Use Mod dir
storagePath = GlobalGameManager().getModPath();
if (storagePath.empty())
{
// Mod path not defined. Use base Path
storagePath = GlobalRegistry().get(RKEY_ENGINE_PATH) + "base/";
wxutil::Messagebox::ShowError(_("Mod path not defined. Using Base path..."), this);
}
storagePath += XData::XDATA_DIR;
break;
case 1: // Use Mod Base dir
storagePath = GlobalGameManager().getModBasePath();
if (storagePath.empty())
{
// Mod Base Path not defined. Use Mod path or base path successively.
storagePath = GlobalGameManager().getModPath();
if (storagePath.empty())
{
storagePath = GlobalRegistry().get(RKEY_ENGINE_PATH) + "base/";
wxutil::Messagebox::ShowError(_("Mod Base path not defined, neither is Mod path. Using Engine path..."),
this);
storagePath += XData::XDATA_DIR;
break;
}
wxutil::Messagebox::ShowError(_("Mod Base path not defined. Using Mod path..."), this);
}
storagePath += XData::XDATA_DIR;
break;
default: // Use custom folder
storagePath = GlobalRegistry().get(RKEY_READABLES_CUSTOM_FOLDER);
if (storagePath.empty())
{
// Custom path not defined. Use Mod path or base path successively.
storagePath = GlobalGameManager().getModPath();
if (storagePath.empty())
{
storagePath = GlobalRegistry().get(RKEY_ENGINE_PATH) + "base/";
wxutil::Messagebox::ShowError(_("Mod Base path not defined, neither is Mod path. Using Engine path..."), this);
storagePath += XData::XDATA_DIR;
break;
}
storagePath += XData::XDATA_DIR;
wxutil::Messagebox::ShowError(_("Mod Base path not defined. Using Mod path..."), this);
break;
}
storagePath += "/" +_mapBasedFilename;
checkVFS = false;
break;
}
// Check whether this path already exists in the VFS in another absolute folder. If so, rename it!
if (checkVFS)
{
std::string compPath = GlobalFileSystem().findFile(XData::XDATA_DIR + _mapBasedFilename);
std::string newFileName = _mapBasedFilename;
if (!compPath.empty()) // VFS-path does exist, now check whether it is in another absolute folder.
{
int fileIdx = 2;
compPath += XData::XDATA_DIR + _mapBasedFilename;
while ( (compPath.compare(storagePath + newFileName) != 0) )
{
newFileName = _mapBasedFilename.substr(0, _mapBasedFilename.rfind(".")) + string::to_string(fileIdx++) + ".xd";
compPath = GlobalFileSystem().findFile(XData::XDATA_DIR + newFileName);
if (compPath.empty())
{
wxutil::Messagebox::ShowError(
fmt::format(_("{0}{1} already exists in another path.\n\nXData will be stored in {2}{3}!"),
XData::XDATA_DIR,
_mapBasedFilename,
XData::XDATA_DIR,
newFileName),
this
);
break;
}
compPath += XData::XDATA_DIR + newFileName;
}
}
storagePath += newFileName;
}
}
else
{
// We are exporting a previously imported XData definition.
// The _xdFilename itself can be a VFS path or an absolute path, depending on the user's settings
if (path_is_absolute(_xdFilename.c_str()))
{
storagePath = _xdFilename;
}
else
{
// Retrieve engine path and append _xdFilename
storagePath = GlobalRegistry().get(RKEY_ENGINE_PATH) + _xdFilename;
}
}
return storagePath;
}
void ReadableEditorDialog::refreshWindowTitle()
{
std::string title = constructStoragePath();
title = title.substr( title.find_first_not_of( GlobalRegistry().get(RKEY_ENGINE_PATH) ) );
title = std::string(_("Readable Editor")) + " - " + title;
SetTitle(title);
}
void ReadableEditorDialog::storeXData()
{
//NumPages does not need storing, because it's stored directly after changing it.
_xData->setName(_xDataNameEntry->GetValue().ToStdString());
_xData->setSndPageTurn(_pageTurnEntry->GetValue().ToStdString());
storeCurrentPage();
}
void ReadableEditorDialog::toggleTwoSidedEditingInterface(bool show)
{
if (show)
{
_textViewRightTitle->GetContainingSizer()->Show(_textViewRightTitle);
_textViewRightBody->GetContainingSizer()->Show(_textViewRightBody);
_pageLeftLabel->GetContainingSizer()->Show(_pageLeftLabel);
_pageRightLabel->GetContainingSizer()->Show(_pageRightLabel);
}
else
{
_textViewRightTitle->GetContainingSizer()->Hide(_textViewRightTitle);
_textViewRightBody->GetContainingSizer()->Hide(_textViewRightBody);
_pageLeftLabel->GetContainingSizer()->Hide(_pageLeftLabel);
_pageRightLabel->GetContainingSizer()->Hide(_pageRightLabel);
}
_textViewRightTitle->GetContainingSizer()->Layout();
}
void ReadableEditorDialog::showPage(std::size_t pageIndex)
{
//Gui Def before:
std::string guiBefore = _guiEntry->GetValue().ToStdString();
// Update CurrentPage Label
_currentPageIndex = pageIndex;
_curPageDisplay->SetLabel(string::to_string(pageIndex+1));
if (_xData->getPageLayout() == XData::TwoSided)
{
// Update Gui statement entry from xData
if (!_xData->getGuiPage(pageIndex).empty())
{
_guiEntry->SetValue(_xData->getGuiPage(pageIndex));
}
else
{
_guiEntry->SetValue(XData::DEFAULT_TWOSIDED_GUI);
}
setTextViewAndScroll(_textViewRightTitle, _xData->getPageContent(XData::Title, pageIndex, XData::Right));
setTextViewAndScroll(_textViewRightBody, _xData->getPageContent(XData::Body, pageIndex, XData::Right));
}
else
{
// Update Gui statement entry from xData
if (!_xData->getGuiPage(pageIndex).empty())
{
_guiEntry->SetValue(_xData->getGuiPage(pageIndex));
}
else
{
_guiEntry->SetValue(XData::DEFAULT_ONESIDED_GUI);
}
}
// Update page statements textviews from xData
setTextViewAndScroll(_textViewTitle, _xData->getPageContent(XData::Title, pageIndex, XData::Left));
setTextViewAndScroll(_textViewBody, _xData->getPageContent(XData::Body, pageIndex, XData::Left));
// Update the GUI View if the gui changed. For the page contents, updateGuiView is called automatically
// by onTextChange.
if (guiBefore != _guiEntry->GetValue().ToStdString())
{
updateGuiView();
}
}
void ReadableEditorDialog::updateGuiView(wxWindow* parent,
const std::string& guiPath,
const std::string& xDataName,
const std::string& xDataPath)
{
// If the name of an xData object is passed it will be rendered instead of the current
// xData object, to enable previewing of XData definitions induced by the XDataSelector.
if (!xDataName.empty())
{
XData::XDataPtr xd;
XData::XDataMap xdMap;
if (_xdLoader->importDef(xDataName, xdMap, xDataPath))
{
xd = xdMap.begin()->second;
_guiView->setGui(xd->getGuiPage(0));
}
else
{
std::string msg = fmt::format(_("Failed to import {0}."), xDataName);
msg += "\n\n";
msg += _("Do you want to open the import summary?");
wxutil::Messagebox dialog(_("Import failed"),
msg, ui::IDialog::MESSAGE_ASK, parent ? parent : this
);
if (dialog.run() == ui::IDialog::RESULT_YES)
{
showXdImportSummary();
}
return;
}
const gui::GuiPtr& gui = _guiView->getGui();
if (gui == NULL)
{
std::string msg = fmt::format(_("Failed to load gui definition {0}."), xd->getGuiPage(0));
msg += "\n\n";
msg += _("Do you want to open the import summary?");
wxutil::Messagebox dialog(_("Import failed"),
msg, ui::IDialog::MESSAGE_ASK, parent ? parent : this
);
if (dialog.run() == ui::IDialog::RESULT_YES)
{
showGuiImportSummary();
}
return;
}
// Load data from xdata into the GUI's state variables
if (xd->getPageLayout() == XData::OneSided)
{
// One-sided has title and body
gui->setStateString("title", xd->getPageContent(XData::Title, 0, XData::Left));
gui->setStateString("body", xd->getPageContent(XData::Body, 0, XData::Left));
}
else
{
// Two-sided has four important state strings
gui->setStateString("left_title", xd->getPageContent(XData::Title, 0, XData::Left));
gui->setStateString("left_body", xd->getPageContent(XData::Body, 0, XData::Left));
gui->setStateString("right_title", xd->getPageContent(XData::Title, 0, XData::Right));
gui->setStateString("right_body", xd->getPageContent(XData::Body, 0, XData::Right));
}
initGuiState(gui);
}
else
{
if (guiPath.empty())
{
_guiView->setGui(_guiEntry->GetValue().ToStdString());
}
else
{
_guiView->setGui(guiPath);
}
const gui::GuiPtr& gui = _guiView->getGui();
if (gui == NULL)
{
std::string nameGui = guiPath.empty() ? _guiEntry->GetValue().ToStdString() : guiPath;
std::string msg = fmt::format(_("Failed to load gui definition {0}."), nameGui);
msg += "\n\n";
msg += _("Do you want to open the import summary?");
wxutil::Messagebox dialog(_("Import failed"),
msg, ui::IDialog::MESSAGE_ASK, parent ? parent : this
);
if (dialog.run() == ui::IDialog::RESULT_YES)
{
showGuiImportSummary();
}
return;
}
// Load data from xdata into the GUI's state variables
if (_xData->getPageLayout() == XData::OneSided)
{
// One-sided has title and body
gui->setStateString("title", _textViewTitle->GetValue().ToStdString());
gui->setStateString("body", _textViewBody->GetValue().ToStdString());
}
else
{
// Two-sided has four important state strings
gui->setStateString("left_title", _textViewTitle->GetValue().ToStdString());
gui->setStateString("left_body", _textViewBody->GetValue().ToStdString());
gui->setStateString("right_title", _textViewRightTitle->GetValue().ToStdString());
gui->setStateString("right_body", _textViewRightBody->GetValue().ToStdString());
}
// Set common GUI state for rendering
initGuiState(gui);
}
_guiView->redraw();
}
void ReadableEditorDialog::initGuiState(const gui::GuiPtr& gui)
{
assert(gui);
// Some fancy readables have custom backgrounds depending on the page number
// This is usually done by game script at runtime, so let's fake something similar
gui->setStateString("curPage", string::to_string(_currentPageIndex + 1));
gui->setStateString("numPages", string::to_string(_numPages->GetValue()));
#if 0
// ContentsFadeIn is reponsible of setting custom backgrounds
if (gui->findWindowDef("ContentsFadeIn"))
{
gui->findWindowDef("ContentsFadeIn")->notime = false;
}
#endif
// Initialise the time of this GUI
gui->initTime(0);
// Run the first frame
gui->update(16);
}
void ReadableEditorDialog::storeCurrentPage()
{
// Store the GUI-Page
_xData->setGuiPage(_guiEntry->GetValue().ToStdString(), _currentPageIndex);
// On OneSidedXData the Side-enum is discarded, so it's save to call this method
_xData->setPageContent(XData::Title, _currentPageIndex, XData::Left, _textViewTitle->GetValue().ToStdString());
_xData->setPageContent(XData::Body, _currentPageIndex, XData::Left, _textViewBody->GetValue().ToStdString());
if (_xData->getPageLayout() == XData::TwoSided)
{
_xData->setPageContent(XData::Title, _currentPageIndex, XData::Right, _textViewRightTitle->GetValue().ToStdString());
_xData->setPageContent(XData::Body, _currentPageIndex, XData::Right, _textViewRightBody->GetValue().ToStdString());
}
}
void ReadableEditorDialog::populateControlsFromXData()
{
toggleTwoSidedEditingInterface(_xData->getPageLayout() == XData::TwoSided);
showPage(0);
_xDataNameEntry->SetValue(_xData->getName());
_numPages->SetValue(static_cast<int>(_xData->getNumPages()));
std::string sndString = _xData->getSndPageTurn();
_pageTurnEntry->SetValue(
sndString.empty() ? XData::DEFAULT_SNDPAGETURN : sndString
);
if (_xData->getPageLayout() == XData::TwoSided)
{
_twoSidedButton->SetValue(true);
}
else
{
_oneSidedButton->SetValue(true);
}
}
void ReadableEditorDialog::checkXDataUniqueness()
{
_runningXDataUniquenessCheck = true;
std::string xdn = _xDataNameEntry->GetValue().ToStdString();
if (_xData->getName() == xdn)
{
_runningXDataUniquenessCheck = false;
return;
}
_xdLoader->retrieveXdInfo();
XData::StringVectorMap::const_iterator it = _xdLoader->getDefinitionList().find(xdn);
if (it != _xdLoader->getDefinitionList().end())
{
// The definition already exists. Ask the user whether it should be imported. If not make a different name suggestion.
wxutil::Messagebox dialog(
_("Import definition?"),
fmt::format(_("The definition {0} already exists. Should it be imported?"), xdn),
ui::IDialog::MESSAGE_ASK, this
);
std::string message = "";
if (dialog.run() == ui::IDialog::RESULT_YES)
{
try
{
int result = XdFileChooserDialog::Import( xdn, _xData, _xdFilename, _xdLoader, this);
if (result == wxID_OK)
{
_xdNameSpecified = true;
_useDefaultFilename = false;
populateControlsFromXData();
_runningXDataUniquenessCheck = false;
refreshWindowTitle();
return;
}
}
catch (XdFileChooserDialog::ImportFailedException&)
{
message = _("Import failed:");
message += "\n\t" + _xdLoader->getImportSummary()[_xdLoader->getImportSummary().size() - 1];
message += "\n\n";
message += _("Consult the import summary for further information.");
message += "\n\n";
}
}
// Dialog RESULT_NO, XdFileChooserDialog::RESULT_CANCEL or import failed! Make a different name suggestion!
std::string suggestion;
for (int n = 1; n > 0; n++)
{
suggestion = xdn + string::to_string(n);
if (_xdLoader->getDefinitionList().find(suggestion) == _xdLoader->getDefinitionList().end())
{
// The suggested XData-name does not exist.
break;
}
}
// Update entry and XData object. Notify the user about the suggestion.
_xDataNameEntry->SetValue(suggestion);
_xData->setName(suggestion);
message += fmt::format(_("To avoid duplicated XData definitions "
"the current definition has been renamed to {0}."), suggestion);
wxutil::Messagebox::Show(
_("XData has been renamed."),
message, ui::IDialog::MESSAGE_CONFIRM, this
);
}
else
{
_xData->setName(xdn);
}
_xdNameSpecified = true;
_useDefaultFilename = true;
_runningXDataUniquenessCheck = false;
refreshWindowTitle();
}
void ReadableEditorDialog::insertPage()
{
storeCurrentPage();
_xData->setNumPages(_xData->getNumPages()+1);
_numPages->SetValue(static_cast<int>(_xData->getNumPages()));
handleNumberOfPagesChanged();
for (std::size_t n = _xData->getNumPages() - 1; n > _currentPageIndex; n--)
{
_xData->setGuiPage(_xData->getGuiPage(n - 1), n);
_xData->setPageContent(XData::Title, n, XData::Left,
_xData->getPageContent(XData::Title, n - 1, XData::Left)
);
_xData->setPageContent(XData::Body, n, XData::Left,
_xData->getPageContent(XData::Body, n - 1, XData::Left)
);
}
// New Page:
_xData->setPageContent(XData::Title, _currentPageIndex, XData::Left, "");
_xData->setPageContent(XData::Body, _currentPageIndex, XData::Left, "");
_xData->setGuiPage(_xData->getGuiPage(_currentPageIndex + 1), _currentPageIndex);
// Right side:
if (_xData->getPageLayout() == XData::TwoSided)
{
for (std::size_t n = _xData->getNumPages() - 1; n > _currentPageIndex; n--)
{
_xData->setGuiPage(_xData->getGuiPage(n - 1), n);
_xData->setPageContent(XData::Title, n, XData::Right,
_xData->getPageContent(XData::Title, n - 1, XData::Right)
);
_xData->setPageContent(XData::Body, n, XData::Right,
_xData->getPageContent(XData::Body, n - 1, XData::Right)
);
}
// New Page:
_xData->setPageContent(XData::Title, _currentPageIndex, XData::Right, "");
_xData->setPageContent(XData::Body, _currentPageIndex, XData::Right, "");
}
showPage(_currentPageIndex);
}
void ReadableEditorDialog::deletePage()
{
if (_currentPageIndex == _xData->getNumPages() - 1)
{
if (_currentPageIndex == 0)
{
_xData->setNumPages(0);
_xData->setNumPages(1);
showPage(0);
return;
}
_numPages->SetValue(static_cast<int>(_currentPageIndex));
handleNumberOfPagesChanged();
}
else
{
for (std::size_t n = _currentPageIndex; n < _xData->getNumPages()-1; n++)
{
_xData->setGuiPage(_xData->getGuiPage(n+1), n);
_xData->setPageContent(XData::Title, n, XData::Left,
_xData->getPageContent(XData::Title, n+1, XData::Left)
);
_xData->setPageContent(XData::Body, n, XData::Left,
_xData->getPageContent(XData::Body, n+1, XData::Left)
);
}
// Right Side
if (_xData->getPageLayout() == XData::TwoSided)
{
for (std::size_t n = _currentPageIndex; n < _xData->getNumPages()-1; n++)
{
_xData->setGuiPage(_xData->getGuiPage(n+1), n);
_xData->setPageContent(XData::Title, n, XData::Right,
_xData->getPageContent(XData::Title, n+1, XData::Right)
);
_xData->setPageContent(XData::Body, n, XData::Right,
_xData->getPageContent(XData::Body, n+1, XData::Right)
);
}