[12177] | 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 | |
---|
| 41 | #include "util/Singleton.h" |
---|
| 42 | #include "core/BaseObject.h" |
---|
| 43 | #include "chat/ChatListener.h" |
---|
| 44 | #include "infos/PlayerInfo.h" |
---|
| 45 | #include "PlayerManager.h" |
---|
| 46 | #endif |
---|
| 47 | |
---|
| 48 | #ifndef _ChatHistory_H__ |
---|
| 49 | #define _ChatHistory_H__ |
---|
| 50 | |
---|
| 51 | |
---|
| 52 | /* Class to implement chat history */ |
---|
| 53 | #ifndef CHATTEST |
---|
| 54 | namespace 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 name Name of the sender |
---|
| 83 | */ |
---|
| 84 | virtual void incomingChat(const std::string& message, const std::string& name) override; |
---|
| 85 | |
---|
| 86 | /** Synchronize logfile onto the hard drive |
---|
| 87 | * |
---|
| 88 | * \return 0 for success, other for error |
---|
| 89 | */ |
---|
| 90 | int syncLog(); |
---|
| 91 | |
---|
| 92 | /** debug-print: output the whole history to stdout */ |
---|
| 93 | void debug_printhist(); |
---|
| 94 | |
---|
| 95 | private: |
---|
| 96 | /* FIELDS */ |
---|
| 97 | /** Vector to store the history in */ |
---|
| 98 | std::deque<std::string> hist_buffer; |
---|
| 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 */ |
---|
| 110 | std::ofstream hist_logfile; |
---|
| 111 | |
---|
| 112 | #ifndef CHATTEST |
---|
| 113 | static ChatHistory* singletonPtr_s; |
---|
| 114 | #endif |
---|
| 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(); |
---|
| 138 | |
---|
| 139 | |
---|
| 140 | /** close logfile */ |
---|
| 141 | void chat_hist_closelog(); |
---|
| 142 | }; |
---|
| 143 | |
---|
| 144 | #ifndef CHATTEST |
---|
| 145 | } |
---|
| 146 | #endif |
---|
| 147 | |
---|
| 148 | #endif /* _ChatHistory_H__ */ |
---|