mirror of
https://github.com/libretro/scummvm.git
synced 2025-02-13 15:40:57 +00:00
ec24687ce4
Adding @defgroup and @ingroup doxygen tags into all headers in the common folder that contain doxygen blocks. This improves the structure, readability, and findability of information in the resulting output. This commit targets purely structure and does not deal with the content of the currently existing doxygen documentation.
93 lines
2.5 KiB
C++
93 lines
2.5 KiB
C++
/* 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.
|
|
*
|
|
*/
|
|
|
|
#ifndef COMMON_CONSOLE_H
|
|
#define COMMON_CONSOLE_H
|
|
|
|
#include "common/scummsys.h"
|
|
|
|
namespace Common {
|
|
|
|
/**
|
|
* @defgroup common_text_console Text console
|
|
* @ingroup common
|
|
*
|
|
* @brief Output formatter, typically used for debugging.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* 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
|