The Battle for Wesnoth  1.19.1+dev
lobby_info.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 
18 #include "config.hpp"
20 
21 #include <boost/dynamic_bitset.hpp>
22 
23 
24 namespace mp
25 {
26 /**
27  * This class represents the collective information the client has
28  * about the players and games on the server
29  */
31 {
32 public:
33  lobby_info();
34 
35  typedef std::map<int, game_info> game_info_map;
36 
37  /** Process a full game list. Current info is discarded. */
38  void process_gamelist(const config& data);
39 
40  /**
41  * Process a gamelist diff.
42  *
43  * @param data Raw game list data, usually received from the MP server.
44  *
45  * @returns True on success, false on failure (e.g. when the diff did
46  * not apply correctly).
47  */
48  bool process_gamelist_diff(const config& data);
49 
50  /**
51  * Updates the game pointer list and returns a second stage cleanup function to be
52  * called after any actions have been done using the pointer list.
53  */
54  std::function<void()> begin_state_sync();
55 
56  /** Returns the raw game list config data. */
57  const config& gamelist() const
58  {
59  return gamelist_;
60  }
61 
62  using game_filter_func = std::function<bool(const game_info&)>;
63 
64  /** Adds a new filter function to be considered when @ref apply_game_filter is called. */
66  {
67  game_filters_.push_back(func);
68  }
69 
70  /** Clears all game filter functions. */
72  {
73  game_filters_.clear();
74  }
75 
76  /** Sets whether the result of each game filter should be inverted. */
77  void set_game_filter_invert(std::function<bool(bool)> value)
78  {
79  game_filter_invert_ = value;
80  }
81 
82  /** Returns whether the game would be visible after the game filters are applied */
83  bool is_game_visible(const game_info&);
84 
85  /** Generates a new list of games that match the current filter functions and inversion setting. */
86  void apply_game_filter();
87 
88  /** Returns info on a game with the given game ID. */
89  game_info* get_game_by_id(int id);
90 
91  /** Const overload of @ref get_game_by_id. */
92  const game_info* get_game_by_id(int id) const;
93 
94  /** Returns info on the user with the given name, or nullptr if they don't eixst. */
95  user_info* get_user(const std::string& name);
96 
97  const std::vector<game_info*>& games() const
98  {
99  return games_;
100  }
101 
102  const boost::dynamic_bitset<>& games_visibility() const
103  {
104  return games_visibility_;
105  }
106 
107  const std::vector<user_info>& users() const
108  {
109  return users_;
110  }
111 
112  std::vector<user_info>& users()
113  {
114  return users_;
115  }
116 
117  bool gamelist_initialized() const
118  {
119  return gamelist_initialized_;
120  }
121 
123 
124 private:
126 
127  void process_userlist();
128 
129  /**
130  * Generates a new vector of game pointers from the ID/game map.
131  * The games will be referenced in ascending order by ID.
132  */
133  void make_games_vector();
134 
135  std::vector<std::string> installed_addons_;
136 
138 
140 
142 
143  std::vector<game_info*> games_;
144 
145  std::vector<user_info> users_;
146 
147  std::vector<game_filter_func> game_filters_;
148 
149  std::function<bool(bool)> game_filter_invert_;
150 
151  boost::dynamic_bitset<> games_visibility_;
152 };
153 
154 enum class notify_mode {
155  none,
156  message,
159  own_nick,
161  whisper,
163  lobby_join,
164  lobby_quit,
166 };
167 
168 void do_notify(notify_mode mode, const std::string& sender = "", const std::string& message = "");
169 }
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:159
This class represents the collective information the client has about the players and games on the se...
Definition: lobby_info.hpp:31
std::function< bool(bool)> game_filter_invert_
Definition: lobby_info.hpp:149
void add_game_filter(game_filter_func func)
Adds a new filter function to be considered when apply_game_filter is called.
Definition: lobby_info.hpp:65
void set_game_filter_invert(std::function< bool(bool)> value)
Sets whether the result of each game filter should be inverted.
Definition: lobby_info.hpp:77
void process_userlist()
Definition: lobby_info.cpp:222
std::function< bool(const game_info &)> game_filter_func
Definition: lobby_info.hpp:62
bool gamelist_initialized_
Definition: lobby_info.hpp:139
bool is_game_visible(const game_info &)
Returns whether the game would be visible after the game filters are applied.
Definition: lobby_info.cpp:325
void clear_game_filters()
Clears all game filter functions.
Definition: lobby_info.hpp:71
std::vector< user_info > & users()
Definition: lobby_info.hpp:112
bool process_gamelist_diff_impl(const config &data)
Definition: lobby_info.cpp:145
const config & gamelist() const
Returns the raw game list config data.
Definition: lobby_info.hpp:57
void process_gamelist(const config &data)
Process a full game list.
Definition: lobby_info.cpp:114
bool process_gamelist_diff(const config &data)
Process a gamelist diff.
Definition: lobby_info.cpp:134
void refresh_installed_addons_cache()
Definition: lobby_info.cpp:48
std::function< void()> begin_state_sync()
Updates the game pointer list and returns a second stage cleanup function to be called after any acti...
Definition: lobby_info.cpp:255
game_info * get_game_by_id(int id)
Returns info on a game with the given game ID.
Definition: lobby_info.cpp:287
bool gamelist_initialized() const
Definition: lobby_info.hpp:117
game_info_map games_by_id_
Definition: lobby_info.hpp:141
void make_games_vector()
Generates a new vector of game pointers from the ID/game map.
Definition: lobby_info.cpp:310
std::vector< user_info > users_
Definition: lobby_info.hpp:145
user_info * get_user(const std::string &name)
Returns info on the user with the given name, or nullptr if they don't eixst.
Definition: lobby_info.cpp:299
const std::vector< game_info * > & games() const
Definition: lobby_info.hpp:97
std::vector< game_info * > games_
Definition: lobby_info.hpp:143
boost::dynamic_bitset games_visibility_
Definition: lobby_info.hpp:151
std::map< int, game_info > game_info_map
Definition: lobby_info.hpp:35
void apply_game_filter()
Generates a new list of games that match the current filter functions and inversion setting.
Definition: lobby_info.cpp:336
const boost::dynamic_bitset & games_visibility() const
Definition: lobby_info.hpp:102
const std::vector< user_info > & users() const
Definition: lobby_info.hpp:107
std::vector< game_filter_func > game_filters_
Definition: lobby_info.hpp:147
std::vector< std::string > installed_addons_
Definition: lobby_info.hpp:135
Main entry points of multiplayer mode.
Definition: lobby_data.cpp:49
void do_notify(notify_mode mode, const std::string &sender, const std::string &message)
Definition: lobby_info.cpp:56
notify_mode
Definition: lobby_info.hpp:154
std::string_view data
Definition: picture.cpp:194
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