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 #pragma once
  23
  24 class BanCacheManager;
  25 class BanItem;
  26 class BufferedSocket;
  27 class Channel;
  28 class Command;
  29 class ConfigReader;
  30 class ConfigTag;
  31 class Extensible;
  32 class FakeUser;
  33 class InspIRCd;
  34 class Invitation;
  35 class InviteBase;
  36 class LocalUser;
  37 class Membership;
  38 class Module;
  39 class OperInfo;
  40 class RemoteUser;
  41 class ServerConfig;
  42 class ServerLimits;
  43 class Thread;
  44 class User;
  45 class XLine;
  46 class XLineManager;
  47 class XLineFactory;
  48 struct ConnectClass;
  49 struct ModResult;
  50
  51 #include "hashcomp.h"
  52 #include "base.h"
  53
  54 typedef TR1NS::unordered_map<std::string, User*, irc::insensitive, irc::StrHashComp> user_hash;
  55 typedef TR1NS::unordered_map<std::string, Channel*, irc::insensitive, irc::StrHashComp> chan_hash;
  56
  57 /** A list holding local users, this is the type of UserManager::local_users
  58  */
  59 typedef std::list<LocalUser*> LocalUserList;
  60
  61 /** A list of failed port bindings, used for informational purposes on startup */
  62 typedef std::vector<std::pair<std::string, std::string> > FailedPortList;
  63
  64 /** 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.
  65  */
  66 typedef std::vector<Invitation*> InviteList;
  67
  68 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
  69  */
  70 typedef std::vector<reference<ConnectClass> > ClassVector;
  71
  72 /** Typedef for the list of user-channel records for a user
  73  */
  74 typedef std::set<Channel*> UserChanList;
  75
  76 /** Shorthand for an iterator into a UserChanList
  77  */
  78 typedef UserChanList::iterator UCListIter;
  79
  80 /** Holds a complete ban list
  81  */
  82 typedef std::vector<BanItem> BanList;
  83
  84 /** A list of custom modes parameters on a channel
  85  */
  86 typedef std::map<char,std::string> CustomModeList;
  87
  88 /** A cached text file stored with its contents as lines
  89  */
  90 typedef std::vector<std::string> file_cache;
  91
  92 /** A configuration key and value pair
  93  */
  94 typedef std::pair<std::string, std::string> KeyVal;
  95
  96 /** The entire configuration
  97  */
  98 typedef std::multimap<std::string, reference<ConfigTag> > ConfigDataHash;
  99
 100 /** Iterator of ConfigDataHash */
 101 typedef ConfigDataHash::const_iterator ConfigIter;
 102 /** Iterator pair, used for tag-name ranges */
 103 typedef std::pair<ConfigIter,ConfigIter> ConfigTagList;
 104
 105 /** Index of valid oper blocks and types */
 106 typedef std::map<std::string, reference<OperInfo> > OperIndex;
 107
 108 /** Files read by the configuration */
 109 typedef std::map<std::string, file_cache> ConfigFileCache;
 110
 111 /** A hash of commands used by the core
 112  */
 113 typedef TR1NS::unordered_map<std::string, Command*> Commandtable;
 114
 115 /** Membership list of a channel */
 116 typedef std::map<User*, Membership*> UserMembList;
 117 /** Iterator of UserMembList */
 118 typedef UserMembList::iterator UserMembIter;
 119 /** const Iterator of UserMembList */
 120 typedef UserMembList::const_iterator UserMembCIter;
 121
 122 /** Generic user list, used for exceptions */
 123 typedef std::set<User*> CUList;
 124
 125 /** A set of strings.
 126  */
 127 typedef std::vector<std::string> string_list;
 128
 129 /** Contains an ident and host split into two strings
 130  */
 131 typedef std::pair<std::string, std::string> IdentHostPair;
 132
 133 /** A map of xline factories
 134  */
 135 typedef std::map<std::string, XLineFactory*> XLineFactMap;
 136
 137 /** A map of XLines indexed by string
 138  */
 139 typedef std::map<irc::string, XLine *> XLineLookup;
 140
 141 /** A map of XLineLookup maps indexed by string
 142  */
 143 typedef std::map<std::string, XLineLookup > XLineContainer;
 144
 145 /** An iterator in an XLineContainer
 146  */
 147 typedef XLineContainer::iterator ContainerIter;
 148
 149 /** An interator in an XLineLookup
 150  */
 151 typedef XLineLookup::iterator LookupIter;