The Battle for Wesnoth  1.17.10+dev
lobby.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2009 - 2022
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 
18 #include "chat_events.hpp"
25 #include "quit_confirmation.hpp"
26 
28 
29 namespace gui2
30 {
31 class grid;
32 class listbox;
33 class text_box;
34 class window;
35 class chatbox;
36 
37 namespace dialogs
38 {
39 class mp_lobby : public modal_dialog, public quit_confirmation, private plugin_executor
40 {
41 public:
42  mp_lobby(mp::lobby_info& info, wesnothd_connection& connection, int& joined_game);
43 
44  ~mp_lobby();
45 
46  void update_gamelist();
47 
48 protected:
49  void update_visible_games();
50 
51  void update_gamelist_diff();
52 
54 
56 
57  void adjust_game_row_contents(const mp::game_info& game, grid* grid, bool add_callbacks = true);
58 
59 public:
60  void update_playerlist();
61 
62  enum lobby_result {
68  };
69 
70 private:
71  void update_selected_game();
72 
73  /**
74  * Network polling callback
75  */
76  void network_handler();
77 
78  void process_network_data(const config& data);
79 
80  void process_gamelist(const config& data);
81 
82  void process_gamelist_diff(const config& data);
83 
85 
86  /**
87  * Exits the lobby and enters the given game.
88  *
89  * This assembles the game request for the server and handles any applicable
90  * pre-join actions, such as prompting the player for the game's password or
91  * informing them additional content needs installing.
92  *
93  * The lobby window will be closed on completion, assuming an error wasn't
94  * encountered.
95  *
96  * @param game Info on the game we're attempting to join.
97  * @param mode Whether joining as player, observer or whichever works.
98  */
99  void enter_game(const mp::game_info& game, JOIN_MODE mode);
100 
101  /** Entry wrapper for @ref enter_game, where game is located by index. */
102  void enter_game_by_index(const int index, JOIN_MODE mode);
103 
104  /** Entry wrapper for @ref enter_game, where game is located by game id. */
105  void enter_game_by_id(const int game_id, JOIN_MODE mode);
106 
107  /** Enter game by index, where index is the selected game listbox row. */
108  void enter_selected_game(JOIN_MODE mode);
109 
110  void show_help_callback();
111 
113 
114  void show_server_info();
115 
116  void open_profile_url();
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 
126  void user_dialog_callback(const mp::user_info* info);
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(window& window) override;
137 
138  virtual void post_show(window& window) override;
139 
141 
143 
145 
151 
153 
155 
157 
159 
161 
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
void game_filter_keypress_callback(const SDL_Keycode key)
Definition: lobby.cpp:970
static std::string announcements_
Definition: lobby.hpp:182
show_mode mode() const
Returns the dialog mode for this window.
Definition: window.hpp:657
void skip_replay_changed_callback()
Definition: lobby.cpp:1000
field_bool * filter_invert_
Definition: lobby.hpp:149
std::vector< int > gamelist_id_at_row_
Definition: lobby.hpp:171
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:883
std::size_t lobby_update_timer_
Timer for updating the lobby.
Definition: lobby.hpp:169
text_box * filter_text_
Definition: lobby.hpp:152
Specialized field class for boolean.
Definition: field.hpp:488
logger & info()
Definition: log.cpp:182
This class represents the info a client has about a game on the server.
Definition: lobby_data.hpp:65
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
Definition: lobby.cpp:564
static std::string server_information_
Definition: lobby.hpp:181
This class represents the collective information the client has about the players and games on the se...
Definition: lobby_info.hpp:31
std::string_view data
Definition: picture.cpp:206
virtual const std::string & window_id() const override
The ID of the window to build.
void adjust_game_row_contents(const mp::game_info &game, grid *grid, bool add_callbacks=true)
Definition: lobby.cpp:409
static bool logout_prompt()
Definition: lobby.cpp:67
void process_network_data(const config &data)
Definition: lobby.cpp:744
void update_selected_game()
Definition: lobby.cpp:539
void enter_selected_game(JOIN_MODE mode)
Enter game by index, where index is the selected game listbox row.
Definition: lobby.cpp:906
field_bool * filter_ignored_
Definition: lobby.hpp:147
void update_visible_games()
Definition: lobby.cpp:368
Class for a single line text area.
Definition: text_box.hpp:141
Generic file dialog.
The listbox class.
Definition: listbox.hpp:45
Base container class.
Definition: grid.hpp:31
listbox * gamelistbox_
Definition: lobby.hpp:140
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:894
Implements a quit confirmation dialog.
void show_preferences_button_callback()
Definition: lobby.cpp:921
A class that represents a TCP/IP connection to the wesnothd server.
void update_gamelist_filter()
Definition: lobby.cpp:515
void process_gamelist_diff(const config &data)
Definition: lobby.cpp:775
void update_gamelist_diff()
Definition: lobby.cpp:261
lobby_player_list_helper player_list_
Definition: lobby.hpp:156
void tab_switch_callback()
Definition: lobby.cpp:687
Various uncategorised dialogs.
void user_dialog_callback(const mp::user_info *info)
Definition: lobby.cpp:977
void network_handler()
Network polling callback.
Definition: lobby.cpp:708
void enter_game(const mp::game_info &game, JOIN_MODE mode)
Exits the lobby and enters the given game.
Definition: lobby.cpp:797
widget_data make_game_row_data(const mp::game_info &game)
Definition: lobby.cpp:380
unsigned last_lobby_update_
Definition: lobby.hpp:162
mp_lobby(mp::lobby_info &info, wesnothd_connection &connection, int &joined_game)
Definition: lobby.cpp:72
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:72
void process_gamelist(const config &data)
Definition: lobby.cpp:765
bool grid()
Definition: general.cpp:568
This class represents the information a client has about another player.
Definition: lobby_data.hpp:32
field_bool * filter_slots_
Definition: lobby.hpp:148
Abstract base class for all modal dialogs.
wesnothd_connection & network_connection_
Definition: lobby.hpp:166
field_bool * filter_friends_
Definition: lobby.hpp:146
std::map< std::string, widget_item > widget_data
Definition: widget.hpp:35
mp::lobby_info & lobby_info_
Definition: lobby.hpp:142
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:60
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
Definition: lobby.cpp:701
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:66
bool exit_hook(window &window)
Definition: lobby.cpp:559