Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

83 lines (78 sloc) 2.958 kb
// The MIT License
//
// Copyright (c) 2012 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.h"
/**
* The GRMustacheInvocation class gives you information about the values that
* are found in the context stack when rendering tags such as `{{name}}`.
*
* You'll be given GRMustacheInvocation instances when providing a
* GRMustacheTemplateDelegate to your templates.
*
* **Companion guide:** https://github.com/groue/GRMustache/blob/master/Guides/delegate.md
*
* @see GRMustacheTemplateDelegate
*
* @since v1.12
*/
@interface GRMustacheInvocation : NSObject {
@private
NSString *_key;
id _returnValue;
id _debuggingToken;
}
/**
* The key that did provide the return value of the invocation.
*
* For instance, the invocation that you would get for a `{{name}}` tag would
* have @"name" in its `key` property, and the name in the `returnValue`
* property.
*
* For tags with compound keys, such as `{{person.name}}`, the key will be
* @"name" if the person could be found in the context stack. It would be
* @"person" otherwise.
*
* @see returnValue
*
* @since v1.12
*/
@property (nonatomic, readonly) NSString *key AVAILABLE_GRMUSTACHE_VERSION_4_0_AND_LATER;
/**
* The return value of the invocation.
*
* For instance, the invocation that you would get for a `{{name}}` tag would
* have the name in the `returnValue` property.
*
* For tags with compound keys, such as `{{person.name}}`, the value will be
* the person's name, if the person could be found in the context stack.
* It would be nil otherwise.
*
* In a template's delegate methods, you can set the returnValue of an
* invocation, and alter a template rendering.
*
* @see key
* @see GRMustacheTemplateDelegate
*
* @since v1.12
*/
@property (nonatomic, retain) id returnValue AVAILABLE_GRMUSTACHE_VERSION_4_0_AND_LATER;
@end
Jump to Line
Something went wrong with that request. Please try again.