2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001-2015 Alexander Barton (alex@barton.de) and Contributors.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 * Please read the file COPYING, README and AUTHORS for more information.
12 #ifndef __irc_macros_h__
13 #define __irc_macros_h__
17 * Macros for functions that handle IRC commands.
21 * Make sure that number of passed parameters is equal to Count.
23 * If there are not exactly Count parameters, send an error to the client and
24 * return from the function.
26 #define _IRC_ARGC_EQ_OR_RETURN_(Client, Req, Count) \
27 if (Req->argc != Count) { \
28 return IRC_WriteErrClient(Client, ERR_NEEDMOREPARAMS_MSG, \
29 Client_ID(Client), Req->command); \
33 * Make sure that number of passed parameters is less or equal than Max.
35 * If there are more than Max parameters, send an error to the client and
36 * return from the function.
38 #define _IRC_ARGC_LE_OR_RETURN_(Client, Req, Max) \
39 if (Req->argc > Max) { \
40 return IRC_WriteErrClient(Client, ERR_NEEDMOREPARAMS_MSG, \
41 Client_ID(Client), Req->command); \
45 * Make sure that number of passed parameters is greater or equal than Min.
47 * If there aren't at least Min parameters, send an error to the client and
48 * return from the function.
50 #define _IRC_ARGC_GE_OR_RETURN_(Client, Req, Min) \
51 if (Req->argc < Min) { \
52 return IRC_WriteErrClient(Client, ERR_NEEDMOREPARAMS_MSG, \
53 Client_ID(Client), Req->command); \
57 * Make sure that number of passed parameters is in between Min and Max.
59 * If there aren't at least Min parameters or if there are more than Max
60 * parameters, send an error to the client and return from the function.
62 #define _IRC_ARGC_BETWEEN_OR_RETURN_(Client, Req, Min, Max) \
63 if (Req->argc < Min || Req->argc > Max) { \
64 return IRC_WriteErrClient(Client, ERR_NEEDMOREPARAMS_MSG, \
65 Client_ID(Client), Req->command); \
69 * Make sure that the command has a prefix.
71 * If there is no prefix, send an error to the client and return from
74 #define _IRC_REQUIRE_PREFIX_OR_RETURN_(Client, Req) \
76 return IRC_WriteErrClient(Client, ERR_NEEDMOREPARAMS_MSG, \
77 Client_ID(Client), Req->command); \
81 * Get sender of an IRC command.
83 * The sender is either stored in the prefix if the command has been
84 * received from a server or set to the client. If the sender is invalid,
85 * send an error to the client and return from the function.
87 #define _IRC_GET_SENDER_OR_RETURN_(Sender, Req, Client) \
88 if (Client_Type(Client) == CLIENT_SERVER) { \
90 return IRC_WriteErrClient(Client, ERR_NEEDMOREPARAMS_MSG, \
91 Client_ID(Client), Req->command); \
92 Sender = Client_Search(Req->prefix); \
96 return IRC_WriteErrClient(Client, ERR_NOSUCHNICK_MSG, \
98 Req->prefix ? Req->prefix : "(none)");
101 * Get target of an IRC command and make sure that it is a server.
103 * Set the target to the local server if no target parameter is given in the
104 * received command, and send an error to the client and return from the
105 * function if the given target isn't resolvable to a server: the target
106 * parameter can be a server name, a nick name (then the target is set to
107 * the server to which this nick is connected), or a mask matching at least
108 * one server name in the network.
110 #define _IRC_GET_TARGET_SERVER_OR_RETURN_(Target, Req, Argc, From) \
111 if (Req->argc > Argc) { \
112 Target = Client_Search(Req->argv[Argc]); \
114 Target = Client_SearchServer(Req->argv[Argc]); \
116 return IRC_WriteErrClient(From, ERR_NOSUCHSERVER_MSG, \
117 Client_ID(From), Req->argv[Argc]); \
118 if (Client_Type(Target) != CLIENT_SERVER) \
119 Target = Client_Introducer(Target); \
121 Target = Client_ThisServer();
123 #endif /* __irc_macros_h__ */