include/modules/names.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2019 Sadie Powell <sadie@witchery.services>
   5  *
   6  * This file is part of InspIRCd.  InspIRCd is free software: you can
   7  * redistribute it and/or modify it under the terms of the GNU General Public
   8  * License as published by the Free Software Foundation, version 2.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  13  * details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19
  20 #pragma once
  21
  22 #include "event.h"
  23
  24 namespace Names
  25 {
  26         class EventListener;
  27 }
  28
  29 class Names::EventListener : public Events::ModuleEventListener
  30 {
  31  public:
  32         EventListener(Module* mod)
  33                 : ModuleEventListener(mod, "event/names")
  34         {
  35         }
  36
  37         /* Called for every item in a NAMES list.
  38          * @param issuer The user who initiated the NAMES request.
  39          * @param memb The channel membership of the user who is being considered for inclusion.
  40          * @param prefixes The prefix character(s) to show in front of the user's nickname.
  41          * @param nick The nickname of the user to show.
  42          * @return Return MOD_RES_PASSTHRU to allow the member to be displayed, MOD_RES_DENY to cause them to be
  43          * excluded from this NAMES list
  44          */
  45         virtual ModResult OnNamesListItem(LocalUser* issuer, Membership* memb, std::string& prefixes, std::string& nick) = 0;
  46 };