/usr/include/ggz_common.h is in libggz-dev 0.0.14.1-1.1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 | /*
* File: ggz_common.h
* Author: GGZ Dev Team
* Project: GGZ Common Library
* Date: 01/13/2002
* $Id: ggz_common.h 9719 2008-02-14 18:20:55Z josef $
*
* This provides GGZ-specific functionality that is common to
* some or all of the ggz-server, game-server, ggz-client, and
* game-client.
*
* Copyright (C) 2002 Brent Hendricks.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef __GGZ_COMMON_H__
#define __GGZ_COMMON_H__
#include <stdbool.h>
#include <sys/types.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/** @brief Seat status values.
*
* Each "seat" at a table of a GGZ game can have one of these values.
* They are used by the GGZ client, GGZ server, and game servers; their
* use in game clients is completely optional.
*/
typedef enum {
GGZ_SEAT_NONE, /**< This seat does not exist. */
GGZ_SEAT_OPEN, /**< The seat is open (unoccupied). */
GGZ_SEAT_BOT, /**< The seat has a bot (AI) in it. */
GGZ_SEAT_PLAYER, /**< The seat has a regular player in it. */
GGZ_SEAT_RESERVED, /**< The seat is reserved for a player. */
GGZ_SEAT_ABANDONED /**< The seat is abandoned by a player. */
} GGZSeatType;
/** @brief Table state values.
*
* GGZ tables take one of the following states. They are used by the
* GGZ client and GGZ server. This is *not* necessarily the same as
* the game state kept by libggzdmod
*/
typedef enum {
GGZ_TABLE_ERROR = -1, /**< There is some error with the table */
GGZ_TABLE_CREATED = 0, /**< Initial created state for the table. */
GGZ_TABLE_WAITING = 1, /**< Waiting for enough players to join before playing */
GGZ_TABLE_PLAYING = 2, /**< Playing a game */
GGZ_TABLE_DONE = 3 /**< The game session is finished and the table will soon exit */
} GGZTableState;
/** @brief Chat types.
*
* Each time we send a chat to the server, it will have one of these
* types associated with it.
* @see ggzcore_room_chat
*/
typedef enum {
/** An unknown/unrecognized chat type - likely either a future chat
* op or a communications error. It can either be ignored or
* handled generically. */
GGZ_CHAT_UNKNOWN,
/** A normal chat, just a message sent to the current room. */
GGZ_CHAT_NORMAL,
/** An announcement, usually triggered with /wall. Only
* admins can do this, and it is announced in all rooms. */
GGZ_CHAT_ANNOUNCE,
/** A beep. We beep a player, and their client will run
* the beep. */
GGZ_CHAT_BEEP,
/** A personal message to another player. It consists of both
* a message and a target player. */
GGZ_CHAT_PERSONAL,
/** A table-wide chat. It goes only to players at the current
* table. */
GGZ_CHAT_TABLE
} GGZChatType;
/** @brief A leave type.
*
* When a player leaves a table, this is a possible reason for the leave.
*/
typedef enum {
/** A normal leave - at user request. */
GGZ_LEAVE_NORMAL,
/** The player has been booted from the table. */
GGZ_LEAVE_BOOT,
/** The game is over; the server exited normally. */
GGZ_LEAVE_GAMEOVER,
/** There was an error in the game server and it was terminated. */
GGZ_LEAVE_GAMEERROR
} GGZLeaveType;
/** @brief Administrative actions.
*
* Administrators or to some extent hosts are able to dissolve player
* problems by several levels of punishment.
*/
typedef enum {
GGZ_ADMIN_GAG, /**< Player chat is ignored by all others */
GGZ_ADMIN_UNGAG, /**< Reversion of temporary gagging */
GGZ_ADMIN_KICK, /**< Player is kicked from the server */
GGZ_ADMIN_BAN, /**< Player banned permanently (unused) */
GGZ_ADMIN_UNKNOWN /**< Invalid admin type */
} GGZAdminType;
/** @brief A player type.
*
* The server will tell the client the type of each player.
*/
typedef enum {
/** A normal player is registered but has no special permission. */
GGZ_PLAYER_NORMAL,
/** A guest player is not registered. */
GGZ_PLAYER_GUEST,
/* An admin player is registered and has all special permissions. */
GGZ_PLAYER_ADMIN,
/* A host player is registered and has a few special permissions. */
GGZ_PLAYER_HOST,
/* A bot is a special type of player. */
GGZ_PLAYER_BOT,
/* This is an unknown type of player. */
GGZ_PLAYER_UNKNOWN
} GGZPlayerType;
/** @brief Get a string identifier for the GGZSeatType.
*
* This returns a pointer to a static string describing the given seat type.
* It is useful for text-based communications protocols and debugging
* output.
* @param type The GGZSeatType, which determines the string returned.
* @note This is the inverse of ggz_string_to_seattype.
*/
const char *ggz_seattype_to_string(GGZSeatType type);
/** @brief Get a GGZSeatType for the given string identifier.
*
* This returns a GGZSeatType that is associated with the given string
* description.
* @param type_str A string describing a GGZSeatType.
* @note If the type_str cannot be parsed GGZ_SEAT_NONE may be returned.
* @note This is the inverse of ggz_seattype_to_string.
*/
GGZSeatType ggz_string_to_seattype(const char *type_str);
/** @brief Get a string identifier for the GGZChatType.
*
* This returns a pointer to a static string describing the given chat
* opcode. It is useful for text-based communications protocols and
* debugging output.
* @param op The GGZChatType, which determines the string returned.
* @note This is the inverse of ggz_string_to_chattype.
*/
const char *ggz_chattype_to_string(GGZChatType type);
/** @brief Get a GGZChatType for the given string identifier.
*
* This returns a GGZChatType that is associated with the given string
* description.
* @param type_str A string describing a GGZChatType.
* @note If the op_str cannot be parsed GGZ_CHAT_NORMAL will be returned.
* @note This is the inverse of ggz_chattype_to_string.
*/
GGZChatType ggz_string_to_chattype(const char *type_str);
/** @brief Get a GGZLeaveType for the given string identifier.
*
* This returns a pointer to a static string describing the given chat
* opcode. It is useful for text-based communications protocols and
* debugging output.
* @param op The GGZLeaveType, which determines thee string returned.
* @note This is the inverse of ggz_string_to_leavetype.
*/
const char *ggz_leavetype_to_string(GGZLeaveType type);
/** @brief Get a GGZLeaveType for the given string identifier.
*
* This returns a GGZLeaveType that is associated with the given string
* description.
* @param type_str A string describing a GGZLeaveType.
* @note If the op_str cannot be parsed GGZ_LEAVE_GAMEERROR will be returned.
* @note This is the inverse of ggz_leavetype_to_string.
*/
GGZLeaveType ggz_string_to_leavetype(const char *type_str);
/** @brief Get a GGZPlayerType for the given string identifier.
*
* This returns a pointer to a static string describing the given player
* type. It is useful for text-based communications protocols and
* debugging output.
* @param type the GGZPlayerType, which determines the string returned.
* @note This is the inverse of ggz_string_to_playertype. */
const char *ggz_playertype_to_string(GGZPlayerType type);
/** @brief Get a GGZPlayerType for the given string identifier.
*
* This returns a GGZPlayerType that is associated with the given string
* description.
* @param type_str A string describing a GGZPlayerType.
* @note If the type_str cannot be parsed GGZ_PLAYER_GUEST will be returned.
* @note This is the inverse of ggz_playertype_to_string.
*/
GGZPlayerType ggz_string_to_playertype(const char *type_str);
/** @brief Get a string identifier for the GGZAdminType.
*
* This returns a pointer to a static string describing the given admin
* action. It is useful for text-based communications protocols and
* debugging output.
* @param op The GGZAdminType, which determines the string returned.
* @note This is the inverse of ggz_string_to_admintype.
*/
const char *ggz_admintype_to_string(GGZAdminType type);
/** @brief Get a GGZAdminType for the given string identifier.
*
* This returns a GGZAdminType that is associated with the given string
* description.
* @param type_str A string describing a GGZAdminType.
* @note This is the inverse of ggz_admintype_to_string.
*/
GGZAdminType ggz_string_to_admintype(const char *type_str);
/** @brief Convert a string to a boolean.
*
* The string should contain "true" or "false".
* @param str The string in question.
* @param dflt The default, if the string is unreadible or NULL.
* @return The boolean value.
*/
int str_to_bool(const char *str, int dflt);
/** @brief Convert a boolean value to a string.
*
* @param bool_value A boolean value.
* @return "true" or "false", as appropriate.
*/
char *bool_to_str(int bool_val);
/**
* @defgroup numberlist Number lists
*
* These functions provide a method for storing and retrieving a simple list
* of positive integers. The list must follow a very restrictive form:
* each value within [1..32] may be included explicitly in the list. Higher
* values may only be included as the part of a single given range [x..y].
*/
/** @brief The number list type. */
typedef struct {
int values;
int min, max;
} GGZNumberList;
/** @brief Return an empty number list. */
GGZNumberList ggz_numberlist_new(void);
/** @brief Read a number list from a text string.
*
* The string is comprised of a list of values (in the range 1..32)
* separated by spaces, followed by an optional range (separated by "..").
* Examples: "2 3 4", "2..4", "1..1000", "2, 3, 10 15-50"
*/
GGZNumberList ggz_numberlist_read(const char* text);
/** @brief Write a number list to a ggz-malloc'd text string. */
char *ggz_numberlist_write(GGZNumberList *list);
/** @brief Check to see if the given value is set in the number list. */
int ggz_numberlist_isset(const GGZNumberList *list, int value);
/** @brief Return the largest value in the set. */
int ggz_numberlist_get_max(const GGZNumberList *list);
/** }@ */
/*
* GGZ Protocols - used by the GGZ server and client.
* These should perhaps go in ggz_protocols.h
*/
/* Changing anything below may require bumping up the protocol version.
* Experiment at your own risk. */
/* Error opcodes. */
typedef enum {
E_NO_STATUS = 1, /* internal placeholder; a statusless event */
E_OK = 0, /* No error */
E_USR_LOOKUP = -1,
E_BAD_OPTIONS = -2,
E_ROOM_FULL = -3,
E_TABLE_FULL = -4,
E_TABLE_EMPTY = -5,
E_LAUNCH_FAIL = -6,
E_JOIN_FAIL = -7,
E_NO_TABLE = -8,
E_LEAVE_FAIL = -9,
E_LEAVE_FORBIDDEN = -10,
E_ALREADY_LOGGED_IN = -11,
E_NOT_LOGGED_IN = -12,
E_NOT_IN_ROOM = -13,
E_AT_TABLE = -14,
E_IN_TRANSIT = -15,
E_NO_PERMISSION = -16,
E_BAD_XML = -17,
E_SEAT_ASSIGN_FAIL = -18,
E_NO_CHANNEL = -19,
E_TOO_LONG = -20,
E_UNKNOWN = -21,
E_BAD_USERNAME = -22,
E_USR_TYPE = -23,
E_USR_FOUND = -24,
E_USR_TAKEN = -25,
E_BAD_PASSWORD = -26
} GGZClientReqError;
/** @brief Get a string identifier for the GGZClientReqError.
*
* This returns a pointer to a static string describing the given status.
* It is useful for text-based communications protocols and debugging
* output.
* @param err The GGZClientReqError, which determines the string returned.
* @note This is the inverse of ggz_string_to_error.
*/
const char *ggz_error_to_string(GGZClientReqError err);
/** @brief Get a GGZClientReqError for the given string identifier.
*
* This returns a GGZClientLeaveType that is associated with the given string
* description.
* @param err_str A string describing a GGZClientReqEerror.
* @note If the err_str cannot be parsed E_UNKNOWN will be returned.
* @note This is the inverse of ggz_error_to_string.
*/
GGZClientReqError ggz_string_to_error(const char *err_str);
/**
* @defgroup perms Player permissions
*
* These definitions and functions provide a set of permissions that GGZ
* players may have.
*/
/** @brief Boolean permissions for GGZ players. */
typedef enum {
GGZ_PERM_JOIN_TABLE, /**< Can join a table */
GGZ_PERM_LAUNCH_TABLE, /**< Can launch a new table */
GGZ_PERM_ROOMS_LOGIN, /**< Can enter login-only rooms */
GGZ_PERM_ROOMS_ADMIN, /**< Can enter admin-only rooms */
GGZ_PERM_CHAT_ANNOUNCE, /**< Can make announcements */
GGZ_PERM_CHAT_BOT, /**< Player is a known bot */
GGZ_PERM_NO_STATS, /**< No stats for this player. */
GGZ_PERM_EDIT_TABLES, /**< Can edit tables. */
GGZ_PERM_TABLE_PRIVMSG, /**< Can send private messages at a table */
GGZ_PERM_COUNT /**< Placeholder */
} GGZPerm;
/** @brief A permission set (bitfield) contains all perms for one player. */
typedef unsigned int GGZPermset;
/** @brief Return true if the perm set qualifies the player as a 'host' */
bool ggz_perms_is_host(GGZPermset perms);
/** @brief Return true if the perm set qualifies the player as a 'bot' */
bool ggz_perms_is_bot(GGZPermset perms);
/** @brief Return true if the perm set qualifies the player as an 'admin' */
bool ggz_perms_is_admin(GGZPermset perms);
/** @brief Initialize the perm set from the given list array. */
void ggz_perms_init_from_list(GGZPermset *perms,
GGZPerm *list, size_t listsz);
/** @brief Sets/clears the given permission.
* @param perms The permissions set to modify.
* @param perm The permission in the set to change.
* @param value Whether to set or clear the permission from the set. */
void ggz_perms_set(GGZPermset *perms, GGZPerm perm, bool val);
/** @brief Return true if the permissions is in the set. */
bool ggz_perms_is_set(GGZPermset perms, GGZPerm perm);
/** @brief Get a string identifier for the GGZPerm.
*
* This returns a pointer to a static string describing the given permission.
* It is useful for text-based communications protocols and debugging
* output.
* @param perm The GGZPerm, which determines the string returned.
* @note This is the inverse of ggz_string_to_perm.
*/
const char *ggz_perm_to_string(GGZPerm perm);
/** @brief Get a GGZPerm for the given string identifier.
*
* This returns a GGZPerm that is associated with the given string
* description.
* @param perm_str A string describing a GGZPerm.
* @note If the perm_str cannot be parsed GGZ_PERM_COUNT may be returned.
* @note This is the inverse of ggz_perm_to_string.
*/
GGZPerm ggz_string_to_perm(const char *perm_str);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* __GGZ_COMMON_H__ */
|