aboutsummaryrefslogtreecommitdiff
path: root/backends/log/log.cpp
blob: e37296aada3b5b5ba49ddc6d611e667ebffe480e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#include "backends/log/log.h"

#include "common/stream.h"
#include "common/str.h"
#include "common/system.h"

#include "base/version.h"

namespace Backends {
namespace Log {

Log::Log(OSystem *system)
    : _system(system), _stream(0), _startOfLine(true) {
	assert(system);
}

void Log::open(Common::WriteStream *stream) {
	// Close the previous log
	close();

	_stream = stream;

	// Output information about the ScummVM version at the start of the log
	// file
	print(gScummVMFullVersion);
	print("\n");
	print(gScummVMFeatures);
	print("\n");
	print("--- Log opened.\n");
	_startOfLine = true;
}

void Log::close() {
	if (_stream) {
		// Output a message to indicate that the log was closed successfully
		print("--- Log closed successfully.\n");

		delete _stream;
		_stream = 0;
	}
}

void Log::print(const char *message, const bool printTime) {
	if (!_stream)
		return;

	while (*message) {
		if (_startOfLine) {
			_startOfLine = false;
			if (printTime)
				printTimeStamp();
		}

		const char *msgStart = message;
		// scan for end of line/string
		while (*message && *message != '\n')
			++message;

		if (*message == '\n') {
			++message;
			_startOfLine = true;
		}

		// TODO: It might be wise to check for write errors and/or incomplete
		// writes here, since losing certain bits of the log is not nice.
		_stream->write(msgStart, message - msgStart);
	}

	_stream->flush();
}

void Log::printTimeStamp() {
	TimeDate date;
	int curMonth;
	_system->getTimeAndDate(date);
	curMonth = date.tm_mon + 1; // month is base 0, we need base 1 (1 = january and so on)

	_stream->writeString(Common::String::format("[%d-%02d-%02d %02d:%02d:%02d] ",
	                     date.tm_year + 1900, curMonth, date.tm_mday,
	                     date.tm_hour, date.tm_min, date.tm_sec));
}

} // End of namespace Log
} // End of namespace Backends