//
//  SentryCrashReportFilterBasic.h
//
//  Created by Karl Stenerud on 2012-05-11.
//
//  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.
//

#import "SentryCrashReportFilter.h"

/**
 * Very basic filter that passes through reports untouched.
 *
 * Input: Anything.
 * Output: Same as input (passthrough).
 */
@interface SentryCrashReportFilterPassthrough : NSObject <SentryCrashReportFilter>

+ (SentryCrashReportFilterPassthrough *)filter;

@end

/**
 * Passes reports to a series of subfilters, then stores the results of those
 * operations as keyed values in final master reports.
 *
 * Input: Anything
 * Output: NSDictionary
 */
@interface SentryCrashReportFilterCombine : NSObject <SentryCrashReportFilter>

/** Constructor.
 *
 * @param firstFilter The first filter, followed by key, filter, key, ...
 *                    Each "filter" can be id<SentryCrashReportFilter> or an
 * NSArray of filters (which gets wrapped in a pipeline filter).
 */
+ (SentryCrashReportFilterCombine *)filterWithFiltersAndKeys:(id)firstFilter,
                                                             ... NS_REQUIRES_NIL_TERMINATION;

/** Initializer.
 *
 * @param firstFilter The first filter, followed by key, filter, key, ...
 *                    Each "filter" can be id<SentryCrashReportFilter> or an
 * NSArray of filters (which gets wrapped in a pipeline filter).
 */
- (id)initWithFiltersAndKeys:(id)firstFilter, ... NS_REQUIRES_NIL_TERMINATION;

@end

/**
 * A pipeline of filters. Reports get passed through each subfilter in order.
 *
 * Input: Depends on what's in the pipeline.
 * Output: Depends on what's in the pipeline.
 */
@interface SentryCrashReportFilterPipeline : NSObject <SentryCrashReportFilter>

/** The filters in this pipeline. */
@property (nonatomic, readonly, retain) NSArray *filters;

/** Constructor.
 *
 * @param firstFilter The first filter, followed by filter, filter, ...
 */
+ (SentryCrashReportFilterPipeline *)filterWithFilters:(id)firstFilter,
                                                       ... NS_REQUIRES_NIL_TERMINATION;

/** Initializer.
 *
 * @param firstFilter The first filter, followed by filter, filter, ...
 */
- (id)initWithFilters:(id)firstFilter, ... NS_REQUIRES_NIL_TERMINATION;

- (void)addFilter:(id<SentryCrashReportFilter>)filter;

@end

/**
 * Extracts data associated with a key from each report.
 */
@interface SentryCrashReportFilterObjectForKey : NSObject <SentryCrashReportFilter>

/** Constructor.
 *
 * @param key The key to search for in each report. If the key is a string,
 *            it will be interpreted as a key path.
 * @param allowNotFound If NO, filtering will stop with an error if the key
 *                      was not found in a report.
 */
+ (SentryCrashReportFilterObjectForKey *)filterWithKey:(id)key allowNotFound:(BOOL)allowNotFound;

/** Initializer.
 *
 * @param key The key to search for in each report. If the key is a string,
 *            it will be interpreted as a key path.
 * @param allowNotFound If NO, filtering will stop with an error if the key
 *                      was not found in a report.
 */
- (id)initWithKey:(id)key allowNotFound:(BOOL)allowNotFound;

@end

/**
 * Takes values by key from the report and concatenates their string
 * representations.
 *
 * Input: NSDictionary
 * Output: NSString
 */
@interface SentryCrashReportFilterConcatenate : NSObject <SentryCrashReportFilter>

/** Constructor.
 *
 * @param separatorFmt Formatting text to use when separating the values. You
 * may include
 *                     %@ in the formatting text to include the key name as
 * well.
 * @param firstKey Series of keys to extract from the source report.
 */
+ (SentryCrashReportFilterConcatenate *)filterWithSeparatorFmt:(NSString *)separatorFmt
                                                          keys:(id)firstKey,
                                                               ... NS_REQUIRES_NIL_TERMINATION;

/** Constructor.
 *
 * @param separatorFmt Formatting text to use when separating the values. You
 * may include
 *                     %@ in the formatting text to include the key name as
 * well.
 * @param firstKey Series of keys to extract from the source report.
 */
- (id)initWithSeparatorFmt:(NSString *)separatorFmt
                      keys:(id)firstKey, ... NS_REQUIRES_NIL_TERMINATION;

@end

/**
 * Fetches subsets of data from the source reports. All other data is discarded.
 *
 * Input: NSDictionary
 * Output: NSDictionary
 */
@interface SentryCrashReportFilterSubset : NSObject <SentryCrashReportFilter>

/** Constructor.
 *
 * @param firstKeyPath Series of key paths to search in the source reports.
 */
+ (SentryCrashReportFilterSubset *)filterWithKeys:(id)firstKeyPath, ... NS_REQUIRES_NIL_TERMINATION;

/** Initializer.
 *
 * @param firstKeyPath Series of key paths to search in the source reports.
 */
- (id)initWithKeys:(id)firstKeyPath, ... NS_REQUIRES_NIL_TERMINATION;

@end

/**
 * Convert UTF-8 data to an NSString.
 *
 * Input: NSData
 * Output: NSString
 */
@interface SentryCrashReportFilterDataToString : NSObject <SentryCrashReportFilter>

+ (SentryCrashReportFilterDataToString *)filter;

@end

/**
 * Convert NSString to UTF-8 encoded NSData.
 *
 * Input: NSString
 * Output: NSData
 */
@interface SentryCrashReportFilterStringToData : NSObject <SentryCrashReportFilter>

+ (SentryCrashReportFilterStringToData *)filter;

@end
