org.antlr.codegen.templates.CSharp3.ASTTreeParser.stg Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of antlr-complete Show documentation
Complete distribution for ANTLR 3
There is a newer version: 3.5.3
/*
 * [The "BSD license"]
 * Copyright (c) 2011 Terence Parr
 * All rights reserved.
 *
 * Conversion to C#:
 * Copyright (c) 2011 Sam Harwell, Pixel Mine, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/** Templates for building ASTs during tree parsing.
 *
 *  Deal with many combinations.  Dimensions are:
 *  Auto build or rewrite
 *    no label, label, list label  (label/no-label handled together)
 *    child, root
 *    token, set, rule, wildcard
 *
 *  Each combination has its own template except that label/no label
 *  is combined into tokenRef, ruleRef, ...
 */

/** Add a variable to track last element matched */
ruleDeclarations() ::= <<


 _first_0 = default();
 _last = default();

>>

/** What to emit when there is no rewrite rule.  For auto build
 *  mode, does nothing.
 */
noRewrite(rewriteBlockLevel=false, treeLevel=false) ::= <<

if () {

retval.Tree = ()_first_0;
if (adaptor.GetParent(retval.Tree)!=null && adaptor.IsNil(adaptor.GetParent(retval.Tree)))
	retval.Tree = ()adaptor.GetParent(retval.Tree);

}

>>

/** match ^(root children) in tree parser; override here to
 *  add tree construction actions.
 */
tree(root, actionsAfterRoot, children, nullableChildList,
     enclosingTreeLevel, treeLevel) ::= <<

_last = ()input.LT(1);
{
 _save_last_ = _last;
 _first_ = default();

 root_ = ()adaptor.Nil();



if ()

if (_first_ == null) _first_ = .Tree;

if (_first_ == null) _first_ = ;




if (input.LA(1) == TokenTypes.Down) {
	Match(input, TokenTypes.Down, null); 
	
	Match(input, TokenTypes.Up, null); 
}

Match(input, TokenTypes.Down, null); 

Match(input, TokenTypes.Up, null); 


adaptor.AddChild(root_, root_);

_last = _save_last_;
}



>>

// TOKEN AST STUFF

/** ID! and output=AST (same as plain tokenRef) 'cept add
 *  setting of _last
 */
tokenRefBang(token,label,elementIndex,terminalOptions) ::= <<

_last = ()input.LT(1);




>>

/** ID auto construct */
tokenRef(token,label,elementIndex,terminalOptions) ::= <<

_last = ()input.LT(1);


if () {

_tree = new (,,);

_tree = ()adaptor.DupNode(,,);
<\n>
adaptor.AddChild(root_, _tree);
}
 
if ()
if (_first_ == null) _first_ = ;




>>

/** label+=TOKEN auto construct */
tokenRefAndListLabel(token,label,elementIndex,terminalOptions) ::= <<






>>

/** ^(ID ...) auto construct */
tokenRefRuleRoot(token,label,elementIndex,terminalOptions) ::= <<

_last = ()input.LT(1);


if () {

_tree = new (,,);

_tree = ()adaptor.DupNode(,,);
<\n>
root_ = ()adaptor.BecomeRoot(_tree, root_);
}




>>

/** Match ^(label+=TOKEN ...) auto construct */
tokenRefRuleRootAndListLabel(token,label,elementIndex,terminalOptions) ::= <<






>>

/** Match . wildcard and auto dup the node/subtree */
wildcard(token,label,elementIndex,terminalOptions) ::= <<

_last = ()input.LT(1);


if () {
_tree = ()adaptor.DupTree();
adaptor.AddChild(root_, _tree);
}
 
if ()
if (_first_ == null) _first_ = ;




>>

// SET AST

matchSet(s,label,terminalOptions,elementIndex,postmatchCode) ::= <<

_last = ()input.LT(1);

if () {

_tree = new (,,);

_tree = ()adaptor.DupNode(,,);
<\n>
adaptor.AddChild(root_, _tree);
\}

}, ...
)>



>>

matchRuleBlockSet(s,label,terminalOptions,elementIndex,postmatchCode,treeLevel="0") ::= <<


 



>>

matchSetBang(s,label,terminalOptions,elementIndex,postmatchCode) ::= <<

_last = ()input.LT(1);




>>

matchSetRuleRoot(s,label,terminalOptions,elementIndex,debug) ::= <<


if () {

_tree = new (,,);

_tree = ()adaptor.DupNode(,,);
<\n>
root_ = ()adaptor.BecomeRoot(_tree, root_);
\}

}, ...
)>



>>

// RULE REF AST

/** rule auto construct */
ruleRef(rule,label,elementIndex,args,scope) ::= <<

_last = ()input.LT(1);

if ()

adaptor.AddChild(root_, .Tree);
 
if (_first_ == null) _first_ = .Tree;




>>

/** x+=rule auto construct */
ruleRefAndListLabel(rule,label,elementIndex,args,scope) ::= <<


.Tree},...)>



>>

/** ^(rule ...) auto construct */
ruleRefRuleRoot(rule,label,elementIndex,args,scope) ::= <<

_last = ()input.LT(1);


if () root_ = ()adaptor.BecomeRoot(.Tree, root_);




>>

/** ^(x+=rule ...) auto construct */
ruleRefRuleRootAndListLabel(rule,label,elementIndex,args,scope) ::= <<


.Tree},...)>



>>

/** rule when output=AST and tracking for rewrite */
ruleRefTrack(rule,label,elementIndex,args,scope) ::= <<
_last = ()input.LT(1);

>>

/** x+=rule when output=AST and tracking for rewrite */
ruleRefTrackAndListLabel(rule,label,elementIndex,args,scope) ::= <<

_last = ()input.LT(1);




>>

/** ^(rule ...) rewrite */
ruleRefRuleRootTrack(rule,label,elementIndex,args,scope) ::= <<

_last = ()input.LT(1);




>>

/** ^(x+=rule ...) rewrite */
ruleRefRuleRootTrackAndListLabel(rule,label,elementIndex,args,scope) ::= <<

_last = ()input.LT(1);




>>

/** Streams for token refs are tree nodes now; override to
 *  change NextToken to NextNode.
 */
createRewriteNodeFromElement(token,terminalOptions,args) ::= <%

new (,stream_.NextNode())

stream_.NextNode()

%>

ruleCleanUp() ::= <<



if () {
retval.Tree = ()adaptor.RulePostProcessing(root_0);
}


>>