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