Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/chat/ChatInputHandler.h @ 9579

Last change on this file since 9579 was 8858, checked in by landauf, 13 years ago

merged output branch back to trunk.

Changes:

  • you have to include util/Output.h instead of util/Debug.h
  • COUT(x) is now called orxout(level)
  • output levels are now defined by an enum instead of numbers. see util/Output.h for the definition
  • it's possible to use output contexts with orxout(level, context). see util/Output.h for some common contexts. you can define more contexts
  • you must use 'endl' at the end of an output message, '\n' does not flush the message

Output levels:

  • instead of COUT(0) use orxout()
  • instead of COUT(1) use orxout(user_error) or orxout(internal_error)
  • instead of COUT(2) use orxout(user_warning) or orxout(internal_warning)
  • instead of COUT(3) use orxout(user_status/user_info) or orxout(internal_status/internal_info)
  • instead of COUT(4) use orxout(verbose)
  • instead of COUT(5) use orxout(verbose_more)
  • instead of COUT(6) use orxout(verbose_ultra)

Guidelines:

  • user_* levels are for the user, visible in the console and the log-file
  • internal_* levels are for developers, visible in the log-file
  • verbose_* levels are for debugging, only visible if the context of the output is activated

Usage in C++:

  • orxout() << "message" << endl;
  • orxout(level) << "message" << endl;
  • orxout(level, context) << "message" << endl;

Usage in Lua:

  • orxout("message")
  • orxout(orxonox.level.levelname, "message")
  • orxout(orxonox.level.levelname, "context", "message")

Usage in Tcl (and in the in-game-console):

  • orxout levelname message
  • orxout_context levelname context message
  • shortcuts: log message, error message, warning message, status message, info message, debug message
  • Property svn:eol-style set to native
File size: 3.8 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 *      Sandro 'smerkli' Merkli
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#ifndef _ChatInputHandler_H__
30#define _ChatInputHandler_H__
31
32#include "OrxonoxPrereqs.h"
33
34#include <string>
35#include <CEGUIForwardRefs.h>
36#include <CEGUIcolour.h>
37
38#include "util/Singleton.h"
39#include "chat/ChatListener.h"
40
41namespace orxonox // tolua_export
42{ // tolua_export
43  /* class to handle chat using an InputBuffer */
44  class _OrxonoxExport ChatInputHandler  // tolua_export
45    : public Singleton<ChatInputHandler>, public ChatListener
46  { // tolua_export
47    private:
48      /** Input buffer, to be used to catch input from the
49       * keyboard
50       */
51      InputBuffer *inpbuf;
52      int disp_offset, width;
53      bool fullchat;
54
55      /* colors for nickname coloring */
56      static const int NumberOfColors = 10;
57      CEGUI::colour text_colors[ NumberOfColors ];
58
59      /** input state */
60      InputState *inputState;
61
62      /** setup input buffer, the constructor calls this */
63      void configureInputBuffer();
64
65      /** adjust display offset depending on cursor position */
66      void sub_adjust_dispoffset( int maxlen, int cursorpos, int inplen );
67
68      /** singleton pointer */
69      static ChatInputHandler* singletonPtr_s;
70
71      /** cegui window handles */
72      CEGUI::Window *input, *inputonly;
73
74      /** cegui handle for the history window */
75      CEGUI::Listbox *lb_history;
76
77      /* methods to deal with colors */
78      void sub_setcolor( CEGUI::ListboxTextItem *tocolor,
79        std::string name );
80
81      void setupColors();
82
83      /* callbacks for input handler */
84      void inputChanged();
85      void addline();
86      void backspace();
87      void deleteChar();
88      void cursorRight();
89      void cursorLeft();
90      void cursorEnd();
91      void cursorHome();
92      void exit();
93
94    public:
95      /** constructor */
96      ChatInputHandler();
97      ~ChatInputHandler();
98      friend class Singleton<ChatInputHandler>;
99
100      static ChatInputHandler& getInstance(void) { return Singleton<ChatInputHandler>::getInstance(); }  // tolua_export
101
102      /** start listening */
103      static void activate_static();
104
105      /** stop listening */
106      static void activate_small_static();
107
108      /** \param message the message text
109       * \param senderID ID of the player who sent the message
110       *
111       * Deal with incoming chat (which means in our case: Add it to the
112       * history window of the full chat window)
113       */
114      void incomingChat(const std::string& message, const std::string& name);
115
116      /** \param full true means show full chat window with history,
117            false means show only an input line
118       *
119       * Show the chat window and redirect the game's keyboard input
120       * into it.
121       */
122      void activate( bool full );
123
124      /** Deactivate the chat window, meaning: hide it. */
125      void deactivate();  // tolua_export
126
127  };  // tolua_export
128
129
130}  // tolua_export
131
132
133#endif /*_ChatInputHandler_H__*/
Note: See TracBrowser for help on using the repository browser.