include/typedefs.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2005, 2008 Craig Edwards <craigedwards@brainbox.cc>
   6  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   7  *
   8  * This file is part of InspIRCd.  InspIRCd is free software: you can
   9  * redistribute it and/or modify it under the terms of the GNU General Public
  10  * License as published by the Free Software Foundation, version 2.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21
  22 #ifndef TYPEDEFS_H
  23 #define TYPEDEFS_H
  24
  25 class BanCacheManager;
  26 class BanItem;
  27 class BufferedSocket;
  28 class Channel;
  29 class Command;
  30 class ConfigReader;
  31 class ConfigTag;
  32 class DNSHeader;
  33 class DNSRequest;
  34 class Extensible;
  35 class FakeUser;
  36 class InspIRCd;
  37 class Invitation;
  38 class InviteBase;
  39 class LocalUser;
  40 class Membership;
  41 class Module;
  42 class OperInfo;
  43 class RemoteUser;
  44 class ServerConfig;
  45 class ServerLimits;
  46 class Thread;
  47 class User;
  48 class UserResolver;
  49 class XLine;
  50 class XLineManager;
  51 class XLineFactory;
  52 struct ConnectClass;
  53 struct ModResult;
  54 struct ResourceRecord;
  55
  56 #include "hashcomp.h"
  57 #include "base.h"
  58
  59 #if defined(WINDOWS) && !defined(HASHMAP_DEPRECATED)
  60         typedef nspace::hash_map<std::string, User*, nspace::hash_compare<std::string, std::less<std::string> > > user_hash;
  61         typedef nspace::hash_map<std::string, Channel*, nspace::hash_compare<std::string, std::less<std::string> > > chan_hash;
  62 #else
  63         #ifdef HASHMAP_DEPRECATED
  64                 typedef nspace::hash_map<std::string, User*, nspace::insensitive, irc::StrHashComp> user_hash;
  65                 typedef nspace::hash_map<std::string, Channel*, nspace::insensitive, irc::StrHashComp> chan_hash;
  66         #else
  67                 typedef nspace::hash_map<std::string, User*, nspace::hash<std::string>, irc::StrHashComp> user_hash;
  68                 typedef nspace::hash_map<std::string, Channel*, nspace::hash<std::string>, irc::StrHashComp> chan_hash;
  69         #endif
  70 #endif
  71
  72 /** A list of failed port bindings, used for informational purposes on startup */
  73 typedef std::vector<std::pair<std::string, std::string> > FailedPortList;
  74
  75 /** Holds a complete list of all channels to which a user has been invited and has not yet joined, and the time at which they'll expire.
  76  */
  77 typedef std::vector<Invitation*> InviteList;
  78
  79 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
  80  */
  81 typedef std::vector<reference<ConnectClass> > ClassVector;
  82
  83 /** Typedef for the list of user-channel records for a user
  84  */
  85 typedef std::set<Channel*> UserChanList;
  86
  87 /** Shorthand for an iterator into a UserChanList
  88  */
  89 typedef UserChanList::iterator UCListIter;
  90
  91 /** Holds a complete ban list
  92  */
  93 typedef std::vector<BanItem> BanList;
  94
  95 /** A list of custom modes parameters on a channel
  96  */
  97 typedef std::map<char,std::string> CustomModeList;
  98
  99 /** A cached text file stored with its contents as lines
 100  */
 101 typedef std::vector<std::string> file_cache;
 102
 103 /** A configuration key and value pair
 104  */
 105 typedef std::pair<std::string, std::string> KeyVal;
 106
 107 /** The entire configuration
 108  */
 109 typedef std::multimap<std::string, reference<ConfigTag> > ConfigDataHash;
 110
 111 /** Iterator of ConfigDataHash */
 112 typedef ConfigDataHash::const_iterator ConfigIter;
 113 /** Iterator pair, used for tag-name ranges */
 114 typedef std::pair<ConfigIter,ConfigIter> ConfigTagList;
 115
 116 /** Index of valid oper blocks and types */
 117 typedef std::map<std::string, reference<OperInfo> > OperIndex;
 118
 119 /** Files read by the configuration */
 120 typedef std::map<std::string, file_cache> ConfigFileCache;
 121
 122 /** A hash of commands used by the core
 123  */
 124 typedef nspace::hash_map<std::string,Command*> Commandtable;
 125
 126 /** Membership list of a channel */
 127 typedef std::map<User*, Membership*> UserMembList;
 128 /** Iterator of UserMembList */
 129 typedef UserMembList::iterator UserMembIter;
 130 /** const Iterator of UserMembList */
 131 typedef UserMembList::const_iterator UserMembCIter;
 132
 133 /** Generic user list, used for exceptions */
 134 typedef std::set<User*> CUList;
 135
 136 /** A set of strings.
 137  */
 138 typedef std::vector<std::string> string_list;
 139
 140 /** Contains an ident and host split into two strings
 141  */
 142 typedef std::pair<std::string, std::string> IdentHostPair;
 143
 144 /** A map of xline factories
 145  */
 146 typedef std::map<std::string, XLineFactory*> XLineFactMap;
 147
 148 /** A map of XLines indexed by string
 149  */
 150 typedef std::map<irc::string, XLine *> XLineLookup;
 151
 152 /** A map of XLineLookup maps indexed by string
 153  */
 154 typedef std::map<std::string, XLineLookup > XLineContainer;
 155
 156 /** An iterator in an XLineContainer
 157  */
 158 typedef XLineContainer::iterator ContainerIter;
 159
 160 /** An interator in an XLineLookup
 161  */
 162 typedef XLineLookup::iterator LookupIter;
 163
 164
 165 #endif
 166