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