362 lines
11 KiB
C
362 lines
11 KiB
C
|
/*
|
||
|
|
File: CAXException.h
|
||
|
|
Abstract: Part of CoreAudio Utility Classes
|
||
|
|
Version: 1.1
|
||
|
|
|
||
|
|
Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple
|
||
|
|
Inc. ("Apple") in consideration of your agreement to the following
|
||
|
|
terms, and your use, installation, modification or redistribution of
|
||
|
|
this Apple software constitutes acceptance of these terms. If you do
|
||
|
|
not agree with these terms, please do not use, install, modify or
|
||
|
|
redistribute this Apple software.
|
||
|
|
|
||
|
|
In consideration of your agreement to abide by the following terms, and
|
||
|
|
subject to these terms, Apple grants you a personal, non-exclusive
|
||
|
|
license, under Apple's copyrights in this original Apple software (the
|
||
|
|
"Apple Software"), to use, reproduce, modify and redistribute the Apple
|
||
|
|
Software, with or without modifications, in source and/or binary forms;
|
||
|
|
provided that if you redistribute the Apple Software in its entirety and
|
||
|
|
without modifications, you must retain this notice and the following
|
||
|
|
text and disclaimers in all such redistributions of the Apple Software.
|
||
|
|
Neither the name, trademarks, service marks or logos of Apple Inc. may
|
||
|
|
be used to endorse or promote products derived from the Apple Software
|
||
|
|
without specific prior written permission from Apple. Except as
|
||
|
|
expressly stated in this notice, no other rights or licenses, express or
|
||
|
|
implied, are granted by Apple herein, including but not limited to any
|
||
|
|
patent rights that may be infringed by your derivative works or by other
|
||
|
|
works in which the Apple Software may be incorporated.
|
||
|
|
|
||
|
|
The Apple Software is provided by Apple on an "AS IS" basis. APPLE
|
||
|
|
MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
|
||
|
|
THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
|
||
|
|
FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
|
||
|
|
OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
|
||
|
|
|
||
|
|
IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
|
||
|
|
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||
|
|
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||
|
|
INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
|
||
|
|
MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
|
||
|
|
AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
|
||
|
|
STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
|
||
|
|
POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
|
||
|
|
Copyright (C) 2014 Apple Inc. All Rights Reserved.
|
||
|
|
|
||
|
|
*/
|
||
|
|
#ifndef __CAXException_h__
|
||
|
|
#define __CAXException_h__
|
||
|
|
|
||
|
|
#if !defined(__COREAUDIO_USE_FLAT_INCLUDES__)
|
||
|
|
#include <CoreFoundation/CoreFoundation.h>
|
||
|
|
#else
|
||
|
|
#include <ConditionalMacros.h>
|
||
|
|
#include <CoreFoundation.h>
|
||
|
|
#endif
|
||
|
|
#include "CADebugMacros.h"
|
||
|
|
#include <ctype.h>
|
||
|
|
//#include <stdio.h>
|
||
|
|
#include <string.h>
|
||
|
|
|
||
|
|
|
||
|
|
class CAX4CCString {
|
||
|
|
public:
|
||
|
|
CAX4CCString(OSStatus error) {
|
||
|
|
// see if it appears to be a 4-char-code
|
||
|
|
UInt32 beErr = CFSwapInt32HostToBig(error);
|
||
|
|
char *str = mStr;
|
||
|
|
memcpy(str + 1, &beErr, 4);
|
||
|
|
if (isprint(str[1]) && isprint(str[2]) && isprint(str[3]) && isprint(str[4])) {
|
||
|
|
str[0] = str[5] = '\'';
|
||
|
|
str[6] = '\0';
|
||
|
|
} else if (error > -200000 && error < 200000)
|
||
|
|
// no, format it as an integer
|
||
|
|
snprintf(str, sizeof(mStr), "%d", (int)error);
|
||
|
|
else
|
||
|
|
snprintf(str, sizeof(mStr), "0x%x", (int)error);
|
||
|
|
}
|
||
|
|
const char *get() const { return mStr; }
|
||
|
|
operator const char *() const { return mStr; }
|
||
|
|
private:
|
||
|
|
char mStr[16];
|
||
|
|
};
|
||
|
|
|
||
|
|
class CAX4CCStringNoQuote {
|
||
|
|
public:
|
||
|
|
CAX4CCStringNoQuote(OSStatus error) {
|
||
|
|
// see if it appears to be a 4-char-code
|
||
|
|
UInt32 beErr = CFSwapInt32HostToBig(error);
|
||
|
|
char *str = mStr;
|
||
|
|
memcpy(str, &beErr, 4);
|
||
|
|
if (isprint(str[0]) && isprint(str[1]) && isprint(str[2]) && isprint(str[3])) {
|
||
|
|
str[4] = '\0';
|
||
|
|
} else if (error > -200000 && error < 200000)
|
||
|
|
// no, format it as an integer
|
||
|
|
snprintf(str, sizeof(mStr), "%d", (int)error);
|
||
|
|
else
|
||
|
|
snprintf(str, sizeof(mStr), "0x%x", (int)error);
|
||
|
|
}
|
||
|
|
const char *get() const { return mStr; }
|
||
|
|
operator const char *() const { return mStr; }
|
||
|
|
private:
|
||
|
|
char mStr[16];
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
// An extended exception class that includes the name of the failed operation
|
||
|
|
class CAXException {
|
||
|
|
public:
|
||
|
|
CAXException(const char *operation, OSStatus err) :
|
||
|
|
mError(err)
|
||
|
|
{
|
||
|
|
if (operation == NULL)
|
||
|
|
mOperation[0] = '\0';
|
||
|
|
else if (strlen(operation) >= sizeof(mOperation)) {
|
||
|
|
memcpy(mOperation, operation, sizeof(mOperation) - 1);
|
||
|
|
mOperation[sizeof(mOperation) - 1] = '\0';
|
||
|
|
} else
|
||
|
|
|
||
|
|
strlcpy(mOperation, operation, sizeof(mOperation));
|
||
|
|
}
|
||
|
|
|
||
|
|
char *FormatError(char *str, size_t strsize) const
|
||
|
|
{
|
||
|
|
return FormatError(str, strsize, mError);
|
||
|
|
}
|
||
|
|
|
||
|
|
char mOperation[256];
|
||
|
|
const OSStatus mError;
|
||
|
|
|
||
|
|
// -------------------------------------------------
|
||
|
|
|
||
|
|
typedef void (*WarningHandler)(const char *msg, OSStatus err);
|
||
|
|
|
||
|
|
static char *FormatError(char *str, size_t strsize, OSStatus error)
|
||
|
|
{
|
||
|
|
strlcpy(str, CAX4CCString(error), strsize);
|
||
|
|
return str;
|
||
|
|
}
|
||
|
|
|
||
|
|
static void Warning(const char *s, OSStatus error)
|
||
|
|
{
|
||
|
|
if (sWarningHandler)
|
||
|
|
(*sWarningHandler)(s, error);
|
||
|
|
}
|
||
|
|
|
||
|
|
static void SetWarningHandler(WarningHandler f) { sWarningHandler = f; }
|
||
|
|
private:
|
||
|
|
static WarningHandler sWarningHandler;
|
||
|
|
};
|
||
|
|
|
||
|
|
#if DEBUG || CoreAudio_Debug
|
||
|
|
#define XThrowIfError(error, operation) \
|
||
|
|
do { \
|
||
|
|
OSStatus __err = error; \
|
||
|
|
if (__err) { \
|
||
|
|
DebugMessageN4("%s:%d: about to throw %s: %s", __FILE__, __LINE__, CAX4CCString(__err).get(), operation);\
|
||
|
|
__THROW_STOP; \
|
||
|
|
throw CAXException(operation, __err); \
|
||
|
|
} \
|
||
|
|
} while (0)
|
||
|
|
|
||
|
|
#define XThrowIf(condition, error, operation) \
|
||
|
|
do { \
|
||
|
|
if (condition) { \
|
||
|
|
OSStatus __err = error; \
|
||
|
|
DebugMessageN4("%s:%d: about to throw %s: %s", __FILE__, __LINE__, CAX4CCString(__err).get(), operation);\
|
||
|
|
__THROW_STOP; \
|
||
|
|
throw CAXException(operation, __err); \
|
||
|
|
} \
|
||
|
|
} while (0)
|
||
|
|
|
||
|
|
#define XRequireNoError(error, label) \
|
||
|
|
do { \
|
||
|
|
OSStatus __err = error; \
|
||
|
|
if (__err) { \
|
||
|
|
DebugMessageN4("%s:%d: about to throw %s: %s", __FILE__, __LINE__, CAX4CCString(__err).get(), #error);\
|
||
|
|
STOP; \
|
||
|
|
goto label; \
|
||
|
|
} \
|
||
|
|
} while (0)
|
||
|
|
|
||
|
|
#define XAssert(assertion) \
|
||
|
|
do { \
|
||
|
|
if (!(assertion)) { \
|
||
|
|
DebugMessageN3("%s:%d: error: failed assertion: %s", __FILE__, __LINE__, #assertion); \
|
||
|
|
__ASSERT_STOP; \
|
||
|
|
} \
|
||
|
|
} while (0)
|
||
|
|
|
||
|
|
#define XAssertNoError(error) \
|
||
|
|
do { \
|
||
|
|
OSStatus __err = error; \
|
||
|
|
if (__err) { \
|
||
|
|
DebugMessageN4("%s:%d: error %s: %s", __FILE__, __LINE__, CAX4CCString(__err).get(), #error);\
|
||
|
|
STOP; \
|
||
|
|
} \
|
||
|
|
} while (0)
|
||
|
|
|
||
|
|
#define ca_require_noerr(errorCode, exceptionLabel) \
|
||
|
|
do \
|
||
|
|
{ \
|
||
|
|
int evalOnceErrorCode = (errorCode); \
|
||
|
|
if ( __builtin_expect(0 != evalOnceErrorCode, 0) ) \
|
||
|
|
{ \
|
||
|
|
DebugMessageN5("ca_require_noerr: [%s, %d] (goto %s;) %s:%d", \
|
||
|
|
#errorCode, evalOnceErrorCode, \
|
||
|
|
#exceptionLabel, \
|
||
|
|
__FILE__, \
|
||
|
|
__LINE__); \
|
||
|
|
goto exceptionLabel; \
|
||
|
|
} \
|
||
|
|
} while ( 0 )
|
||
|
|
|
||
|
|
#define ca_verify_noerr(errorCode) \
|
||
|
|
do \
|
||
|
|
{ \
|
||
|
|
int evalOnceErrorCode = (errorCode); \
|
||
|
|
if ( __builtin_expect(0 != evalOnceErrorCode, 0) ) \
|
||
|
|
{ \
|
||
|
|
DebugMessageN4("ca_verify_noerr: [%s, %d] %s:%d", \
|
||
|
|
#errorCode, evalOnceErrorCode, \
|
||
|
|
__FILE__, \
|
||
|
|
__LINE__); \
|
||
|
|
} \
|
||
|
|
} while ( 0 )
|
||
|
|
|
||
|
|
#define ca_debug_string(message) \
|
||
|
|
do \
|
||
|
|
{ \
|
||
|
|
DebugMessageN3("ca_debug_string: %s %s:%d", \
|
||
|
|
message, \
|
||
|
|
__FILE__, \
|
||
|
|
__LINE__); \
|
||
|
|
} while ( 0 )
|
||
|
|
|
||
|
|
|
||
|
|
#define ca_verify(assertion) \
|
||
|
|
do \
|
||
|
|
{ \
|
||
|
|
if ( __builtin_expect(!(assertion), 0) ) \
|
||
|
|
{ \
|
||
|
|
DebugMessageN3("ca_verify: %s %s:%d", \
|
||
|
|
#assertion, \
|
||
|
|
__FILE__, \
|
||
|
|
__LINE__); \
|
||
|
|
} \
|
||
|
|
} while ( 0 )
|
||
|
|
|
||
|
|
#define ca_require(assertion, exceptionLabel) \
|
||
|
|
do \
|
||
|
|
{ \
|
||
|
|
if ( __builtin_expect(!(assertion), 0) ) \
|
||
|
|
{ \
|
||
|
|
DebugMessageN4("ca_require: %s %s %s:%d", \
|
||
|
|
#assertion, \
|
||
|
|
#exceptionLabel, \
|
||
|
|
__FILE__, \
|
||
|
|
__LINE__); \
|
||
|
|
goto exceptionLabel; \
|
||
|
|
} \
|
||
|
|
} while ( 0 )
|
||
|
|
|
||
|
|
#define ca_check(assertion) \
|
||
|
|
do \
|
||
|
|
{ \
|
||
|
|
if ( __builtin_expect(!(assertion), 0) ) \
|
||
|
|
{ \
|
||
|
|
DebugMessageN3("ca_check: %s %s:%d", \
|
||
|
|
#assertion, \
|
||
|
|
__FILE__, \
|
||
|
|
__LINE__); \
|
||
|
|
} \
|
||
|
|
} while ( 0 )
|
||
|
|
|
||
|
|
#else
|
||
|
|
#define XThrowIfError(error, operation) \
|
||
|
|
do { \
|
||
|
|
OSStatus __err = error; \
|
||
|
|
if (__err) { \
|
||
|
|
throw CAXException(operation, __err); \
|
||
|
|
} \
|
||
|
|
} while (0)
|
||
|
|
|
||
|
|
#define XThrowIf(condition, error, operation) \
|
||
|
|
do { \
|
||
|
|
if (condition) { \
|
||
|
|
OSStatus __err = error; \
|
||
|
|
throw CAXException(operation, __err); \
|
||
|
|
} \
|
||
|
|
} while (0)
|
||
|
|
|
||
|
|
#define XRequireNoError(error, label) \
|
||
|
|
do { \
|
||
|
|
OSStatus __err = error; \
|
||
|
|
if (__err) { \
|
||
|
|
goto label; \
|
||
|
|
} \
|
||
|
|
} while (0)
|
||
|
|
|
||
|
|
#define XAssert(assertion) \
|
||
|
|
do { \
|
||
|
|
if (!(assertion)) { \
|
||
|
|
} \
|
||
|
|
} while (0)
|
||
|
|
|
||
|
|
#define XAssertNoError(error) \
|
||
|
|
do { \
|
||
|
|
/*OSStatus __err =*/ error; \
|
||
|
|
} while (0)
|
||
|
|
|
||
|
|
#define ca_require_noerr(errorCode, exceptionLabel) \
|
||
|
|
do \
|
||
|
|
{ \
|
||
|
|
if ( __builtin_expect(0 != (errorCode), 0) ) \
|
||
|
|
{ \
|
||
|
|
goto exceptionLabel; \
|
||
|
|
} \
|
||
|
|
} while ( 0 )
|
||
|
|
|
||
|
|
#define ca_verify_noerr(errorCode) \
|
||
|
|
do \
|
||
|
|
{ \
|
||
|
|
if ( 0 != (errorCode) ) \
|
||
|
|
{ \
|
||
|
|
} \
|
||
|
|
} while ( 0 )
|
||
|
|
|
||
|
|
#define ca_debug_string(message)
|
||
|
|
|
||
|
|
#define ca_verify(assertion) \
|
||
|
|
do \
|
||
|
|
{ \
|
||
|
|
if ( !(assertion) ) \
|
||
|
|
{ \
|
||
|
|
} \
|
||
|
|
} while ( 0 )
|
||
|
|
|
||
|
|
#define ca_require(assertion, exceptionLabel) \
|
||
|
|
do \
|
||
|
|
{ \
|
||
|
|
if ( __builtin_expect(!(assertion), 0) ) \
|
||
|
|
{ \
|
||
|
|
goto exceptionLabel; \
|
||
|
|
} \
|
||
|
|
} while ( 0 )
|
||
|
|
|
||
|
|
#define ca_check(assertion) \
|
||
|
|
do \
|
||
|
|
{ \
|
||
|
|
if ( !(assertion) ) \
|
||
|
|
{ \
|
||
|
|
} \
|
||
|
|
} while ( 0 )
|
||
|
|
|
||
|
|
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#define XThrow(error, operation) XThrowIf(true, error, operation)
|
||
|
|
#define XThrowIfErr(error) XThrowIfError(error, #error)
|
||
|
|
|
||
|
|
#endif // __CAXException_h__
|