The Battle for Wesnoth  1.19.6+dev
lobby.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2009 - 2024
3  by Tomasz Sniatowski <kailoran@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 #pragma once
17 
23 #include "quit_confirmation.hpp"
24 
26 
27 namespace gui2
28 {
29 class grid;
30 class listbox;
31 class text_box;
32 class window;
33 class chatbox;
34 
35 namespace dialogs
36 {
37 class mp_lobby : public modal_dialog, public quit_confirmation, private plugin_executor
38 {
39 public:
40  mp_lobby(mp::lobby_info& info, wesnothd_connection& connection, int& joined_game);
41 
42  ~mp_lobby();
43 
44  void update_gamelist();
45 
46 protected:
47  void update_visible_games();
48 
49  void update_gamelist_diff();
50 
52 
54 
55  void adjust_game_row_contents(const mp::game_info& game, grid* grid, bool add_callbacks = true);
56 
57 public:
58  void update_playerlist();
59 
60  enum lobby_result {
66  };
67 
68 private:
69  void update_selected_game();
70 
71  /**
72  * Network polling callback
73  */
74  void network_handler();
75 
76  void process_network_data(const config& data);
77 
78  void process_gamelist(const config& data);
79 
80  void process_gamelist_diff(const config& data);
81 
83 
84  /**
85  * Exits the lobby and enters the given game.
86  *
87  * This assembles the game request for the server and handles any applicable
88  * pre-join actions, such as prompting the player for the game's password or
89  * informing them additional content needs installing.
90  *
91  * The lobby window will be closed on completion, assuming an error wasn't
92  * encountered.
93  *
94  * @param game Info on the game we're attempting to join.
95  * @param mode Whether joining as player, observer or whichever works.
96  */
98 
99  /** Entry wrapper for @ref enter_game, where game is located by index. */
100  void enter_game_by_index(const int index, JOIN_MODE mode);
101 
102  /** Entry wrapper for @ref enter_game, where game is located by game id. */
103  void enter_game_by_id(const int game_id, JOIN_MODE mode);
104 
105  /** Enter game by index, where index is the selected game listbox row. */
107 
108  void show_help_callback();
109 
111 
112  void show_server_info();
113 
114  void open_profile_url();
115 
116  void open_match_history();
117 
118  void tab_switch_callback();
119 
120  void refresh_lobby();
121 
122  void game_filter_init();
123 
124  void game_filter_keypress_callback(const SDL_Keycode key);
125 
127 
129 
130  bool exit_hook(window& window);
131 
132  static bool logout_prompt();
133 
134  virtual const std::string& window_id() const override;
135 
136  virtual void pre_show() override;
137 
138  virtual void post_show() override;
139 
141 
143 
145 
151 
153 
155 
157 
159 
161 
162  std::chrono::steady_clock::time_point last_lobby_update_;
163 
165 
167 
168  /** Timer for updating the lobby. */
169  std::size_t lobby_update_timer_;
170 
171  std::vector<int> gamelist_id_at_row_;
172 
174 
176 
178 
180 
181  static inline std::string server_information_ = "";
182  static inline std::string announcements_ = "";
183 };
184 
185 } // namespace dialogs
186 } // namespace gui2
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:172
Abstract base class for all modal dialogs.
void enter_selected_game(JOIN_MODE mode)
Enter game by index, where index is the selected game listbox row.
Definition: lobby.cpp:908
void process_gamelist(const config &data)
Definition: lobby.cpp:769
field_bool * filter_slots_
Definition: lobby.hpp:148
void update_visible_games()
Definition: lobby.cpp:364
void update_selected_game()
Definition: lobby.cpp:535
virtual void post_show() override
Actions to be taken after the window has been shown.
Definition: lobby.cpp:697
mp::lobby_info & lobby_info_
Definition: lobby.hpp:142
text_box * filter_text_
Definition: lobby.hpp:152
lobby_player_list_helper player_list_
Definition: lobby.hpp:156
void skip_replay_changed_callback()
Definition: lobby.cpp:1002
static std::string announcements_
Definition: lobby.hpp:182
virtual const std::string & window_id() const override
The ID of the window to build.
wesnothd_connection & network_connection_
Definition: lobby.hpp:166
void update_gamelist_filter()
Definition: lobby.cpp:511
field_bool * filter_friends_
Definition: lobby.hpp:146
listbox * gamelistbox_
Definition: lobby.hpp:140
void process_network_data(const config &data)
Definition: lobby.cpp:748
widget_data make_game_row_data(const mp::game_info &game)
Definition: lobby.cpp:376
field_bool * filter_ignored_
Definition: lobby.hpp:147
void game_filter_keypress_callback(const SDL_Keycode key)
Definition: lobby.cpp:972
field_bool * filter_invert_
Definition: lobby.hpp:149
void enter_game_by_id(const int game_id, JOIN_MODE mode)
Entry wrapper for enter_game, where game is located by game id.
Definition: lobby.cpp:896
void update_gamelist_diff()
Definition: lobby.cpp:257
void show_preferences_button_callback()
Definition: lobby.cpp:923
static std::string server_information_
Definition: lobby.hpp:181
void enter_game(const mp::game_info &game, JOIN_MODE mode)
Exits the lobby and enters the given game.
Definition: lobby.cpp:801
static bool logout_prompt()
Definition: lobby.cpp:63
void user_dialog_callback(const mp::user_info *info)
Definition: lobby.cpp:979
void tab_switch_callback()
Definition: lobby.cpp:683
mp_lobby(mp::lobby_info &info, wesnothd_connection &connection, int &joined_game)
Definition: lobby.cpp:68
void process_gamelist_diff(const config &data)
Definition: lobby.cpp:779
std::size_t lobby_update_timer_
Timer for updating the lobby.
Definition: lobby.hpp:169
virtual void pre_show() override
Actions to be taken before showing the window.
Definition: lobby.cpp:560
void adjust_game_row_contents(const mp::game_info &game, grid *grid, bool add_callbacks=true)
Definition: lobby.cpp:405
std::vector< int > gamelist_id_at_row_
Definition: lobby.hpp:171
std::chrono::steady_clock::time_point last_lobby_update_
Definition: lobby.hpp:162
void network_handler()
Network polling callback.
Definition: lobby.cpp:712
void enter_game_by_index(const int index, JOIN_MODE mode)
Entry wrapper for enter_game, where game is located by index.
Definition: lobby.cpp:885
Specialized field class for boolean.
Definition: field.hpp:488
Base container class.
Definition: grid.hpp:32
The listbox class.
Definition: listbox.hpp:43
A widget that allows the user to input text in single line.
Definition: text_box.hpp:125
base class of top level items, the only item which needs to store the final canvases to draw on.
Definition: window.hpp:61
show_mode mode() const
Returns the dialog mode for this window.
Definition: window.hpp:694
This class represents the collective information the client has about the players and games on the se...
Definition: lobby_info.hpp:31
Implements a quit confirmation dialog.
A class that represents a TCP/IP connection to the wesnothd server.
Various uncategorised dialogs.
Generic file dialog.
std::map< std::string, widget_item > widget_data
Definition: widget.hpp:36
logger & info()
Definition: log.cpp:319
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:70
std::string_view data
Definition: picture.cpp:178
This class represents the info a client has about a game on the server.
Definition: lobby_data.hpp:63
This class represents the information a client has about another player.
Definition: lobby_data.hpp:30