mirror of
https://github.com/morgan9e/VolumeControl
synced 2026-04-14 00:04:05 +09:00
229 lines
8.2 KiB
Objective-C
229 lines
8.2 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/>.
|
|
|
|
//
|
|
// VC_Utils.h
|
|
// SharedSource
|
|
//
|
|
// Copyright © 2016-2020 Kyle Neideck
|
|
//
|
|
|
|
#ifndef SharedSource__VC_Utils
|
|
#define SharedSource__VC_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 and line numbers added.
|
|
#if DEBUG
|
|
#define VCAssert(inCondition, inMessage, ...) \
|
|
if(!(inCondition)) \
|
|
{ \
|
|
DebugMsg("%s:%d:%s: " inMessage, \
|
|
__FILE__, \
|
|
__LINE__, \
|
|
__FUNCTION__, \
|
|
## __VA_ARGS__); \
|
|
__ASSERT_STOP; \
|
|
}
|
|
#else
|
|
#define VCAssert(inCondition, inMessage, ...)
|
|
#endif /* DEBUG */
|
|
|
|
#define VCAssertNonNull(expression) \
|
|
VCAssertNonNull2((expression), #expression)
|
|
|
|
#define VCAssertNonNull2(expression, expressionStr) \
|
|
VCAssert((expression), \
|
|
"%s:%d:%s: '%s' is null", \
|
|
__FILE__, \
|
|
__LINE__, \
|
|
__FUNCTION__, \
|
|
expressionStr);
|
|
|
|
// Used to give the first 3 arguments of VC_Utils::LogAndSwallowExceptions and
|
|
// VC_Utils::LogUnexpectedExceptions (and probably others in future). Mainly so we can call those
|
|
// functions directly instead of using the macro wrappers.
|
|
#define VCDbgArgs __FILE__, __LINE__, __FUNCTION__
|
|
|
|
#pragma mark Objective-C Macros
|
|
|
|
#if defined(__OBJC__)
|
|
|
|
#if __has_feature(objc_generics)
|
|
|
|
// This trick is from https://gist.github.com/robb/d55b72d62d32deaee5fa
|
|
@interface VCNonNullCastHelper<__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 VC_Utils::NN for other types.
|
|
//
|
|
// TODO: Replace existing non-null casts with this.
|
|
#define VCNN(expression) ({ \
|
|
__typeof((expression)) value = (expression); \
|
|
VCAssertNonNull2(value, #expression); \
|
|
VCNonNullCastHelper<__typeof((expression))>* helper; \
|
|
(__typeof(helper.asNonNull) __nonnull)value; \
|
|
})
|
|
|
|
#else /* __has_feature(objc_generics) */
|
|
|
|
#define VCNN(expression) ({ \
|
|
id value = (expression); \
|
|
VCAssertNonNull2(value, #expression); \
|
|
value; \
|
|
})
|
|
|
|
#endif /* __has_feature(objc_generics) */
|
|
|
|
#endif /* defined(__OBJC__) */
|
|
|
|
#pragma mark C++ Macros
|
|
|
|
#if defined(__cplusplus)
|
|
|
|
#define VCLogException(exception) \
|
|
VC_Utils::LogException(__FILE__, __LINE__, __FUNCTION__, exception)
|
|
|
|
#define VCLogExceptionIn(callerName, exception) \
|
|
VC_Utils::LogException(__FILE__, __LINE__, callerName, exception)
|
|
|
|
#define VCLogAndSwallowExceptions(callerName, function) \
|
|
VC_Utils::LogAndSwallowExceptions(__FILE__, __LINE__, callerName, function)
|
|
|
|
#define VCLogAndSwallowExceptionsMsg(callerName, message, function) \
|
|
VC_Utils::LogAndSwallowExceptions(__FILE__, __LINE__, callerName, message, function)
|
|
|
|
#define VCLogUnexpectedException() \
|
|
VC_Utils::LogUnexpectedException(__FILE__, __LINE__, __FUNCTION__)
|
|
|
|
#define VCLogUnexpectedExceptionIn(callerName) \
|
|
VC_Utils::LogUnexpectedException(__FILE__, __LINE__, callerName)
|
|
|
|
#define VCLogUnexpectedExceptions(callerName, function) \
|
|
VC_Utils::LogUnexpectedExceptions(__FILE__, __LINE__, callerName, function)
|
|
|
|
#define VCLogUnexpectedExceptionsMsg(callerName, message, function) \
|
|
VC_Utils::LogUnexpectedExceptions(__FILE__, __LINE__, callerName, message, function)
|
|
|
|
#endif /* defined(__cplusplus) */
|
|
|
|
|
|
#pragma clang assume_nonnull begin
|
|
|
|
#pragma mark C Utility Functions
|
|
|
|
dispatch_queue_t VCGetDispatchQueue_PriorityUserInteractive(void);
|
|
|
|
#if defined(__cplusplus)
|
|
|
|
#pragma mark C++ Utility Functions
|
|
|
|
namespace VC_Utils
|
|
{
|
|
// Used to explicitly cast from nullable to non-null. For Objective-C objects, use the VCNN
|
|
// macro (above).
|
|
template <typename T>
|
|
inline T __nonnull NN(T __nullable v) {
|
|
VCAssertNonNull(v);
|
|
return static_cast<T __nonnull>(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__VC_Utils */
|
|
|