The Battle for Wesnoth  1.15.0-dev
context_manager.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2003 - 2018 by David White <dave@whitevine.net>
3  Part of the Battle for Wesnoth Project http://www.wesnoth.org/
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY.
11 
12  See the COPYING file for more details.
13 */
14 #define GETTEXT_DOMAIN "wesnoth-editor"
15 
16 #include "resources.hpp"
17 #include "team.hpp"
18 
19 #include "display.hpp"
22 #include "filesystem.hpp"
23 #include "formula/string_utils.hpp"
26 #include "gettext.hpp"
27 
28 #include "editor/action/action.hpp"
30 #include "preferences/editor.hpp"
31 
37 #include "gui/dialogs/message.hpp"
39 #include "gui/widgets/retval.hpp"
40 
43 
44 #include "terrain/translation.hpp"
45 
46 #include <memory>
47 
48 namespace editor {
49 
50 static std::vector<std::string> saved_windows_;
51 
52 static const std::string get_menu_marker(const bool changed)
53 {
54  std::ostringstream ss;
55  ss << "[<span ";
56 
57  if(changed) {
58  ss << "color='#f00' ";
59  }
60 
61  ss << "size='large'>" << font::unicode_bullet << "</span>]";
62  return ss.str();
63 }
64 
66  : locs_(nullptr)
67  , gui_(gui)
68  , game_config_(game_config)
69  , default_dir_(preferences::editor::default_dir())
70  , map_generators_()
71  , last_map_generator_(nullptr)
72  , current_context_index_(0)
73  , auto_update_transitions_(preferences::editor::auto_update_transitions())
74  , map_contexts_()
75  , clipboard_()
76 {
77  resources::filter_con = this;
78 
79  if(default_dir_.empty()) {
81  }
82 
84  init_map_generators(game_config);
85 }
86 
88 {
89  // Restore default window title
91 
92  resources::filter_con = nullptr;
93 }
94 
96 {
98 
99  // TODO register the tod_manager with the gui?
102 
103  gui().init_flags();
104 
105  reload_map();
106 
107  // Enable the labels of the current context;
109 
111 }
112 
114 {
115  gui_.rebuild_all();
119  if(locs_) {
120  for(const auto& loc : get_map_context().map().special_locations().left) {
121  locs_->add_item(loc.first);
122  }
123  if(!get_map_context().is_pure_map()) {
124  // If the scenario has more than 9 teams, add locations for them
125  // (First 9 teams are always in the list)
126  size_t n_teams = get_map_context().teams().size();
127  for(size_t i = 10; i <= n_teams; i++) {
128  locs_->add_item(std::to_string(i));
129  }
130  }
131  }
132 }
133 
135 {
136  gui_.reload_map();
139  refresh_all();
140 }
141 
143 {
144  switch (auto_update_transitions_) {
146  return (item == "editor-auto-update-transitions");
148  return (item == "editor-partial-update-transitions");
150  return (item == "editor-no-update-transitions");
151  }
152 
153  return true; //should not be reached
154 }
155 
157 {
160 
162  return true;
163  }
164 
165  return false;
166 }
167 
168 std::size_t context_manager::modified_maps(std::string& message)
169 {
170  std::vector<std::string> modified;
171  for(auto& mc : map_contexts_) {
172  if(mc->modified()) {
173  if(!mc->get_name().empty()) {
174  modified.push_back(mc->get_name());
175  } else if(!mc->get_filename().empty()) {
176  modified.push_back(mc->get_filename());
177  } else {
178  modified.push_back(mc->get_default_context_name());
179  }
180  }
181  }
182 
183  for(std::string& str : modified) {
184  message += "\n" + font::unicode_bullet + " " + str;
185  }
186 
187  return modified.size();
188 }
189 
190 void context_manager::load_map_dialog(bool force_same_context /* = false */)
191 {
193  if(fn.empty()) {
194  fn = default_dir_;
195  }
196 
198 
199  dlg.set_title(_("Load Map"))
200  .set_path(fn);
201 
202  if(dlg.show()) {
203  load_map(dlg.path(), !force_same_context);
204  }
205 }
206 
207 void context_manager::load_mru_item(unsigned int index, bool force_same_context /* = false */)
208 {
209  const std::vector<std::string>& mru = preferences::editor::recent_files();
210  if(mru.empty() || index >= mru.size()) {
211  return;
212  }
213 
214  load_map(mru[index], !force_same_context);
215 }
216 
218 {
219  team& t = get_map_context().teams()[side_index];
220 
221  editor_team_info team_info(t);
222 
223  if(gui2::dialogs::editor_edit_side::execute(team_info)) {
224  get_map_context().set_side_setup(team_info);
225  }
226 }
227 
229 {
230  map_context& context = get_map_context();
231 
232  // TODO
233  //std::string fn = filesystem::directory_name(context.get_filename());
234 
235  std::string id = context.get_id();
236  std::string name = context.get_name();
237  std::string description = context.get_description();
238 
239  int turns = context.get_time_manager()->number_of_turns();
240  int xp_mod = context.get_xp_mod();
241 
242  bool victory = context.victory_defeated();
243  bool random = context.random_start_time();
244 
245  const bool ok = gui2::dialogs::editor_edit_scenario::execute(
246  id, name, description, turns, xp_mod, victory, random
247  );
248 
249  if(!ok) {
250  return;
251  }
252 
253  context.set_scenario_setup(id, name, description, turns, xp_mod, victory, random);
254 
255  if(!name.empty()) {
257  }
258 }
259 
261 {
262  const editor_map& map = get_map_context().map();
263 
264  int w = map.w();
265  int h = map.h();
266 
267  if(gui2::dialogs::editor_new_map::execute(_("New Map"), w, h)) {
269  new_map(w, h, fill, true);
270  }
271 }
272 
274 {
275  const editor_map& map = get_map_context().map();
276 
277  int w = map.w();
278  int h = map.h();
279 
280  if(gui2::dialogs::editor_new_map::execute(_("New Scenario"), w, h)) {
282  new_scenario(w, h, fill, true);
283  }
284 }
285 
286 void context_manager::expand_open_maps_menu(std::vector<config>& items, int i)
287 {
288  auto pos = items.erase(items.begin() + i);
289  std::vector<config> contexts;
290 
291  for(std::size_t mci = 0; mci < map_contexts_.size(); ++mci) {
292  map_context& mc = *map_contexts_[mci];
293 
294  std::string filename;
295  if(mc.is_pure_map()) {
296  filename = filesystem::base_name(mc.get_filename());
297  } else {
298  filename = mc.get_name();
299  }
300 
301  if(filename.empty()) {
302  filename = mc.get_default_context_name();
303  }
304 
305  std::ostringstream ss;
306  ss << "[" << mci + 1 << "] ";
307 
308  const bool changed = mc.modified();
309 
310  if(changed) {
311  ss << "<i>" << filename << "</i>";
312  } else {
313  ss << filename;
314  }
315 
316  if(mc.is_embedded()) {
317  ss << " (E)";
318  }
319 
320  const std::string label = ss.str();
321  const std::string details = get_menu_marker(changed);
322 
323  contexts.emplace_back("label", label, "details", details);
324  }
325 
326  items.insert(pos, contexts.begin(), contexts.end());
327 }
328 
329 void context_manager::expand_load_mru_menu(std::vector<config>& items, int i)
330 {
331  std::vector<std::string> mru = preferences::editor::recent_files();
332 
333  auto pos = items.erase(items.begin() + i);
334 
335  if(mru.empty()) {
336  items.insert(pos, config {"label", _("No Recent Files")});
337  return;
338  }
339 
340  for(std::string& path : mru) {
341  // TODO: add proper leading ellipsization instead, since otherwise
342  // it'll be impossible to tell apart files with identical names and
343  // different parent paths.
345  }
346 
347  std::vector<config> temp;
348  std::transform(mru.begin(), mru.end(), std::back_inserter(temp), [](const std::string& str) {
349  return config {"label", str};
350  });
351 
352  items.insert(pos, temp.begin(), temp.end());
353 }
354 
355 void context_manager::expand_areas_menu(std::vector<config>& items, int i)
356 {
358  if(!tod) {
359  return;
360  }
361 
362  auto pos = items.erase(items.begin() + i);
363  std::vector<config> area_entries;
364 
365  std::vector<std::string> area_ids = tod->get_area_ids();
366 
367  for(std::size_t mci = 0; mci < area_ids.size(); ++mci) {
368  const std::string& area = area_ids[mci];
369 
370  std::stringstream ss;
371  ss << "[" << mci + 1 << "] ";\
372 
373  if(area.empty()) {
374  ss << "<i>" << _("Unnamed Area") << "</i>";
375  } else {
376  ss << area;
377  }
378 
379  const bool changed =
380  mci == static_cast<std::size_t>(get_map_context().get_active_area())
381  && tod->get_area_by_index(mci) != get_map_context().map().selection();
382 
383  const std::string label = ss.str();
384  const std::string details = get_menu_marker(changed);
385 
386  area_entries.emplace_back("label", label, "details", details);
387  }
388 
389  items.insert(pos, area_entries.begin(), area_entries.end());
390 }
391 
392 void context_manager::expand_sides_menu(std::vector<config>& items, int i)
393 {
394  auto pos = items.erase(items.begin() + i);
395  std::vector<config> contexts;
396 
397  for(std::size_t mci = 0; mci < get_map_context().teams().size(); ++mci) {
398 
399  const team& t = get_map_context().teams()[mci];
400  const std::string& teamname = t.user_team_name();
401  std::stringstream label;
402  label << "[" << mci+1 << "] ";
403 
404  if(teamname.empty()) {
405  label << "<i>" << _("New Side") << "</i>";
406  } else {
407  label << teamname;
408  }
409 
410  contexts.emplace_back("label", label.str());
411  }
412 
413  items.insert(pos, contexts.begin(), contexts.end());
414 }
415 
416 void context_manager::expand_time_menu(std::vector<config>& items, int i)
417 {
418  auto pos = items.erase(items.begin() + i);
419  std::vector<config> times;
420 
422 
423  assert(tod_m != nullptr);
424 
425  for(const time_of_day& time : tod_m->times()) {
426  times.emplace_back(
427  "details", time.name, // Use 'details' field here since the image will take the first column
428  "image", time.image
429  );
430  }
431 
432  items.insert(pos, times.begin(), times.end());
433 }
434 
435 void context_manager::expand_local_time_menu(std::vector<config>& items, int i)
436 {
437  auto pos = items.erase(items.begin() + i);
438  std::vector<config> times;
439 
441 
442  for(const time_of_day& time : tod_m->times(get_map_context().get_active_area())) {
443  times.emplace_back(
444  "details", time.name, // Use 'details' field here since the image will take the first column
445  "image", time.image
446  );
447  }
448 
449  items.insert(pos, times.begin(), times.end());
450 }
451 
453 {
454  std::string fn = get_map_context().get_filename();
455  if(fn.empty()) {
456  fn = default_dir_;
457  }
458 
460 
461  dlg.set_title(_("Apply Mask"))
462  .set_path(fn);
463 
464  if(dlg.show()) {
465  try {
466  map_context mask(game_config_, dlg.path());
467  editor_action_apply_mask a(mask.map());
469  } catch (const editor_map_load_exception& e) {
470  gui2::show_transient_message(_("Error loading mask"), e.what());
471  return;
472  } catch (const editor_action_exception& e) {
474  return;
475  }
476  }
477 }
478 
479 void context_manager::perform_refresh(const editor_action& action, bool drag_part /* =false */)
480 {
482  refresh_after_action(drag_part);
483 }
484 
486 {
487  int active_area = get_map_context().get_active_area();
488  std::string name = get_map_context().get_time_manager()->get_area_ids()[active_area];
489 
490  if(gui2::dialogs::edit_text::execute(N_("Rename Area"), N_("Identifier:"), name)) {
491  get_map_context().get_time_manager()->set_area_id(active_area, name);
492  }
493 }
494 
496 {
497  std::string fn = get_map_context().get_filename();
498  if(fn.empty()) {
499  fn = default_dir_;
500  }
501 
503 
504  dlg.set_title(_("Choose Target Map"))
505  .set_path(fn);
506 
507  if(dlg.show()) {
508  try {
509  map_context map(game_config_, dlg.path());
510  editor_action_create_mask a(map.map());
512  } catch (const editor_map_load_exception& e) {
513  gui2::show_transient_message(_("Error loading map"), e.what());
514  return;
515  } catch (const editor_action_exception& e) {
517  return;
518  }
519  }
520 }
521 
523 {
524  if(get_map_context().needs_reload()) {
525  reload_map();
526  return;
527  }
528 
529  const std::set<map_location>& changed_locs = get_map_context().changed_locations();
530 
531  if(get_map_context().needs_terrain_rebuild()) {
534  && (!drag_part || get_map_context().everything_changed())))
535  {
536  gui_.rebuild_all();
538  } else {
539  for(const map_location& loc : changed_locs) {
540  gui_.rebuild_terrain(loc);
541  }
542  }
543  }
544 
545  if(get_map_context().needs_labels_reset()) {
547  }
548 
551 }
552 
554 {
555  const editor_map& map = get_map_context().map();
556 
557  int w = map.w();
558  int h = map.h();
559 
561  bool copy = false;
562 
563  if(!gui2::dialogs::editor_resize_map::execute(w, h, dir, copy)) {
564  return;
565  }
566 
567  if(w != map.w() || h != map.h()) {
569  if(copy) {
571  }
572 
573  int x_offset = map.w() - w;
574  int y_offset = map.h() - h;
575 
576  switch (dir) {
580  y_offset = 0;
581  break;
585  y_offset /= 2;
586  break;
590  break;
591  default:
592  y_offset = 0;
593  WRN_ED << "Unknown resize expand direction" << std::endl;
594  break;
595  }
596 
597  switch (dir) {
601  x_offset = 0;
602  break;
606  x_offset /= 2;
607  break;
611  break;
612  default:
613  x_offset = 0;
614  break;
615  }
616 
617  editor_action_resize_map a(w, h, x_offset, y_offset, fill);
618  perform_refresh(a);
619  }
620 }
621 
623 {
624  std::string input_name = get_map_context().get_filename();
625  if(input_name.empty()) {
626  input_name = filesystem::get_dir(default_dir_ + "/maps");
627  }
628 
630 
631  dlg.set_title(_("Save Map As"))
632  .set_save_mode(true)
633  .set_path(input_name)
634  .set_extension(".map");
635 
636  if(!dlg.show()) {
637  return;
638  }
639 
640  save_map_as(dlg.path());
641 }
642 
644 {
645  std::string input_name = get_map_context().get_filename();
646  if(input_name.empty()) {
647  input_name = filesystem::get_dir(default_dir_ + "/scenarios");
648  }
649 
651 
652  dlg.set_title(_("Save Scenario As"))
653  .set_save_mode(true)
654  .set_path(input_name)
655  .set_extension(".cfg");
656 
657  if(!dlg.show()) {
658  return;
659  }
660 
661  save_scenario_as(dlg.path());
662 }
663 
665 {
666  for(const config& i : game_config.child_range("multiplayer")) {
667  if(i["map_generation"].empty() && i["scenario_generation"].empty()) {
668  continue;
669  }
670 
671  const config& generator_cfg = i.child("generator");
672  if(!generator_cfg) {
673  ERR_ED << "Scenario \"" << i["name"] << "\" with id " << i["id"]
674  << " has map_generation= but no [generator] tag" << std::endl;
675  } else {
676  map_generators_.emplace_back(create_map_generator(i["map_generation"], generator_cfg));
677  }
678  }
679 }
680 
682 {
683  if(map_generators_.empty()) {
684  gui2::show_error_message(_("No random map generators found."));
685  return;
686  }
687 
690  dialog.show();
691 
692  if(dialog.get_retval() == gui2::retval::OK) {
693  std::string map_string;
695  try {
696  map_string = map_generator->create_map(dialog.get_seed());
697  } catch (const mapgen_exception& e) {
698  gui2::show_transient_message(_("Map creation failed."), e.what());
699  return;
700  }
701 
702  if(map_string.empty()) {
703  gui2::show_transient_message("", _("Map creation failed."));
704  } else {
705  editor_map new_map(game_config_, map_string);
706  editor_action_whole_map a(new_map);
707  get_map_context().set_needs_labels_reset(); // Ensure Player Start labels are updated together with newly generated map
708  perform_refresh(a);
709  }
710 
711  last_map_generator_ = map_generator;
712  }
713 }
714 
716 {
717  if(get_map_context().modified()) {
718  const int res = gui2::show_message(_("Unsaved Changes"),
719  _("Do you want to discard all changes made to the map since the last save?"), gui2::dialogs::message::yes_no_buttons);
720  return gui2::retval::CANCEL != res;
721  }
722 
723  return true;
724 }
725 
727 {
729 }
730 
731 void context_manager::save_all_maps(bool auto_save_windows)
732 {
733  int current = current_context_index_;
734  saved_windows_.clear();
735  for(std::size_t i = 0; i < map_contexts_.size(); ++i) {
736  switch_context(i);
737  std::string name = get_map_context().get_filename();
738  if(auto_save_windows) {
739  if(name.empty() || filesystem::is_directory(name)) {
740  std::ostringstream s;
741  s << default_dir_ << "/" << "window_" << i + 1;
742  name = s.str();
744  }
745  }
746  saved_windows_.push_back(name);
747  save_map();
748  }
749 
750  switch_context(current);
751 }
752 
754 {
755  const std::string& name = get_map_context().get_filename();
756  if(name.empty() || filesystem::is_directory(name)) {
757  if(get_map_context().is_pure_map()) {
759  } else {
761  }
762  } else {
763  if(get_map_context().is_pure_map()) {
764  write_map();
765  } else {
766  write_scenario();
767  }
768  }
769 }
770 
771 bool context_manager::save_scenario_as(const std::string& filename)
772 {
773  std::size_t is_open = check_open_map(filename);
774  if(is_open < map_contexts_.size() && is_open != static_cast<unsigned>(current_context_index_)) {
775  gui2::show_transient_message(_("This scenario is already open."), filename);
776  return false;
777  }
778 
779  std::string old_filename = get_map_context().get_filename();
780  bool embedded = get_map_context().is_embedded();
781 
782  get_map_context().set_filename(filename);
783  get_map_context().set_embedded(false);
784 
785  if(!write_scenario(true)) {
786  get_map_context().set_filename(old_filename);
787  get_map_context().set_embedded(embedded);
788  return false;
789  }
790 
791  return true;
792 }
793 
794 bool context_manager::save_map_as(const std::string& filename)
795 {
796  std::size_t is_open = check_open_map(filename);
797  if(is_open < map_contexts_.size() && is_open != static_cast<unsigned>(current_context_index_)) {
798  gui2::show_transient_message(_("This map is already open."), filename);
799  return false;
800  }
801 
802  std::string old_filename = get_map_context().get_filename();
803  bool embedded = get_map_context().is_embedded();
804 
805  get_map_context().set_filename(filename);
806  get_map_context().set_embedded(false);
807 
808  if(!write_map(true)) {
809  get_map_context().set_filename(old_filename);
810  get_map_context().set_embedded(embedded);
811  return false;
812  }
813 
814  return true;
815 }
816 
817 bool context_manager::write_scenario(bool display_confirmation)
818 {
819  try {
821  if(display_confirmation) {
822  gui2::show_transient_message("", _("Scenario saved."));
823  }
824  } catch (const editor_map_save_exception& e) {
826  return false;
827  }
828 
829  return true;
830 }
831 
832 bool context_manager::write_map(bool display_confirmation)
833 {
834  try {
836  if(display_confirmation) {
837  gui2::show_transient_message("", _("Map saved."));
838  }
839  } catch (const editor_map_save_exception& e) {
841  return false;
842  }
843 
844  return true;
845 }
846 
847 std::size_t context_manager::check_open_map(const std::string& fn) const
848 {
849  std::size_t i = 0;
850  while(i < map_contexts_.size() && map_contexts_[i]->get_filename() != fn) {
851  ++i;
852  }
853 
854  return i;
855 }
856 
857 bool context_manager::check_switch_open_map(const std::string& fn)
858 {
859  std::size_t i = check_open_map(fn);
860  if(i < map_contexts_.size()) {
861  gui2::show_transient_message(_("This map is already open."), fn);
862  switch_context(i);
863  return true;
864  }
865 
866  return false;
867 }
868 
869 void context_manager::load_map(const std::string& filename, bool new_context)
870 {
871  if(new_context && check_switch_open_map(filename)) {
872  return;
873  }
874 
875  LOG_ED << "Load map: " << filename << (new_context ? " (new)" : " (same)") << "\n";
876  try {
877  {
878  context_ptr mc(new map_context(game_config_, filename));
879  if(mc->get_filename() != filename) {
880  if(new_context && check_switch_open_map(mc->get_filename())) {
881  return;
882  }
883  }
884 
885  if(new_context) {
886  int new_id = add_map_context_of(std::move(mc));
887  switch_context(new_id);
888  } else {
889  replace_map_context_with(std::move(mc));
890  }
891  }
892 
893  if(get_map_context().is_embedded()) {
894  const std::string& msg = _("Loaded embedded map data");
895  gui2::show_transient_message(_("Map loaded from scenario"), msg);
896  } else {
897  if(get_map_context().get_filename() != filename) {
898  if(get_map_context().get_map_data_key().empty()) {
899  ERR_ED << "Internal error, map context filename changed: "
900  << filename << " -> " << get_map_context().get_filename()
901  << " with no apparent scenario load\n";
902  } else {
903  utils::string_map symbols;
904  symbols["old"] = filename;
905  const std::string& msg = _("Loaded referenced map file:\n$new");
906  symbols["new"] = get_map_context().get_filename();
907  symbols["map_data"] = get_map_context().get_map_data_key();
908  gui2::show_transient_message(_("Map loaded from scenario"),
909  //TODO: msg is already translated does vgettext make sense?
910  VGETTEXT(msg.c_str(), symbols));
911  }
912  }
913  }
914  } catch(const editor_map_load_exception& e) {
915  gui2::show_transient_message(_("Error loading map"), e.what());
916  return;
917  }
918 }
919 
921 {
922  if(!confirm_discard()) {
923  return;
924  }
925 
926  std::string filename = get_map_context().get_filename();
927  if(filename.empty()) {
928  ERR_ED << "Empty filename in map revert" << std::endl;
929  return;
930  }
931 
932  load_map(filename, false);
933 }
934 
935 void context_manager::new_map(int width, int height, const t_translation::terrain_code& fill, bool new_context)
936 {
937  const config& default_schedule = game_config_.find_child("editor_times", "id", "default");
938  editor_map m(game_config_, width, height, fill);
939 
940  if(new_context) {
941  int new_id = add_map_context(m, true, default_schedule);
942  switch_context(new_id);
943  } else {
944  replace_map_context(m, true, default_schedule);
945  }
946 }
947 
948 void context_manager::new_scenario(int width, int height, const t_translation::terrain_code& fill, bool new_context)
949 {
950  const config& default_schedule = game_config_.find_child("editor_times", "id", "default");
951  editor_map m(game_config_, width, height, fill);
952 
953  if(new_context) {
954  int new_id = add_map_context(m, false, default_schedule);
955  switch_context(new_id);
956  } else {
957  replace_map_context(m, false, default_schedule);
958  }
959 
960  // Give the new scenario an initial side.
962  gui_.init_flags();
963 }
964 
965 //
966 // Context manipulation
967 //
968 
969 template<typename... T>
970 int context_manager::add_map_context(const T&... args)
971 {
972  map_contexts_.emplace_back(new map_context(args...));
973  return map_contexts_.size() - 1;
974 }
975 
977 {
978  map_contexts_.emplace_back(std::move(mc));
979  return map_contexts_.size() - 1;
980 }
981 
982 template<typename... T>
984 {
985  context_ptr new_mc(new map_context(args...));
986  replace_map_context_with(std::move(new_mc));
987 }
988 
990 {
993 }
994 
996 {
997  if(saved_windows_.empty()) {
1000 
1001  const config& default_schedule = game_config_.find_child("editor_times", "id", "default");
1002  add_map_context(editor_map(game_config_, 44, 33, default_terrain), true, default_schedule);
1003  } else {
1004  for(const std::string& filename : saved_windows_) {
1005  add_map_context(game_config_, filename);
1006  }
1007 
1008  saved_windows_.clear();
1009  }
1010 }
1011 
1013 {
1014  if(!confirm_discard()) return;
1015 
1016  if(map_contexts_.size() == 1) {
1018  map_contexts_.erase(map_contexts_.begin());
1019  } else if(current_context_index_ == static_cast<int>(map_contexts_.size()) - 1) {
1020  map_contexts_.pop_back();
1022  } else {
1024  }
1025 
1027 }
1028 
1029 void context_manager::switch_context(const int index, const bool force)
1030 {
1031  if(index < 0 || static_cast<std::size_t>(index) >= map_contexts_.size()) {
1032  WRN_ED << "Invalid index in switch map context: " << index << std::endl;
1033  return;
1034  }
1035 
1036  if(index == current_context_index_ && !force) {
1037  return;
1038  }
1039 
1040  // Disable the labels of the current context before switching.
1041  // The refresher handles enabling the new ones.
1042  get_map_context().get_labels().enable(false);
1043 
1045 
1047 }
1048 
1050 {
1051  std::string name = get_map_context().get_name();
1052 
1053  if(name.empty()) {
1055  }
1056 
1057  if(name.empty()){
1059  }
1060 
1061  const std::string& wm_title_string = name + " - " + game_config::get_default_title_string();
1062  CVideo::get_singleton().set_window_title(wm_title_string);
1063 }
1064 
1065 } //Namespace editor
int auto_update_transitions()
Definition: editor.cpp:24
bool write_scenario(bool display_confirmation=false)
Dialog was closed with the CANCEL button.
Definition: retval.hpp:37
void set_side_setup(editor_team_info &info)
TODO.
void show_message(const std::string &title, const std::string &msg, const std::string &button_caption, const bool auto_close, const bool message_use_markup, const bool title_use_markup)
Shows a message to the user.
Definition: message.cpp:150
const std::string & get_name() const
boost::optional< uint32_t > get_seed()
::tod_manager * tod_manager
Definition: resources.cpp:29
int h() const
Effective map height.
Definition: map.hpp:93
void apply_mask_dialog()
Display an apply mask dialog and process user input.
std::size_t check_open_map(const std::string &fn) const
Check if a map is already open.
bool check_switch_open_map(const std::string &fn)
Check if a map is already open.
std::unique_ptr< map_context > context_ptr
std::size_t modified_maps(std::string &modified)
int auto_update_transitions_
Flag to rebuild terrain on every terrain change.
const t_translation::terrain_code & get_selected_bg_terrain()
std::vector< std::string > recent_files()
Retrieves the list of recently opened files.
Definition: editor.cpp:118
const terrain_code NONE_TERRAIN
Definition: translation.hpp:58
void edit_scenario_dialog()
Display a scenario edit dialog and process user input.
std::map< std::string, t_string > string_map
file_dialog & set_extension(const std::string &value)
Sets the default file extension for file names in save mode.
game_classification * classification
Definition: resources.cpp:34
file_dialog & set_path(const std::string &value)
Sets the initial file selection.
void change_display_context(const display_context *dc)
Definition: display.cpp:405
void replace_map_context_with(context_ptr &&mc)
std::vector< context_ptr > map_contexts_
The currently opened map context object.
config & find_child(config_key_type key, const std::string &name, const std::string &value)
Returns the first child of tag key with a name attribute containing value.
Definition: config.cpp:789
void new_side()
Adds a new side to the map.
void reload_map()
Reload the map after it has significantly changed (when e.g.
bool save_scenario()
Saves the scenario under the current filename.
void resize_map_dialog()
Display a load map dialog and process user input.
#define a
void save_scenario_as_dialog()
Display a save map as dialog and process user input.
void rename_area_dialog()
Display an dialog to querry a new id for an [time_area].
void refresh_after_action(bool drag_part=false)
Refresh the display after an action has been performed.
void init_flags()
Initialize the flag list for all sides.
Definition: display.cpp:178
const std::string & get_filename() const
child_itors child_range(config_key_type key)
Definition: config.cpp:366
void set_area_id(int area_index, const std::string &id)
context_manager(editor_display &gui, const config &game_config)
map_labels & get_labels()
void save_map()
Save the map, open dialog if not named yet.
#define LOG_ED
General purpose widgets.
std::string default_dir_
Default directory for map load/save as dialogs.
A terrain string which is converted to a terrain is a string with 1 or 2 layers the layers are separa...
Definition: translation.hpp:49
std::string get_default_title_string()
void perform_refresh(const editor_action &action, bool drag_part=false)
Perform an action on the current map_context, then refresh the display.
file_dialog & set_save_mode(bool value)
Sets the dialog&#39;s behavior on non-existent file name inputs.
static CVideo & get_singleton()
Definition: video.hpp:48
#define h
static void msg(const char *act, debug_info &i, const char *to="", const char *result="")
Definition: debugger.cpp:109
const std::vector< std::string > items
int add_map_context(const T &... args)
Add a map context.
Replace contents of the entire map, Useful as a fallback undo method when something else would be imp...
Definition: action.hpp:37
int get_xp_mod() const
-file sdl_utils.hpp
bool show(const unsigned auto_close_time=0)
Shows the window.
bool confirm_discard()
Shows an are-you-sure dialog if the map was modified.
void set_needs_reload(bool value=true)
Setter for the reload flag.
map_context & get_map_context()
Get the current map context object.
void refresh_all()
Refresh everything, i.e.
int add_map_context_of(context_ptr &&mc)
map_generator * get_selected_map_generator()
void set_scenario_setup(const std::string &id, const std::string &name, const std::string &description, int turns, int xp_mod, bool victory_defeated, bool random_time)
TODO.
void revert_map()
Revert the map by reloading it from disk.
const std::string & get_id() const
bool modified() const
void expand_areas_menu(std::vector< config > &items, int i)
Menu expanding for the map&#39;s defined areas.
std::string path() const
Gets the current file selection.
std::string default_dir()
Definition: editor.cpp:32
#define WRN_ED
game_classification & get_classification()
void set_window_title(const std::string &title)
Sets the title of the main window.
Definition: video.cpp:297
Object which defines a time of day with associated bonuses, image, sounds etc.
Definition: time_of_day.hpp:57
This class stores all the data for a single &#39;side&#39; (in game nomenclature).
Definition: team.hpp:44
void close_current_context()
Closes the active map context.
static UNUSEDNOWARN std::string _(const char *str)
Definition: gettext.hpp:89
const std::set< map_location > & selection() const
Return the selection set.
Definition: editor_map.hpp:149
void load_map_dialog(bool force_same_context=false)
Display a load map dialog and process user input.
std::string get_user_data_dir()
Definition: filesystem.cpp:749
void reset_starting_position_labels(display &disp)
void recalculate_minimap()
Schedule the minimap for recalculation.
Definition: display.hpp:647
void select_map_generator(map_generator *mg)
filter_context * filter_con
Definition: resources.cpp:23
void show_transient_message(const std::string &title, const std::string &message, const std::string &image, const bool message_use_markup, const bool title_use_markup)
Shows a transient message to the user.
void set_embedded(bool v)
const std::set< map_location > changed_locations() const
void set_auto_update_transitions(int value)
Definition: editor.cpp:28
void new_scenario_dialog()
Display a new map dialog and process user input.
bool is_directory(const std::string &fname)
Returns true if the given file is a directory.
Definition: filesystem.cpp:984
Editor action classes.
bool random_start_time() const
bool save_map()
Saves the map under the current filename.
void enable(bool is_enabled)
Definition: label.cpp:253
Modify, read and display user preferences.
Shows a yes and no button.
Definition: message.hpp:79
map_display and display: classes which take care of displaying the map and game-data on the screen...
void refresh_on_context_change()
Performs the necessary housekeeping necessary when switching contexts.
bool is_pure_map() const
Manage the empty-palette in the editor.
Definition: action.cpp:29
std::string default_terrain
Definition: game_config.cpp:69
void perform_action(const editor_action &action)
Performs an action (thus modifying the map).
const char * what() const noexcept
Definition: exceptions.hpp:37
bool is_active_transitions_hotkey(const std::string &item)
void switch_context(const int index, const bool force=false)
Switches the context to the one under the specified index.
void new_scenario(int width, int height, const t_translation::terrain_code &fill, bool new_context)
Create a new scenario.
Paint the same terrain on a number of locations on the map.
Definition: action.hpp:284
void new_map(int width, int height, const t_translation::terrain_code &fill, bool new_context)
Create a new map.
bool is_embedded() const
int number_of_turns() const
void load_map(const std::string &filename, bool new_context)
Load a map given the filename.
virtual std::string create_map(boost::optional< uint32_t > randomseed=boost::none)=0
Creates a new map and returns it.
std::vector< std::string > get_area_ids() const
map_generator * create_map_generator(const std::string &name, const config &cfg)
Definition: map_create.cpp:28
void set_needs_terrain_rebuild(bool value=true)
Setter for the terrain rebuild flag.
Encapsulates the map of the game.
Definition: location.hpp:42
class location_palette * locs_
const std::string & get_description() const
void clear_changed_locations()
int w() const
Effective map width.
Definition: map.hpp:90
This class adds extra editor-specific functionality to a normal gamemap.
Definition: editor_map.hpp:69
static fs::path get_dir(const fs::path &dirpath)
Definition: filesystem.cpp:311
std::size_t i
Definition: function.cpp:933
void add_item(const std::string &id)
void fill_selection()
Fill the selection with the foreground terrain.
void save_map_as_dialog()
Display a save map as dialog and process user input.
bool write_map(bool display_confirmation=false)
Save the map under a given filename.
Game configuration data as global variables.
Definition: build_info.cpp:46
void expand_local_time_menu(std::vector< config > &items, int i)
Menu expanding for the map&#39;s defined areas.
void rebuild_terrain(const map_location &loc)
bool save_scenario_as(const std::string &filename)
const tod_manager * get_time_manager() const
static map_location::DIRECTION s
const std::vector< time_of_day > & times(const map_location &loc=map_location::null_location()) const
editor_display & gui()
Base class for all editor actions.
Definition: action_base.hpp:40
void save_all_maps(bool auto_save_windows=false)
Save all maps, open dialog if not named yet, except when using auto_save_windows which will name unna...
const std::string & get_map_data_key() const
void create_mask_to_dialog()
Display an apply mask dialog and process user input.
Declarations for File-IO.
int w
This class wraps around a map to provide a concise interface for the editor to work with...
Definition: map_context.hpp:55
#define N_(String)
Definition: gettext.hpp:97
std::size_t index(const std::string &str, const std::size_t index)
Codepoint index corresponding to the nth character in a UTF-8 string.
Definition: unicode.cpp:71
const std::string unicode_bullet
Definition: constants.cpp:42
#define VGETTEXT(msgid,...)
void replace_map_context(const T &... args)
Replace the current map context and refresh accordingly.
std::string base_name(const std::string &file, const bool remove_extension)
Returns the base filename of a file, with directory name stripped.
void expand_sides_menu(std::vector< config > &items, int i)
Menu expanding for the map&#39;s player sides.
bool victory_defeated() const
static std::string get_filename(const std::string &file_code)
map_generator * last_map_generator_
int turns()
Definition: game.cpp:559
void edit_side_dialog(int side_index)
Display a side edit dialog and process user input.
double t
Definition: astarsearch.cpp:63
void reload_map()
Updates internals that cache map size.
Definition: display.cpp:400
virtual const editor_map & map() const override
Const map accessor.
lu_byte left
Definition: lparser.cpp:1026
int get_active_area() const
#define ERR_ED
void set_needs_labels_reset(bool value=true)
Setter for the labels reset flag.
std::vector< std::unique_ptr< map_generator > > map_generators_
Available random map generators.
void set_filename(const std::string &fn)
void expand_load_mru_menu(std::vector< config > &items, int i)
Menu expanding for most recent loaded list.
const std::set< map_location > & get_area_by_index(int index) const
void show_error_message(const std::string &msg, bool message_use_markup)
Shows an error message to the user.
Definition: message.cpp:203
void generate_map_dialog()
Display a generate random map dialog and process user input.
void set_window_title()
Displays the specified map name in the window titlebar.
void create_default_context()
Creates a default map context object, used to ensure there is always at least one.
The dialog for selecting which random generator to use in the editor.
#define e
bool save_map_as(const std::string &filename)
Save the map under a given filename.
Dialog was closed with the OK button.
Definition: retval.hpp:34
void expand_time_menu(std::vector< config > &items, int i)
Menu expanding for the map&#39;s defined areas.
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:68
void init_map_generators(const config &game_config)
init available random map generators
void load_mru_item(unsigned index, bool force_same_context=false)
Open the specified entry from the recent files list.
virtual const std::vector< team > & teams() const override
Const teams accessor.
static std::vector< std::string > saved_windows_
static const std::string get_menu_marker(const bool changed)
std::string path
File path.
void expand_open_maps_menu(std::vector< config > &items, int i)
Menu expanding for open maps list.
std::string directory_name(const std::string &file)
Returns the directory name of a file, with filename stripped.
const t_string & user_team_name() const
Definition: team.hpp:295
terrain_code read_terrain_code(const std::string &str, const ter_layer filler)
Reads a single terrain from a string.
const t_string get_default_context_name() const
void rebuild_all()
Rebuild all dynamic terrain.
Definition: display.cpp:395
void new_map_dialog()
Display a new map dialog and process user input.
file_dialog & set_title(const std::string &value)
Sets the current dialog title text.
Definition: file_dialog.hpp:56