You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@freemarker.apache.org by dd...@apache.org on 2015/12/15 23:24:04 UTC

[23/23] incubator-freemarker git commit: Merge remote-tracking branch 'origin/2.3-gae' into 2.3

Merge remote-tracking branch 'origin/2.3-gae' into 2.3

Conflicts:
	src/main/java/freemarker/core/TemplateElement.java
	src/main/java/freemarker/debug/impl/RmiDebuggerService.java


Project: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/commit/c9425287
Tree: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/tree/c9425287
Diff: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/diff/c9425287

Branch: refs/heads/2.3
Commit: c942528745019d145ddf753d094bcb0350736afc
Parents: 5758b0a 204723f
Author: ddekany <dd...@apache.org>
Authored: Tue Dec 15 23:23:20 2015 +0100
Committer: ddekany <dd...@apache.org>
Committed: Tue Dec 15 23:23:20 2015 +0100

----------------------------------------------------------------------
 .../cache/TemplateLookupStrategy.java           |   2 +-
 src/main/java/freemarker/core/Assignment.java   |   3 +-
 .../freemarker/core/AssignmentInstruction.java  |  26 +-
 src/main/java/freemarker/core/AttemptBlock.java |  38 +-
 src/main/java/freemarker/core/AutoEscBlock.java |  17 +-
 .../java/freemarker/core/BlockAssignment.java   |  14 +-
 .../java/freemarker/core/BodyInstruction.java   |   8 +-
 .../java/freemarker/core/BreakInstruction.java  |   2 +-
 src/main/java/freemarker/core/Case.java         |  17 +-
 src/main/java/freemarker/core/Comment.java      |   3 +-
 .../java/freemarker/core/CompressedBlock.java   |  19 +-
 .../java/freemarker/core/ConditionalBlock.java  |  18 +-
 src/main/java/freemarker/core/DebugBreak.java   |  14 +-
 .../java/freemarker/core/DollarVariable.java    |   3 +-
 src/main/java/freemarker/core/ElseOfList.java   |  14 +-
 src/main/java/freemarker/core/Environment.java  | 196 +++++----
 src/main/java/freemarker/core/EscapeBlock.java  |  19 +-
 src/main/java/freemarker/core/Expression.java   |   3 +-
 .../freemarker/core/FallbackInstruction.java    |   8 +-
 .../java/freemarker/core/FlushInstruction.java  |   3 +-
 src/main/java/freemarker/core/IfBlock.java      |  30 +-
 src/main/java/freemarker/core/Include.java      |   9 +-
 src/main/java/freemarker/core/Items.java        |  11 +-
 .../java/freemarker/core/IteratorBlock.java     |  51 +--
 src/main/java/freemarker/core/LibraryLoad.java  |   9 +-
 .../java/freemarker/core/ListElseContainer.java |  15 +-
 .../java/freemarker/core/LocalContextStack.java |  39 ++
 src/main/java/freemarker/core/Macro.java        |  38 +-
 src/main/java/freemarker/core/MixedContent.java |  43 +-
 .../NestedContentNotSupportedException.java     |   5 +-
 .../java/freemarker/core/NoAutoEscBlock.java    |  17 +-
 .../java/freemarker/core/NoEscapeBlock.java     |  12 +-
 .../java/freemarker/core/NumericalOutput.java   |   3 +-
 .../java/freemarker/core/OutputFormatBlock.java |  17 +-
 .../java/freemarker/core/PropertySetting.java   |   3 +-
 .../java/freemarker/core/RecoveryBlock.java     |  14 +-
 src/main/java/freemarker/core/RecurseNode.java  |   8 +-
 .../java/freemarker/core/ReturnInstruction.java |  13 +-
 src/main/java/freemarker/core/Sep.java          |  11 +-
 .../freemarker/core/StackTraceVisibility.java   |   8 +
 .../java/freemarker/core/StopInstruction.java   |   2 +-
 src/main/java/freemarker/core/SwitchBlock.java  |  19 +-
 .../java/freemarker/core/TemplateElement.java   | 432 +++++++++----------
 .../core/TemplateElementArrayBuilder.java       |  80 ++++
 .../core/TemplateElementsToVisit.java           |  30 ++
 .../java/freemarker/core/TemplateObject.java    |  28 +-
 src/main/java/freemarker/core/TextBlock.java    |  44 +-
 ...nterruptionSupportTemplatePostProcessor.java |  36 +-
 .../java/freemarker/core/TransformBlock.java    |  18 +-
 .../java/freemarker/core/TrimInstruction.java   |   5 +-
 src/main/java/freemarker/core/UnifiedCall.java  |  35 +-
 src/main/java/freemarker/core/VisitNode.java    |   8 +-
 src/main/java/freemarker/core/_CoreAPI.java     |   8 +
 .../debug/impl/RmiDebuggerService.java          |  13 +-
 .../debug/impl/RmiDebuggerService.java.orig     | 415 ++++++++++++++++++
 .../freemarker/template/SimpleSequence.java     |   1 -
 src/main/java/freemarker/template/Template.java |  33 +-
 src/main/javacc/FTL.jj                          | 220 +++++-----
 src/manual/book.xml                             |  24 ++
 src/test/java/freemarker/core/ASTPrinter.java   |  51 ++-
 src/test/java/freemarker/core/ASTTest.java      |   4 +
 .../core/ast-multipleignoredchildren.ast        |  12 +
 .../core/ast-multipleignoredchildren.ftl        |  15 +
 63 files changed, 1483 insertions(+), 833 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/c9425287/src/main/java/freemarker/core/TemplateElement.java
