http://nexus.sonatype.org/oss-repository-hosting.html/ST4: StringTemplate is a java template engine for generating source code,
web pages, emails, or any other formatted text output.
StringTemplate is particularly good at multi-targeted code generators,
multiple site skins, and internationalization/localization.
It evolved over years of effort developing jGuru.com.
StringTemplate also powers the ANTLR 3 and 4 code generator. Its distinguishing characteristic
is that unlike other engines, it strictly enforces model-view separation.
Strict separation makes websites and code generators more flexible
and maintainable; it also provides an excellent defense against malicious
template authors.
/*
* [The "BSD license"]
* Copyright (c) 2011 Terence Parr
* 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.
*/
package org.stringtemplate.v4;
import org.stringtemplate.v4.debug.EvalTemplateEvent;
import org.stringtemplate.v4.debug.InterpEvent;
import org.stringtemplate.v4.gui.STViz;
import java.util.ArrayList;
import java.util.List;
/** */
public class InstanceScope {
Template that invoked us. /** Template that invoked us. */
public final InstanceScope parent;
Template we're executing. /** Template we're executing. */
public final ST st;
Current instruction pointer. /** Current instruction pointer. */
public int ip;
Includes the EvalTemplateEvent for this template. This is a subset of Interpreter.events field. The final EvalTemplateEvent is stored in 3 places:
- In
parent's childEvalTemplateEvents list
- In this list
- In the
Interpreter.events list
The root ST has the final EvalTemplateEvent in its list. All events get added to the parent's event list.
/**
* Includes the {@link EvalTemplateEvent} for this template. This is a
* subset of {@link Interpreter#events} field. The final
* {@link EvalTemplateEvent} is stored in 3 places:
*
* <ol>
* <li>In {@link #parent}'s {@link #childEvalTemplateEvents} list</li>
* <li>In this list</li>
* <li>In the {@link Interpreter#events} list</li>
* </ol>
*
* The root ST has the final {@link EvalTemplateEvent} in its list.
* <p>
* All events get added to the {@link #parent}'s event list.</p>
*/
public List<InterpEvent> events = new ArrayList<InterpEvent>();
/** All templates evaluated and embedded in this {@link ST}. Used
* for tree view in {@link STViz}.
*/
public List<EvalTemplateEvent> childEvalTemplateEvents =
new ArrayList<EvalTemplateEvent>();
public boolean earlyEval;
public InstanceScope(InstanceScope parent, ST st) {
this.parent = parent;
this.st = st;
this.earlyEval = parent != null && parent.earlyEval;
}
}