The Battle for Wesnoth  1.19.11+dev
help_browser.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2017 - 2025
3  by Charles Dang <exodia339@gmail.com>
4  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY.
12 
13  See the COPYING file for more details.
14 */
15 
16 #define GETTEXT_DOMAIN "wesnoth-lib"
17 
19 
20 #include "gui/widgets/button.hpp"
21 #include "gui/widgets/label.hpp"
25 #include "gui/widgets/text_box.hpp"
29 #include "gui/widgets/window.hpp"
30 #include "help/help.hpp"
32 #include "utils/ci_searcher.hpp"
33 
34 static lg::log_domain log_help("help");
35 #define ERR_HP LOG_STREAM(err, log_help)
36 #define WRN_HP LOG_STREAM(warn, log_help)
37 #define DBG_HP LOG_STREAM(debug, log_help)
38 
39 namespace gui2::dialogs
40 {
41 
42 namespace
43 {
44  int win_w = 0;
45  int tree_w = 0;
46 }
47 
48 REGISTER_DIALOG(help_browser)
49 
50 help_browser::help_browser(const help::section& toplevel, const std::string& initial)
51  : modal_dialog(window_id())
52  , initial_topic_(initial.empty() ? help::default_show_topic : initial)
53  , current_topic_()
54  , toplevel_(toplevel)
55  , history_()
56  , history_pos_(0)
57 {
58  if(initial_topic_.compare(0, 2, "..") == 0) {
59  initial_topic_.replace(0, 2, "+");
60  } else {
61  initial_topic_.insert(0, "-");
62  }
64 }
65 
67 {
68  tree_view& topic_tree = find_widget<tree_view>("topic_tree");
69 
70  button& back_button = find_widget<button>("back");
71  button& next_button = find_widget<button>("next");
72 
73  rich_label& topic_text = find_widget<rich_label>("topic_text");
74 
75  next_button.set_active(false);
76  back_button.set_active(false);
77  connect_signal_mouse_left_click(back_button, std::bind(&help_browser::on_history_navigate, this, true));
78  connect_signal_mouse_left_click(next_button, std::bind(&help_browser::on_history_navigate, this, false));
79 
80  toggle_button& contents = find_widget<toggle_button>("contents");
81 
82  contents.set_value(true);
83  topic_tree.set_visible(true);
84  connect_signal_mouse_left_click(contents, [&](auto&&...) {
85  auto parent = topic_text.get_window();
86  // Cache the initial values, get_best_size() keeps changing
87  if ((parent != nullptr) && (win_w == 0)) {
88  win_w = parent->get_best_size().x;
89  }
90  if (tree_w == 0) {
91  tree_w = topic_tree.get_best_size().x;
92  }
93 
94  // Set RL's width and reshow
95  bool is_contents_visible = (topic_tree.get_visible() == widget::visibility::visible);
96  if (topic_text.get_window()) {
97  topic_text.set_width(win_w - (is_contents_visible ? 0 : tree_w) - 20 /* Padding */);
98  show_topic(history_.at(history_pos_), false);
99  }
100  topic_tree.set_visible(!is_contents_visible);
102  });
103 
104  text_box& filter = find_widget<text_box>("filter_box");
106  filter.on_modified([this](const auto& box) { update_list(box.text()); });
107 
108  topic_text.register_link_callback(std::bind(&help_browser::show_topic, this, std::placeholders::_1, true));
109 
110  connect_signal_notify_modified(topic_tree, std::bind(&help_browser::on_topic_select, this));
111 
112  keyboard_capture(&topic_tree);
113 
115 
116  tree_view_node& initial_node = topic_tree.find_widget<tree_view_node>(initial_topic_);
117  initial_node.select_node(true);
118 
119  on_topic_select();
120 }
121 
122 void help_browser::update_list(const std::string& filter_text) {
123  tree_view& topic_tree = find_widget<tree_view>("topic_tree");
124  topic_tree.clear();
125  if(!add_topics_for_section(toplevel_, topic_tree.get_root_node(), filter_text)) {
126  // Add everything if nothing matches
128  }
129 }
130 
131 bool help_browser::add_topics_for_section(const help::section& parent_section, tree_view_node& parent_node, const std::string& filter_text)
132 {
133  bool topics_added = false;
134  const auto match = translation::make_ci_matcher(filter_text);
135 
136  for(const help::section& section : parent_section.sections) {
137  tree_view_node& section_node = add_topic(section.id, section.title, true, parent_node);
138  bool subtopics_added = add_topics_for_section(section, section_node, filter_text);
139 
140  if (subtopics_added || (match(section.id) || match(section.title))) {
141  if (!filter_text.empty()) {
142  section_node.unfold();
143  }
144  topics_added = true;
145  } else {
146  find_widget<tree_view>("topic_tree").remove_node(&section_node);
147  }
148  }
149 
150  for(const help::topic& topic : parent_section.topics) {
151  if ((match(topic.id) || match(topic.title)) && (topic.id.compare(0, 2, "..") != 0)) {
152  add_topic(topic.id, topic.title, false, parent_node);
153  topics_added = true;
154  }
155  }
156 
157  return topics_added;
158 }
159 
160 tree_view_node& help_browser::add_topic(const std::string& topic_id, const std::string& topic_title,
161  bool expands, tree_view_node& parent)
162 {
164  widget_item item;
165 
166  item["label"] = topic_title;
167  data.emplace("topic_name", item);
168 
169  tree_view_node& new_node = parent.add_child(expands ? "section" : "topic", data);
170  new_node.set_id(std::string(expands ? "+" : "-") + topic_id);
171 
172  return new_node;
173 }
174 
175 void help_browser::show_topic(std::string topic_id, bool add_to_history)
176 {
177  if(topic_id.empty() || topic_id == current_topic_) {
178  return;
179  } else {
180  current_topic_ = topic_id;
181  }
182 
183  if(topic_id[0] == '+') {
184  topic_id.replace(topic_id.begin(), topic_id.begin() + 1, 2, '.');
185  }
186 
187  if(topic_id[0] == '-') {
188  topic_id.erase(topic_id.begin(), topic_id.begin() + 1);
189  }
190 
191  auto iter = parsed_pages_.find(topic_id);
192  if(iter == parsed_pages_.end()) {
193  const help::topic* topic = help::find_topic(toplevel_, topic_id);
194  if(!topic) {
195  ERR_HP << "Help browser tried to show topic with id '" << topic_id
196  << "' but that topic could not be found." << std::endl;
197  return;
198  }
199 
200  DBG_HP << "Showing topic: " << topic->id << ": " << topic->title;
201 
202  std::string topic_id_temp = topic->id;
203  if(topic_id_temp.compare(0, 2, "..") == 0) {
204  topic_id_temp.replace(0, 2, "+");
205  } else {
206  topic_id_temp.insert(0, "-");
207  }
208  tree_view& topic_tree = find_widget<tree_view>("topic_tree");
209  tree_view_node& selected_node = topic_tree.find_widget<tree_view_node>(topic_id_temp);
210  selected_node.select_node(true);
211 
212  find_widget<label>("topic_title").set_label(topic->title);
213  find_widget<rich_label>("topic_text").set_dom(topic->text.parsed_text());
214 
216  }
217 
218  if (add_to_history) {
219  // history pos is 0 initially, so it's already at first entry
220  // no need to increment first time
221  if (!history_.empty()) {
222  // don't add duplicate entries back-to-back
223  if (history_.back() == topic_id) {
224  return;
225  }
226  history_pos_++;
227  }
228  history_.push_back(topic_id);
229 
230  find_widget<button>("back").set_active(history_pos_ != 0);
231  }
232 }
233 
235 {
236  tree_view& topic_tree = find_widget<tree_view>("topic_tree");
237 
238  if(topic_tree.empty()) {
239  return;
240  }
241 
242  tree_view_node* selected = topic_tree.selected_item();
243  assert(selected);
244 
245  show_topic(selected->id());
246 }
247 
249 {
250  if(backwards) {
251  history_pos_--;
252  } else {
253  history_pos_++;
254  }
255  find_widget<button>("back").set_active(!history_.empty() && history_pos_ != 0);
256  find_widget<button>("next").set_active(!history_.empty() && history_pos_ != (history_.size()-1));
257 
258  show_topic(history_.at(history_pos_), false);
259 }
260 
261 } // namespace dialogs
Simple push button.
Definition: button.hpp:36
virtual void set_active(const bool active) override
See styled_widget::set_active.
Definition: button.cpp:64
Help browser dialog.
const help::section & toplevel_
void update_list(const std::string &)
bool add_topics_for_section(const help::section &parent_section, tree_view_node &parent_node, const std::string &filter_text="")
void show_topic(std::string topic_id, bool add_to_history=true)
std::map< std::string, int > parsed_pages_
virtual void pre_show() override
Actions to be taken before showing the window.
void on_history_navigate(bool backwards)
tree_view_node & add_topic(const std::string &topic_id, const std::string &topic_title, bool expands, tree_view_node &parent)
std::vector< std::string > history_
Abstract base class for all modal dialogs.
A rich_label takes marked up text and shows it correctly formatted and wrapped but no scrollbars are ...
Definition: rich_label.hpp:38
void set_width(const int width)
Definition: rich_label.hpp:136
void register_link_callback(std::function< void(std::string)> link_handler)
Definition: rich_label.cpp:835
A widget that allows the user to input text in single line.
Definition: text_box.hpp:125
virtual void set_value(unsigned selected, bool fire_event=false) override
Inherited from selectable_item.
void select_node(bool expand_parents=false)
void unfold(const bool recursive=false)
const tree_view_node & get_root_node() const
Definition: tree_view.hpp:53
bool empty() const
Definition: tree_view.cpp:99
tree_view_node * selected_item()
Definition: tree_view.hpp:98
point get_best_size() const
Gets the best size for the widget.
Definition: widget.cpp:203
void set_visible(const visibility visible)
Definition: widget.cpp:479
void set_id(const std::string &id)
Definition: widget.cpp:98
visibility get_visible() const
Definition: widget.cpp:506
window * get_window()
Get the parent window.
Definition: widget.cpp:117
@ visible
The user sets the widget visible, that means:
T * find_widget(const std::string_view id, const bool must_be_active, const bool must_exist)
Gets a widget with the wanted id.
Definition: widget.hpp:747
widget * parent()
Definition: widget.cpp:170
void keyboard_capture(widget *widget)
Definition: window.cpp:1201
void invalidate_layout()
Updates the size of the window.
Definition: window.cpp:760
void add_to_keyboard_chain(widget *widget)
Adds the widget to the keyboard chain.
Definition: window.cpp:1207
const config & parsed_text() const
Definition: help_impl.cpp:380
This file contains the window object, this object is a top level container which has the event manage...
#define DBG_HP
#define ERR_HP
static lg::log_domain log_help("help")
std::string selected
REGISTER_DIALOG(editor_edit_unit)
void connect_signal_notify_modified(dispatcher &dispatcher, const signal_notification &signal)
Connects a signal handler for getting a notification upon modification.
Definition: dispatcher.cpp:189
void connect_signal_mouse_left_click(dispatcher &dispatcher, const signal &signal)
Connects a signal handler for a left mouse button click.
Definition: dispatcher.cpp:163
std::map< std::string, widget_item > widget_data
Definition: widget.hpp:36
std::map< std::string, t_string > widget_item
Definition: widget.hpp:33
void init_help()
Definition: help.cpp:145
const topic * find_topic(const section &sec, const std::string &id)
Search for the topic with the specified identifier in the section and its subsections.
Definition: help_impl.cpp:1293
const std::string default_show_topic
Definition: help_impl.cpp:82
auto make_ci_matcher(std::string_view filter_text)
Returns a function which performs locale-aware case-insensitive search.
Definition: ci_searcher.hpp:24
constexpr auto filter
Definition: ranges.hpp:38
std::string_view data
Definition: picture.cpp:188
A section contains topics and sections along with title and ID.
Definition: help_impl.hpp:148
section_list sections
Definition: help_impl.hpp:168
std::string id
Definition: help_impl.hpp:166
std::string title
Definition: help_impl.hpp:166
topic_list topics
Definition: help_impl.hpp:167
A topic contains a title, an id and some text.
Definition: help_impl.hpp:115
std::string id
Definition: help_impl.hpp:139
topic_text text
Definition: help_impl.hpp:140
std::string title
Definition: help_impl.hpp:139