ChannelAwareness

Implements *channel awareness* in a plugin module.

This maintains a cache of all current channels, their topics and modes, and their participants. The cache kept is an associative array, in IRCPluginState.channels.

Channel awareness explicitly requires user awareness and will halt compilation if it is not also mixed in.

@safe

mixin template ChannelAwareness (

ChannelPolicy channelPolicy = ChannelPolicy.home

Flag!"debug_" debug_ = No.debug_

string module_ = __MODULE__

) {

struct IRCEvent via import dialect.defs : IRCEvent;;

mixintemplate MixinConstraints(MixinScope mixinScope, string mixinName = "a constrained mixin") via import lu.traits : MixinConstraints, MixinScope;;

enum MixinScope via import lu.traits : MixinConstraints, MixinScope;;

package

enum hasChannelAwareness;

static if(!__traits(compiles, ))

enum pattern;

static if(!__traits(compiles, ))

enum message;

void onChannelAwarenessSelfjoinMixin(IRCPlugin plugin, IRCEvent event);

void onChannelAwarenessSelfpartMixin(IRCPlugin plugin, IRCEvent event);

void onChannelAwarenessJoinMixin(IRCPlugin plugin, IRCEvent event);

void onChannelAwarenessPartMixin(IRCPlugin plugin, IRCEvent event);

void onChannelAwarenessNickMixin(IRCPlugin plugin, IRCEvent event);

void onChannelAwarenessQuitMixin(IRCPlugin plugin, IRCEvent event);

void onChannelAwarenessTopicMixin(IRCPlugin plugin, IRCEvent event);

void onChannelAwarenessCreationTimeMixin(IRCPlugin plugin, IRCEvent event);

void onChannelAwarenessModeMixin(IRCPlugin plugin, IRCEvent event);

void onChannelAwarenessWhoReplyMixin(IRCPlugin plugin, IRCEvent event);

void onChannelAwarenessNamesReplyMixin(IRCPlugin plugin, IRCEvent event);

void onChannelAwarenessModeListsMixin(IRCPlugin plugin, IRCEvent event);

void onChannelAwarenessChannelModeIsMixin(IRCPlugin plugin, IRCEvent event);

}

Members

Functions

onChannelAwarenessChannelModeIsMixin void onChannelAwarenessChannelModeIsMixin(IRCPlugin plugin, IRCEvent event): Proxies to onChannelAwarenessChannelModeIs.
onChannelAwarenessCreationTimeMixin void onChannelAwarenessCreationTimeMixin(IRCPlugin plugin, IRCEvent event): Proxies to onChannelAwarenessCreationTime.
onChannelAwarenessJoinMixin void onChannelAwarenessJoinMixin(IRCPlugin plugin, IRCEvent event): Proxies to onChannelAwarenessJoin.
onChannelAwarenessModeListsMixin void onChannelAwarenessModeListsMixin(IRCPlugin plugin, IRCEvent event): Proxies to onChannelAwarenessModeLists.
onChannelAwarenessModeMixin void onChannelAwarenessModeMixin(IRCPlugin plugin, IRCEvent event): Proxies to onChannelAwarenessMode.
onChannelAwarenessNamesReplyMixin void onChannelAwarenessNamesReplyMixin(IRCPlugin plugin, IRCEvent event): Proxies to onChannelAwarenessNamesReply.
onChannelAwarenessNickMixin void onChannelAwarenessNickMixin(IRCPlugin plugin, IRCEvent event): Proxies to onChannelAwarenessNick.
onChannelAwarenessPartMixin void onChannelAwarenessPartMixin(IRCPlugin plugin, IRCEvent event): Proxies to onChannelAwarenessPart.
onChannelAwarenessQuitMixin void onChannelAwarenessQuitMixin(IRCPlugin plugin, IRCEvent event): Proxies to onChannelAwarenessQuit.
onChannelAwarenessSelfjoinMixin void onChannelAwarenessSelfjoinMixin(IRCPlugin plugin, IRCEvent event): Proxies to onChannelAwarenessSelfjoin.
onChannelAwarenessSelfpartMixin void onChannelAwarenessSelfpartMixin(IRCPlugin plugin, IRCEvent event): Proxies to onChannelAwarenessSelfpart.
onChannelAwarenessTopicMixin void onChannelAwarenessTopicMixin(IRCPlugin plugin, IRCEvent event): Proxies to onChannelAwarenessTopic.
onChannelAwarenessWhoReplyMixin void onChannelAwarenessWhoReplyMixin(IRCPlugin plugin, IRCEvent event): Proxies to onChannelAwarenessWhoReply.

Manifest constants

hasChannelAwareness enum hasChannelAwareness;: Flag denoting that ChannelAwareness has been mixed in.

Parameters

channelPolicy: What ChannelPolicy to apply to enwrapped event handlers.
debug_: Whether or not to include debugging output.
module_: String name of the mixing-in module; generally leave as-is.

ChannelAwareness

Members

Functions

Manifest constants

Parameters

See Also