-
Notifications
You must be signed in to change notification settings - Fork 5
/
GRMustacheSectionHelper.h
135 lines (118 loc) · 4.54 KB
/
GRMustacheSectionHelper.h
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
// 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 GRMustacheSection;
// =============================================================================
#pragma mark - <GRMustacheSectionHelper>
/**
* Deprecated protocol. Use GRMustacheSectionTagHelper protocol instead.
*
* The deprecated protocol for implementing Mustache "lambda" sections.
*
* The responsability of a GRMustacheSectionHelper is to render a Mustache
* section such as `{{#bold}}...{{/bold}}`.
*
* When the data given to a Mustache section is a GRMustacheSectionHelper,
* GRMustache invokes the `renderSection:` method of the helper, and inserts the
* raw return value in the template rendering.
*
* **Companion guide:** https://github.com/groue/GRMustache/blob/master/Guides/section_tag_helpers.md
*
* @since v1.9
* @deprecated v5.3
*
* @see GRMustacheSectionTagHelper
*/
@protocol GRMustacheSectionHelper<NSObject>
@required
////////////////////////////////////////////////////////////////////////////////
/// @name Rendering Sections
////////////////////////////////////////////////////////////////////////////////
/**
* Returns the rendering of a Mustache section.
*
* @param section The section to render
*
* @return The rendering of the section
*
* @since v2.0
* @deprecated v5.3
*/
- (NSString *)renderSection:(GRMustacheSection *)section AVAILABLE_GRMUSTACHE_VERSION_5_1_AND_LATER_BUT_DEPRECATED_IN_GRMUSTACHE_VERSION_5_3;
@end
// =============================================================================
#pragma mark - GRMustacheSectionHelper
/**
* Deprecated class. Use GRMustacheSectionTagHelper class instead.
*
* The GRMustacheSectionHelper class helps building mustache helpers without
* writing a custom class that conforms to the GRMustacheSectionHelper protocol.
*
* **Companion guide:** https://github.com/groue/GRMustache/blob/master/Guides/section_tag_helpers.md
*
* @see GRMustacheSectionTagHelper protocol
*
* @since v2.0
* @deprecated v5.3
*/
@interface GRMustacheSectionHelper: NSObject<GRMustacheSectionHelper>
////////////////////////////////////////////////////////////////////////////////
/// @name Creating Helpers
////////////////////////////////////////////////////////////////////////////////
/**
* Returns a GRMustacheSectionHelper object that executes the provided block
* when rendering a section tag.
*
* @param block The block that renders a section.
*
* @return a GRMustacheSectionHelper object.
*
* @since v2.0
* @deprecated v5.3
*/
+ (id)helperWithBlock:(NSString *(^)(GRMustacheSection* section))block AVAILABLE_GRMUSTACHE_VERSION_5_1_AND_LATER_BUT_DEPRECATED_IN_GRMUSTACHE_VERSION_5_3;
@end
// =============================================================================
#pragma mark - Compatibility with deprecated declarations
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
/**
* Deprecated. Use GRMustacheSectionHelper instead.
*
* @since v1.9
* @deprecated v5.1
*/
AVAILABLE_GRMUSTACHE_VERSION_5_0_AND_LATER_BUT_DEPRECATED_IN_GRMUSTACHE_VERSION_5_1
@protocol GRMustacheHelper <GRMustacheSectionHelper>
@end
#pragma clang diagnostic pop
/**
* Deprecated. Use GRMustacheSectionHelper instead.
*
* @since v2.0
* @deprecated v5.1
*/
AVAILABLE_GRMUSTACHE_VERSION_5_0_AND_LATER_BUT_DEPRECATED_IN_GRMUSTACHE_VERSION_5_1
@interface GRMustacheHelper: GRMustacheSectionHelper
+ (id)helperWithBlock:(NSString *(^)(GRMustacheSection* section))block;
@end