summaryrefslogtreecommitdiff
path: root/include/snomasks.h
diff options
context:
space:
mode:
authorpeavey <peavey@e03df62e-2008-0410-955e-edbf42e46eb7>2007-07-16 17:14:45 +0000
committerpeavey <peavey@e03df62e-2008-0410-955e-edbf42e46eb7>2007-07-16 17:14:45 +0000
commitbab14f0dd2345c9d7dcbc47c918563709e1ac094 (patch)
tree753a23cfc9fc08c6697e80b3e686f074aa911d85 /include/snomasks.h
parent3abff3a37550cc1d88dd4d1fd7ed526e89309a53 (diff)
'svn propset -R svn:eol-style CR *' Set to UNIX-style always. Binaries are auto skipped by svn.
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@7454 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'include/snomasks.h')
-rw-r--r--include/snomasks.h86
1 files changed, 1 insertions, 85 deletions
diff --git a/include/snomasks.h b/include/snomasks.h
index db8be55f8..b318fdc26 100644
--- a/include/snomasks.h
+++ b/include/snomasks.h
@@ -1,85 +1 @@
-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
- *
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
- *
- * This program is free but copyrighted software; see
- * the file COPYING for details.
- *
- * ---------------------------------------------------
- */
-
-#ifndef __SNOMASKS_H__
-#define __SNOMASKS_H__
-
-#include <string>
-#include <vector>
-#include <map>
-#include "configreader.h"
-#include "inspircd.h"
-
-/** A list of snomasks which are valid, and their descriptive texts
- */
-typedef std::map<char, std::string> SnoList;
-
-/** Snomask manager handles routing of SNOMASK (usermode +n) messages to opers.
- * Modules and the core can enable and disable snomask characters. If they do,
- * then sending snomasks using these characters becomes possible.
- */
-class CoreExport SnomaskManager : public Extensible
-{
- private:
- /** Creator/owner
- */
- InspIRCd* ServerInstance;
- /** Currently active snomask list
- */
- SnoList SnoMasks;
- /** Set up the default (core available) snomask chars
- */
- void SetupDefaults();
- public:
- /** Create a new SnomaskManager
- */
- SnomaskManager(InspIRCd* Instance);
- /** Delete SnomaskManager
- */
- ~SnomaskManager();
-
- /** Enable a snomask.
- * @param letter The snomask letter to enable. Once enabled,
- * server notices may be routed to users with this letter in
- * their list, and users may add this letter to their list.
- * @param description The descriptive text sent along with any
- * server notices, at the start of the notice, e.g. "GLOBOPS".
- * @return True if the snomask was enabled, false if it already
- * exists.
- */
- bool EnableSnomask(char letter, const std::string &description);
- /** Disable a snomask.
- * @param letter The snomask letter to disable.
- * @return True if the snomask was disabled, false if it didn't
- * exist.
- */
- bool DisableSnomask(char letter);
- /** Write to all users with a given snomask.
- * @param letter The snomask letter to write to
- * @param text The text to send to the users
- */
- void WriteToSnoMask(char letter, const std::string &text);
- /** Write to all users with a given snomask.
- * @param letter The snomask letter to write to
- * @param text A format string containing text to send
- * @param ... Format arguments
- */
- void WriteToSnoMask(char letter, const char* text, ...);
- /** Check if a snomask is enabled.
- * @param letter The snomask letter to check.
- * @return True if the snomask has been enabled.
- */
- bool IsEnabled(char letter);
-};
-
-#endif
+/* +------------------------------------+ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * * InspIRCd: (C) 2002-2007 InspIRCd Development Team * See: http://www.inspircd.org/wiki/index.php/Credits * * This program is free but copyrighted software; see * the file COPYING for details. * * --------------------------------------------------- */ #ifndef __SNOMASKS_H__ #define __SNOMASKS_H__ #include <string> #include <vector> #include <map> #include "configreader.h" #include "inspircd.h" /** A list of snomasks which are valid, and their descriptive texts */ typedef std::map<char, std::string> SnoList; /** Snomask manager handles routing of SNOMASK (usermode +n) messages to opers. * Modules and the core can enable and disable snomask characters. If they do, * then sending snomasks using these characters becomes possible. */ class CoreExport SnomaskManager : public Extensible { private: /** Creator/owner */ InspIRCd* ServerInstance; /** Currently active snomask list */ SnoList SnoMasks; /** Set up the default (core available) snomask chars */ void SetupDefaults(); public: /** Create a new SnomaskManager */ SnomaskManager(InspIRCd* Instance); /** Delete SnomaskManager */ ~SnomaskManager(); /** Enable a snomask. * @param letter The snomask letter to enable. Once enabled, * server notices may be routed to users with this letter in * their list, and users may add this letter to their list. * @param description The descriptive text sent along with any * server notices, at the start of the notice, e.g. "GLOBOPS". * @return True if the snomask was enabled, false if it already * exists. */ bool EnableSnomask(char letter, const std::string &description); /** Disable a snomask. * @param letter The snomask letter to disable. * @return True if the snomask was disabled, false if it didn't * exist. */ bool DisableSnomask(char letter); /** Write to all users with a given snomask. * @param letter The snomask letter to write to * @param text The text to send to the users */ void WriteToSnoMask(char letter, const std::string &text); /** Write to all users with a given snomask. * @param letter The snomask letter to write to * @param text A format string containing text to send * @param ... Format arguments */ void WriteToSnoMask(char letter, const char* text, ...); /** Check if a snomask is enabled. * @param letter The snomask letter to check. * @return True if the snomask has been enabled. */ bool IsEnabled(char letter); }; #endif \ No newline at end of file