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 #ifdef HASHMAP_DEPRECATED
  60         typedef nspace::hash_map<std::string, User*, nspace::insensitive, irc::StrHashComp> user_hash;
  61         typedef nspace::hash_map<std::string, Channel*, nspace::insensitive, irc::StrHashComp> chan_hash;
  62 #else
  63         typedef nspace::hash_map<std::string, User*, nspace::hash<std::string>, irc::StrHashComp> user_hash;
  64         typedef nspace::hash_map<std::string, Channel*, nspace::hash<std::string>, irc::StrHashComp> chan_hash;
  65 #endif
  66
  67 /** A list holding local users, this is the type of UserManager::local_users
  68  */
  69 typedef std::list<LocalUser*> LocalUserList;
  70
  71 /** A list of failed port bindings, used for informational purposes on startup */
  72 typedef std::vector<std::pair<std::string, std::string> > FailedPortList;
  73
  74 /** 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.
  75  */
  76 typedef std::vector<Invitation*> InviteList;
  77
  78 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
  79  */
  80 typedef std::vector<reference<ConnectClass> > ClassVector;
  81
  82 /** Typedef for the list of user-channel records for a user
  83  */
  84 typedef std::set<Channel*> UserChanList;
  85
  86 /** Shorthand for an iterator into a UserChanList
  87  */
  88 typedef UserChanList::iterator UCListIter;
  89
  90 /** Holds a complete ban list
  91  */
  92 typedef std::vector<BanItem> BanList;
  93
  94 /** A list of custom modes parameters on a channel
  95  */
  96 typedef std::map<char,std::string> CustomModeList;
  97
  98 /** A cached text file stored with its contents as lines
  99  */
 100 typedef std::vector<std::string> file_cache;
 101
 102 /** A configuration key and value pair
 103  */
 104 typedef std::pair<std::string, std::string> KeyVal;
 105
 106 /** The entire configuration
 107  */
 108 typedef std::multimap<std::string, reference<ConfigTag> > ConfigDataHash;
 109
 110 /** Iterator of ConfigDataHash */
 111 typedef ConfigDataHash::const_iterator ConfigIter;
 112 /** Iterator pair, used for tag-name ranges */
 113 typedef std::pair<ConfigIter,ConfigIter> ConfigTagList;
 114
 115 /** Index of valid oper blocks and types */
 116 typedef std::map<std::string, reference<OperInfo> > OperIndex;
 117
 118 /** Files read by the configuration */
 119 typedef std::map<std::string, file_cache> ConfigFileCache;
 120
 121 /** A hash of commands used by the core
 122  */
 123 typedef nspace::hash_map<std::string,Command*> Commandtable;
 124
 125 /** Membership list of a channel */
 126 typedef std::map<User*, Membership*> UserMembList;
 127 /** Iterator of UserMembList */
 128 typedef UserMembList::iterator UserMembIter;
 129 /** const Iterator of UserMembList */
 130 typedef UserMembList::const_iterator UserMembCIter;
 131
 132 /** Generic user list, used for exceptions */
 133 typedef std::set<User*> CUList;
 134
 135 /** A set of strings.
 136  */
 137 typedef std::vector<std::string> string_list;
 138
 139 /** Contains an ident and host split into two strings
 140  */
 141 typedef std::pair<std::string, std::string> IdentHostPair;
 142
 143 /** A map of xline factories
 144  */
 145 typedef std::map<std::string, XLineFactory*> XLineFactMap;
 146
 147 /** A map of XLines indexed by string
 148  */
 149 typedef std::map<irc::string, XLine *> XLineLookup;
 150
 151 /** A map of XLineLookup maps indexed by string
 152  */
 153 typedef std::map<std::string, XLineLookup > XLineContainer;
 154
 155 /** An iterator in an XLineContainer
 156  */
 157 typedef XLineContainer::iterator ContainerIter;
 158
 159 /** An interator in an XLineLookup
 160  */
 161 typedef XLineLookup::iterator LookupIter;
 162
 163
 164 #endif
 165