//
//  KSNSErrorHelper.h
//
//  Created by Karl Stenerud on 2013-02-09.
//
//  Copyright (c) 2012 Karl Stenerud. All rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall remain in place
// in this source code.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//

#ifdef __OBJC__

#import <Foundation/Foundation.h>

/**
 * Simpler interface for constructing NSError objects.
 */
@interface KSNSErrorHelper : NSObject

/** Convenience constructor to make an error with the specified localized description.
 *
 * @param domain The domain
 * @param code The code
 * @param fmt Description of the error (gets placed into the user data with the key
 *                    NSLocalizedDescriptionKey).
 */
+ (NSError *)errorWithDomain:(NSString *)domain code:(NSInteger)code description:(NSString *)fmt, ...;

/** Fill an error pointer with an NSError object if it's not nil.
 *
 * @param error Error pointer to fill (ignored if nil).
 * @param domain The domain
 * @param code The code
 * @param fmt Description of the error (gets placed into the user data with the key
 *                    NSLocalizedDescriptionKey).
 * @return NO (to keep the analyzer happy).
 */
+ (BOOL)fillError:(NSError **)error withDomain:(NSString *)domain code:(NSInteger)code description:(NSString *)fmt, ...;

/** Clear a pointer-to-error to nil of its pointer is not nil.
 *
 * @param error Error pointer to fill (ignored if nil).
 * @return NO (to keep the analyzer happy).
 */
+ (BOOL)clearError:(NSError **)error;

@end

#endif
