Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/particleeffects/src/libraries/core/command/IRC.h @ 8740

Last change on this file since 8740 was 7401, checked in by landauf, 14 years ago

merged doc branch back to trunk

  • Property svn:eol-style set to native
File size: 2.6 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file
31    @ingroup Command Tcl
32    @brief Declaration of IRC helper class, used for IRC connections using Tcl.
33*/
34
35#ifndef _IRC_H__
36#define _IRC_H__
37
38#include "core/CorePrereqs.h"
39
40#include <string>
41
42namespace orxonox
43{
44    /**
45        @brief The IRC class creates a Tcl-thread (see TclThreadManager) and connects to an IRC server.
46        It provides different console commands to send messages and to perform other actions on the IRC server.
47    */
48    class _CoreExport IRC
49    {
50        public:
51            static IRC& getInstance();
52
53            static void say(const std::string& message);
54            static void msg(const std::string& channel, const std::string& message);
55            static void nick(const std::string& nickname);
56
57            static void tcl_say(Tcl::object const &channel, Tcl::object const &nick, Tcl::object const &args);
58            static void tcl_privmsg(Tcl::object const &query, Tcl::object const &nick, Tcl::object const &args);
59            static void tcl_action(Tcl::object const &channel, Tcl::object const &nick, Tcl::object const &args);
60            static void tcl_info(Tcl::object const &channel, Tcl::object const &args);
61
62        private:
63            static bool eval(const std::string& command);
64            void initialize();
65
66            IRC();
67            IRC(const IRC& other);              ///< Copy-constructor: Not implemented
68            ~IRC() {}                           ///< Destructor
69
70            Tcl::interpreter* interpreter_;     ///< The Tcl interpreter that is used for the IRC connection
71            std::string nickname_;              ///< The user's nickname on the IRC server
72    };
73}
74
75#endif /* _IRC_H__ */
Note: See TracBrowser for help on using the repository browser.