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
|
/* 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 3 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, see <http://www.gnu.org/licenses/>.
*
*/
//=============================================================================
//
// LogFile, the IOutputHandler implementation that writes to file.
//
// When created LogFile may open file right away or delay doing this.
// In the latter case it will buffer output up to certain size limit.
// When told to open the file, it will first flush its buffer. This allows to
// log events even before the log path is decided (for example, before or
// during reading configuration and/or parsing command line).
//
//=============================================================================
#ifndef AGS_ENGINE_DEBUGGING_LOG_FILE_H
#define AGS_ENGINE_DEBUGGING_LOG_FILE_H
#include "common/std/memory.h"
#include "ags/shared/debugging/output_handler.h"
namespace AGS3 {
namespace AGS {
namespace Shared {
class Stream;
}
namespace Engine {
using Shared::DebugMessage;
using Shared::Stream;
using Shared::String;
class LogFile : public AGS::Shared::IOutputHandler {
public:
enum OpenMode {
kLogFile_Overwrite,
kLogFile_OverwriteAtFirstMessage,
kLogFile_Append
};
public:
LogFile();
void PrintMessage(const Shared::DebugMessage &msg) override;
// Open file using given file path, optionally appending if one exists
//
// TODO: filepath parameter here may be actually used as a pattern
// or prefix, while the actual filename could be made by combining
// this prefix with current date, game name, and similar additional
// useful information. Whether this is to be determined here or on
// high-level side remains a question.
//
bool OpenFile(const String &file_path, OpenMode open_mode = kLogFile_Overwrite);
// Close file
void CloseFile();
private:
std::unique_ptr<Stream> _file;
String _filePath;
OpenMode _openMode;
};
} // namespace Engine
} // namespace AGS
} // namespace AGS3
#endif
|
