Changeset 693

Timestamp:

2008-10-13 08:59:27 (5 years ago)

Author:

jgou

Message:

KTL: improving template inheritance: allow calling the overridden block from the template (calling 'super')

Location:

trunk/universe/kauri-template/src

Files:

• main/java/org/kauriproject/template/DefaultTemplateBuilder.java (modified) (2 diffs)
• main/java/org/kauriproject/template/Directive.java (modified) (2 diffs)
• main/java/org/kauriproject/template/ExecutionContext.java (modified) (4 diffs)
• main/java/org/kauriproject/template/InheritanceBlock.java (modified) (1 diff)
• main/java/org/kauriproject/template/SuperBlock.java (added)
• test/resources/org/kauriproject/template/inherit_multiple.xml (modified) (2 diffs)
• test/resources/org/kauriproject/template/inherit_multiple_result.xml (modified) (1 diff)

trunk/universe/kauri-template/src/main/java/org/kauriproject/template/DefaultTemplateBuilder.java

@@ -163 +163 @@
         last.setCompiledNext(endStep);
         last = endStep;
+    }
+
+    protected TemplateBlock findParentOnStack(Class<? extends TemplateBlock> blockClass) {
+        boolean result = false;
+        int index = stack.size() - 1;
+        TemplateBlock block = null;
+        while (!result && index >= 0) {
+            block = stack.elementAt(index);
+            if (block.getClass().isAssignableFrom(blockClass)) {
+                result = true;
+            }
+            index--;
+        }
+        if (!result) {
+            return null;
+        }
+        return block;
     }
 
@@ -329 +346 @@
                     }
                     inheritanceRegistry.put(inheritblock.getName(), inheritblock);
+                } else if (Directive.SUPERBLOCK == directive) {
+                    InheritanceBlock parent = (InheritanceBlock) findParentOnStack(InheritanceBlock.class);
+                    SuperBlock superblock = new SuperBlock(locator, new SaxElement(uri, localName, name,
+                            attributes), parent);
+                    if (parent == null) {
+                        throw new RuntimeException(
+                                "A call to a superBlock is only possible from within an overriding block, location "
+                                        + superblock.getStartStep().getLocation());
+                    }
+                    pushBlock(superblock);
                 } else {
                     log.warn("Unsupported KTL directive: " + localName);

trunk/universe/kauri-template/src/main/java/org/kauriproject/template/Directive.java

@@ -99 +99 @@
      * block name="blockid"
      */
-    BLOCK("block");
+    BLOCK("block"),
+    /**
+     * directive (in block construct) to call the overriden block
+     */
+    SUPERBLOCK("superBlock");
 
     private final String tagName;
@@ -144 +148 @@
         else if (name.equals(BLOCK.tagName))
             return BLOCK;
+        else if (name.equals(SUPERBLOCK.tagName))
+            return SUPERBLOCK;
         else
             return null;// throw RuntimeException ?

trunk/universe/kauri-template/src/main/java/org/kauriproject/template/ExecutionContext.java

@@ -19 +19 @@
 import java.util.List;
 import java.util.Map;
+import java.util.Stack;
 
 import org.kauriproject.template.el.FunctionRegistry;
@@ -38 +39 @@
     private Map<String, IncludeBlock> includeRegistry;
     private Map<String, List<InheritanceBlock>> inheritanceChain;
+    private Stack<SuperBlock> superBlockStack;
 
     private boolean inherited = false;
@@ -54 +56 @@
         this.includeRegistry = new HashMap<String, IncludeBlock>();
         this.inheritanceChain = new HashMap<String, List<InheritanceBlock>>();
+        this.superBlockStack = new Stack<SuperBlock>();
     }
 
@@ -104 +107 @@
     }
 
+    public Stack<SuperBlock> getSuperBlockStack() {
+        return superBlockStack;
+    }
+
 }

trunk/universe/kauri-template/src/main/java/org/kauriproject/template/InheritanceBlock.java

@@ -81 +81 @@
             // lookup base block and execute baseblock.endstep.next
             if (context.isInherited()) {
-                // InheritanceBlock block = context.getBaseTemplate().getInheritanceRegistry().get(getName());
+                // check if this block is executed as a superblock and return to the calling block
+                if (!context.getSuperBlockStack().isEmpty()) {
+                    SuperBlock superBlock = context.getSuperBlockStack().peek();
+                    return superBlock.getEndStep();
+                }
+                // otherwise: lookup highest overridden block in chain
                 List<InheritanceBlock> chain = context.getInheritanceChain().get(getName());
                 if (chain != null && chain.size() > 0) {

trunk/universe/kauri-template/src/test/resources/org/kauriproject/template/inherit_multiple.xml

@@ -6 +6 @@
     <body>
         <ktl:block name="block1">
-            <p>first block - 2nd level child</p>
+            <div>
+                <ktl:superBlock />
+                <p>first block - 2nd level child</p>
+                <ktl:superBlock />
+            </div>
         </ktl:block>
         <ktl:block name="block2">
@@ -12 +16 @@
         </ktl:block>
         <ktl:block name="child">
-      <p>overriding block defined in parent</p>
-    </ktl:block>
-    <p>blablabla</p>
+            <p>overriding block defined in parent</p>
+        </ktl:block>
+        <p>blablabla</p>
     </body>
 </html>

trunk/universe/kauri-template/src/test/resources/org/kauriproject/template/inherit_multiple_result.xml

@@ -6 +6 @@
     <body>
         <p>leading stuff from base</p>
+        <div>
+        <p>first block - child</p>
         <p>first block - 2nd level child</p>
+        <p>first block - child</p>
+        </div>
         <p>second block - 2nd level child</p>
         <div>