Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

file 97 lines (84 sloc) 3.607 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
// 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"

@class GRMustacheSectionTagRenderingContext;


// =============================================================================
#pragma mark - <GRMustacheSectionTagHelper>

/**
* The protocol for implementing Section tag helpers.
*
* The responsability of a GRMustacheSectionTagHelper is to render a Mustache
* section such as `{{#bold}}...{{/bold}}`.
*
* When the data given to a Mustache section is a GRMustacheSectionTagHelper,
* GRMustache invokes the `renderForSectionTagInContext:` method of the helper,
* and inserts the raw return value in the final rendering.
*
* **Companion guide:** https://github.com/groue/GRMustache/blob/master/Guides/section_tag_helpers.md
*
* @since v5.3
*/
@protocol GRMustacheSectionTagHelper<NSObject>
@required

////////////////////////////////////////////////////////////////////////////////
/// @name Rendering Sections
////////////////////////////////////////////////////////////////////////////////

/**
* Returns the rendering of a Mustache section.
*
* @param context A section tag rendering context
*
* @return The rendering of the section
*
* @since v5.3
*/
- (NSString *)renderForSectionTagInContext:(GRMustacheSectionTagRenderingContext *)context AVAILABLE_GRMUSTACHE_VERSION_5_3_AND_LATER;
@end


// =============================================================================
#pragma mark - GRMustacheSectionTagHelper

/**
* The GRMustacheSectionTagHelper class helps building mustache helpers without
* writing a custom class that conforms to the GRMustacheSectionTagHelper protocol.
*
* **Companion guide:** https://github.com/groue/GRMustache/blob/master/Guides/section_tag_helpers.md
*
* @see GRMustacheSectionTagHelper protocol
*
* @since v5.3
*/
@interface GRMustacheSectionTagHelper: NSObject<GRMustacheSectionTagHelper>

////////////////////////////////////////////////////////////////////////////////
/// @name Creating Helpers
////////////////////////////////////////////////////////////////////////////////

/**
* Returns a GRMustacheSectionTagHelper object that executes the provided block
* when rendering a Mustache section.
*
* @param block The block that renders a section.
*
* @return a GRMustacheSectionTagHelper object.
*
* @since v5.3
*/
+ (id)helperWithBlock:(NSString *(^)(GRMustacheSectionTagRenderingContext* context))block AVAILABLE_GRMUSTACHE_VERSION_5_3_AND_LATER;

@end
Something went wrong with that request. Please try again.