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 size = rect.getSize();
170 v2s32 topleft = v2s32(10, 10);
177 core::rect<s32> rect(0, 0, 200, 20);
179 //proper text is set below, when a mod is selected
180 m_modname_text = Environment->addStaticText(L"Mod: N/A", rect, false,
184 core::rect<s32> rect(0, 0, 200, 20);
185 rect += v2s32(0, 25) + topleft;
186 wchar_t* text = wgettext("enabled");
188 Environment->addCheckBox(false, rect, this, GUI_ID_ENABLED_CHECKBOX,
191 m_enabled_checkbox->setVisible(false);
194 core::rect<s32> rect(0, 0, 85, 30);
195 rect = rect + v2s32(0, 25) + topleft;
196 wchar_t* text = wgettext("Enable All");
197 m_enableall = Environment->addButton(rect, this, GUI_ID_ENABLEALL,
200 m_enableall->setVisible(false);
203 core::rect<s32> rect(0, 0, 85, 30);
204 rect = rect + v2s32(115, 25) + topleft;
205 wchar_t* text = wgettext("Disable All");
206 m_disableall = Environment->addButton(rect, this, GUI_ID_DISABLEALL, text );
208 m_disableall->setVisible(false);
211 core::rect<s32> rect(0, 0, 200, 20);
212 rect += v2s32(0, 60) + topleft;
213 wchar_t* text = wgettext("depends on:");
214 Environment->addStaticText(text, rect, false, false, this, -1);
218 core::rect<s32> rect(0, 0, 200, 85);
219 rect += v2s32(0, 80) + topleft;
220 m_dependencies_listbox =
221 Environment->addListBox(rect, this, GUI_ID_DEPENDS_LISTBOX, true);
224 core::rect<s32> rect(0, 0, 200, 20);
225 rect += v2s32(0, 175) + topleft;
226 wchar_t* text = wgettext("is required by:");
227 Environment->addStaticText( text, rect, false, false, this, -1);
231 core::rect<s32> rect(0, 0, 200, 85);
232 rect += v2s32(0, 195) + topleft;
233 m_rdependencies_listbox =
234 Environment->addListBox(rect,this, GUI_ID_RDEPENDS_LISTBOX,true);
237 core::rect<s32> rect(0, 0, 340, 250);
238 rect += v2s32(220, 0) + topleft;
239 m_treeview = Environment->addTreeView(rect, this,
240 GUI_ID_MOD_TREEVIEW,true);
241 gui::IGUITreeViewNode* node
242 = m_treeview->getRoot()->addChildBack(L"Add-Ons");
243 buildTreeView(m_addontree, node);
246 core::rect<s32> rect(0, 0, 120, 30);
247 rect = rect + v2s32(330, 270) - topleft;
248 wchar_t* text = wgettext("Cancel");
249 Environment->addButton(rect, this, GUI_ID_CANCEL, text);
253 core::rect<s32> rect(0, 0, 120, 30);
254 rect = rect + v2s32(460, 270) - topleft;
255 wchar_t* text = wgettext("Save");
256 Environment->addButton(rect, this, GUI_ID_SAVE, text);
261 // at start, none of the treeview nodes is selected, so we select
262 // the first element in the treeview of mods manually here.
263 if(m_treeview->getRoot()->hasChilds())
265 m_treeview->getRoot()->getFirstChild()->setExpanded(true);
266 m_treeview->getRoot()->getFirstChild()->setSelected(true);
267 // Because a manual ->setSelected() doesn't cause an event, we
268 // have to do this here:
273 bool GUIConfigureWorld::OnEvent(const SEvent& event)
276 gui::IGUITreeViewNode* selected_node = NULL;
277 if(m_treeview != NULL)
278 selected_node = m_treeview->getSelected();
280 if(event.EventType==EET_KEY_INPUT_EVENT && event.KeyInput.PressedDown)
282 switch (event.KeyInput.Key) {
287 // irrlicht's built-in TreeView gui has no keyboard control,
288 // so we do it here: up/down to select prev/next node,
289 // left/right to collapse/expand nodes, space to toggle
292 if(selected_node != NULL)
294 gui::IGUITreeViewNode* node = selected_node->getNextVisible();
297 node->setSelected(true);
304 if(selected_node != NULL)
306 gui::IGUITreeViewNode* node = selected_node->getPrevSibling();
309 node->setSelected(true);
314 gui::IGUITreeViewNode* parent = selected_node->getParent();
315 if(selected_node == parent->getFirstChild() &&
316 parent != m_treeview->getRoot())
318 parent->setSelected(true);
326 if(selected_node != NULL && selected_node->hasChilds())
327 selected_node->setExpanded(true);
331 if(selected_node != NULL && selected_node->hasChilds())
332 selected_node->setExpanded(false);
336 if(selected_node != NULL && !selected_node->hasChilds() &&
337 selected_node->getText() != NULL)
339 std::string modname = wide_to_narrow(selected_node->getText());
340 bool checked = m_enabled_checkbox->isChecked();
341 m_enabled_checkbox->setChecked(!checked);
342 setEnabled(modname,!checked);
349 if(event.EventType==EET_GUI_EVENT)
351 if(event.GUIEvent.EventType==gui::EGET_ELEMENT_FOCUS_LOST
354 if(!canTakeFocus(event.GUIEvent.Element))
356 dstream<<"GUIConfigureWorld: Not allowing focus change."
358 // Returning true disables focus change
362 if(event.GUIEvent.EventType==gui::EGET_BUTTON_CLICKED){
363 switch(event.GUIEvent.Caller->getID()){
364 case GUI_ID_CANCEL: {
369 std::string worldmtfile = m_wspec.path+DIR_DELIM+"world.mt";
370 m_settings.updateConfigFile(worldmtfile.c_str());
372 // The trailing spaces are because there seems to be a
373 // bug in the text-size calculation. if the trailing
374 // spaces are removed from the message text, the
375 // message gets wrapped and parts of it are cut off:
376 wchar_t* text = wgettext("Configuration saved. ");
377 GUIMessageMenu *menu =
378 new GUIMessageMenu(Environment, Parent, -1, m_menumgr,
385 ModConfiguration modconf(m_wspec.path);
386 if(!modconf.isConsistent())
388 wchar_t* text = wgettext("Warning: Configuration not consistent. ");
389 GUIMessageMenu *menu =
390 new GUIMessageMenu(Environment, Parent, -1, m_menumgr,
398 errorstream<<err.what()<<std::endl;
399 std::wstring text = narrow_to_wide(err.what()) + wgettext("\nCheck debug.txt for details.");
400 GUIMessageMenu *menu =
401 new GUIMessageMenu(Environment, Parent, -1, m_menumgr,
409 case GUI_ID_ENABLEALL: {
410 if(selected_node != NULL && selected_node->getParent() == m_treeview->getRoot())
412 enableAllMods(m_addonmods,true);
414 else if(selected_node != NULL && selected_node->getText() != NULL)
416 std::string modname = wide_to_narrow(selected_node->getText());
417 std::map<std::string, ModSpec>::iterator mod_it = m_addonmods.find(modname);
418 if(mod_it != m_addonmods.end())
419 enableAllMods(mod_it->second.modpack_content,true);
423 case GUI_ID_DISABLEALL: {
424 if(selected_node != NULL && selected_node->getParent() == m_treeview->getRoot())
426 enableAllMods(m_addonmods,false);
428 if(selected_node != NULL && selected_node->getText() != NULL)
430 std::string modname = wide_to_narrow(selected_node->getText());
431 std::map<std::string, ModSpec>::iterator mod_it = m_addonmods.find(modname);
432 if(mod_it != m_addonmods.end())
433 enableAllMods(mod_it->second.modpack_content,false);
439 if(event.GUIEvent.EventType==gui::EGET_CHECKBOX_CHANGED &&
440 event.GUIEvent.Caller->getID() == GUI_ID_ENABLED_CHECKBOX)
442 if(selected_node != NULL && !selected_node->hasChilds() &&
443 selected_node->getText() != NULL)
445 std::string modname = wide_to_narrow(selected_node->getText());
446 setEnabled(modname, m_enabled_checkbox->isChecked());
450 if(event.GUIEvent.EventType==gui::EGET_TREEVIEW_NODE_SELECT &&
451 event.GUIEvent.Caller->getID() == GUI_ID_MOD_TREEVIEW)
458 if(event.GUIEvent.EventType==gui::EGET_LISTBOX_CHANGED &&
459 event.GUIEvent.Caller->getID() == GUI_ID_DEPENDS_LISTBOX)
461 selecting_dep = m_dependencies_listbox->getSelected();
465 if(event.GUIEvent.EventType==gui::EGET_LISTBOX_CHANGED &&
466 event.GUIEvent.Caller->getID() == GUI_ID_RDEPENDS_LISTBOX)
469 selecting_rdep = m_rdependencies_listbox->getSelected();
473 //double click in a dependency listbox: find corresponding
474 //treeviewnode and select it:
475 if(event.GUIEvent.EventType==gui::EGET_LISTBOX_SELECTED_AGAIN)
477 gui::IGUIListBox* box = NULL;
478 if(event.GUIEvent.Caller->getID() == GUI_ID_DEPENDS_LISTBOX)
480 box = m_dependencies_listbox;
481 if(box->getSelected() != selecting_dep)
484 if(event.GUIEvent.Caller->getID() == GUI_ID_RDEPENDS_LISTBOX)
486 box = m_rdependencies_listbox;
487 if(box->getSelected() != selecting_rdep)
490 if(box != NULL && box->getSelected() != -1 &&
491 box->getListItem(box->getSelected()) != NULL)
493 std::string modname =
494 wide_to_narrow(box->getListItem(box->getSelected()));
495 std::map<std::string, gui::IGUITreeViewNode*>::iterator it =
496 m_nodes.find(modname);
497 if(it != m_nodes.end())
499 // select node and make sure node is visible by
500 // expanding all parents
501 gui::IGUITreeViewNode* node = (*it).second;
502 node->setSelected(true);
503 while(!node->isVisible() &&
504 node->getParent() != m_treeview->getRoot())
506 node = node->getParent();
507 node->setExpanded(true);
516 return Parent ? Parent->OnEvent(event) : false;
519 void GUIConfigureWorld::buildTreeView(std::map<std::string, ModSpec> mods,
520 gui::IGUITreeViewNode* node)
522 for(std::map<std::string,ModSpec>::iterator it = mods.begin();
523 it != mods.end(); ++it)
525 std::string modname = (*it).first;
526 ModSpec mod = (*it).second;
527 gui::IGUITreeViewNode* new_node =
528 node->addChildBack(narrow_to_wide(modname).c_str());
529 m_nodes.insert(std::make_pair(modname, new_node));
531 buildTreeView(mod.modpack_content, new_node);
534 // set icon for node: x for disabled mods, checkmark for enabled mods
535 bool mod_enabled = false;
536 if(m_settings.exists("load_mod_"+modname))
537 mod_enabled = m_settings.getBool("load_mod_"+modname);
539 new_node->setIcon(CHECKMARK_STR);
541 new_node->setIcon(CROSS_STR);
547 void GUIConfigureWorld::adjustSidebar()
549 gui::IGUITreeViewNode* node = m_treeview->getSelected();
550 std::wstring modname_w;
551 if(node->getText() != NULL)
552 modname_w = node->getText();
555 std::string modname = wide_to_narrow(modname_w);
558 std::map<std::string, ModSpec>::iterator it = m_addonmods.find(modname);
559 if(it != m_addonmods.end())
562 m_dependencies_listbox->clear();
563 m_rdependencies_listbox->clear();
565 // if no mods installed, there is nothing to enable/disable, so we
566 // don't show buttons or checkbox on the sidebar
567 if(node->getParent() == m_treeview->getRoot() && !node->hasChilds())
569 m_disableall->setVisible(false);
570 m_enableall->setVisible(false);
571 m_enabled_checkbox->setVisible(false);
575 // a modpack is not enabled/disabled by itself, only its cotnents
576 // are. so we show show enable/disable all buttons, but hide the
578 if(node->getParent() == m_treeview->getRoot() ||
581 m_enabled_checkbox->setVisible(false);
582 m_disableall->setVisible(true);
583 m_enableall->setVisible(true);
584 m_modname_text->setText((L"Modpack: "+modname_w).c_str());
588 // for a normal mod, we hide the enable/disable all buttons, but show the checkbox.
589 m_disableall->setVisible(false);
590 m_enableall->setVisible(false);
591 m_enabled_checkbox->setVisible(true);
592 m_modname_text->setText((L"Mod: "+modname_w).c_str());
594 // the mod is enabled unless it is disabled in the world.mt settings.
595 bool mod_enabled = true;
596 if(m_settings.exists("load_mod_"+modname))
597 mod_enabled = m_settings.getBool("load_mod_"+modname);
598 m_enabled_checkbox->setChecked(mod_enabled);
600 for(std::set<std::string>::iterator it=mspec.depends.begin();
601 it != mspec.depends.end(); ++it)
603 // check if it is an add-on mod or a game/world mod. We only
604 // want to show add-ons
605 std::string dependency = (*it);
606 if(m_gamemods.count(dependency) > 0)
607 dependency += " (" + m_gspec.id + ")";
608 else if(m_worldmods.count(dependency) > 0)
609 dependency += " (" + m_wspec.name + ")";
610 else if(m_addonmods.count(dependency) == 0)
611 dependency += " (missing)";
612 m_dependencies_listbox->addItem(narrow_to_wide(dependency).c_str());
615 // reverse dependencies of this mod:
616 std::pair< std::multimap<std::string, std::string>::iterator,
617 std::multimap<std::string, std::string>::iterator > rdep =
618 m_reverse_depends.equal_range(modname);
619 for(std::multimap<std::string,std::string>::iterator it = rdep.first;
620 it != rdep.second; ++it)
622 // check if it is an add-on mod or a game/world mod. We only
623 // want to show add-ons
624 std::string rdependency = (*it).second;
625 if(m_addonmods.count(rdependency) > 0)
626 m_rdependencies_listbox->addItem(narrow_to_wide(rdependency).c_str());
630 void GUIConfigureWorld::enableAllMods(std::map<std::string, ModSpec> mods,bool enable)
632 for(std::map<std::string, ModSpec>::iterator it = mods.begin();
633 it != mods.end(); ++it)
635 ModSpec mod = (*it).second;
637 // a modpack, recursively enable all mods in it
638 enableAllMods(mod.modpack_content,enable);
639 else // not a modpack
640 setEnabled(mod.name, enable);
645 void GUIConfigureWorld::enableMod(std::string modname)
647 std::map<std::string, ModSpec>::iterator mod_it = m_addonmods.find(modname);
648 if(mod_it == m_addonmods.end()){
649 errorstream << "enableMod() called with invalid mod name \"" << modname << "\"" << std::endl;
652 ModSpec mspec = mod_it->second;
653 m_settings.setBool("load_mod_"+modname,true);
654 std::map<std::string,gui::IGUITreeViewNode*>::iterator it =
655 m_nodes.find(modname);
656 if(it != m_nodes.end())
657 (*it).second->setIcon(CHECKMARK_STR);
658 //also enable all dependencies
659 for(std::set<std::string>::iterator it=mspec.depends.begin();
660 it != mspec.depends.end(); ++it)
662 std::string dependency = *it;
663 // only enable it if it is an add-on mod
664 if(m_addonmods.count(dependency) > 0)
665 enableMod(dependency);
669 void GUIConfigureWorld::disableMod(std::string modname)
671 std::map<std::string, ModSpec>::iterator mod_it = m_addonmods.find(modname);
672 if(mod_it == m_addonmods.end()){
673 errorstream << "disableMod() called with invalid mod name \"" << modname << "\"" << std::endl;
677 m_settings.setBool("load_mod_"+modname,false);
678 std::map<std::string,gui::IGUITreeViewNode*>::iterator it =
679 m_nodes.find(modname);
680 if(it != m_nodes.end())
681 (*it).second->setIcon(CROSS_STR);
682 //also disable all mods that depend on this one
683 std::pair<std::multimap<std::string, std::string>::iterator,
684 std::multimap<std::string, std::string>::iterator > rdep =
685 m_reverse_depends.equal_range(modname);
686 for(std::multimap<std::string,std::string>::iterator it = rdep.first;
687 it != rdep.second; ++it)
689 std::string rdependency = (*it).second;
690 // only disable it if it is an add-on mod
691 if(m_addonmods.count(rdependency) > 0)
692 disableMod(rdependency);