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
|
/* 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.
*
* $URL$
* $Id$
*/
#ifndef COMMON_CONSOLE_H
#define COMMON_CONSOLE_H
#include "common/scummsys.h"
namespace Common {
/**
* An output formatter takes a source string and 'decorates' it with
* extra information, storing the result in a destination buffer.
* A typical use is to (optionally) enhance the output given by
* the error() and debug() functions with extra information on
* the state of the active engine.
*/
typedef void (*OutputFormatter)(char *dst, const char *src, size_t dstSize);
/**
* Set the output formatter used by error().
*/
void setErrorOutputFormatter(OutputFormatter f);
/**
* A callback which is invoked by error() just before aborting.
* A typical example would be a function which shows a debug
* console and displays the given message in it.
*/
typedef void (*ErrorHandler)(const char *msg);
/**
* Set a callback that is invoked by error() after the error
* message has been printed, but before the application is
* terminated.
* This can be used to e.g. show a debugger console.
*/
void setErrorHandler(ErrorHandler handler);
} // End of namespace Common
void NORETURN_PRE error(const char *s, ...) GCC_PRINTF(1, 2) NORETURN_POST;
#ifdef DISABLE_TEXT_CONSOLE
inline void warning(const char *s, ...) {}
#else
/**
* Print a warning message to the text console (stderr).
* Automatically prepends the text "WARNING: " and appends
* an exclamation mark and a newline.
*/
void warning(const char *s, ...) GCC_PRINTF(1, 2);
#endif
#endif
|