----------------------------------------------------------------------
diff --cc src/main/java/freemarker/core/TemplateElement.java
index 9d54b19,916769e..af18136
--- a/src/main/java/freemarker/core/TemplateElement.java
+++ b/src/main/java/freemarker/core/TemplateElement.java
@@@ -180,23 -191,10 +193,14 @@@ abstract public class TemplateElement e
          return !isLeaf();
      }
  
 -    public int getIndex(TemplateElement node) {
 +    /**
 +     * @deprecated Starting from 2.4, we won't use {@link TreeNode} API, as it requires Swing.
 +     */
 +    @Deprecated
 +    public int getIndex(TreeNode node) {
-         if (nestedBlock instanceof MixedContent) {
-             return nestedBlock.getIndex(node);
-         }
-         if (nestedBlock != null) {
-             if (node == nestedBlock) {
-                 return 0;
-             }
-         } else {
-             for (int i = 0; i < regulatedChildCount; i++) {
-                 if (regulatedChildBuffer[i].equals(node)) { 
-                     return i;
-                 }
+         for (int i = 0; i < childCount; i++) {
+             if (childBuffer[i].equals(node)) {
+                 return i;
              }
          }
          return -1;
@@@ -229,28 -215,19 +221,20 @@@
      }
  
      /**
 -     * @deprecated Internal API - even internally, use {@link #getChild(int)} instead.
 +     * @deprecated This method will return {@link TemplateElement} starting from 2.4, as that doesn't require Swing;
-      * don't use it.
++     * don't use it. Internally, use {@link #getChild(int)} instead.
       */
      @Deprecated
 -    public TemplateElement getChildAt(int index) {
 +    public TreeNode getChildAt(int index) {
-         if (nestedBlock instanceof MixedContent) {
-             return nestedBlock.getChildAt(index);
+         if (childCount == 0) {
+             throw new IndexOutOfBoundsException("Template element has no children");
          }
-         if (nestedBlock != null) {
-             if (index == 0) {
-                 return nestedBlock;
-             }
-             throw new ArrayIndexOutOfBoundsException("invalid index");
-         } else if (regulatedChildCount != 0) {
-             try {
-                 return regulatedChildBuffer[index];
-             } catch (ArrayIndexOutOfBoundsException e) {
-                 // nestedElements was a List earlier, so we emulate the same kind of exception
-                 throw new IndexOutOfBoundsException("Index: " + index + ", Size: " + regulatedChildCount);
-             }
+         try {
+             return childBuffer[index];
+         } catch (ArrayIndexOutOfBoundsException e) {
+             // nestedElements was a List earlier, so we emulate the same kind of exception
+             throw new IndexOutOfBoundsException("Index: " + index + ", Size: " + childCount);
          }
-         throw new ArrayIndexOutOfBoundsException("Template element has no children");
      }
  
      public void setChildAt(int index, TemplateElement element) {
@@@ -269,16 -236,17 +243,18 @@@
              element.index = index;
              element.parent = this;
          } else {
-             throw new IndexOutOfBoundsException("element has no children");
+             throw new IndexOutOfBoundsException("Index: " + index + ", Size: " + childCount);
          }
      }
-     
+ 
      /**
+      * The element whose child this element is, or {@code null} if this is the root node.
+      * 
 -     * @deprecated Don't use in internal code either; use {@link #getParentElement()} there.
 +     * @deprecated This method will return {@link TemplateElement} starting from 2.4, as that doesn't require Swing;
-      * don't use it.
++     * don't use it. Don't use in internal code either; use {@link #getParentElement()} there.
       */
      @Deprecated
 -    public TemplateElement getParent() {
 +    public TreeNode getParent() {
          return parent;
      }
      

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/c9425287/src/main/java/freemarker/debug/impl/RmiDebuggerService.java.orig
----------------------------------------------------------------------
diff --cc src/main/java/freemarker/debug/impl/RmiDebuggerService.java.orig
index 0000000,0000000..262e459
new file mode 100644
--- /dev/null
+++ b/src/main/java/freemarker/debug/impl/RmiDebuggerService.java.orig
@@@ -1,0 -1,0 +1,415 @@@
++/*
++ * Licensed to the Apache Software Foundation (ASF) under one
++ * or more contributor license agreements.  See the NOTICE file
++ * distributed with this work for additional information
++ * regarding copyright ownership.  The ASF licenses this file
++ * to you under the Apache License, Version 2.0 (the
++ * "License"); you may not use this file except in compliance
++ * with the License.  You may obtain a copy of the License at
++ * 
++ *   http://www.apache.org/licenses/LICENSE-2.0
++ * 
++ * Unless required by applicable law or agreed to in writing,
++ * software distributed under the License is distributed on an
++ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
++ * KIND, either express or implied.  See the License for the
++ * specific language governing permissions and limitations
++ * under the License.
++ */
++
++package freemarker.debug.impl;
++
++import java.io.Serializable;
++import java.lang.ref.ReferenceQueue;
++import java.lang.ref.WeakReference;
++import java.rmi.RemoteException;
++import java.rmi.server.RemoteObject;
++import java.rmi.server.UnicastRemoteObject;
++import java.util.ArrayList;
++import java.util.Collection;
++import java.util.Collections;
++import java.util.Enumeration;
++import java.util.HashMap;
++import java.util.HashSet;
++import java.util.Iterator;
++import java.util.List;
++import java.util.Map;
++
++import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
++import freemarker.core.DebugBreak;
++import freemarker.core.Environment;
++import freemarker.core.TemplateElement;
++import freemarker.core._CoreAPI;
++import freemarker.debug.Breakpoint;
++import freemarker.debug.DebuggerListener;
++import freemarker.debug.EnvironmentSuspendedEvent;
++import freemarker.template.Template;
++import freemarker.template.utility.UndeclaredThrowableException;
++
++/**
++ * @version $Id
++ */
++class RmiDebuggerService
++extends
++    DebuggerService {
++    private final Map templateDebugInfos = new HashMap();
++    private final HashSet suspendedEnvironments = new HashSet();
++    private final Map listeners = new HashMap();
++    private final ReferenceQueue refQueue = new ReferenceQueue();
++     
++
++    private final RmiDebuggerImpl debugger;
++    private DebuggerServer server;
++
++    RmiDebuggerService() {
++        try {
++            debugger = new RmiDebuggerImpl(this);
++            server = new DebuggerServer((Serializable) RemoteObject.toStub(debugger));
++            server.start();
++        } catch (RemoteException e) {
++            e.printStackTrace();
++            throw new UndeclaredThrowableException(e);
++        }
++    }
++    
++    @Override
++    List getBreakpointsSpi(String templateName) {
++        synchronized (templateDebugInfos) {
++            TemplateDebugInfo tdi = findTemplateDebugInfo(templateName);
++            return tdi == null ? Collections.EMPTY_LIST : tdi.breakpoints;
++        }
++    }
++
++    List getBreakpointsSpi() {
++        List sumlist = new ArrayList();
++        synchronized (templateDebugInfos) {
++            for (Iterator iter = templateDebugInfos.values().iterator(); iter.hasNext(); ) {
++                sumlist.addAll(((TemplateDebugInfo) iter.next()).breakpoints);
++            }
++        }
++        Collections.sort(sumlist);
++        return sumlist;
++    }
++
++    // TODO See in SuppressFBWarnings
++    @Override
++    @SuppressFBWarnings(value={ "UW_UNCOND_WAIT", "WA_NOT_IN_LOOP" }, justification="Will have to be re-desigend; postponed.")
++    boolean suspendEnvironmentSpi(Environment env, String templateName, int line)
++    throws RemoteException {
++        RmiDebuggedEnvironmentImpl denv = 
++            (RmiDebuggedEnvironmentImpl)
++                RmiDebuggedEnvironmentImpl.getCachedWrapperFor(env);
++                
++        synchronized (suspendedEnvironments) {
++            suspendedEnvironments.add(denv);
++        }
++        try {
++            EnvironmentSuspendedEvent breakpointEvent = 
++                new EnvironmentSuspendedEvent(this, templateName, line, denv);
++    
++            synchronized (listeners) {
++                for (Iterator iter = listeners.values().iterator(); iter.hasNext(); ) {
++                    DebuggerListener listener = (DebuggerListener) iter.next();
++                    listener.environmentSuspended(breakpointEvent);
++                }
++            }
++            synchronized (denv) {
++                try {
++                    denv.wait();
++                } catch (InterruptedException e) {
++                    ;// Intentionally ignored
++                }
++            }
++            return denv.isStopped();
++        } finally {
++            synchronized (suspendedEnvironments) {
++                suspendedEnvironments.remove(denv);
++            }
++        }
++    }
++    
++    @Override
++    void registerTemplateSpi(Template template) {
++        String templateName = template.getName();
++        synchronized (templateDebugInfos) {
++            TemplateDebugInfo tdi = createTemplateDebugInfo(templateName);
++            tdi.templates.add(new TemplateReference(templateName, template, refQueue));
++            // Inject already defined breakpoints into the template
++            for (Iterator iter = tdi.breakpoints.iterator(); iter.hasNext(); ) {
++                Breakpoint breakpoint = (Breakpoint) iter.next();
++                insertDebugBreak(template, breakpoint);
++            }
++        }
++    }
++    
++    Collection getSuspendedEnvironments() {
++        return (Collection) suspendedEnvironments.clone();
++    }
++
++    Object addDebuggerListener(DebuggerListener listener) {
++        Object id; 
++        synchronized (listeners) {
++            id = Long.valueOf(System.currentTimeMillis());
++            listeners.put(id, listener);
++        }
++        return id;
++    }
++    
++    void removeDebuggerListener(Object id) {
++        synchronized (listeners) {
++            listeners.remove(id);
++        }
++    }
++
++    void addBreakpoint(Breakpoint breakpoint) {
++        String templateName = breakpoint.getTemplateName();
++        synchronized (templateDebugInfos) {
++            TemplateDebugInfo tdi = createTemplateDebugInfo(templateName);
++            List breakpoints = tdi.breakpoints;
++            int pos = Collections.binarySearch(breakpoints, breakpoint);
++            if (pos < 0) {
++                // Add to the list of breakpoints
++                breakpoints.add(-pos - 1, breakpoint);
++                // Inject the breakpoint into all templates with this name
++                for (Iterator iter = tdi.templates.iterator(); iter.hasNext(); ) {
++                    TemplateReference ref = (TemplateReference) iter.next();
++                    Template t = ref.getTemplate();
++                    if (t == null) {
++                        iter.remove();
++                    } else {
++                        insertDebugBreak(t, breakpoint);
++                    }
++                }
++            }
++        }
++    }
++
++    private static void insertDebugBreak(Template t, Breakpoint breakpoint) {
++        TemplateElement te = findTemplateElement(t.getRootTreeNode(), breakpoint.getLine());
++        if (te == null) {
++            return;
++        }
++<<<<<<< HEAD
++        TemplateElement parent = (TemplateElement) te.getParent();
++=======
++        TemplateElement parent = _CoreAPI.getParentElement(te);
++>>>>>>> origin/2.3-gae
++        DebugBreak db = new DebugBreak(te);
++        // TODO: Ensure there always is a parent by making sure
++        // that the root element in the template is always a MixedContent
++        // Also make sure it doesn't conflict with anyone's code.
++        parent.setChildAt(parent.getIndex(te), db);
++    }
++
++    private static TemplateElement findTemplateElement(TemplateElement te, int line) {
++        if (te.getBeginLine() > line || te.getEndLine() < line) {
++            return null;
++        }
++        // Find the narrowest match
++        List childMatches = new ArrayList();
++        for (Enumeration children = te.children(); children.hasMoreElements(); ) {
++            TemplateElement child = (TemplateElement) children.nextElement();
++            TemplateElement childmatch = findTemplateElement(child, line);
++            if (childmatch != null) {
++                childMatches.add(childmatch);
++            }
++        }
++        //find a match that exactly matches the begin/end line
++        TemplateElement bestMatch = null;
++        for (int i = 0; i < childMatches.size(); i++) {
++            TemplateElement e = (TemplateElement) childMatches.get(i);
++
++            if ( bestMatch == null ) {
++                bestMatch = e;
++            }
++
++            if ( e.getBeginLine() == line && e.getEndLine() > line ) {
++                bestMatch = e;
++            }
++
++            if ( e.getBeginLine() == e.getEndLine() && e.getBeginLine() == line) {
++                bestMatch = e;
++                break;
++            }
++        }
++        if ( bestMatch != null) {
++           return bestMatch;
++        }
++        // If no child provides narrower match, return this
++        return te;
++    }
++    
++    private TemplateDebugInfo findTemplateDebugInfo(String templateName) {
++        processRefQueue();
++        return (TemplateDebugInfo) templateDebugInfos.get(templateName); 
++    }
++    
++    private TemplateDebugInfo createTemplateDebugInfo(String templateName) {
++        TemplateDebugInfo tdi = findTemplateDebugInfo(templateName);
++        if (tdi == null) {
++            tdi = new TemplateDebugInfo();
++            templateDebugInfos.put(templateName, tdi);
++        }
++        return tdi;
++    }
++    
++    void removeBreakpoint(Breakpoint breakpoint) {
++        String templateName = breakpoint.getTemplateName();
++        synchronized (templateDebugInfos) {
++            TemplateDebugInfo tdi = findTemplateDebugInfo(templateName);
++            if (tdi != null) {
++                List breakpoints = tdi.breakpoints;
++                int pos = Collections.binarySearch(breakpoints, breakpoint);
++                if (pos >= 0) { 
++                    breakpoints.remove(pos);
++                    for (Iterator iter = tdi.templates.iterator(); iter.hasNext(); ) {
++                        TemplateReference ref = (TemplateReference) iter.next();
++                        Template t = ref.getTemplate();
++                        if (t == null) {
++                            iter.remove();
++                        } else {
++                            removeDebugBreak(t, breakpoint);
++                        }
++                    }
++                }
++                if (tdi.isEmpty()) {
++                    templateDebugInfos.remove(templateName);
++                }
++            }
++        }
++    }
++
++    private void removeDebugBreak(Template t, Breakpoint breakpoint) {
++        TemplateElement te = findTemplateElement(t.getRootTreeNode(), breakpoint.getLine());
++        if (te == null) {
++            return;
++        }
++        DebugBreak db = null;
++        while (te != null) {
++            if (te instanceof DebugBreak) {
++                db = (DebugBreak) te;
++                break;
++            }
++<<<<<<< HEAD
++            te = (TemplateElement) te.getParent();
++=======
++            te = _CoreAPI.getParentElement(te);
++>>>>>>> origin/2.3-gae
++        }
++        if (db == null) {
++            return;
++        }
++<<<<<<< HEAD
++        TemplateElement parent = (TemplateElement) db.getParent(); 
++        parent.setChildAt(parent.getIndex(db), (TemplateElement) db.getChildAt(0));
++=======
++        TemplateElement parent = _CoreAPI.getParentElement(db); 
++        parent.setChildAt(parent.getIndex(db), _CoreAPI.getChildElement(db, 0));
++>>>>>>> origin/2.3-gae
++    }
++    
++    void removeBreakpoints(String templateName) {
++        synchronized (templateDebugInfos) {
++            TemplateDebugInfo tdi = findTemplateDebugInfo(templateName);
++            if (tdi != null) {
++                removeBreakpoints(tdi);
++                if (tdi.isEmpty()) {
++                    templateDebugInfos.remove(templateName);
++                }
++            }
++        }
++    }
++
++    void removeBreakpoints() {
++        synchronized (templateDebugInfos) {
++            for (Iterator iter = templateDebugInfos.values().iterator(); iter.hasNext(); ) {
++                TemplateDebugInfo tdi = (TemplateDebugInfo) iter.next(); 
++                removeBreakpoints(tdi);
++                if (tdi.isEmpty()) {
++                    iter.remove();
++                }
++            }
++        }
++    }
++
++    private void removeBreakpoints(TemplateDebugInfo tdi) {
++        tdi.breakpoints.clear();
++        for (Iterator iter = tdi.templates.iterator(); iter.hasNext(); ) {
++            TemplateReference ref = (TemplateReference) iter.next();
++            Template t = ref.getTemplate();
++            if (t == null) {
++                iter.remove();
++            } else {
++                removeDebugBreaks(t.getRootTreeNode());
++            }
++        }
++    }
++    
++    private void removeDebugBreaks(TemplateElement te) {
++        int count = te.getChildCount();
++        for (int i = 0; i < count; ++i) {
++<<<<<<< HEAD
++            TemplateElement child = (TemplateElement) te.getChildAt(i);
++            while (child instanceof DebugBreak) {
++                TemplateElement dbchild = (TemplateElement) child.getChildAt(0); 
++=======
++            TemplateElement child = _CoreAPI.getChildElement(te, i);
++            while (child instanceof DebugBreak) {
++                TemplateElement dbchild = _CoreAPI.getChildElement(child, 0); 
++>>>>>>> origin/2.3-gae
++                te.setChildAt(i, dbchild);
++                child = dbchild;
++            }
++            removeDebugBreaks(child);
++        }
++    }
++    
++    private static final class TemplateDebugInfo {
++        final List templates = new ArrayList();
++        final List breakpoints = new ArrayList();
++        
++        boolean isEmpty() {
++            return templates.isEmpty() && breakpoints.isEmpty();
++        }
++    }
++    
++    private static final class TemplateReference extends WeakReference {
++        final String templateName;
++         
++        TemplateReference(String templateName, Template template, ReferenceQueue queue) {
++            super(template, queue);
++            this.templateName = templateName;
++        }
++        
++        Template getTemplate() {
++            return (Template) get();
++        }
++    }
++    
++    private void processRefQueue() {
++        for (; ; ) {
++            TemplateReference ref = (TemplateReference) refQueue.poll();
++            if (ref == null) {
++                break;
++            }
++            TemplateDebugInfo tdi = findTemplateDebugInfo(ref.templateName);
++            if (tdi != null) {
++                tdi.templates.remove(ref);
++                if (tdi.isEmpty()) {
++                    templateDebugInfos.remove(ref.templateName);
++                }
++            }
++        }
++    }
++
++    @Override
++    void shutdownSpi() {
++        server.stop();
++        try {
++            UnicastRemoteObject.unexportObject(this.debugger, true);
++        } catch (Exception e) {
++        }
++
++        RmiDebuggedEnvironmentImpl.cleanup();
++    }
++}

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/c9425287/src/main/java/freemarker/template/Template.java
----------------------------------------------------------------------