Files
firebase-ios-sdk/Firestore/Source/Util/FSTUsageValidation.h
T
Gil 729b8d176c Move all Firestore Objective-C to Objective-C++ (#734)
* Move all Firestore files to Objective-C++
* Update project file references
* Don't use module imports from Objective-C++
* Use extern "C" for C-accessible globals
* Work around more stringent type checking in Objective-C++
  * NSMutableDictionary ivars aren't implicitly casted to NSDictionary
  * FSTMaybeDocument callback can't be passed a function that accepts
    FSTDocument
  * NSComparisonResult can't be multiplied by -1 without casting
* Add a #include <inttypes.h> where needed
* Avoid using C++ keywords as variables
* Remove #if __cplusplus guards
2018-01-31 11:23:55 -08:00

46 lines
1.7 KiB
C

/*
* Copyright 2017 Google
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
/** Helper for creating a general exception for invalid usage of an API. */
NSException *FSTInvalidUsage(NSString *exceptionName, NSString *format, ...);
/**
* Macro to throw exceptions in response to API usage errors. Avoids the lint warning you usually
* get when using @throw and (unlike a function) doesn't trigger warnings about not all codepaths
* returning a value.
*
* Exceptions should only be used for programmer errors made by consumers of the SDK, e.g.
* invalid method arguments.
*
* For recoverable runtime errors, use NSError**.
* For internal programming errors, use FSTFail().
*/
#define FSTThrowInvalidUsage(exceptionName, format, ...) \
do { \
@throw FSTInvalidUsage(exceptionName, format, ##__VA_ARGS__); \
} while (0)
#define FSTThrowInvalidArgument(format, ...) \
do { \
@throw FSTInvalidUsage(@"FIRInvalidArgumentException", format, ##__VA_ARGS__); \
} while (0)
NS_ASSUME_NONNULL_END