// The MIT License
// 
// Copyright (c) 2014 Gwendal Roué
// 
// 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 be included in
// all copies or substantial portions of the Software.
// 
// 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 <Foundation/Foundation.h>
#import "GRMustacheAvailabilityMacros_private.h"

// prevent GRMustacheFilter.h to load
#define GRMUSTACHE_FILTER

// Documented in GRMustacheFilter.h
@protocol GRMustacheFilter <NSObject>
@required

// Documented in GRMustacheFilter.h
- (id)transformedValue:(id)object GRMUSTACHE_API_PUBLIC;

@optional

/**
 * Returns a new filter that uses the _object_ parameter.
 *
 * Filter currying is involved in `f(a,...)` expressions, filters with more than
 * one argument.
 *
 * The evaluation of `f(a,b)` is implemented as `f(a)(b)`: the filter `f` is
 * asked for a curried filter using argument `a`. This curried filter `g` is
 * then applied to `b`:
 *
 * g = f(a)
 * f(a,b) = g(b)
 */
- (id<GRMustacheFilter>)filterByCurryingArgument:(id)object GRMUSTACHE_API_INTERNAL;
@end


// Documented in GRMustacheFilter.h
@interface GRMustacheFilter : NSObject<GRMustacheFilter>

// Documented in GRMustacheFilter.h
+ (id<GRMustacheFilter>)filterWithBlock:(id(^)(id value))block GRMUSTACHE_API_PUBLIC;

// Documented in GRMustacheFilter.h
+ (id<GRMustacheFilter>)variadicFilterWithBlock:(id(^)(NSArray *arguments))block GRMUSTACHE_API_PUBLIC;

@end
