dxx-rebirth/common/include/dxxerror.h

105 lines
3.6 KiB
C

/*
* Portions of this file are copyright Rebirth contributors and licensed as
* described in COPYING.txt.
* Portions of this file are copyright Parallax Software and licensed
* according to the Parallax license below.
* See COPYING.txt for license details.
THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
SOFTWARE CORPORATION ("PARALLAX"). PARALLAX, IN DISTRIBUTING THE CODE TO
END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
IN USING, DISPLAYING, AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
FREE PURPOSES. IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES. THE END-USER UNDERSTANDS
AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
COPYRIGHT 1993-1998 PARALLAX SOFTWARE CORPORATION. ALL RIGHTS RESERVED.
*/
/*
*
* Header for error handling/printing/exiting code
*
*/
#pragma once
#include <stdio.h>
#include "dxxsconf.h"
#include <assert.h>
#include "fmtcheck.h"
#ifdef __cplusplus
#ifdef __GNUC__
#define __noreturn __attribute__ ((noreturn))
#else
#define __noreturn
#endif
int error_init(void (*func)(const char *)); //init error system, returns 0=ok
void Warning_puts(const char *str) __attribute_nonnull();
void Warning(const char *fmt,...) __attribute_format_printf(1, 2); //print out warning message to user
#define Warning(F,...) dxx_call_printf_checked(Warning,Warning_puts,(),(F),##__VA_ARGS__)
void set_warn_func(void (*f)(const char *s));//specifies the function to call with warning messages
void clear_warn_func();//say this function no longer valid
void Error_puts(const char *func, unsigned line, const char *str) __noreturn __attribute_nonnull();
#define Error_puts(F) Error_puts(__func__, __LINE__,F)
void Error(const char *func, unsigned line, const char *fmt,...) __noreturn __attribute_format_printf(3, 4); //exit with error code=1, print message
#define Error(F,...) dxx_call_printf_checked(Error,(Error_puts),(__func__, __LINE__),(F),##__VA_ARGS__)
void UserError_puts(const char *str) __noreturn __attribute_nonnull();
void UserError(const char *fmt, ...) __noreturn __attribute_format_printf(1, 2);
#define UserError(F,...) dxx_call_printf_checked(UserError,(UserError_puts),(),(F),##__VA_ARGS__)
#define Assert assert
/* Compatibility with x86-specific name */
#define Int3() d_debugbreak()
#ifndef NDEBUG //macros for debugging
# define DXX_ENABLE_DEBUGBREAK_TRAP
#endif
/* Allow macro override */
#if defined(DXX_ENABLE_DEBUGBREAK_TRAP) && !defined(DXX_DEBUGBREAK_TRAP)
#if defined __clang__
/* Must be first, since clang also defines __GNUC__ */
# define DXX_DEBUGBREAK_TRAP() __builtin_debugtrap()
#elif defined __GNUC__
# if defined(__i386__) || defined(__amd64__)
# define DXX_DEBUGBREAK_TRAP() __asm__ __volatile__("int3" ::: "cc", "memory")
# endif
#elif defined _MSC_VER
# define DXX_DEBUGBREAK_TRAP() __debugbreak()
#endif
#ifndef DXX_DEBUGBREAK_TRAP
# if defined __unix__
/* for raise */
# include <signal.h>
# define DXX_DEBUGBREAK_TRAP() raise(SIGTRAP)
# elif defined __GNUC__
/* May terminate execution */
# define DXX_DEBUGBREAK_TRAP() __builtin_trap()
# endif
#endif
#endif
// Encourage optimizer to treat d_debugbreak paths as unlikely
__attribute_cold
// Requested by btb to force Xcode to stay in the calling function
__attribute_always_inline()
static inline void d_debugbreak()
{
/* Allow explicit activation in NDEBUG builds */
#ifdef DXX_DEBUGBREAK_TRAP
DXX_DEBUGBREAK_TRAP();
#endif
}
#endif