| <!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.BufferedReader; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.StringReader; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.io.Writer; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.HashMap; |
| <a name="27" href="#27">27</a> |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang.StringUtils; |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.context.InternalContextAdapter; |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.context.VMContext; |
| <a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.MethodInvocationException; |
| <a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.TemplateInitException; |
| <a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.RuntimeConstants; |
| <a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.RuntimeServices; |
| <a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.ParserTreeConstants; |
| <a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.Token; |
| <a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.node.ASTDirective; |
| <a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.node.Node; |
| <a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.node.SimpleNode; |
| <a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.visitor.VMReferenceMungeVisitor; |
| <a name="41" href="#41">41</a> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * VelocimacroProxy.java</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * a proxy Directive-derived object to fit with the current directive system</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="47" href="#47">47</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="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @version $Id: VelocimacroProxy.java 471381 2006-11-05 08:56:58Z wglass $</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="50" href="#50">50</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="51" href="#51">51</a> { |
| <a name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> String macroName = <span class="jxr_string">""</span>; |
| <a name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> String macroBody = <span class="jxr_string">""</span>; |
| <a name="54" href="#54">54</a> <strong class="jxr_keyword">private</strong> String[] argArray = <strong class="jxr_keyword">null</strong>; |
| <a name="55" href="#55">55</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="56" href="#56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> numMacroArgs = 0; |
| <a name="57" href="#57">57</a> <strong class="jxr_keyword">private</strong> String namespace = <span class="jxr_string">""</span>; |
| <a name="58" href="#58">58</a> |
| <a name="59" href="#59">59</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> init = false; |
| <a name="60" href="#60">60</a> <strong class="jxr_keyword">private</strong> String[] callingArgs; |
| <a name="61" href="#61">61</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong>[] callingArgTypes; |
| <a name="62" href="#62">62</a> <strong class="jxr_keyword">private</strong> HashMap proxyArgHash = <strong class="jxr_keyword">new</strong> HashMap(); |
| <a name="63" href="#63">63</a> |
| <a name="64" href="#64">64</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> strictArguments; |
| <a name="65" href="#65">65</a> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * Return name of this Velocimacro.</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * @return The name of this Velocimacro.</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="70" href="#70">70</a> <strong class="jxr_keyword">public</strong> String getName() |
| <a name="71" href="#71">71</a> { |
| <a name="72" href="#72">72</a> <strong class="jxr_keyword">return</strong> macroName; |
| <a name="73" href="#73">73</a> } |
| <a name="74" href="#74">74</a> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * Velocimacros are always LINE</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * type directives.</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * @return The type of this directive.</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="80" href="#80">80</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getType() |
| <a name="81" href="#81">81</a> { |
| <a name="82" href="#82">82</a> <strong class="jxr_keyword">return</strong> LINE; |
| <a name="83" href="#83">83</a> } |
| <a name="84" href="#84">84</a> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * sets the directive name of this VM</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * @param name</em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="89" href="#89">89</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setName( String name ) |
| <a name="90" href="#90">90</a> { |
| <a name="91" href="#91">91</a> macroName = name; |
| <a name="92" href="#92">92</a> } |
| <a name="93" href="#93">93</a> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * sets the array of arguments specified in the macro definition</em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * @param arr</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="98" href="#98">98</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setArgArray( String [] arr ) |
| <a name="99" href="#99">99</a> { |
| <a name="100" href="#100">100</a> argArray = arr; |
| <a name="101" href="#101">101</a> |
| <a name="102" href="#102">102</a> <em class="jxr_comment">/*</em> |
| <a name="103" href="#103">103</a> <em class="jxr_comment"> * get the arg count from the arg array. remember that the arg array</em> |
| <a name="104" href="#104">104</a> <em class="jxr_comment"> * has the macro name as it's 0th element</em> |
| <a name="105" href="#105">105</a> <em class="jxr_comment"> */</em> |
| <a name="106" href="#106">106</a> |
| <a name="107" href="#107">107</a> numMacroArgs = argArray.length - 1; |
| <a name="108" href="#108">108</a> } |
| <a name="109" href="#109">109</a> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * @param tree</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="113" href="#113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setNodeTree( SimpleNode tree ) |
| <a name="114" href="#114">114</a> { |
| <a name="115" href="#115">115</a> nodeTree = tree; |
| <a name="116" href="#116">116</a> } |
| <a name="117" href="#117">117</a> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * returns the number of ars needed for this VM</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @return The number of ars needed for this VM</em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="122" href="#122">122</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getNumArgs() |
| <a name="123" href="#123">123</a> { |
| <a name="124" href="#124">124</a> <strong class="jxr_keyword">return</strong> numMacroArgs; |
| <a name="125" href="#125">125</a> } |
| <a name="126" href="#126">126</a> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * Sets the orignal macro body. This is simply the cat of the macroArray, but the</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * Macro object creates this once during parsing, and everyone shares it.</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * Note : it must not be modified.</em> |
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * @param mb</em> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="133" href="#133">133</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setMacrobody( String mb ) |
| <a name="134" href="#134">134</a> { |
| <a name="135" href="#135">135</a> macroBody = mb; |
| <a name="136" href="#136">136</a> } |
| <a name="137" href="#137">137</a> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * @param ns</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">void</strong> setNamespace( String ns ) |
| <a name="142" href="#142">142</a> { |
| <a name="143" href="#143">143</a> <strong class="jxr_keyword">this</strong>.namespace = ns; |
| <a name="144" href="#144">144</a> } |
| <a name="145" href="#145">145</a> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * Renders the macro using the context</em> |
| <a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * @param context</em> |
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * @param writer</em> |
| <a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * @param node</em> |
| <a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * @return True if the directive rendered successfully.</em> |
| <a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * @throws IOException</em> |
| <a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * @throws MethodInvocationException</em> |
| <a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="155" href="#155">155</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> render( InternalContextAdapter context, Writer writer, Node node) |
| <a name="156" href="#156">156</a> <strong class="jxr_keyword">throws</strong> IOException, <a href="../../../../../org/apache/velocity/exception/MethodInvocationException.html">MethodInvocationException</a> |
| <a name="157" href="#157">157</a> { |
| <a name="158" href="#158">158</a> <strong class="jxr_keyword">try</strong> |
| <a name="159" href="#159">159</a> { |
| <a name="160" href="#160">160</a> <em class="jxr_comment">/*</em> |
| <a name="161" href="#161">161</a> <em class="jxr_comment"> * it's possible the tree hasn't been parsed yet, so get</em> |
| <a name="162" href="#162">162</a> <em class="jxr_comment"> * the VMManager to parse and init it</em> |
| <a name="163" href="#163">163</a> <em class="jxr_comment"> */</em> |
| <a name="164" href="#164">164</a> |
| <a name="165" href="#165">165</a> <strong class="jxr_keyword">if</strong> (nodeTree != <strong class="jxr_keyword">null</strong>) |
| <a name="166" href="#166">166</a> { |
| <a name="167" href="#167">167</a> <strong class="jxr_keyword">if</strong> ( !init ) |
| <a name="168" href="#168">168</a> { |
| <a name="169" href="#169">169</a> nodeTree.init( context, rsvc); |
| <a name="170" href="#170">170</a> init = <strong class="jxr_keyword">true</strong>; |
| <a name="171" href="#171">171</a> } |
| <a name="172" href="#172">172</a> |
| <a name="173" href="#173">173</a> <em class="jxr_comment">/*</em> |
| <a name="174" href="#174">174</a> <em class="jxr_comment"> * wrap the current context and add the VMProxyArg objects</em> |
| <a name="175" href="#175">175</a> <em class="jxr_comment"> */</em> |
| <a name="176" href="#176">176</a> |
| <a name="177" href="#177">177</a> <a href="../../../../../org/apache/velocity/context/VMContext.html">VMContext</a> vmc = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/context/VMContext.html">VMContext</a>( context, rsvc ); |
| <a name="178" href="#178">178</a> |
| <a name="179" href="#179">179</a> <strong class="jxr_keyword">for</strong>( <strong class="jxr_keyword">int</strong> i = 1; i < argArray.length; i++) |
| <a name="180" href="#180">180</a> { |
| <a name="181" href="#181">181</a> <em class="jxr_comment">/*</em> |
| <a name="182" href="#182">182</a> <em class="jxr_comment"> * we can do this as VMProxyArgs don't change state. They change</em> |
| <a name="183" href="#183">183</a> <em class="jxr_comment"> * the context.</em> |
| <a name="184" href="#184">184</a> <em class="jxr_comment"> */</em> |
| <a name="185" href="#185">185</a> |
| <a name="186" href="#186">186</a> <a href="../../../../../org/apache/velocity/runtime/directive/VMProxyArg.html">VMProxyArg</a> arg = (VMProxyArg) proxyArgHash.get( argArray[i] ); |
| <a name="187" href="#187">187</a> vmc.addVMProxyArg( arg ); |
| <a name="188" href="#188">188</a> } |
| <a name="189" href="#189">189</a> |
| <a name="190" href="#190">190</a> <em class="jxr_comment">/*</em> |
| <a name="191" href="#191">191</a> <em class="jxr_comment"> * now render the VM</em> |
| <a name="192" href="#192">192</a> <em class="jxr_comment"> */</em> |
| <a name="193" href="#193">193</a> |
| <a name="194" href="#194">194</a> nodeTree.render( vmc, writer ); |
| <a name="195" href="#195">195</a> } |
| <a name="196" href="#196">196</a> <strong class="jxr_keyword">else</strong> |
| <a name="197" href="#197">197</a> { |
| <a name="198" href="#198">198</a> rsvc.getLog().error(<span class="jxr_string">"VM error "</span> + macroName + <span class="jxr_string">". Null AST"</span>); |
| <a name="199" href="#199">199</a> } |
| <a name="200" href="#200">200</a> } |
| <a name="201" href="#201">201</a> |
| <a name="202" href="#202">202</a> <em class="jxr_comment">/*</em> |
| <a name="203" href="#203">203</a> <em class="jxr_comment"> * if it's a MIE, it came from the render.... throw it...</em> |
| <a name="204" href="#204">204</a> <em class="jxr_comment"> */</em> |
| <a name="205" href="#205">205</a> <strong class="jxr_keyword">catch</strong>( MethodInvocationException e ) |
| <a name="206" href="#206">206</a> { |
| <a name="207" href="#207">207</a> <strong class="jxr_keyword">throw</strong> e; |
| <a name="208" href="#208">208</a> } |
| <a name="209" href="#209">209</a> |
| <a name="210" href="#210">210</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="211" href="#211">211</a> <em class="jxr_javadoccomment"> * pass through application level runtime exceptions</em> |
| <a name="212" href="#212">212</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="213" href="#213">213</a> <strong class="jxr_keyword">catch</strong>( RuntimeException e ) |
| <a name="214" href="#214">214</a> { |
| <a name="215" href="#215">215</a> <strong class="jxr_keyword">throw</strong> e; |
| <a name="216" href="#216">216</a> } |
| <a name="217" href="#217">217</a> |
| <a name="218" href="#218">218</a> <strong class="jxr_keyword">catch</strong> ( Exception e ) |
| <a name="219" href="#219">219</a> { |
| <a name="220" href="#220">220</a> |
| <a name="221" href="#221">221</a> rsvc.getLog().error(<span class="jxr_string">"VelocimacroProxy.render() : exception VM = #"</span> + |
| <a name="222" href="#222">222</a> macroName + <span class="jxr_string">"()"</span>, e); |
| <a name="223" href="#223">223</a> } |
| <a name="224" href="#224">224</a> |
| <a name="225" href="#225">225</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <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, patches the</em> |
| <a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * macro body, renders the macro into an AST, and then inits the AST, so it is ready</em> |
| <a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * for quick rendering. Note that this is only AST dependant stuff. Not context.</em> |
| <a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * @param rs</em> |
| <a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * @param context</em> |
| <a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * @param node</em> |
| <a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> * @throws TemplateInitException</em> |
| <a name="236" href="#236">236</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="237" href="#237">237</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init( RuntimeServices rs, InternalContextAdapter context, Node node) |
| <a name="238" href="#238">238</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../../org/apache/velocity/exception/TemplateInitException.html">TemplateInitException</a> |
| <a name="239" href="#239">239</a> { |
| <a name="240" href="#240">240</a> <strong class="jxr_keyword">super</strong>.init( rs, context, node ); |
| <a name="241" href="#241">241</a> |
| <a name="242" href="#242">242</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="243" href="#243">243</a> <em class="jxr_javadoccomment"> * Throw exception for invalid number of arguments?</em> |
| <a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="245" href="#245">245</a> strictArguments = rs.getConfiguration().getBoolean(RuntimeConstants.VM_ARGUMENTS_STRICT,false); |
| <a name="246" href="#246">246</a> |
| <a name="247" href="#247">247</a> <em class="jxr_comment">/*</em> |
| <a name="248" href="#248">248</a> <em class="jxr_comment"> * how many args did we get?</em> |
| <a name="249" href="#249">249</a> <em class="jxr_comment"> */</em> |
| <a name="250" href="#250">250</a> |
| <a name="251" href="#251">251</a> <strong class="jxr_keyword">int</strong> i = node.jjtGetNumChildren(); |
| <a name="252" href="#252">252</a> |
| <a name="253" href="#253">253</a> <em class="jxr_comment">/*</em> |
| <a name="254" href="#254">254</a> <em class="jxr_comment"> * right number of args?</em> |
| <a name="255" href="#255">255</a> <em class="jxr_comment"> */</em> |
| <a name="256" href="#256">256</a> |
| <a name="257" href="#257">257</a> <strong class="jxr_keyword">if</strong> ( getNumArgs() != i ) |
| <a name="258" href="#258">258</a> { |
| <a name="259" href="#259">259</a> <em class="jxr_comment">// If we have a not-yet defined macro, we do get no arguments because</em> |
| <a name="260" href="#260">260</a> <em class="jxr_comment">// the syntax tree looks different than with a already defined macro.</em> |
| <a name="261" href="#261">261</a> <em class="jxr_comment">// But we do know that we must be in a macro definition context somewhere up the</em> |
| <a name="262" href="#262">262</a> <em class="jxr_comment">// syntax tree.</em> |
| <a name="263" href="#263">263</a> <em class="jxr_comment">// Check for that, if it is true, suppress the error message.</em> |
| <a name="264" href="#264">264</a> <em class="jxr_comment">// Fixes VELOCITY-71.</em> |
| <a name="265" href="#265">265</a> |
| <a name="266" href="#266">266</a> <strong class="jxr_keyword">for</strong> (Node parent = node.jjtGetParent(); parent != <strong class="jxr_keyword">null</strong>; ) |
| <a name="267" href="#267">267</a> { |
| <a name="268" href="#268">268</a> <strong class="jxr_keyword">if</strong> ((parent instanceof ASTDirective) && |
| <a name="269" href="#269">269</a> StringUtils.equals(((ASTDirective) parent).getDirectiveName(), <span class="jxr_string">"macro"</span>)) |
| <a name="270" href="#270">270</a> { |
| <a name="271" href="#271">271</a> <strong class="jxr_keyword">return</strong>; |
| <a name="272" href="#272">272</a> } |
| <a name="273" href="#273">273</a> parent = parent.jjtGetParent(); |
| <a name="274" href="#274">274</a> } |
| <a name="275" href="#275">275</a> |
| <a name="276" href="#276">276</a> String errormsg = <span class="jxr_string">"VM #"</span> + macroName + <span class="jxr_string">": error : too "</span> + |
| <a name="277" href="#277">277</a> ((getNumArgs() > i) ? <span class="jxr_string">"few"</span> : <span class="jxr_string">"many"</span>) + |
| <a name="278" href="#278">278</a> <span class="jxr_string">" arguments to macro. Wanted "</span> + getNumArgs() + |
| <a name="279" href="#279">279</a> <span class="jxr_string">" got "</span> + i; |
| <a name="280" href="#280">280</a> |
| <a name="281" href="#281">281</a> <strong class="jxr_keyword">if</strong> (strictArguments) |
| <a name="282" href="#282">282</a> { |
| <a name="283" href="#283">283</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="284" href="#284">284</a> <em class="jxr_javadoccomment"> * indicate col/line assuming it starts at 0 - this will be</em> |
| <a name="285" href="#285">285</a> <em class="jxr_javadoccomment"> * corrected one call up</em> |
| <a name="286" href="#286">286</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="287" href="#287">287</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/exception/TemplateInitException.html">TemplateInitException</a>(errormsg, |
| <a name="288" href="#288">288</a> context.getCurrentTemplateName(), |
| <a name="289" href="#289">289</a> 0, |
| <a name="290" href="#290">290</a> 0); |
| <a name="291" href="#291">291</a> } |
| <a name="292" href="#292">292</a> <strong class="jxr_keyword">else</strong> |
| <a name="293" href="#293">293</a> { |
| <a name="294" href="#294">294</a> rsvc.getLog().error(errormsg); |
| <a name="295" href="#295">295</a> <strong class="jxr_keyword">return</strong>; |
| <a name="296" href="#296">296</a> } |
| <a name="297" href="#297">297</a> } |
| <a name="298" href="#298">298</a> |
| <a name="299" href="#299">299</a> <em class="jxr_comment">/*</em> |
| <a name="300" href="#300">300</a> <em class="jxr_comment"> * get the argument list to the instance use of the VM</em> |
| <a name="301" href="#301">301</a> <em class="jxr_comment"> */</em> |
| <a name="302" href="#302">302</a> |
| <a name="303" href="#303">303</a> callingArgs = getArgArray( node ); |
| <a name="304" href="#304">304</a> |
| <a name="305" href="#305">305</a> <em class="jxr_comment">/*</em> |
| <a name="306" href="#306">306</a> <em class="jxr_comment"> * now proxy each arg in the context</em> |
| <a name="307" href="#307">307</a> <em class="jxr_comment"> */</em> |
| <a name="308" href="#308">308</a> |
| <a name="309" href="#309">309</a> setupMacro( callingArgs, callingArgTypes ); |
| <a name="310" href="#310">310</a> } |
| <a name="311" href="#311">311</a> |
| <a name="312" href="#312">312</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="313" href="#313">313</a> <em class="jxr_javadoccomment"> * basic VM setup. Sets up the proxy args for this</em> |
| <a name="314" href="#314">314</a> <em class="jxr_javadoccomment"> * use, and parses the tree</em> |
| <a name="315" href="#315">315</a> <em class="jxr_javadoccomment"> * @param callArgs</em> |
| <a name="316" href="#316">316</a> <em class="jxr_javadoccomment"> * @param callArgTypes</em> |
| <a name="317" href="#317">317</a> <em class="jxr_javadoccomment"> * @return True if the proxy was setup successfully.</em> |
| <a name="318" href="#318">318</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="319" href="#319">319</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> setupMacro( String[] callArgs, <strong class="jxr_keyword">int</strong>[] callArgTypes ) |
| <a name="320" href="#320">320</a> { |
| <a name="321" href="#321">321</a> setupProxyArgs( callArgs, callArgTypes ); |
| <a name="322" href="#322">322</a> parseTree( callArgs ); |
| <a name="323" href="#323">323</a> |
| <a name="324" href="#324">324</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a name="325" href="#325">325</a> } |
| <a name="326" href="#326">326</a> |
| <a name="327" href="#327">327</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * parses the macro. We need to do this here, at init time, or else</em> |
| <a name="329" href="#329">329</a> <em class="jxr_javadoccomment"> * the local-scope template feature is hard to get to work :)</em> |
| <a name="330" href="#330">330</a> <em class="jxr_javadoccomment"> * @param callArgs</em> |
| <a name="331" href="#331">331</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="332" href="#332">332</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> parseTree( String[] callArgs ) |
| <a name="333" href="#333">333</a> { |
| <a name="334" href="#334">334</a> <strong class="jxr_keyword">try</strong> |
| <a name="335" href="#335">335</a> { |
| <a name="336" href="#336">336</a> BufferedReader br = <strong class="jxr_keyword">new</strong> BufferedReader( <strong class="jxr_keyword">new</strong> StringReader( macroBody ) ); |
| <a name="337" href="#337">337</a> |
| <a name="338" href="#338">338</a> <em class="jxr_comment">/*</em> |
| <a name="339" href="#339">339</a> <em class="jxr_comment"> * now parse the macro - and don't dump the namespace</em> |
| <a name="340" href="#340">340</a> <em class="jxr_comment"> */</em> |
| <a name="341" href="#341">341</a> |
| <a name="342" href="#342">342</a> nodeTree = rsvc.parse( br, namespace, false ); |
| <a name="343" href="#343">343</a> |
| <a name="344" href="#344">344</a> <em class="jxr_comment">/*</em> |
| <a name="345" href="#345">345</a> <em class="jxr_comment"> * now, to make null references render as proper schmoo</em> |
| <a name="346" href="#346">346</a> <em class="jxr_comment"> * we need to tweak the tree and change the literal of</em> |
| <a name="347" href="#347">347</a> <em class="jxr_comment"> * the appropriate references</em> |
| <a name="348" href="#348">348</a> <em class="jxr_comment"> *</em> |
| <a name="349" href="#349">349</a> <em class="jxr_comment"> * we only do this at init time, so it's the overhead</em> |
| <a name="350" href="#350">350</a> <em class="jxr_comment"> * is irrelevant</em> |
| <a name="351" href="#351">351</a> <em class="jxr_comment"> */</em> |
| <a name="352" href="#352">352</a> |
| <a name="353" href="#353">353</a> HashMap hm = <strong class="jxr_keyword">new</strong> HashMap(); |
| <a name="354" href="#354">354</a> |
| <a name="355" href="#355">355</a> <strong class="jxr_keyword">for</strong>( <strong class="jxr_keyword">int</strong> i = 1; i < argArray.length; i++) |
| <a name="356" href="#356">356</a> { |
| <a name="357" href="#357">357</a> String arg = callArgs[i-1]; |
| <a name="358" href="#358">358</a> |
| <a name="359" href="#359">359</a> <em class="jxr_comment">/*</em> |
| <a name="360" href="#360">360</a> <em class="jxr_comment"> * if the calling arg is indeed a reference</em> |
| <a name="361" href="#361">361</a> <em class="jxr_comment"> * then we add to the map. We ignore other</em> |
| <a name="362" href="#362">362</a> <em class="jxr_comment"> * stuff</em> |
| <a name="363" href="#363">363</a> <em class="jxr_comment"> */</em> |
| <a name="364" href="#364">364</a> |
| <a name="365" href="#365">365</a> <strong class="jxr_keyword">if</strong> (arg.charAt(0) == '$') |
| <a name="366" href="#366">366</a> { |
| <a name="367" href="#367">367</a> hm.put( argArray[i], arg ); |
| <a name="368" href="#368">368</a> } |
| <a name="369" href="#369">369</a> } |
| <a name="370" href="#370">370</a> |
| <a name="371" href="#371">371</a> <em class="jxr_comment">/*</em> |
| <a name="372" href="#372">372</a> <em class="jxr_comment"> * now make one of our reference-munging visitor, and</em> |
| <a name="373" href="#373">373</a> <em class="jxr_comment"> * let 'er rip</em> |
| <a name="374" href="#374">374</a> <em class="jxr_comment"> */</em> |
| <a name="375" href="#375">375</a> |
| <a name="376" href="#376">376</a> <a href="../../../../../org/apache/velocity/runtime/visitor/VMReferenceMungeVisitor.html">VMReferenceMungeVisitor</a> v = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/runtime/visitor/VMReferenceMungeVisitor.html">VMReferenceMungeVisitor</a>( hm ); |
| <a name="377" href="#377">377</a> nodeTree.jjtAccept( v, <strong class="jxr_keyword">null</strong> ); |
| <a name="378" href="#378">378</a> } |
| <a name="379" href="#379">379</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="380" href="#380">380</a> <em class="jxr_javadoccomment"> * pass through application level runtime exceptions</em> |
| <a name="381" href="#381">381</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="382" href="#382">382</a> <strong class="jxr_keyword">catch</strong>( RuntimeException e ) |
| <a name="383" href="#383">383</a> { |
| <a name="384" href="#384">384</a> <strong class="jxr_keyword">throw</strong> e; |
| <a name="385" href="#385">385</a> } |
| <a name="386" href="#386">386</a> <strong class="jxr_keyword">catch</strong> ( Exception e ) |
| <a name="387" href="#387">387</a> { |
| <a name="388" href="#388">388</a> rsvc.getLog().error(<span class="jxr_string">"VelocimacroManager.parseTree() : exception "</span> + |
| <a name="389" href="#389">389</a> macroName, e); |
| <a name="390" href="#390">390</a> } |
| <a name="391" href="#391">391</a> } |
| <a name="392" href="#392">392</a> |
| <a name="393" href="#393">393</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> setupProxyArgs( String[] callArgs, <strong class="jxr_keyword">int</strong> [] callArgTypes ) |
| <a name="394" href="#394">394</a> { |
| <a name="395" href="#395">395</a> <em class="jxr_comment">/*</em> |
| <a name="396" href="#396">396</a> <em class="jxr_comment"> * for each of the args, make a ProxyArg</em> |
| <a name="397" href="#397">397</a> <em class="jxr_comment"> */</em> |
| <a name="398" href="#398">398</a> |
| <a name="399" href="#399">399</a> <strong class="jxr_keyword">for</strong>( <strong class="jxr_keyword">int</strong> i = 1; i < argArray.length; i++) |
| <a name="400" href="#400">400</a> { |
| <a name="401" href="#401">401</a> <a href="../../../../../org/apache/velocity/runtime/directive/VMProxyArg.html">VMProxyArg</a> arg = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/runtime/directive/VMProxyArg.html">VMProxyArg</a>( rsvc, argArray[i], callArgs[i-1], callArgTypes[i-1] ); |
| <a name="402" href="#402">402</a> proxyArgHash.put( argArray[i], arg ); |
| <a name="403" href="#403">403</a> } |
| <a name="404" href="#404">404</a> } |
| <a name="405" href="#405">405</a> |
| <a name="406" href="#406">406</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="407" href="#407">407</a> <em class="jxr_javadoccomment"> * gets the args to the VM from the instance-use AST</em> |
| <a name="408" href="#408">408</a> <em class="jxr_javadoccomment"> * @param node</em> |
| <a name="409" href="#409">409</a> <em class="jxr_javadoccomment"> * @return array of arguments</em> |
| <a name="410" href="#410">410</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="411" href="#411">411</a> <strong class="jxr_keyword">private</strong> String[] getArgArray( Node node ) |
| <a name="412" href="#412">412</a> { |
| <a name="413" href="#413">413</a> <strong class="jxr_keyword">int</strong> numArgs = node.jjtGetNumChildren(); |
| <a name="414" href="#414">414</a> |
| <a name="415" href="#415">415</a> String args[] = <strong class="jxr_keyword">new</strong> String[ numArgs ]; |
| <a name="416" href="#416">416</a> callingArgTypes = <strong class="jxr_keyword">new</strong> <strong class="jxr_keyword">int</strong>[numArgs]; |
| <a name="417" href="#417">417</a> |
| <a name="418" href="#418">418</a> <em class="jxr_comment">/*</em> |
| <a name="419" href="#419">419</a> <em class="jxr_comment"> * eat the args</em> |
| <a name="420" href="#420">420</a> <em class="jxr_comment"> */</em> |
| <a name="421" href="#421">421</a> <strong class="jxr_keyword">int</strong> i = 0; |
| <a name="422" href="#422">422</a> <a href="../../../../../org/apache/velocity/runtime/parser/Token.html">Token</a> t = <strong class="jxr_keyword">null</strong>; |
| <a name="423" href="#423">423</a> <a href="../../../../../org/apache/velocity/runtime/parser/Token.html">Token</a> tLast = <strong class="jxr_keyword">null</strong>; |
| <a name="424" href="#424">424</a> |
| <a name="425" href="#425">425</a> <strong class="jxr_keyword">while</strong>( i < numArgs ) |
| <a name="426" href="#426">426</a> { |
| <a name="427" href="#427">427</a> args[i] = <span class="jxr_string">""</span>; |
| <a name="428" href="#428">428</a> <em class="jxr_comment">/*</em> |
| <a name="429" href="#429">429</a> <em class="jxr_comment"> * we want string literalss to lose the quotes. #foo( "blargh" ) should have 'blargh' patched</em> |
| <a name="430" href="#430">430</a> <em class="jxr_comment"> * into macro body. So for each arg in the use-instance, treat the stringlierals specially...</em> |
| <a name="431" href="#431">431</a> <em class="jxr_comment"> */</em> |
| <a name="432" href="#432">432</a> |
| <a name="433" href="#433">433</a> callingArgTypes[i] = node.jjtGetChild(i).getType(); |
| <a name="434" href="#434">434</a> |
| <a name="435" href="#435">435</a> |
| <a name="436" href="#436">436</a> <strong class="jxr_keyword">if</strong> (false && node.jjtGetChild(i).getType() == ParserTreeConstants.JJTSTRINGLITERAL ) |
| <a name="437" href="#437">437</a> { |
| <a name="438" href="#438">438</a> args[i] += node.jjtGetChild(i).getFirstToken().image.substring(1, node.jjtGetChild(i).getFirstToken().image.length() - 1); |
| <a name="439" href="#439">439</a> } |
| <a name="440" href="#440">440</a> <strong class="jxr_keyword">else</strong> |
| <a name="441" href="#441">441</a> { |
| <a name="442" href="#442">442</a> <em class="jxr_comment">/*</em> |
| <a name="443" href="#443">443</a> <em class="jxr_comment"> * just wander down the token list, concatenating everything together</em> |
| <a name="444" href="#444">444</a> <em class="jxr_comment"> */</em> |
| <a name="445" href="#445">445</a> t = node.jjtGetChild(i).getFirstToken(); |
| <a name="446" href="#446">446</a> tLast = node.jjtGetChild(i).getLastToken(); |
| <a name="447" href="#447">447</a> |
| <a name="448" href="#448">448</a> <strong class="jxr_keyword">while</strong>( t != tLast ) |
| <a name="449" href="#449">449</a> { |
| <a name="450" href="#450">450</a> args[i] += t.image; |
| <a name="451" href="#451">451</a> t = t.next; |
| <a name="452" href="#452">452</a> } |
| <a name="453" href="#453">453</a> |
| <a name="454" href="#454">454</a> <em class="jxr_comment">/*</em> |
| <a name="455" href="#455">455</a> <em class="jxr_comment"> * don't forget the last one... :)</em> |
| <a name="456" href="#456">456</a> <em class="jxr_comment"> */</em> |
| <a name="457" href="#457">457</a> args[i] += t.image; |
| <a name="458" href="#458">458</a> } |
| <a name="459" href="#459">459</a> i++; |
| <a name="460" href="#460">460</a> } |
| <a name="461" href="#461">461</a> <strong class="jxr_keyword">return</strong> args; |
| <a name="462" href="#462">462</a> } |
| <a name="463" href="#463">463</a> } |
| <a name="464" href="#464">464</a> |
| <a name="465" href="#465">465</a> |
| <a name="466" href="#466">466</a> |
| <a name="467" href="#467">467</a> |
| <a name="468" href="#468">468</a> |
| <a name="469" href="#469">469</a> |
| <a name="470" href="#470">470</a> |
| <a name="471" href="#471">471</a> |
| <a name="472" href="#472">472</a> |
| <a name="473" href="#473">473</a> |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
