1 /*

     2  * Hedgewars, a free turn based strategy game

     3  * Copyright (C) 2012 Simeon Maxein <smaxein@googlemail.com>

     4  *

     5  * This program is free software; you can redistribute it and/or

     6  * modify it under the terms of the GNU General Public License

     7  * as published by the Free Software Foundation; either version 2

     8  * of the License, or (at your option) any later version.

     9  *

    10  * This program is distributed in the hope that it will be useful,

    11  * but WITHOUT ANY WARRANTY; without even the implied warranty of

    12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    13  * GNU General Public License for more details.

    14  *

    15  * You should have received a copy of the GNU General Public License

    16  * along with this program; if not, write to the Free Software

    17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    18  */

    19 

    20 /**

    21  * Models the list of rooms on a server for netplay.

    22  */

    23 

    24 #ifndef ROOMLIST_H_

    25 #define ROOMLIST_H_

    26 

    27 #include <stdbool.h>

    28 

    29 typedef struct {

    30     bool inProgress;	// true if the game is running

    31     char *name;

    32     int playerCount;

    33     int teamCount;

    34     char *owner;

    35     char *map;			// This is either a map name, or one of +rnd+, +maze+ or +drawn+.

    36     char *scheme;

    37     char *weapons;

    38 } flib_room;

    39 

    40 typedef struct {

    41 	int roomCount;

    42 	flib_room **rooms;

    43 } flib_roomlist;

    44 

    45 flib_roomlist *flib_roomlist_create();

    46 

    47 void flib_roomlist_destroy(flib_roomlist *list);

    48 

    49 /**

    50  * Insert a new room at the start of the list. The room is defined by the params-array,

    51  * which must consist of 8 non-null strings, as sent by the server in netplay.

    52  *

    53  * Returns 0 on success.

    54  */

    55 int flib_roomlist_add(flib_roomlist *list, char **params);

    56 

    57 /**

    58  * Update the room with the name [name] with parameters sent by the server.

    59  *

    60  * Returns 0 on success.

    61  */

    62 int flib_roomlist_update(flib_roomlist *list, const char *name, char **params);

    63 

    64 /**

    65  * Returns the room with the name [name] from the list if it exists, NULL otherwise

    66  */

    67 flib_room *flib_roomlist_find(const flib_roomlist *list, const char *name);

    68 

    69 /**

    70  * Removes all rooms from the list

    71  */

    72 void flib_roomlist_clear(flib_roomlist *list);

    73 

    74 /**

    75  * Delete the room with the name [name] from the room list.

    76  * Returns 0 on success.

    77  */

    78 int flib_roomlist_delete(flib_roomlist *list, const char *name);

    79 

    80 #endif