Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/usability/src/orxonox/ChatHistory.h @ 11476

Last change on this file since 11476 was 7163, checked in by dafrick, 14 years ago

Merged presentation3 branch into trunk.

  • Property svn:eol-style set to native
File size: 3.5 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#include <deque>
30#include <string>
31#include <fstream>
32#include <iostream>
33#include <cassert>
34
35/* define this if you're unit testing */
36//#define CHATTEST
37
38#ifndef CHATTEST
39#include <OrxonoxPrereqs.h>
40#include <PlayerManager.h>
41#include <infos/PlayerInfo.h>
42#include <core/BaseObject.h>
43#include <network/ChatListener.h>
44#include <core/PathConfig.h>
45#include <util/Singleton.h>
46#endif
47
48#ifndef _ChatHistory_H__
49#define _ChatHistory_H__
50
51
52/* Class to implement chat history */
53#ifndef CHATTEST
54namespace orxonox
55{
56#endif
57
58  /* constructor */
59#ifndef CHATTEST
60  class _OrxonoxExport ChatHistory : public ChatListener,
61    public Singleton<ChatHistory>
62
63#else
64  class ChatHistory
65#endif
66  {
67    public:
68      /* constructors, destructors */
69#ifndef CHATTEST
70      ChatHistory();
71      friend class Singleton<ChatHistory>;
72#else
73      ChatHistory();
74#endif
75      virtual ~ChatHistory();
76
77
78    //protected:
79      /** what to do with incoming chat
80       *
81       * \param message The incoming message
82       * \param senderID Identification number of the sender
83       */
84      virtual void incomingChat(const std::string& message,
85        unsigned int senderID);
86
87      /** Synchronize logfile onto the hard drive
88       *
89       * \return 0 for success, other for error
90       */
91      int syncLog();
92
93      /** debug-print: output the whole history to stdout */
94      void debug_printhist();
95
96    private:
97      /* FIELDS */
98      /** Vector to store the history in */
99      std::deque<std::string> hist_buffer;
100
101      /** Maximum number of lines stored in this history */
102      unsigned int hist_maxlines;
103
104      /** is logging enabled? */
105      bool hist_log_enabled;
106
107      /** path of logfile on the file system */
108      std::string hist_logfile_path;
109
110      /** Output file stream for logfile */
111      std::ofstream hist_logfile;
112
113#ifndef CHATTEST
114      static ChatHistory* singletonPtr_s;
115#endif
116
117
118
119      /* METHODS */
120      /** Append line to chat history
121       *
122       * \param toadd The line to add to the history
123       * \return 0 for success, other for error TODO: Throw exception
124       */
125      int chat_hist_addline( const std::string& toadd );
126
127      /** Append line to logfile
128       *
129       * \param toadd The line to add to the logfile
130       * \return 0 for success, other for error TODO: Throw exception
131       */
132      int chat_hist_logline( const std::string& toadd );
133
134      /** open logfile to log to
135       *
136       * \return 0 for success,s other for error
137       */
138      int chat_hist_openlog();
139
140
141      /** close logfile */
142      void chat_hist_closelog();
143  };
144
145#ifndef CHATTEST
146}
147#endif
148
149#endif /* _ChatHistory_H__ */
Note: See TracBrowser for help on using the repository browser.