mirror of
https://github.com/kyleneideck/BackgroundMusic
synced 2024-11-23 04:33:03 +00:00
59e70fb9d1
This is mostly so BGMApp won't leave BGMDevice as the default if BGMApp crashes, which would stop audio from playing until the user changed the default device themselves. Also handles SIGINT, SIGTERM and SIGQUIT. For crashes where the BGMApp process may be in an unknown state, e.g. segfaults, BGMXPCHelper handles changing the default device. Should fix the Travis Xcode 9 build, which is currently failing because the AppleScript we use to quit BGMApp in .travis.yml gets "user cancelled" for some reason. Also makes some minor improvements to the reports generated by CrashReporter. The way CrashReporter works with Background Music should otherwise be unchanged.
215 lines
7.5 KiB
Objective-C
215 lines
7.5 KiB
Objective-C
// This file is part of Background Music.
|
|
//
|
|
// Background Music 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.
|
|
//
|
|
// Background Music 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 Background Music. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
//
|
|
// BGM_Utils.h
|
|
// SharedSource
|
|
//
|
|
// Copyright © 2016, 2017 Kyle Neideck
|
|
//
|
|
|
|
#ifndef SharedSource__BGM_Utils
|
|
#define SharedSource__BGM_Utils
|
|
|
|
// PublicUtility Includes
|
|
#include "CADebugMacros.h"
|
|
|
|
#if defined(__cplusplus)
|
|
|
|
#include "CAException.h"
|
|
|
|
// STL Includes
|
|
#include <functional>
|
|
|
|
#endif /* defined(__cplusplus) */
|
|
|
|
// System Includes
|
|
#include <mach/error.h>
|
|
#include <dispatch/dispatch.h>
|
|
|
|
#pragma mark Macros
|
|
|
|
// The Assert macro from CADebugMacros with support for format strings added.
|
|
#define BGMAssert(inCondition, inMessage, ...) \
|
|
if(!(inCondition)) \
|
|
{ \
|
|
DebugMsg(inMessage, ## __VA_ARGS__); \
|
|
__ASSERT_STOP; \
|
|
}
|
|
|
|
#define BGMAssertNonNull(expression) \
|
|
BGMAssertNonNull2((expression), #expression)
|
|
|
|
#define BGMAssertNonNull2(expression, expressionStr) \
|
|
BGMAssert((expression), \
|
|
"%s:%d:%s: '%s' is null", \
|
|
__FILE__, \
|
|
__LINE__, \
|
|
__FUNCTION__, \
|
|
expressionStr);
|
|
|
|
#pragma mark Objective-C Macros
|
|
|
|
#if defined(__OBJC__)
|
|
|
|
#if __has_feature(objc_generics)
|
|
|
|
// This trick is from https://gist.github.com/robb/d55b72d62d32deaee5fa
|
|
@interface BGMNonNullCastHelper<__covariant T>
|
|
|
|
- (nonnull T) asNonNull;
|
|
|
|
@end
|
|
|
|
// Explicitly casts expressions from nullable to non-null. Only works with expressions that
|
|
// evaluate to Objective-C objects. Use BGM_Utils::NN for other types.
|
|
//
|
|
// TODO: Replace existing non-null casts with this.
|
|
#define BGMNN(expression) ({ \
|
|
__typeof((expression)) value = (expression); \
|
|
BGMAssertNonNull2(value, #expression); \
|
|
BGMNonNullCastHelper<__typeof((expression))>* helper; \
|
|
(__typeof(helper.asNonNull))value; \
|
|
})
|
|
|
|
#else /* __has_feature(objc_generics) */
|
|
|
|
#define BGMNN(expression) ({ \
|
|
id value = (expression); \
|
|
BGMAssertNonNull2(value, #expression); \
|
|
value; \
|
|
})
|
|
|
|
#endif /* __has_feature(objc_generics) */
|
|
|
|
#endif /* defined(__OBJC__) */
|
|
|
|
#pragma mark C++ Macros
|
|
|
|
#if defined(__cplusplus)
|
|
|
|
#define BGMLogException(exception) \
|
|
BGM_Utils::LogException(__FILE__, __LINE__, __FUNCTION__, exception)
|
|
|
|
#define BGMLogExceptionIn(callerName, exception) \
|
|
BGM_Utils::LogException(__FILE__, __LINE__, callerName, exception)
|
|
|
|
#define BGMLogAndSwallowExceptions(callerName, function) \
|
|
BGM_Utils::LogAndSwallowExceptions(__FILE__, __LINE__, callerName, function)
|
|
|
|
#define BGMLogAndSwallowExceptionsMsg(callerName, message, function) \
|
|
BGM_Utils::LogAndSwallowExceptions(__FILE__, __LINE__, callerName, message, function)
|
|
|
|
#define BGMLogUnexpectedException() \
|
|
BGM_Utils::LogUnexpectedException(__FILE__, __LINE__, __FUNCTION__)
|
|
|
|
#define BGMLogUnexpectedExceptionIn(callerName) \
|
|
BGM_Utils::LogUnexpectedException(__FILE__, __LINE__, callerName)
|
|
|
|
#define BGMLogUnexpectedExceptions(callerName, function) \
|
|
BGM_Utils::LogUnexpectedExceptions(__FILE__, __LINE__, callerName, function)
|
|
|
|
#define BGMLogUnexpectedExceptionsMsg(callerName, message, function) \
|
|
BGM_Utils::LogUnexpectedExceptions(__FILE__, __LINE__, callerName, message, function)
|
|
|
|
#endif /* defined(__cplusplus) */
|
|
|
|
|
|
#pragma clang assume_nonnull begin
|
|
|
|
#pragma mark C Utility Functions
|
|
|
|
dispatch_queue_t BGMGetDispatchQueue_PriorityUserInteractive();
|
|
|
|
#if defined(__cplusplus)
|
|
|
|
#pragma mark C++ Utility Functions
|
|
|
|
namespace BGM_Utils
|
|
{
|
|
// Used to explicitly cast from nullable to non-null. For Objective-C objects, use the BGMNN
|
|
// macro (above).
|
|
template <typename T>
|
|
inline T __nonnull NN(T __nullable v) {
|
|
BGMAssertNonNull(v);
|
|
return v;
|
|
}
|
|
|
|
// Log (and swallow) errors returned by Mach functions. Returns false if there was an error.
|
|
bool LogIfMachError(const char* callerName,
|
|
const char* errorReturnedBy,
|
|
mach_error_t error);
|
|
|
|
// Similar to ThrowIfKernelError from CADebugMacros.h, but also logs (in debug builds) the
|
|
// Mach error string that corresponds to the error.
|
|
void ThrowIfMachError(const char* callerName,
|
|
const char* errorReturnedBy,
|
|
mach_error_t error);
|
|
|
|
// If function throws an exception, log an error and continue.
|
|
//
|
|
// Fails/stops debug builds. It's likely that if we log an error for an exception in release
|
|
// builds, even if it's expected (i.e. not a bug in Background Music), we'd want to know if
|
|
// it gets thrown during testing/debugging.
|
|
OSStatus LogAndSwallowExceptions(const char* __nullable fileName,
|
|
int lineNumber,
|
|
const char* callerName,
|
|
const std::function<void(void)>& function);
|
|
|
|
OSStatus LogAndSwallowExceptions(const char* __nullable fileName,
|
|
int lineNumber,
|
|
const char* callerName,
|
|
const char* __nullable message,
|
|
const std::function<void(void)>& function);
|
|
|
|
void LogException(const char* __nullable fileName,
|
|
int lineNumber,
|
|
const char* callerName,
|
|
const CAException& e);
|
|
|
|
void LogUnexpectedException(const char* __nullable fileName,
|
|
int lineNumber,
|
|
const char* callerName);
|
|
|
|
OSStatus LogUnexpectedExceptions(const char* callerName,
|
|
const std::function<void(void)>& function);
|
|
|
|
OSStatus LogUnexpectedExceptions(const char* __nullable fileName,
|
|
int lineNumber,
|
|
const char* callerName,
|
|
const std::function<void(void)>& function);
|
|
|
|
// Log unexpected exceptions and continue.
|
|
//
|
|
// Generally, you don't want to use this unless the alternative is to crash. And even then
|
|
// crashing is often the better option. (Especially if we've added crash reporting by the
|
|
// time you're reading this.)
|
|
//
|
|
// Fails/stops debug builds.
|
|
//
|
|
// TODO: Allow a format string and args for the message.
|
|
OSStatus LogUnexpectedExceptions(const char* __nullable fileName,
|
|
int lineNumber,
|
|
const char* callerName,
|
|
const char* __nullable message,
|
|
const std::function<void(void)>& function);
|
|
}
|
|
|
|
#endif /* defined(__cplusplus) */
|
|
|
|
#pragma clang assume_nonnull end
|
|
|
|
#endif /* SharedSource__BGM_Utils */
|
|
|