mirror of
https://github.com/inspircd/inspircd.git
synced 2025-03-10 11:09:04 -04:00
0556720b55
- Type of the extension used to store data is a template parameter - The extension is automatically unset when the mode is unset - Handlers inheriting from ParamMode have to provide OnSet() and SerializeParam(); may optionally provide OnUnset() - Transparently handle the case when OnSet() modifies the mode parameter - Remove Channel::custom_mode_params map; ask the mode handlers to serialize their parameters instead
76 lines
2.4 KiB
C++
76 lines
2.4 KiB
C++
/*
|
|
* InspIRCd -- Internet Relay Chat Daemon
|
|
*
|
|
* Copyright (C) 2014 Attila Molnar <attilamolnar@hush.com>
|
|
*
|
|
* This file is part of InspIRCd. InspIRCd is free software: you can
|
|
* redistribute it and/or modify it under the terms of the GNU General Public
|
|
* License as published by the Free Software Foundation, version 2.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
|
* details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
|
|
#pragma once
|
|
|
|
class CoreExport ParamModeBase : public ModeHandler
|
|
{
|
|
private:
|
|
virtual void OnUnsetInternal(User* source, Channel* chan) = 0;
|
|
|
|
public:
|
|
ParamModeBase(Module* Creator, const std::string& Name, char modeletter, ParamSpec ps)
|
|
: ModeHandler(Creator, Name, modeletter, ps, MODETYPE_CHANNEL, MC_PARAM) { }
|
|
|
|
ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& param, bool adding) CXX11_OVERRIDE;
|
|
|
|
// Does nothing by default
|
|
void OnUnset(User* source, Channel* chan) { }
|
|
virtual ModeAction OnSet(User* source, Channel* chan, std::string& param) = 0;
|
|
virtual void GetParameter(Channel* chan, std::string& out) = 0;
|
|
};
|
|
|
|
/** Defines a parameter mode
|
|
* T = Child class
|
|
* ExtItemT = Type of the extension item used to store the parameter
|
|
*
|
|
* When unsetting the mode, the extension is automatically unset.
|
|
*/
|
|
template <typename T, typename ExtItemT>
|
|
class ParamMode : public ParamModeBase
|
|
{
|
|
public:
|
|
ExtItemT ext;
|
|
|
|
/**
|
|
* @param Creator Module handling this mode
|
|
* @param Name The internal name of this mode
|
|
* @param modeletter The mode letter of this mode
|
|
* @param ps The parameter type of this mode, one of ParamSpec
|
|
*/
|
|
ParamMode(Module* Creator, const std::string& Name, char modeletter, ParamSpec ps = PARAM_SETONLY)
|
|
: ParamModeBase(Creator, Name, modeletter, ps)
|
|
, ext("parammode_" + Name, Creator)
|
|
{
|
|
}
|
|
|
|
void OnUnsetInternal(User* source, Channel* chan) CXX11_OVERRIDE
|
|
{
|
|
T* mh = static_cast<T*>(this);
|
|
mh->OnUnset(source, chan);
|
|
ext.unset(chan);
|
|
}
|
|
|
|
void GetParameter(Channel* chan, std::string& out) CXX11_OVERRIDE
|
|
{
|
|
T* mh = static_cast<T*>(this);
|
|
mh->SerializeParam(chan, ext.get(chan), out);
|
|
}
|
|
};
|