Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/gamecontent/src/orxonox/chat/ChatHistory.cc @ 9193

Last change on this file since 9193 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: 4.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 "ChatHistory.h"
30#include "util/ScopedSingletonManager.h"
31
32#ifndef CHATTEST
33namespace orxonox
34{
35  /* singleton */
36  ManageScopedSingleton( ChatHistory, ScopeID::Root, false );
37#endif
38
39  /* constructor */
40#ifndef CHATTEST
41  //ChatHistory::ChatHistory( BaseObject* creator ) : BaseObject(creator)
42  ChatHistory::ChatHistory()
43#else
44  ChatHistory::ChatHistory()
45#endif
46  {
47    /* register the object */
48#ifndef CHATTEST
49    RegisterObject(ChatHistory);
50#endif
51
52    this->hist_log_enabled = true;
53
54    /* Read setting for logfiles */
55    if( hist_log_enabled ) /* NOTE Make this a check for the logfile setting */
56    { this->chat_hist_openlog();
57
58      /* push starting line */
59      this->chat_hist_logline( "--- Logfile opened ---" );
60    }
61
62    /* Read setting for maximum number of lines and set limit */
63    this->hist_maxlines = 200; /* NOTE to be changed, 200 is just for testing */
64  }
65
66  /* destructor */
67  ChatHistory::~ChatHistory()
68  {
69    chat_hist_closelog();
70
71    /* clear list */
72    this->hist_buffer.clear();
73  }
74
75  /* react to incoming chat */
76  void ChatHistory::incomingChat(const std::string& message, const std::string& /*name*/)
77  {
78    /* add the line to the history */
79    this->chat_hist_addline( message );
80
81    /* add the line to the log */
82    this->chat_hist_logline( message );
83  }
84
85  /* Synchronize logfile onto the hard drive */ /* MARK MARK */
86  int ChatHistory::syncLog()
87  {
88    //if( this->hist_logfile )
89      //this->hist_logfile.sync();
90    return 0;
91  }
92
93  /* add a line to this history */
94  int ChatHistory::chat_hist_addline( const std::string& toadd )
95  {
96    /* crop history at the end if it's too large */
97    while( this->hist_buffer.size() > this->hist_maxlines+1 )
98      this->hist_buffer.pop_front();
99
100    /* push to the front of the history */
101    this->hist_buffer.push_back( toadd );
102    return 0;
103  }
104
105  /* log a line to a logfile */
106  int ChatHistory::chat_hist_logline( const std::string& toadd )
107  {
108    /* output the line to the file if logging is enabled */
109    if( this->hist_log_enabled )
110      this->hist_logfile << toadd << endl;
111    return 0;
112  }
113
114  /* open logfile */
115  int ChatHistory::chat_hist_openlog()
116  {
117    /* TODO: find out the name of the file to log to via settings
118     *       and set the this->hist_logfile_path variable to it
119     */
120#ifndef CHATTEST
121    this->hist_logfile.open( (PathConfig::getInstance().getLogPathString() +
122      "chatlog.log").c_str(),
123      std::fstream::out | std::fstream::app );
124#else
125    this->hist_logfile.open( "/tmp/chatlog.log",
126      std::fstream::out | std::fstream::app );
127#endif
128
129    /* TODO check whether this works (not sure how you'd like it?) */
130    if( !this->hist_logfile )
131    { this->hist_log_enabled = false;
132#ifndef CHATTEST
133      orxout(internal_warning) << "Could not open logfile." << endl;
134#endif
135    }
136
137    /* if it worked */
138    return 0;
139  }
140
141  /* close logfile */
142  void ChatHistory::chat_hist_closelog()
143  {
144    /* see if we've actually got a logfile */
145    if( this->hist_logfile )
146    {
147      /* yes, we've got one, add a line that shows we're closing it */
148      this->chat_hist_logline( "--- Logfile closed ---" );
149
150      /* actually close down the file */
151      this->hist_logfile.close();
152    }
153  }
154
155  /* output history for debugging */
156  void ChatHistory::debug_printhist()
157  {
158    /* create deque iterator */
159    std::deque<std::string>::iterator it;
160
161    /* output all the strings */
162    for( it = this->hist_buffer.begin(); it != this->hist_buffer.end();
163      ++it )
164      orxout(debug_output) << *it << endl;
165
166    /* output size */
167    orxout(debug_output) << "Size: " << hist_buffer.size() << endl;
168  }
169
170#ifndef CHATTEST
171}
172#endif
Note: See TracBrowser for help on using the repository browser.