2 * IRC - Internet Relay Chat, include/s_stats.h
3 * Copyright (C) 2000 Joseph Bongaarts
5 * See file AUTHORS in IRC package for additional names of
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 1, or (at your option)
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #ifndef INCLUDED_s_stats_h
26 #define INCLUDED_s_stats_h
27 #ifndef INCLUDED_features_h
28 #include "ircd_features.h"
35 /** Statistics callback function.
36 * @param[in] cptr Client requesting statistics.
37 * @param[in] sd Stats descriptor for request.
38 * @param[in] param Extra parameter from user (may be NULL).
40 typedef void (*StatFunc)(struct Client *cptr, const struct StatDesc *sd, char *param);
42 /** Statistics entry. */
45 char sd_c; /**< stats character (or '\\0') */
46 char *sd_name; /**< full name for stats */
47 unsigned int sd_flags; /**< flags to control the stats */
48 enum Feature sd_control; /**< feature controlling stats */
49 StatFunc sd_func; /**< function to dispatch to */
50 int sd_funcdata; /**< extra data for the function */
51 char *sd_desc; /**< descriptive text */
54 #define STAT_FLAG_OPERONLY 0x01 /**< Oper-only stat */
55 #define STAT_FLAG_OPERFEAT 0x02 /**< Oper-only if the feature is true */
56 #define STAT_FLAG_CASESENS 0x04 /**< Flag is case-sensitive */
57 #define STAT_FLAG_VARPARAM 0x08 /**< May have an extra parameter */
59 extern void stats_init(void);
60 const struct StatDesc *stats_find(const char *name_or_char);
62 #endif /* INCLUDED_s_stats_h */