Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/chat/ChatHistory.h @ 12394

Last change on this file since 12394 was 11099, checked in by muemart, 9 years ago

Fix loads of doxygen warnings and other documentation issues

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