The Battle for Wesnoth  1.15.12+dev
lobby_info.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2009 - 2018 by Tomasz Sniatowski <kailoran@gmail.com>
3  Part of the Battle for Wesnoth Project https://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 
15 #pragma once
16 
17 #include "config.hpp"
19 
20 #include <boost/dynamic_bitset.hpp>
21 
22 #include <memory>
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  explicit lobby_info(const std::vector<std::string>& installed_addons);
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  bool process_gamelist_diff_impl(const config& data);
51 
53 
54  /**
55  * Generates a new vector of game pointers from the ID/game map.
56  * The games will be referenced in ascending order by ID.
57  */
58  void make_games_vector();
59 
60  /** Returns the raw game list config data. */
61  const config& gamelist() const
62  {
63  return gamelist_;
64  }
65 
66  using game_filter_func = std::function<bool(const game_info&)>;
67 
68  /** Adds a new filter function to be considered when @ref apply_game_filter is called. */
70  {
71  game_filters_.push_back(func);
72  }
73 
74  /** Clears all game filter functions. */
76  {
77  game_filters_.clear();
78  }
79 
80  /** Sets whether the result of each game filter should be inverted. */
81  void set_game_filter_invert(bool value)
82  {
83  game_filter_invert_ = value;
84  }
85 
86  /** Returns whether the game would be visible after the game filters are applied */
87  bool is_game_visible(const game_info&);
88 
89  /** Generates a new list of games that match the current filter functions and inversion setting. */
90  void apply_game_filter();
91 
92  /** Returns info on a game with the given game ID. */
93  game_info* get_game_by_id(int id);
94 
95  /** Const overload of @ref get_game_by_id. */
96  const game_info* get_game_by_id(int id) const;
97 
98  /** Returns info on the user with the given name, or nullptr if they don't eixst. */
99  user_info* get_user(const std::string& name);
100 
101  void update_user_statuses(int game_id, const room_info* room);
102 
103  const std::vector<game_info*>& games() const
104  {
105  return games_;
106  }
107 
108  const boost::dynamic_bitset<>& games_visibility() const
109  {
110  return games_visibility_;
111  }
112 
113  const std::vector<user_info>& users() const
114  {
115  return users_;
116  }
117 
118  std::vector<user_info>& users()
119  {
120  return users_;
121  }
122 
123  bool gamelist_initialized() const
124  {
125  return gamelist_initialized_;
126  }
127 
128  void set_installed_addons(const std::vector<std::string>& new_list)
129  {
130  installed_addons_ = new_list;
131  }
132 
133 private:
134  void process_userlist();
135 
136  std::vector<std::string> installed_addons_;
137 
139 
141 
142  game_info_map games_by_id_;
143 
144  std::vector<game_info*> games_;
145 
146  std::vector<user_info> users_;
147 
148  std::vector<game_filter_func> game_filters_;
149 
151 
152  boost::dynamic_bitset<> games_visibility_;
153 };
154 
156 {
157 public:
158  /** Open a new chat room with the given name. */
159  void open_room(const std::string& name);
160 
161  /** Close the chat room with the given name. */
162  void close_room(const std::string& name);
163 
164  /** Returns whether a room with the given name has been opened. */
165  bool has_room(const std::string& name) const;
166 
167  /** Returns info on room with the given name, or nullptr if it doesn't exist. */
168  room_info* get_room(const std::string& name);
169 
170  /** Const overload of @ref get_room. */
171  const room_info* get_room(const std::string& name) const;
172 
173  chat_session& get_whisper_log(const std::string& name)
174  {
175  return whispers_[name];
176  }
177 
178  const std::map<std::string, room_info>& rooms() const
179  {
180  return rooms_;
181  }
182 
183 private:
184  std::map<std::string, room_info> rooms_;
185 
186  std::map<std::string, chat_session> whispers_;
187 };
188 
201 };
202 
203 void do_notify(notify_mode mode, const std::string& sender = "", const std::string& message = "");
204 }
const config & gamelist() const
Returns the raw game list config data.
Definition: lobby_info.hpp:61
user_info * get_user(const std::string &name)
Returns info on the user with the given name, or nullptr if they don&#39;t eixst.
Definition: lobby_info.cpp:308
bool is_game_visible(const game_info &)
Returns whether the game would be visible after the game filters are applied.
Definition: lobby_info.cpp:346
This class represents the info a client has about a game on the server.
Definition: lobby_data.hpp:141
std::map< int, game_info > game_info_map
Definition: lobby_info.hpp:35
void update_user_statuses(int game_id, const room_info *room)
Definition: lobby_info.cpp:375
This class represents the collective information the client has about the players and games on the se...
Definition: lobby_info.hpp:30
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:69
std::vector< game_filter_func > game_filters_
Definition: lobby_info.hpp:148
Definitions for the interface to Wesnoth Markup Language (WML).
this class memorizes a chat session.
Definition: lobby_data.hpp:42
void process_gamelist(const config &data)
Process a full game list.
Definition: lobby_info.cpp:109
void apply_game_filter()
Generates a new list of games that match the current filter functions and inversion setting...
Definition: lobby_info.cpp:364
std::vector< std::string > installed_addons_
Definition: lobby_info.hpp:136
void set_installed_addons(const std::vector< std::string > &new_list)
Definition: lobby_info.hpp:128
game_info * get_game_by_id(int id)
Returns info on a game with the given game ID.
Definition: lobby_info.cpp:273
void make_games_vector()
Generates a new vector of game pointers from the ID/game map.
Definition: lobby_info.cpp:331
Main entry points of multiplayer mode.
Definition: lobby_data.cpp:51
void do_notify(notify_mode mode, const std::string &sender, const std::string &message)
Definition: lobby_info.cpp:51
chat_session & get_whisper_log(const std::string &name)
Definition: lobby_info.hpp:173
boost::dynamic_bitset games_visibility_
Definition: lobby_info.hpp:152
void sync_games_display_status()
Definition: lobby_info.cpp:252
std::vector< std::string > installed_addons()
Retrieves the names of all installed add-ons.
Definition: manager.cpp:177
void set_game_filter_invert(bool value)
Sets whether the result of each game filter should be inverted.
Definition: lobby_info.hpp:81
game_info_map games_by_id_
Definition: lobby_info.hpp:142
bool gamelist_initialized_
Definition: lobby_info.hpp:140
const boost::dynamic_bitset & games_visibility() const
Definition: lobby_info.hpp:108
std::vector< user_info > & users()
Definition: lobby_info.hpp:118
const std::vector< game_info * > & games() const
Definition: lobby_info.hpp:103
std::function< bool(const game_info &)> game_filter_func
Definition: lobby_info.hpp:66
bool gamelist_initialized() const
Definition: lobby_info.hpp:123
This class represents the information a client has about a room.
Definition: lobby_data.hpp:67
bool game_filter_invert_
Definition: lobby_info.hpp:150
void clear_game_filter()
Clears all game filter functions.
Definition: lobby_info.hpp:75
bool process_gamelist_diff(const config &data)
Process a gamelist diff.
Definition: lobby_info.cpp:129
lobby_info(const std::vector< std::string > &installed_addons)
Definition: lobby_info.cpp:38
void process_userlist()
Definition: lobby_info.cpp:217
This class represents the information a client has about another player.
Definition: lobby_data.hpp:104
std::map< std::string, room_info > rooms_
Definition: lobby_info.hpp:184
notify_mode
Definition: lobby_info.hpp:189
const std::vector< user_info > & users() const
Definition: lobby_info.hpp:113
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:59
std::vector< user_info > users_
Definition: lobby_info.hpp:146
std::vector< game_info * > games_
Definition: lobby_info.hpp:144
bool process_gamelist_diff_impl(const config &data)
Definition: lobby_info.cpp:140
std::map< std::string, chat_session > whispers_
Definition: lobby_info.hpp:186
const std::map< std::string, room_info > & rooms() const
Definition: lobby_info.hpp:178