| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> |
| <title>VelocimacroProxy xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/velocity/runtime/directive/VelocimacroProxy.html">View Javadoc</a></div><pre> |
|
|
| <a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.velocity.runtime.directive;
|
| <a name="2" href="#2">2</a>
|
| <a name="3" href="#3">3</a> <em class="jxr_comment">/*</em>
|
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
|
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
|
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
|
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
|
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
|
| <a name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
|
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
|
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
|
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
|
| <a name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
|
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
|
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
|
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
|
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
|
| <a name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
|
| <a name="19" href="#19">19</a> <em class="jxr_comment"> * under the License. </em>
|
| <a name="20" href="#20">20</a> <em class="jxr_comment"> */</em>
|
| <a name="21" href="#21">21</a>
|
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
|
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.Writer;
|
| <a name="24" href="#24">24</a>
|
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang.StringUtils;
|
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.context.InternalContextAdapter;
|
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.context.ProxyVMContext;
|
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.MacroOverflowException;
|
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.MethodInvocationException;
|
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.TemplateInitException;
|
| <a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.VelocityException;
|
| <a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.RuntimeConstants;
|
| <a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.RuntimeServices;
|
| <a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.ParserTreeConstants;
|
| <a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.node.ASTDirective;
|
| <a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.node.Node;
|
| <a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.node.SimpleNode;
|
| <a name="38" href="#38">38</a>
|
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * VelocimacroProxy.java</em>
|
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * a proxy Directive-derived object to fit with the current directive system</em>
|
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:geirm@optonline.net" target="alexandria_uri">mailto:geirm@optonline.net</a>">Geir Magnusson Jr.</a></em>
|
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * @version $Id: VelocimacroProxy.java 718424 2008-11-17 22:50:43Z nbubna $</em>
|
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="47" href="#47">47</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/velocity/runtime/directive/VelocimacroProxy.html">VelocimacroProxy</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/velocity/runtime/directive/Directive.html">Directive</a>
|
| <a name="48" href="#48">48</a> {
|
| <a name="49" href="#49">49</a> <strong class="jxr_keyword">private</strong> String macroName;
|
| <a name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> String[] argArray = <strong class="jxr_keyword">null</strong>;
|
| <a name="51" href="#51">51</a> <strong class="jxr_keyword">private</strong> String[] literalArgArray = <strong class="jxr_keyword">null</strong>;
|
| <a name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html">SimpleNode</a> nodeTree = <strong class="jxr_keyword">null</strong>;
|
| <a name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> numMacroArgs = 0;
|
| <a name="54" href="#54">54</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> preInit = false;
|
| <a name="55" href="#55">55</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> strictArguments;
|
| <a name="56" href="#56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> localContextScope = false;
|
| <a name="57" href="#57">57</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> maxCallDepth;
|
| <a name="58" href="#58">58</a>
|
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * Return name of this Velocimacro.</em>
|
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @return The name of this Velocimacro.</em>
|
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="63" href="#63">63</a> <strong class="jxr_keyword">public</strong> String getName()
|
| <a name="64" href="#64">64</a> {
|
| <a name="65" href="#65">65</a> <strong class="jxr_keyword">return</strong> macroName;
|
| <a name="66" href="#66">66</a> }
|
| <a name="67" href="#67">67</a>
|
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * Velocimacros are always LINE type directives.</em>
|
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @return The type of this directive.</em>
|
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="72" href="#72">72</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getType()
|
| <a name="73" href="#73">73</a> {
|
| <a name="74" href="#74">74</a> <strong class="jxr_keyword">return</strong> LINE;
|
| <a name="75" href="#75">75</a> }
|
| <a name="76" href="#76">76</a>
|
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * sets the directive name of this VM</em>
|
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * </em>
|
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @param name</em>
|
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="82" href="#82">82</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setName(String name)
|
| <a name="83" href="#83">83</a> {
|
| <a name="84" href="#84">84</a> macroName = name;
|
| <a name="85" href="#85">85</a> }
|
| <a name="86" href="#86">86</a>
|
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * sets the array of arguments specified in the macro definition</em>
|
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * </em>
|
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * @param arr</em>
|
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="92" href="#92">92</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setArgArray(String[] arr)
|
| <a name="93" href="#93">93</a> {
|
| <a name="94" href="#94">94</a> argArray = arr;
|
| <a name="95" href="#95">95</a>
|
| <a name="96" href="#96">96</a> <em class="jxr_comment">// for performance reasons we precache these strings - they are needed in</em>
|
| <a name="97" href="#97">97</a> <em class="jxr_comment">// "render literal if null" functionality</em>
|
| <a name="98" href="#98">98</a> literalArgArray = <strong class="jxr_keyword">new</strong> String[arr.length];
|
| <a name="99" href="#99">99</a> <strong class="jxr_keyword">for</strong>(<strong class="jxr_keyword">int</strong> i = 0; i < arr.length; i++)
|
| <a name="100" href="#100">100</a> {
|
| <a name="101" href="#101">101</a> literalArgArray[i] = <span class="jxr_string">".literal.$"</span> + argArray[i];
|
| <a name="102" href="#102">102</a> }
|
| <a name="103" href="#103">103</a>
|
| <a name="104" href="#104">104</a> <em class="jxr_comment">/*</em>
|
| <a name="105" href="#105">105</a> <em class="jxr_comment"> * get the arg count from the arg array. remember that the arg array has the macro name as</em>
|
| <a name="106" href="#106">106</a> <em class="jxr_comment"> * it's 0th element</em>
|
| <a name="107" href="#107">107</a> <em class="jxr_comment"> */</em>
|
| <a name="108" href="#108">108</a>
|
| <a name="109" href="#109">109</a> numMacroArgs = argArray.length - 1;
|
| <a name="110" href="#110">110</a> }
|
| <a name="111" href="#111">111</a>
|
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * @param tree</em>
|
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="115" href="#115">115</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setNodeTree(<a href="../../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html">SimpleNode</a> tree)
|
| <a name="116" href="#116">116</a> {
|
| <a name="117" href="#117">117</a> nodeTree = tree;
|
| <a name="118" href="#118">118</a> }
|
| <a name="119" href="#119">119</a>
|
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * returns the number of ars needed for this VM</em>
|
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * </em>
|
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * @return The number of ars needed for this VM</em>
|
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="125" href="#125">125</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getNumArgs()
|
| <a name="126" href="#126">126</a> {
|
| <a name="127" href="#127">127</a> <strong class="jxr_keyword">return</strong> numMacroArgs;
|
| <a name="128" href="#128">128</a> }
|
| <a name="129" href="#129">129</a>
|
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * Renders the macro using the context.</em>
|
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * </em>
|
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * @param context Current rendering context</em>
|
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * @param writer Writer for output</em>
|
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * @param node AST that calls the macro</em>
|
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * @return True if the directive rendered successfully.</em>
|
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * @throws IOException</em>
|
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * @throws MethodInvocationException</em>
|
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * @throws MacroOverflowException</em>
|
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="141" href="#141">141</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> render(<a href="../../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</a> context, Writer writer, <a href="../../../../../org/apache/velocity/runtime/parser/node/Node.html">Node</a> node)
|
| <a name="142" href="#142">142</a> <strong class="jxr_keyword">throws</strong> IOException, MethodInvocationException, <a href="../../../../../org/apache/velocity/exception/MacroOverflowException.html">MacroOverflowException</a>
|
| <a name="143" href="#143">143</a> {
|
| <a name="144" href="#144">144</a> <em class="jxr_comment">// wrap the current context and add the macro arguments</em>
|
| <a name="145" href="#145">145</a>
|
| <a name="146" href="#146">146</a> <em class="jxr_comment">// the creation of this context is a major bottleneck (incl 2x HashMap)</em>
|
| <a name="147" href="#147">147</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/velocity/context/ProxyVMContext.html">ProxyVMContext</a> vmc = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/context/ProxyVMContext.html">ProxyVMContext</a>(context, rsvc, localContextScope);
|
| <a name="148" href="#148">148</a>
|
| <a name="149" href="#149">149</a> <strong class="jxr_keyword">int</strong> callArguments = node.jjtGetNumChildren();
|
| <a name="150" href="#150">150</a>
|
| <a name="151" href="#151">151</a> <strong class="jxr_keyword">if</strong> (callArguments > 0)
|
| <a name="152" href="#152">152</a> {
|
| <a name="153" href="#153">153</a> <em class="jxr_comment">// the 0th element is the macro name</em>
|
| <a name="154" href="#154">154</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 1; i < argArray.length && i <= callArguments; i++)
|
| <a name="155" href="#155">155</a> {
|
| <a name="156" href="#156">156</a> <a href="../../../../../org/apache/velocity/runtime/parser/node/Node.html">Node</a> macroCallArgument = node.jjtGetChild(i - 1);
|
| <a name="157" href="#157">157</a>
|
| <a name="158" href="#158">158</a> <em class="jxr_comment">/*</em>
|
| <a name="159" href="#159">159</a> <em class="jxr_comment"> * literalArgArray[i] is needed for "render literal if null" functionality.</em>
|
| <a name="160" href="#160">160</a> <em class="jxr_comment"> * The value is used in ASTReference render-method.</em>
|
| <a name="161" href="#161">161</a> <em class="jxr_comment"> * </em>
|
| <a name="162" href="#162">162</a> <em class="jxr_comment"> * The idea is to avoid generating the literal until absolutely necessary.</em>
|
| <a name="163" href="#163">163</a> <em class="jxr_comment"> * </em>
|
| <a name="164" href="#164">164</a> <em class="jxr_comment"> * This makes VMReferenceMungeVisitor obsolete and it would not work anyway </em>
|
| <a name="165" href="#165">165</a> <em class="jxr_comment"> * when the macro AST is shared</em>
|
| <a name="166" href="#166">166</a> <em class="jxr_comment"> */</em>
|
| <a name="167" href="#167">167</a> vmc.addVMProxyArg(context, argArray[i], literalArgArray[i], macroCallArgument);
|
| <a name="168" href="#168">168</a> }
|
| <a name="169" href="#169">169</a> }
|
| <a name="170" href="#170">170</a>
|
| <a name="171" href="#171">171</a> <em class="jxr_comment">/*</em>
|
| <a name="172" href="#172">172</a> <em class="jxr_comment"> * check that we aren't already at the max call depth</em>
|
| <a name="173" href="#173">173</a> <em class="jxr_comment"> */</em>
|
| <a name="174" href="#174">174</a> <strong class="jxr_keyword">if</strong> (maxCallDepth > 0 && maxCallDepth == vmc.getCurrentMacroCallDepth())
|
| <a name="175" href="#175">175</a> {
|
| <a name="176" href="#176">176</a> String templateName = vmc.getCurrentTemplateName();
|
| <a name="177" href="#177">177</a> Object[] stack = vmc.getMacroNameStack();
|
| <a name="178" href="#178">178</a>
|
| <a name="179" href="#179">179</a> StringBuffer out = <strong class="jxr_keyword">new</strong> StringBuffer(100)
|
| <a name="180" href="#180">180</a> .append(<span class="jxr_string">"Max calling depth of "</span>).append(maxCallDepth)
|
| <a name="181" href="#181">181</a> .append(<span class="jxr_string">" was exceeded in Template:"</span>).append(templateName)
|
| <a name="182" href="#182">182</a> .append(<span class="jxr_string">" and Macro:"</span>).append(macroName)
|
| <a name="183" href="#183">183</a> .append(<span class="jxr_string">" with Call Stack:"</span>);
|
| <a name="184" href="#184">184</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < stack.length; i++)
|
| <a name="185" href="#185">185</a> {
|
| <a name="186" href="#186">186</a> <strong class="jxr_keyword">if</strong> (i != 0)
|
| <a name="187" href="#187">187</a> {
|
| <a name="188" href="#188">188</a> out.append(<span class="jxr_string">"->"</span>);
|
| <a name="189" href="#189">189</a> }
|
| <a name="190" href="#190">190</a> out.append(stack[i]);
|
| <a name="191" href="#191">191</a> }
|
| <a name="192" href="#192">192</a> rsvc.getLog().error(out.toString());
|
| <a name="193" href="#193">193</a>
|
| <a name="194" href="#194">194</a> <strong class="jxr_keyword">try</strong>
|
| <a name="195" href="#195">195</a> {
|
| <a name="196" href="#196">196</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/exception/MacroOverflowException.html">MacroOverflowException</a>(out.toString());
|
| <a name="197" href="#197">197</a> }
|
| <a name="198" href="#198">198</a> <strong class="jxr_keyword">finally</strong>
|
| <a name="199" href="#199">199</a> {
|
| <a name="200" href="#200">200</a> <em class="jxr_comment">// clean out the macro stack, since we just broke it</em>
|
| <a name="201" href="#201">201</a> <strong class="jxr_keyword">while</strong> (vmc.getCurrentMacroCallDepth() > 0)
|
| <a name="202" href="#202">202</a> {
|
| <a name="203" href="#203">203</a> vmc.popCurrentMacroName();
|
| <a name="204" href="#204">204</a> }
|
| <a name="205" href="#205">205</a> }
|
| <a name="206" href="#206">206</a> }
|
| <a name="207" href="#207">207</a>
|
| <a name="208" href="#208">208</a> <strong class="jxr_keyword">try</strong>
|
| <a name="209" href="#209">209</a> {
|
| <a name="210" href="#210">210</a> <em class="jxr_comment">// render the velocity macro</em>
|
| <a name="211" href="#211">211</a> vmc.pushCurrentMacroName(macroName);
|
| <a name="212" href="#212">212</a> nodeTree.render(vmc, writer);
|
| <a name="213" href="#213">213</a> vmc.popCurrentMacroName();
|
| <a name="214" href="#214">214</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
|
| <a name="215" href="#215">215</a> }
|
| <a name="216" href="#216">216</a> <strong class="jxr_keyword">catch</strong> (RuntimeException e)
|
| <a name="217" href="#217">217</a> {
|
| <a name="218" href="#218">218</a> <strong class="jxr_keyword">throw</strong> e;
|
| <a name="219" href="#219">219</a> }
|
| <a name="220" href="#220">220</a> <strong class="jxr_keyword">catch</strong> (Exception e)
|
| <a name="221" href="#221">221</a> {
|
| <a name="222" href="#222">222</a> String msg = <span class="jxr_string">"VelocimacroProxy.render() : exception VM = #"</span> + macroName + <span class="jxr_string">"()"</span>;
|
| <a name="223" href="#223">223</a> rsvc.getLog().error(msg, e);
|
| <a name="224" href="#224">224</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/exception/VelocityException.html">VelocityException</a>(msg, e);
|
| <a name="225" href="#225">225</a> }
|
| <a name="226" href="#226">226</a> }
|
| <a name="227" href="#227">227</a>
|
| <a name="228" href="#228">228</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * The major meat of VelocimacroProxy, init() checks the # of arguments.</em>
|
| <a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * </em>
|
| <a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * @param rs</em>
|
| <a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * @param context</em>
|
| <a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * @param node</em>
|
| <a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * @throws TemplateInitException</em>
|
| <a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="236" href="#236">236</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init(<a href="../../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</a> rs, <a href="../../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</a> context, <a href="../../../../../org/apache/velocity/runtime/parser/node/Node.html">Node</a> node)
|
| <a name="237" href="#237">237</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../../org/apache/velocity/exception/TemplateInitException.html">TemplateInitException</a>
|
| <a name="238" href="#238">238</a> {
|
| <a name="239" href="#239">239</a> <em class="jxr_comment">// there can be multiple threads here so avoid double inits</em>
|
| <a name="240" href="#240">240</a> <strong class="jxr_keyword">synchronized</strong> (<strong class="jxr_keyword">this</strong>)
|
| <a name="241" href="#241">241</a> {
|
| <a name="242" href="#242">242</a> <strong class="jxr_keyword">if</strong> (!preInit)
|
| <a name="243" href="#243">243</a> {
|
| <a name="244" href="#244">244</a> <strong class="jxr_keyword">super</strong>.init(rs, context, node);
|
| <a name="245" href="#245">245</a>
|
| <a name="246" href="#246">246</a> <em class="jxr_comment">// this is a very expensive call (ExtendedProperties is very slow)</em>
|
| <a name="247" href="#247">247</a> strictArguments = rs.getConfiguration().getBoolean(
|
| <a name="248" href="#248">248</a> RuntimeConstants.VM_ARGUMENTS_STRICT, false);
|
| <a name="249" href="#249">249</a>
|
| <a name="250" href="#250">250</a> <em class="jxr_comment">// support for local context scope feature, where all references are local</em>
|
| <a name="251" href="#251">251</a> <em class="jxr_comment">// we do not have to check this at every invocation of ProxyVMContext</em>
|
| <a name="252" href="#252">252</a> localContextScope = rsvc.getBoolean(RuntimeConstants.VM_CONTEXT_LOCALSCOPE, false);
|
| <a name="253" href="#253">253</a>
|
| <a name="254" href="#254">254</a> <em class="jxr_comment">// get the macro call depth limit</em>
|
| <a name="255" href="#255">255</a> maxCallDepth = rsvc.getInt(RuntimeConstants.VM_MAX_DEPTH);
|
| <a name="256" href="#256">256</a>
|
| <a name="257" href="#257">257</a> <em class="jxr_comment">// initialize the parsed AST</em>
|
| <a name="258" href="#258">258</a> <em class="jxr_comment">// since this is context independent we need to do this only once so</em>
|
| <a name="259" href="#259">259</a> <em class="jxr_comment">// do it here instead of the render method</em>
|
| <a name="260" href="#260">260</a> nodeTree.init(context, rs);
|
| <a name="261" href="#261">261</a>
|
| <a name="262" href="#262">262</a> preInit = <strong class="jxr_keyword">true</strong>;
|
| <a name="263" href="#263">263</a> }
|
| <a name="264" href="#264">264</a> }
|
| <a name="265" href="#265">265</a>
|
| <a name="266" href="#266">266</a> <em class="jxr_comment">// check how many arguments we got</em>
|
| <a name="267" href="#267">267</a> <strong class="jxr_keyword">int</strong> i = node.jjtGetNumChildren();
|
| <a name="268" href="#268">268</a>
|
| <a name="269" href="#269">269</a> <em class="jxr_comment">// Throw exception for invalid number of arguments?</em>
|
| <a name="270" href="#270">270</a> <strong class="jxr_keyword">if</strong> (getNumArgs() != i)
|
| <a name="271" href="#271">271</a> {
|
| <a name="272" href="#272">272</a> <em class="jxr_comment">// If we have a not-yet defined macro, we do get no arguments because</em>
|
| <a name="273" href="#273">273</a> <em class="jxr_comment">// the syntax tree looks different than with a already defined macro.</em>
|
| <a name="274" href="#274">274</a> <em class="jxr_comment">// But we do know that we must be in a macro definition context somewhere up the</em>
|
| <a name="275" href="#275">275</a> <em class="jxr_comment">// syntax tree.</em>
|
| <a name="276" href="#276">276</a> <em class="jxr_comment">// Check for that, if it is true, suppress the error message.</em>
|
| <a name="277" href="#277">277</a> <em class="jxr_comment">// Fixes VELOCITY-71.</em>
|
| <a name="278" href="#278">278</a>
|
| <a name="279" href="#279">279</a> <strong class="jxr_keyword">for</strong> (Node parent = node.jjtGetParent(); parent != <strong class="jxr_keyword">null</strong>;)
|
| <a name="280" href="#280">280</a> {
|
| <a name="281" href="#281">281</a> <strong class="jxr_keyword">if</strong> ((parent instanceof ASTDirective)
|
| <a name="282" href="#282">282</a> && StringUtils.equals(((ASTDirective) parent).getDirectiveName(), <span class="jxr_string">"macro"</span>))
|
| <a name="283" href="#283">283</a> {
|
| <a name="284" href="#284">284</a> <strong class="jxr_keyword">return</strong>;
|
| <a name="285" href="#285">285</a> }
|
| <a name="286" href="#286">286</a> parent = parent.jjtGetParent();
|
| <a name="287" href="#287">287</a> }
|
| <a name="288" href="#288">288</a>
|
| <a name="289" href="#289">289</a> String msg = <span class="jxr_string">"VM #"</span> + macroName + <span class="jxr_string">": too "</span>
|
| <a name="290" href="#290">290</a> + ((getNumArgs() > i) ? <span class="jxr_string">"few"</span> : <span class="jxr_string">"many"</span>) + <span class="jxr_string">" arguments to macro. Wanted "</span>
|
| <a name="291" href="#291">291</a> + getNumArgs() + <span class="jxr_string">" got "</span> + i;
|
| <a name="292" href="#292">292</a>
|
| <a name="293" href="#293">293</a> <strong class="jxr_keyword">if</strong> (strictArguments)
|
| <a name="294" href="#294">294</a> {
|
| <a name="295" href="#295">295</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="296" href="#296">296</a> <em class="jxr_javadoccomment"> * indicate col/line assuming it starts at 0 - this will be corrected one call up</em>
|
| <a name="297" href="#297">297</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="298" href="#298">298</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/exception/TemplateInitException.html">TemplateInitException</a>(msg, context.getCurrentTemplateName(), 0, 0);
|
| <a name="299" href="#299">299</a> }
|
| <a name="300" href="#300">300</a> <strong class="jxr_keyword">else</strong>
|
| <a name="301" href="#301">301</a> {
|
| <a name="302" href="#302">302</a> rsvc.getLog().debug(msg);
|
| <a name="303" href="#303">303</a> <strong class="jxr_keyword">return</strong>;
|
| <a name="304" href="#304">304</a> }
|
| <a name="305" href="#305">305</a> }
|
| <a name="306" href="#306">306</a>
|
| <a name="307" href="#307">307</a> <em class="jxr_comment">/*<em class="jxr_comment"> now validate that none of the arguments are plain words, (VELOCITY-614)</em></em>
|
| <a name="308" href="#308">308</a> <em class="jxr_comment"> * they should be string literals, references, inline maps, or inline lists */</em>
|
| <a name="309" href="#309">309</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> n=0; n < i; n++)
|
| <a name="310" href="#310">310</a> {
|
| <a name="311" href="#311">311</a> <a href="../../../../../org/apache/velocity/runtime/parser/node/Node.html">Node</a> child = node.jjtGetChild(n);
|
| <a name="312" href="#312">312</a> <strong class="jxr_keyword">if</strong> (child.getType() == ParserTreeConstants.JJTWORD)
|
| <a name="313" href="#313">313</a> {
|
| <a name="314" href="#314">314</a> <em class="jxr_comment">/*<em class="jxr_comment"> indicate col/line assuming it starts at 0</em></em>
|
| <a name="315" href="#315">315</a> <em class="jxr_comment"> * this will be corrected one call up */</em>
|
| <a name="316" href="#316">316</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/exception/TemplateInitException.html">TemplateInitException</a>(<span class="jxr_string">"Invalid arg #"</span>
|
| <a name="317" href="#317">317</a> + n + <span class="jxr_string">" in VM #"</span> + macroName, context.getCurrentTemplateName(), 0, 0);
|
| <a name="318" href="#318">318</a> }
|
| <a name="319" href="#319">319</a> }
|
| <a name="320" href="#320">320</a> }
|
| <a name="321" href="#321">321</a> }
|
| <a name="322" href="#322">322</a>
|
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
|
|
