3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include "guiConfigureWorld.h"
26 #include "guiMessageMenu.h"
27 #include <IGUIButton.h>
28 #include <IGUICheckBox.h>
29 #include <IGUIListBox.h>
30 #include <IGUIStaticText.h>
31 #include <IGUITreeView.h>
33 #include "util/string.h"
39 GUI_ID_MOD_TREEVIEW = 101,
40 GUI_ID_ENABLED_CHECKBOX,
43 GUI_ID_DEPENDS_LISTBOX,
44 GUI_ID_RDEPENDS_LISTBOX,
49 #define QUESTIONMARK_STR L"?"
50 #define CHECKMARK_STR L"\411"
51 #define CROSS_STR L"\403"
53 GUIConfigureWorld::GUIConfigureWorld(gui::IGUIEnvironment* env,
54 gui::IGUIElement* parent, s32 id,
55 IMenuManager *menumgr, WorldSpec wspec):
56 GUIModalMenu(env, parent, id, menumgr),
58 m_gspec(findWorldSubgame(m_wspec.path)),
61 //will be initialized in regenerateGUI()
65 m_gamemods = flattenModTree(getModsInPath(m_gspec.gamemods_path));
68 std::string worldmods_path = wspec.path + DIR_DELIM + "worldmods";
69 m_worldmods = flattenModTree(getModsInPath(worldmods_path));
71 // fill m_addontree with add-on mods
72 std::set<std::string> paths = m_gspec.addon_mods_paths;
73 for(std::set<std::string>::iterator it=paths.begin();
74 it != paths.end(); ++it)
76 std::map<std::string,ModSpec> mods = getModsInPath(*it);
77 m_addontree.insert(mods.begin(), mods.end());
81 m_addonmods = flattenModTree(m_addontree);
83 // collect reverse dependencies
84 for(std::map<std::string, ModSpec>::iterator it = m_addonmods.begin();
85 it != m_addonmods.end(); ++it)
87 std::string modname = (*it).first;
88 ModSpec mod = (*it).second;
89 for(std::set<std::string>::iterator dep_it = mod.depends.begin();
90 dep_it != mod.depends.end(); ++dep_it)
92 m_reverse_depends.insert(std::make_pair((*dep_it),modname));
96 m_settings.readConfigFile((m_wspec.path + DIR_DELIM + "world.mt").c_str());
97 std::vector<std::string> names = m_settings.getNames();
99 // mod_names contains the names of mods mentioned in the world.mt file
100 std::set<std::string> mod_names;
101 for(std::vector<std::string>::iterator it = names.begin();
102 it != names.end(); ++it)
104 std::string name = *it;
105 if (name.compare(0,9,"load_mod_")==0)
106 mod_names.insert(name.substr(9));
109 // find new mods (installed but not mentioned in world.mt)
110 for(std::map<std::string, ModSpec>::iterator it = m_addonmods.begin();
111 it != m_addonmods.end(); ++it)
113 std::string modname = (*it).first;
114 ModSpec mod = (*it).second;
115 // a mod is new if it is not a modpack, and does not occur in
117 if(!mod.is_modpack &&
118 mod_names.count(modname) == 0)
119 m_settings.setBool("load_mod_"+modname, false);
121 // find missing mods (mentioned in world.mt, but not installed)
122 for(std::set<std::string>::iterator it = mod_names.begin();
123 it != mod_names.end(); ++it)
125 std::string modname = *it;
126 if(m_addonmods.count(modname) == 0)
127 m_settings.remove("load_mod_"+modname);
129 std::string worldmtfile = m_wspec.path+DIR_DELIM+"world.mt";
130 m_settings.updateConfigFile(worldmtfile.c_str());
133 void GUIConfigureWorld::drawMenu()
135 gui::IGUISkin* skin = Environment->getSkin();
138 video::IVideoDriver* driver = Environment->getVideoDriver();
140 video::SColor bgcolor(140,0,0,0);
141 driver->draw2DRectangle(bgcolor, AbsoluteRect, &AbsoluteClippingRect);
143 gui::IGUIElement::draw();
147 void GUIConfigureWorld::regenerateGui(v2u32 screensize)
156 Calculate new sizes and positions
158 core::rect<s32> rect(
159 screensize.X/2 - 580/2,
160 screensize.Y/2 - 300/2,
161 screensize.X/2 + 580/2,
162 screensize.Y/2 + 300/2
166 recalculateAbsolutePosition(false);
168 v2s32 topleft = v2s32(10, 10);
175 core::rect<s32> rect(0, 0, 200, 20);
177 //proper text is set below, when a mod is selected
178 m_modname_text = Environment->addStaticText(L"Mod: N/A", rect, false,
182 core::rect<s32> rect(0, 0, 200, 20);
183 rect += v2s32(0, 25) + topleft;
184 wchar_t* text = wgettext("enabled");
186 Environment->addCheckBox(false, rect, this, GUI_ID_ENABLED_CHECKBOX,
189 m_enabled_checkbox->setVisible(false);
192 core::rect<s32> rect(0, 0, 85, 30);
193 rect = rect + v2s32(0, 25) + topleft;
194 wchar_t* text = wgettext("Enable All");
195 m_enableall = Environment->addButton(rect, this, GUI_ID_ENABLEALL,
198 m_enableall->setVisible(false);
201 core::rect<s32> rect(0, 0, 85, 30);
202 rect = rect + v2s32(115, 25) + topleft;
203 wchar_t* text = wgettext("Disable All");
204 m_disableall = Environment->addButton(rect, this, GUI_ID_DISABLEALL, text );
206 m_disableall->setVisible(false);
209 core::rect<s32> rect(0, 0, 200, 20);
210 rect += v2s32(0, 60) + topleft;
211 wchar_t* text = wgettext("depends on:");
212 Environment->addStaticText(text, rect, false, false, this, -1);
216 core::rect<s32> rect(0, 0, 200, 85);
217 rect += v2s32(0, 80) + topleft;
218 m_dependencies_listbox =
219 Environment->addListBox(rect, this, GUI_ID_DEPENDS_LISTBOX, true);
222 core::rect<s32> rect(0, 0, 200, 20);
223 rect += v2s32(0, 175) + topleft;
224 wchar_t* text = wgettext("is required by:");
225 Environment->addStaticText( text, rect, false, false, this, -1);
229 core::rect<s32> rect(0, 0, 200, 85);
230 rect += v2s32(0, 195) + topleft;
231 m_rdependencies_listbox =
232 Environment->addListBox(rect,this, GUI_ID_RDEPENDS_LISTBOX,true);
235 core::rect<s32> rect(0, 0, 340, 250);
236 rect += v2s32(220, 0) + topleft;
237 m_treeview = Environment->addTreeView(rect, this,
238 GUI_ID_MOD_TREEVIEW,true);
239 gui::IGUITreeViewNode* node
240 = m_treeview->getRoot()->addChildBack(L"Add-Ons");
241 buildTreeView(m_addontree, node);
244 core::rect<s32> rect(0, 0, 120, 30);
245 rect = rect + v2s32(330, 270) - topleft;
246 wchar_t* text = wgettext("Cancel");
247 Environment->addButton(rect, this, GUI_ID_CANCEL, text);
251 core::rect<s32> rect(0, 0, 120, 30);
252 rect = rect + v2s32(460, 270) - topleft;
253 wchar_t* text = wgettext("Save");
254 Environment->addButton(rect, this, GUI_ID_SAVE, text);
259 // at start, none of the treeview nodes is selected, so we select
260 // the first element in the treeview of mods manually here.
261 if(m_treeview->getRoot()->hasChilds())
263 m_treeview->getRoot()->getFirstChild()->setExpanded(true);
264 m_treeview->getRoot()->getFirstChild()->setSelected(true);
265 // Because a manual ->setSelected() doesn't cause an event, we
266 // have to do this here:
271 bool GUIConfigureWorld::OnEvent(const SEvent& event)
274 gui::IGUITreeViewNode* selected_node = NULL;
275 if(m_treeview != NULL)
276 selected_node = m_treeview->getSelected();
278 if(event.EventType==EET_KEY_INPUT_EVENT && event.KeyInput.PressedDown)
280 switch (event.KeyInput.Key) {
285 // irrlicht's built-in TreeView gui has no keyboard control,
286 // so we do it here: up/down to select prev/next node,
287 // left/right to collapse/expand nodes, space to toggle
290 if(selected_node != NULL)
292 gui::IGUITreeViewNode* node = selected_node->getNextVisible();
295 node->setSelected(true);
302 if(selected_node != NULL)
304 gui::IGUITreeViewNode* node = selected_node->getPrevSibling();
307 node->setSelected(true);
312 gui::IGUITreeViewNode* parent = selected_node->getParent();
313 if(selected_node == parent->getFirstChild() &&
314 parent != m_treeview->getRoot())
316 parent->setSelected(true);
324 if(selected_node != NULL && selected_node->hasChilds())
325 selected_node->setExpanded(true);
329 if(selected_node != NULL && selected_node->hasChilds())
330 selected_node->setExpanded(false);
334 if(selected_node != NULL && !selected_node->hasChilds() &&
335 selected_node->getText() != NULL)
337 std::string modname = wide_to_narrow(selected_node->getText());
338 bool checked = m_enabled_checkbox->isChecked();
339 m_enabled_checkbox->setChecked(!checked);
340 setEnabled(modname,!checked);
347 if(event.EventType==EET_GUI_EVENT)
349 if(event.GUIEvent.EventType==gui::EGET_ELEMENT_FOCUS_LOST
352 if(!canTakeFocus(event.GUIEvent.Element))
354 dstream<<"GUIConfigureWorld: Not allowing focus change."
356 // Returning true disables focus change
360 if(event.GUIEvent.EventType==gui::EGET_BUTTON_CLICKED){
361 switch(event.GUIEvent.Caller->getID()){
362 case GUI_ID_CANCEL: {
367 std::string worldmtfile = m_wspec.path+DIR_DELIM+"world.mt";
368 m_settings.updateConfigFile(worldmtfile.c_str());
370 // The trailing spaces are because there seems to be a
371 // bug in the text-size calculation. if the trailing
372 // spaces are removed from the message text, the
373 // message gets wrapped and parts of it are cut off:
374 wchar_t* text = wgettext("Configuration saved. ");
375 GUIMessageMenu *menu =
376 new GUIMessageMenu(Environment, Parent, -1, m_menumgr,
383 ModConfiguration modconf(m_wspec.path);
384 if(!modconf.isConsistent())
386 wchar_t* text = wgettext("Warning: Configuration not consistent. ");
387 GUIMessageMenu *menu =
388 new GUIMessageMenu(Environment, Parent, -1, m_menumgr,
396 errorstream<<err.what()<<std::endl;
397 std::wstring text = narrow_to_wide(err.what()) + wgettext("\nCheck debug.txt for details.");
398 GUIMessageMenu *menu =
399 new GUIMessageMenu(Environment, Parent, -1, m_menumgr,
407 case GUI_ID_ENABLEALL: {
408 if(selected_node != NULL && selected_node->getParent() == m_treeview->getRoot())
410 enableAllMods(m_addonmods,true);
412 else if(selected_node != NULL && selected_node->getText() != NULL)
414 std::string modname = wide_to_narrow(selected_node->getText());
415 std::map<std::string, ModSpec>::iterator mod_it = m_addonmods.find(modname);
416 if(mod_it != m_addonmods.end())
417 enableAllMods(mod_it->second.modpack_content,true);
421 case GUI_ID_DISABLEALL: {
422 if(selected_node != NULL && selected_node->getParent() == m_treeview->getRoot())
424 enableAllMods(m_addonmods,false);
426 if(selected_node != NULL && selected_node->getText() != NULL)
428 std::string modname = wide_to_narrow(selected_node->getText());
429 std::map<std::string, ModSpec>::iterator mod_it = m_addonmods.find(modname);
430 if(mod_it != m_addonmods.end())
431 enableAllMods(mod_it->second.modpack_content,false);
437 if(event.GUIEvent.EventType==gui::EGET_CHECKBOX_CHANGED &&
438 event.GUIEvent.Caller->getID() == GUI_ID_ENABLED_CHECKBOX)
440 if(selected_node != NULL && !selected_node->hasChilds() &&
441 selected_node->getText() != NULL)
443 std::string modname = wide_to_narrow(selected_node->getText());
444 setEnabled(modname, m_enabled_checkbox->isChecked());
448 if(event.GUIEvent.EventType==gui::EGET_TREEVIEW_NODE_SELECT &&
449 event.GUIEvent.Caller->getID() == GUI_ID_MOD_TREEVIEW)
456 if(event.GUIEvent.EventType==gui::EGET_LISTBOX_CHANGED &&
457 event.GUIEvent.Caller->getID() == GUI_ID_DEPENDS_LISTBOX)
459 selecting_dep = m_dependencies_listbox->getSelected();
463 if(event.GUIEvent.EventType==gui::EGET_LISTBOX_CHANGED &&
464 event.GUIEvent.Caller->getID() == GUI_ID_RDEPENDS_LISTBOX)
467 selecting_rdep = m_rdependencies_listbox->getSelected();
471 //double click in a dependency listbox: find corresponding
472 //treeviewnode and select it:
473 if(event.GUIEvent.EventType==gui::EGET_LISTBOX_SELECTED_AGAIN)
475 gui::IGUIListBox* box = NULL;
476 if(event.GUIEvent.Caller->getID() == GUI_ID_DEPENDS_LISTBOX)
478 box = m_dependencies_listbox;
479 if(box->getSelected() != selecting_dep)
482 if(event.GUIEvent.Caller->getID() == GUI_ID_RDEPENDS_LISTBOX)
484 box = m_rdependencies_listbox;
485 if(box->getSelected() != selecting_rdep)
488 if(box != NULL && box->getSelected() != -1 &&
489 box->getListItem(box->getSelected()) != NULL)
491 std::string modname =
492 wide_to_narrow(box->getListItem(box->getSelected()));
493 std::map<std::string, gui::IGUITreeViewNode*>::iterator it =
494 m_nodes.find(modname);
495 if(it != m_nodes.end())
497 // select node and make sure node is visible by
498 // expanding all parents
499 gui::IGUITreeViewNode* node = (*it).second;
500 node->setSelected(true);
501 while(!node->isVisible() &&
502 node->getParent() != m_treeview->getRoot())
504 node = node->getParent();
505 node->setExpanded(true);
514 return Parent ? Parent->OnEvent(event) : false;
517 void GUIConfigureWorld::buildTreeView(std::map<std::string, ModSpec> mods,
518 gui::IGUITreeViewNode* node)
520 for(std::map<std::string,ModSpec>::iterator it = mods.begin();
521 it != mods.end(); ++it)
523 std::string modname = (*it).first;
524 ModSpec mod = (*it).second;
525 gui::IGUITreeViewNode* new_node =
526 node->addChildBack(narrow_to_wide(modname).c_str());
527 m_nodes.insert(std::make_pair(modname, new_node));
529 buildTreeView(mod.modpack_content, new_node);
532 // set icon for node: x for disabled mods, checkmark for enabled mods
533 bool mod_enabled = false;
534 if(m_settings.exists("load_mod_"+modname))
535 mod_enabled = m_settings.getBool("load_mod_"+modname);
537 new_node->setIcon(CHECKMARK_STR);
539 new_node->setIcon(CROSS_STR);
545 void GUIConfigureWorld::adjustSidebar()
547 gui::IGUITreeViewNode* node = m_treeview->getSelected();
548 std::wstring modname_w;
549 if(node->getText() != NULL)
550 modname_w = node->getText();
553 std::string modname = wide_to_narrow(modname_w);
556 std::map<std::string, ModSpec>::iterator it = m_addonmods.find(modname);
557 if(it != m_addonmods.end())
560 m_dependencies_listbox->clear();
561 m_rdependencies_listbox->clear();
563 // if no mods installed, there is nothing to enable/disable, so we
564 // don't show buttons or checkbox on the sidebar
565 if(node->getParent() == m_treeview->getRoot() && !node->hasChilds())
567 m_disableall->setVisible(false);
568 m_enableall->setVisible(false);
569 m_enabled_checkbox->setVisible(false);
573 // a modpack is not enabled/disabled by itself, only its cotnents
574 // are. so we show show enable/disable all buttons, but hide the
576 if(node->getParent() == m_treeview->getRoot() ||
579 m_enabled_checkbox->setVisible(false);
580 m_disableall->setVisible(true);
581 m_enableall->setVisible(true);
582 m_modname_text->setText((L"Modpack: "+modname_w).c_str());
586 // for a normal mod, we hide the enable/disable all buttons, but show the checkbox.
587 m_disableall->setVisible(false);
588 m_enableall->setVisible(false);
589 m_enabled_checkbox->setVisible(true);
590 m_modname_text->setText((L"Mod: "+modname_w).c_str());
592 // the mod is enabled unless it is disabled in the world.mt settings.
593 bool mod_enabled = true;
594 if(m_settings.exists("load_mod_"+modname))
595 mod_enabled = m_settings.getBool("load_mod_"+modname);
596 m_enabled_checkbox->setChecked(mod_enabled);
598 for(std::set<std::string>::iterator it=mspec.depends.begin();
599 it != mspec.depends.end(); ++it)
601 // check if it is an add-on mod or a game/world mod. We only
602 // want to show add-ons
603 std::string dependency = (*it);
604 if(m_gamemods.count(dependency) > 0)
605 dependency += " (" + m_gspec.id + ")";
606 else if(m_worldmods.count(dependency) > 0)
607 dependency += " (" + m_wspec.name + ")";
608 else if(m_addonmods.count(dependency) == 0)
609 dependency += " (missing)";
610 m_dependencies_listbox->addItem(narrow_to_wide(dependency).c_str());
613 // reverse dependencies of this mod:
614 std::pair< std::multimap<std::string, std::string>::iterator,
615 std::multimap<std::string, std::string>::iterator > rdep =
616 m_reverse_depends.equal_range(modname);
617 for(std::multimap<std::string,std::string>::iterator it = rdep.first;
618 it != rdep.second; ++it)
620 // check if it is an add-on mod or a game/world mod. We only
621 // want to show add-ons
622 std::string rdependency = (*it).second;
623 if(m_addonmods.count(rdependency) > 0)
624 m_rdependencies_listbox->addItem(narrow_to_wide(rdependency).c_str());
628 void GUIConfigureWorld::enableAllMods(std::map<std::string, ModSpec> mods,bool enable)
630 for(std::map<std::string, ModSpec>::iterator it = mods.begin();
631 it != mods.end(); ++it)
633 ModSpec mod = (*it).second;
635 // a modpack, recursively enable all mods in it
636 enableAllMods(mod.modpack_content,enable);
637 else // not a modpack
638 setEnabled(mod.name, enable);
643 void GUIConfigureWorld::enableMod(std::string modname)
645 std::map<std::string, ModSpec>::iterator mod_it = m_addonmods.find(modname);
646 if(mod_it == m_addonmods.end()){
647 errorstream << "enableMod() called with invalid mod name \"" << modname << "\"" << std::endl;
650 ModSpec mspec = mod_it->second;
651 m_settings.setBool("load_mod_"+modname,true);
652 std::map<std::string,gui::IGUITreeViewNode*>::iterator it =
653 m_nodes.find(modname);
654 if(it != m_nodes.end())
655 (*it).second->setIcon(CHECKMARK_STR);
656 //also enable all dependencies
657 for(std::set<std::string>::iterator it=mspec.depends.begin();
658 it != mspec.depends.end(); ++it)
660 std::string dependency = *it;
661 // only enable it if it is an add-on mod
662 if(m_addonmods.count(dependency) > 0)
663 enableMod(dependency);
667 void GUIConfigureWorld::disableMod(std::string modname)
669 std::map<std::string, ModSpec>::iterator mod_it = m_addonmods.find(modname);
670 if(mod_it == m_addonmods.end()){
671 errorstream << "disableMod() called with invalid mod name \"" << modname << "\"" << std::endl;
675 m_settings.setBool("load_mod_"+modname,false);
676 std::map<std::string,gui::IGUITreeViewNode*>::iterator it =
677 m_nodes.find(modname);
678 if(it != m_nodes.end())
679 (*it).second->setIcon(CROSS_STR);
680 //also disable all mods that depend on this one
681 std::pair<std::multimap<std::string, std::string>::iterator,
682 std::multimap<std::string, std::string>::iterator > rdep =
683 m_reverse_depends.equal_range(modname);
684 for(std::multimap<std::string,std::string>::iterator it = rdep.first;
685 it != rdep.second; ++it)
687 std::string rdependency = (*it).second;
688 // only disable it if it is an add-on mod
689 if(m_addonmods.count(rdependency) > 0)
690 disableMod(rdependency);