1 files changed, 121 insertions, 0 deletions
diff --git a/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Define.java b/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Define.java
new file mode 100755
index 00000000..f1e90f6a
--- /dev/null
+++ b/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/Define.java
@@ -0,0 +1,121 @@
+package org.apache.velocity.runtime.directive;
+
+/*
+ * 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.
+ */
+
+import org.apache.velocity.context.InternalContextAdapter;
+import org.apache.velocity.exception.TemplateInitException;
+import org.apache.velocity.exception.VelocityException;
+import org.apache.velocity.runtime.RuntimeConstants;
+import org.apache.velocity.runtime.RuntimeServices;
+import org.apache.velocity.runtime.parser.ParseException;
+import org.apache.velocity.runtime.parser.Token;
+import org.apache.velocity.runtime.parser.node.Node;
+import org.apache.velocity.runtime.parser.node.ParserTreeConstants;
+import org.apache.velocity.util.StringUtils;
+
+import java.io.Writer;
+import java.util.ArrayList;
+
+/**
+ * Directive that puts an unrendered AST block in the context
+ * under the specified key, postponing rendering until the
+ * reference is used and rendered.
+ *
+ * @author Andrew Tetlaw
+ * @author Nathan Bubna
+ * @version $Id: Define.java 686842 2008-08-18 18:29:31Z nbubna $
+ */
+public class Define extends Block
+{
+    /**
+     * Return name of this directive.
+     */
+    @Override
+    public String getName()
+    {
+        return "define";
+    }
+
+    /**
+     *  simple init - get the key
+     */
+    @Override
+    public void init(RuntimeServices rs, InternalContextAdapter context, Node node)
+        throws TemplateInitException
+    {
+        super.init(rs, context, node);
+
+        // the first child is the block name (key), the second child is the block AST body
+        if ( node.jjtGetNumChildren() != 2 )
+        {
+            throw new VelocityException("parameter missing: block name at "
+                 + StringUtils.formatFileString(this),
+                null,
+                rsvc.getLogContext().getStackTrace());
+        }
+
+        /*
+         * first token is the name of the block. We don't even check the format,
+         * just assume it looks like this: $block_name. Should we check if it has
+         * a '$' or not?
+         */
+        key = node.jjtGetChild(0).getFirstTokenImage().substring(1);
+
+        /*
+         * default max depth of two is used because intentional recursion is
+         * unlikely and discouraged, so make unintentional ones end fast
+         */
+        maxDepth = rsvc.getInt(RuntimeConstants.DEFINE_DIRECTIVE_MAXDEPTH, 2);
+    }
+
+    /**
+     * directive.render() simply makes an instance of the Block inner class
+     * and places it into the context as indicated.
+     */
+    @Override
+    public boolean render(InternalContextAdapter context, Writer writer, Node node)
+    {
+        /* put a Block.Reference instance into the context,
+         * using the user-defined key, for later inline rendering.
+         */
+        context.put(key, new Reference(context, this));
+        return true;
+    }
+
+    /**
+     * Called by the parser to validate the argument types
+     */
+    @Override
+    public void checkArgs(ArrayList<Integer> argtypes, Token t, String templateName)
+    throws ParseException
+    {
+      if (argtypes.size() != 1)
+      {
+          throw new MacroParseException("The #define directive requires one argument",
+             templateName, t);
+      }
+
+      if (argtypes.get(0) == ParserTreeConstants.JJTWORD)
+      {
+          throw new MacroParseException("The argument to #define is of the wrong type",
+              templateName, t);
+      }
+    }
+}