Author: Kev <klmitch@mit.edu>
[ircu2.10.12-pk.git] / include / s_stats.h
1 /*
2  * IRC - Internet Relay Chat, include/s_stats.h
3  * Copyright (C) 2000 Joseph Bongaarts
4  *
5  * See file AUTHORS in IRC package for additional names of
6  * the programmers.
7  *
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)
11  * any later version.
12  *
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.
17  *
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.
21  *
22  * $Id$
23  */
24
25 #ifndef INCLUDED_s_stats_h
26 #define INCLUDED_s_stats_h
27 #ifndef INCLUDED_features_h
28 #include "ircd_features.h"
29 #endif
30
31 struct Client;
32
33 struct StatDesc;
34
35 /* Source of /stats, stats descriptor, stats char, extra param (might be 0) */
36 typedef void (*StatFunc)(struct Client *, struct StatDesc *, int, char *);
37
38 struct StatDesc
39 {
40   char         sd_c;           /* stats character */
41   unsigned int sd_flags;       /* flags to control the stats */
42   enum Feature sd_control;     /* feature controlling stats */
43   StatFunc     sd_func;        /* function to dispatch to */
44   int          sd_funcdata;    /* extra data for the function */
45   char        *sd_desc;        /* descriptive text */
46 };
47
48 #define STAT_FLAG_OPERONLY 0x01    /* Oper-only stat */
49 #define STAT_FLAG_OPERFEAT 0x02    /* Oper-only if the feature is true */
50 #define STAT_FLAG_CASESENS 0x04    /* Flag is case-sensitive */
51 #define STAT_FLAG_VARPARAM 0x08    /* may have an extra parameter */
52
53 extern struct StatDesc statsinfo[];
54 extern struct StatDesc *statsmap[];
55
56 extern void stats_init(void);
57
58 #endif /* INCLUDED_s_stats_h */