1 /* 2 [The "BSD license"] 3 Copyright (c) 2007 Kay Roepke 2010 Alan Condit 4 All rights reserved. 5 6 Redistribution and use in source and binary forms, with or without 7 modification, are permitted provided that the following conditions 8 are met: 9 1. Redistributions of source code must retain the above copyright 10 notice, this list of conditions and the following disclaimer. 11 2. Redistributions in binary form must reproduce the above copyright 12 notice, this list of conditions and the following disclaimer in the 13 documentation and/or other materials provided with the distribution. 14 3. The name of the author may not be used to endorse or promote products 15 derived from this software without specific prior written permission. 16 17 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /** Templates for building ASTs during tree parsing. 30 * 31 * Deal with many combinations. Dimensions are: 32 * Auto build or rewrite 33 * no label, label, list label (label/no-label handled together) 34 * child, root 35 * token, set, rule, wildcard 36 * 37 * Each combination has its own template except that label/no label 38 * is combined into tokenRef, ruleRef, ... 39 */ 40 41 /* addition memVars for returnscopes */ 42 @returnScopeInterface.memVars() ::= << 43 /* ASTTreeParser returnScopeInterface.memVars */ 44 <recognizer.ASTLabelType; null="ANTLRCommonTree"> *tree; 45 >> 46 47 /** the interface of returnScope methodsDecl */ 48 @returnScopeInterface.methodsDecl() ::= << 49 /* ASTTreeParser returnScopeInterface.methodsDecl */ 50 - (<recognizer.ASTLabelType; null="ANTLRCommonTree"> *)getTree; 51 - (void) setTree:(<recognizer.ASTLabelType; null="ANTLRCommonTree"> *)aTree;<\n> 52 >> 53 54 /** the implementation of returnScope methods */ 55 @returnScope.methods() ::= << 56 /* ASTTreeParser returnScope.methods */ 57 - (<ASTLabelType> *)getTree 58 { 59 return tree; 60 } 61 62 - (void) setTree:(<ASTLabelType> *)aTree 63 { 64 if (tree != aTree) { 65 if ( tree ) [tree release]; 66 if ( aTree ) [aTree retain]; 67 tree = aTree; 68 } 69 } 70 71 - (void) dealloc 72 { 73 [self setTree:nil]; 74 [super dealloc]; 75 } 76 77 @synthesize tree; 78 >> 79 80 @returnScopeProperties() ::= << 81 @property (retain) <recognizer.ASTLabelType; null="ANTLRCommonTree"> *tree; 82 >> 83 84 /** Add a variable to track last element matched */ 85 ruleDeclarations() ::= << 86 /* ASTTreeParser ruleDeclarations */ 87 <super.ruleDeclarations()> 88 <ASTLabelType> *_first_0 = nil; 89 <ASTLabelType> *_last = nil;<\n> 90 >> 91 92 /** What to emit when there is no rewrite rule. For auto build 93 * mode, does nothing. 94 */ 95 noRewrite(rewriteBlockLevel, treeLevel) ::= << 96 /* ASTTreeParser noRewrite */ 97 <if(backtracking)>if ( <actions.(actionScope).synpredgate> ) {<endif> 98 <if(rewriteMode)> 99 retval.tree = (<ASTLabelType> *)_first_0; 100 if ( [treeAdaptor getParent:retval.tree] != nil && [treeAdaptor isNil:[treeAdaptor getParent:retval.tree]] ) ) 101 retval.tree = (<ASTLabelType> *)[treeAdaptor getParent:retval.tree]; 102 <endif> 103 <if(backtracking)>}<endif> 104 >> 105 106 /** match ^(root children) in tree parser; override here to 107 * add tree construction actions. 108 */ 109 tree(root, actionsAfterRoot, children, nullableChildList, 110 enclosingTreeLevel, treeLevel) ::= << 111 /* ASTTreeParser tree */ 112 _last = (<ASTLabelType> *)[input LT:1]; 113 { 114 <ASTLabelType> *_save_last_<treeLevel> = _last; 115 <ASTLabelType> *_first_<treeLevel> = nil; 116 <if(!rewriteMode)> 117 <ASTLabelType> *root_<treeLevel> = [[[treeAdaptor class] newEmptyTree] retain]; 118 <endif> 119 <root:element()> 120 <if(rewriteMode)> 121 <if(backtracking)>if ( <actions.(actionScope).synpredgate> )<endif> 122 <if(root.el.rule)> 123 if ( _first_<enclosingTreeLevel>==nil ) _first_<enclosingTreeLevel> = <root.el.label>.tree; 124 <else> 125 if ( _first_<enclosingTreeLevel>==nil ) _first_<enclosingTreeLevel> = <root.el.label>; 126 <endif> 127 <endif> 128 <actionsAfterRoot:element()> 129 <if(nullableChildList)> 130 if ( [input LA:1] == ANTLRTokenTypeDOWN ) { 131 [self match:input TokenType:ANTLRTokenTypeDOWN Follow:nil]; <checkRuleBacktrackFailure()> 132 <children:element()> 133 [self match:input TokenType:ANTLRTokenTypeUP Follow:nil]; <checkRuleBacktrackFailure()> 134 } 135 <else> 136 [self match:input TokenType:ANTLRTokenTypeDOWN Follow:nil]; <checkRuleBacktrackFailure()> 137 <children:element()> 138 [self match:input TokenType:ANTLRTokenTypeUP Follow:nil]; <checkRuleBacktrackFailure()> 139 <endif> 140 <if(!rewriteMode)> 141 [treeAdaptor addChild:root_<treeLevel> toTree:root_<enclosingTreeLevel>]; 142 <endif> 143 _last = _save_last_<treeLevel>; 144 }<\n> 145 >> 146 147 // TOKEN AST STUFF 148 149 /** ID! and output=AST (same as plain tokenRef) 'cept add 150 * setting of _last 151 */ 152 tokenRefBang(token,label,elementIndex,terminalOptions) ::= << 153 /* ASTTreeParser tokenRefBang */ 154 _last = (<ASTLabelType> *)[input LT:1]; 155 <super.tokenRef(...)> 156 >> 157 158 /** ID auto construct */ 159 tokenRef(token,label,elementIndex,terminalOptions) ::= << 160 /* ASTTreeParser tokenRef */ 161 _last = (<ASTLabelType> *)[input LT:1]; 162 <super.tokenRef(...)> 163 <if(!rewriteMode)> 164 <if(backtracking)>if ( <actions.(actionScope).synpredgate> ) {<endif> 165 <if(terminalOptions.node)> 166 <label>_tree = [ANTLR<terminalOptions.node> newANTLR<terminalOptions.node>:<label>]; 167 <else> 168 <label>_tree = (<ASTLabelType> *)[treeAdaptor dupNode:<label>]; 169 <endif><\n> 170 [treeAdaptor addChild:<label>_tree toTree:root_<treeLevel>]; 171 <if(backtracking)>}<endif> 172 <else> <! rewrite mode !> 173 <if(backtracking)>if ( <actions.(actionScope).synpredgate> )<endif> 174 if ( _first_<treeLevel>==nil ) _first_<treeLevel> = <label>; 175 <endif> 176 >> 177 178 /** label+=TOKEN auto construct */ 179 tokenRefAndListLabel(token,label,elementIndex,terminalOptions) ::= << 180 /* ASTTreeParser tokenRefAndListLabel */ 181 <tokenRef(...)> 182 <listLabel(elem=label,...)> 183 >> 184 185 /** ^(ID ...) auto construct */ 186 tokenRefRuleRoot(token,label,elementIndex) ::= << 187 /* ASTTreeParser tokenRefRuleRoot */ 188 _last = (<ASTLabelType> *)[input LT:1]; 189 <super.tokenRef(...)> 190 <if(!rewriteMode)> 191 <if(backtracking)>if ( <actions.(actionScope).synpredgate> ) {<endif> 192 <if(terminalOptions.node)> 193 <label>_tree = [ANTLR<terminalOptions.node> newANTLR<terminalOptions.node>:<label>]; 194 <else> 195 <label>_tree = (<ASTLabelType> *)[treeAdaptor dupNode:<label>]; 196 <endif><\n> 197 root_<treeLevel> = (<ASTLabelType> *)[treeAdaptor becomeRoot:<label>_tree old:root_<treeLevel>]; 198 <if(backtracking)>}<endif> 199 <endif> 200 >> 201 202 /** Match ^(label+=TOKEN ...) auto construct */ 203 tokenRefRuleRootAndListLabel(token,label,elementIndex,terminalOptions) ::= << 204 /* ASTTreeParser tokenRefRuleRootAndListLabel */ 205 <tokenRefRuleRoot(...)> 206 <listLabel(elem=label,...)> 207 >> 208 209 /** Match . wildcard and auto dup the node/subtree */ 210 wildcard(token,label,elementIndex,terminalOptions) ::= << 211 /* ASTTreeParser wildcard */ 212 _last = (<ASTLabelType> *)[input LT:1]; 213 <super.wildcard(...)> 214 <if(!rewriteMode)> 215 <if(backtracking)>if ( <actions.(actionScope).synpredgate> ) {<endif> 216 <label>_tree = (<ASTLabelType> *)[adaptor dupTree:<label>]; 217 [adaptor addChild:<label>_tree toTree:root_<treeLevel>]; 218 <if(backtracking)>}<endif> 219 <else> <! rewrite mode !> 220 <if(backtracking)>if ( <actions.(actionScope).synpredgate> )<endif> 221 if ( _first_<treeLevel> == nil ) _first_<treeLevel> = <label>; 222 <endif> 223 >> 224 225 // SET AST 226 227 matchSet(s,label,terminalOptions,elementIndex,postmatchCode) ::= << 228 /* ASTTreeParser matchSet */ 229 _last = (<ASTLabelType> *)[input LT:1]; 230 <super.matchSet(postmatchCode={ 231 <if(!rewriteMode)> 232 <if(backtracking)>if ( <actions.(actionScope).synpredgate> ) {<endif> 233 <if(terminalOptions.node)> 234 <label>_tree = [ANTLR<terminalOptions.node> newANTLR<terminalOptions.node>:<label>]; 235 <else> 236 <label>_tree = (<ASTLabelType> *)[adaptor dupNode:<label>]; 237 <endif><\n> 238 [adaptor addChild:<label>_tree toTree:root_<treeLevel>]; 239 <if(backtracking)>\}<endif> 240 <endif> 241 }, ... 242 )> 243 >> 244 245 matchRuleBlockSet(s,label,terminalOptions,elementIndex,postmatchCode,treeLevel="0") ::= << 246 /* ASTTreeParser matchRuleBlockSet */ 247 <matchSet(...)> 248 <noRewrite(...)> <! set return tree !> 249 >> 250 251 matchSetBang(s,label,terminalOptions,elementIndex,postmatchCode) ::= << 252 /* ASTTreeParser matchSetBang */ 253 _last = (<ASTLabelType> *)[input LT:1]; 254 <super.matchSet(...)> 255 >> 256 257 matchSetRuleRoot(s,label,terminalOptions,elementIndex,debug) ::= << 258 /* ASTTreeParser matchSetRuleRoot */ 259 <super.matchSet(postmatchCode={ 260 <if(!rewriteMode)> 261 <if(backtracking)>if ( <actions.(actionScope).synpredgate> ) {<endif> 262 <if(terminalOptions.node)> 263 <label>_tree = [ANTLR<terminalOptions.node> newANTLR<terminalOptions.node>:<label>]; 264 <else> 265 <label>_tree = (<ASTLabelType> *)[adaptor dupNode:<label>]; 266 <endif><\n> 267 root_<treeLevel> = (<ASTLabelType> *)[adaptor becomeRoot:<label>_tree old:root_<treeLevel>]; 268 <if(backtracking)>\}<endif> 269 <endif> 270 }, ... 271 )> 272 >> 273 274 // RULE REF AST 275 276 /** rule auto construct */ 277 ruleRef(rule,label,elementIndex,args,scope) ::= << 278 /* ASTTreeParser ruleRef */ 279 _last = (<ASTLabelType> *)[input LT:1]; 280 <super.ruleRef(...)> 281 <if(backtracking)>if ( <actions.(actionScope).synpredgate> ) <endif> 282 <if(!rewriteMode)> 283 [treeAdaptor addChild:<label>.tree toTree:root_<treeLevel>]; 284 <else> <! rewrite mode !> 285 if ( _first_<treeLevel> == nil ) _first_<treeLevel> = <label>.tree; 286 <endif> 287 >> 288 289 /** x+=rule auto construct */ 290 ruleRefAndListLabel(rule,label,elementIndex,args,scope) ::= << 291 /* ASTTreeParser ruleRefAndListLabel */ 292 <ruleRef(...)> 293 <! <listLabel(elem = "["+label+" getTree]",...)> !> 294 <listLabel(elem = {[<label> getTree]},...)> 295 >> 296 297 /** ^(rule ...) auto construct */ 298 ruleRefRuleRoot(rule,label,elementIndex,args,scope) ::= << 299 /* ASTTreeParser ruleRefRuleRoot */ 300 _last = (<ASTLabelType> *)[input LT:1]; 301 <super.ruleRef(...)> 302 <if(!rewriteMode)> 303 <if(backtracking)>if ( state.backtracking == 0 ) <endif> 304 root_<treeLevel> = (<ASTLabelType> *)[treeAdaptor becomeRoot:<label>.tree old:root_<treeLevel>]; 305 <endif> 306 >> 307 308 /** ^(x+=rule ...) auto construct */ 309 ruleRefRuleRootAndListLabel(rule,label,elementIndex,args,scope) ::= << 310 /* ASTTreeParser ruleRefRuleRootAndListLabel */ 311 <ruleRefRuleRoot(...)> 312 <listLabel(elem = {[<label> getTree]},...)> 313 >> 314 315 /** rule when output=AST and tracking for rewrite */ 316 ruleRefTrack(rule,label,elementIndex,args,scope) ::= << 317 /* ASTTreeParser ruleRefTrack */ 318 _last = (<ASTLabelType> *)[input LT:1]; 319 <super.ruleRefTrack(...)> 320 >> 321 322 /** x+=rule when output=AST and tracking for rewrite */ 323 ruleRefTrackAndListLabel(rule,label,elementIndex,args,scope) ::= << 324 /* ASTTreeParser ruleRefTrackAndListLabel */ 325 _last = (<ASTLabelType> *)[input LT:1]; 326 <super.ruleRefTrackAndListLabel(...)> 327 >> 328 329 /** ^(rule ...) rewrite */ 330 ruleRefRuleRootTrack(rule,label,elementIndex,args,scope) ::= << 331 /* ASTTreeParser ruleRefRuleRootTrack */ 332 _last = (<ASTLabelType> *)[input LT:1]; 333 <super.ruleRefRootTrack(...)> 334 >> 335 336 /** ^(x+=rule ...) rewrite */ 337 ruleRefRuleRootTrackAndListLabel(rule,label,elementIndex,args,scope) ::= << 338 /* ASTTreeParser ruleRefRuleRootTrackAndListLabel */ 339 _last = (<ASTLabelType> *)[input LT:1]; 340 <super.ruleRefRuleRootTrackAndListLabel(...)> 341 >> 342 343 /** Streams for token refs are tree nodes now; override to 344 * change nextToken to nextNode. 345 */ 346 createRewriteNodeFromElement(token,terminalOptions,scope) ::= << 347 /* ASTTreeParser createRewriteNodeFromElement */ 348 <if(terminalOptions.node)> 349 <! new <terminalOptions.node>(stream_<token>.nextNode()) !> 350 [[[ANTLR<terminalOptions.node>(stream_<token> alloc] init] nextNode]; 351 <else> 352 <! stream_<token>.nextNode() !> 353 [stream_<token> nextNode] 354 <endif> 355 >> 356 357 ruleCleanUp() ::= << 358 /* ASTTreeParser ruleCleanUp */ 359 <super.ruleCleanUp()> 360 <if(!rewriteMode)> 361 <if(backtracking)>if ( <actions.(actionScope).synpredgate> ) {<\n><endif> 362 retval.tree = (<ASTLabelType> *)[treeAdaptor rulePostProcessing:root_0]; 363 <if(backtracking)>}<endif> 364 <endif> 365 >> 366
