mirror of
https://github.com/scp-fs2open/fs2open.github.com.git
synced 2026-11-10 12:41:35 -10:00
asarium
575091aea4
This also changes the lables on the dialog to make sense and also unifies Int3 behavior by using a function provided by SDL.
83 lines
3.0 KiB
C++
83 lines
3.0 KiB
C++
|
|
#ifndef _OSAPI_DIALOGS_H
|
|
#define _OSAPI_DIALOGS_H
|
|
#pragma once
|
|
|
|
#include "globalincs/pstypes.h"
|
|
|
|
struct lua_State;
|
|
|
|
namespace os
|
|
{
|
|
namespace dialogs
|
|
{
|
|
/**
|
|
* @brief Displays an assert message.
|
|
* @note Used by Assert() and Assertion() to display an error message, should not be used directly
|
|
*
|
|
* @param text The text to display
|
|
* @param filename The source code filename where this function was called
|
|
* @param linenum The source code line number where this function was called
|
|
* @param format An optional message to display in addition to the specified text
|
|
*/
|
|
void AssertMessage(const char* text, const char* filename, int linenum,
|
|
const char* format = nullptr, ...);
|
|
|
|
/**
|
|
* @brief Shows a lua error.
|
|
* This captures the current state of the given lua_State and displays a dialog describing the error.
|
|
* If @c format is @c nullptr this function pops a string from the top of the lua stack and uses that as the error message.
|
|
* @param L The lua_State to capture the state of
|
|
* @param format The error message to display, may be @c nullptr
|
|
*/
|
|
void LuaError(lua_State *L, const char *format = nullptr, ...);
|
|
|
|
/**
|
|
* @brief Shows an error dialog.
|
|
* Only use this function if the program is in an unrecoverable state because of invalid user data, programming errors should
|
|
* be handled with Assert() and Assertion(). This function usually doesn't return as the generated error is considered fatal.
|
|
*
|
|
* @param filename The source code filename where this function was called
|
|
* @param line The source code line number where this function was called
|
|
* @param format The error message to display (a format string)
|
|
*/
|
|
void Error(const char* filename, int line, const char* format, ...);
|
|
|
|
/**
|
|
* @brief Shows an error dialog.
|
|
* This is a more general version of Error(const char*,int,const char*,...) that only displays the dialog.
|
|
*
|
|
* @param text The text to display
|
|
*/
|
|
void Error(const char* text);
|
|
|
|
/**
|
|
* @brief Shows a warning dialog.
|
|
* A warning should be generated if a recoverable user data error was detected. This function is only enabled in debug builds.
|
|
*
|
|
* @param filename The source code filename where this function was called
|
|
* @param line The source code line number where this function was called
|
|
* @param format The message to display
|
|
*/
|
|
void Warning(const char* filename, int line, const char* format, ...);
|
|
|
|
/**
|
|
* @brief Shows an extra warning.
|
|
* Same as Warning(const char*,int,const char*) but only Cmdline_extra_warn is set to @c 1.
|
|
*
|
|
* @param filename The source code filename where this function was called
|
|
* @param line The source code line number where this function was called
|
|
* @param format The message to display
|
|
*/
|
|
void WarningEx(const char* filename, int line, const char* format, ...);
|
|
}
|
|
}
|
|
|
|
// Make these available in the global namespace for compatibility
|
|
using os::dialogs::LuaError;
|
|
using os::dialogs::Error;
|
|
using os::dialogs::Warning;
|
|
using os::dialogs::WarningEx;
|
|
|
|
#endif // _OSAPI_DIALOGS_H
|