blob: e6c9d45da063c7f5d0a2920312a9f8f3b2458098 [file] [log] [blame]
<!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>VelocimacroManager xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/velocity/runtime/VelocimacroManager.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.velocity.runtime;
<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.StringReader;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Hashtable;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.context.InternalContextAdapter;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.directive.VelocimacroProxy;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.node.SimpleNode;
<a name="28" href="#28">28</a>
<a name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em>
<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * Manages VMs in namespaces. Currently, two namespace modes are</em>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * supported:</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> *</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * &lt;ul&gt;</em>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * &lt;li&gt;flat - all allowable VMs are in the global namespace&lt;/li&gt;</em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * &lt;li&gt;local - inline VMs are added to it's own template namespace&lt;/li&gt;</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * &lt;/ul&gt;</em>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> *</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * Thanks to &lt;a href="<a href="mailto:JFernandez@viquity.com" target="alexandria_uri">mailto:JFernandez@viquity.com</a>"&gt;Jose Alberto Fernandez&lt;/a&gt;</em>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * for some ideas incorporated here.</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> *</em>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:geirm@optonline.net" target="alexandria_uri">mailto:geirm@optonline.net</a>"&gt;Geir Magnusson Jr.&lt;/a&gt;</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:JFernandez@viquity.com" target="alexandria_uri">mailto:JFernandez@viquity.com</a>"&gt;Jose Alberto Fernandez&lt;/a&gt;</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @version $Id: VelocimacroManager.java 463298 2006-10-12 16:10:32Z henning $</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em>
<a name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/velocity/runtime/VelocimacroManager.html">VelocimacroManager</a>
<a name="46" href="#46">46</a> {
<a name="47" href="#47">47</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</a> rsvc;
<a name="48" href="#48">48</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String GLOBAL_NAMESPACE = <span class="jxr_string">""</span>;
<a name="49" href="#49">49</a>
<a name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> registerFromLib = false;
<a name="51" href="#51">51</a>
<a name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Hash of namespace hashes. */</em>
<a name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Hashtable namespaceHash = <strong class="jxr_keyword">new</strong> Hashtable();
<a name="54" href="#54">54</a>
<a name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> map of names of library tempates/namespaces */</em>
<a name="56" href="#56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Hashtable libraryMap = <strong class="jxr_keyword">new</strong> Hashtable();
<a name="57" href="#57">57</a>
<a name="58" href="#58">58</a> <em class="jxr_comment">/*</em>
<a name="59" href="#59">59</a> <em class="jxr_comment"> * big switch for namespaces. If true, then properties control</em>
<a name="60" href="#60">60</a> <em class="jxr_comment"> * usage. If false, no.</em>
<a name="61" href="#61">61</a> <em class="jxr_comment"> */</em>
<a name="62" href="#62">62</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> namespacesOn = <strong class="jxr_keyword">true</strong>;
<a name="63" href="#63">63</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> inlineLocalMode = false;
<a name="64" href="#64">64</a>
<a name="65" href="#65">65</a> <em class="jxr_javadoccomment">/**</em>
<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * Adds the global namespace to the hash.</em>
<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> */</em>
<a name="68" href="#68">68</a> <a href="../../../../org/apache/velocity/runtime/VelocimacroManager.html">VelocimacroManager</a>(<a href="../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</a> rsvc)
<a name="69" href="#69">69</a> {
<a name="70" href="#70">70</a> <strong class="jxr_keyword">this</strong>.rsvc = rsvc;
<a name="71" href="#71">71</a>
<a name="72" href="#72">72</a> <em class="jxr_comment">/*</em>
<a name="73" href="#73">73</a> <em class="jxr_comment"> * add the global namespace to the namespace hash. We always have that.</em>
<a name="74" href="#74">74</a> <em class="jxr_comment"> */</em>
<a name="75" href="#75">75</a>
<a name="76" href="#76">76</a> addNamespace(GLOBAL_NAMESPACE);
<a name="77" href="#77">77</a> }
<a name="78" href="#78">78</a>
<a name="79" href="#79">79</a> <em class="jxr_javadoccomment">/**</em>
<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * Adds a VM definition to the cache.</em>
<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * @param vmName Name of the new VelociMacro.</em>
<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * @param macroBody String representation of the macro body.</em>
<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @param argArray Array of macro parameters, first parameter is the macro name.</em>
<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * @param namespace The namespace/template from which this macro has been loaded.</em>
<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @return Whether everything went okay.</em>
<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> */</em>
<a name="87" href="#87">87</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> addVM(<strong class="jxr_keyword">final</strong> String vmName, <strong class="jxr_keyword">final</strong> String macroBody, <strong class="jxr_keyword">final</strong> String argArray[],
<a name="88" href="#88">88</a> <strong class="jxr_keyword">final</strong> String namespace)
<a name="89" href="#89">89</a> {
<a name="90" href="#90">90</a> <a href="../../../../org/apache/velocity/runtime/VelocimacroManager.html">MacroEntry</a> me = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/runtime/VelocimacroManager.html">MacroEntry</a>(vmName, macroBody, argArray,
<a name="91" href="#91">91</a> namespace);
<a name="92" href="#92">92</a>
<a name="93" href="#93">93</a> me.setFromLibrary(registerFromLib);
<a name="94" href="#94">94</a>
<a name="95" href="#95">95</a> <em class="jxr_comment">/*</em>
<a name="96" href="#96">96</a> <em class="jxr_comment"> * the client (VMFactory) will signal to us via</em>
<a name="97" href="#97">97</a> <em class="jxr_comment"> * registerFromLib that we are in startup mode registering</em>
<a name="98" href="#98">98</a> <em class="jxr_comment"> * new VMs from libraries. Therefore, we want to</em>
<a name="99" href="#99">99</a> <em class="jxr_comment"> * addto the library map for subsequent auto reloads</em>
<a name="100" href="#100">100</a> <em class="jxr_comment"> */</em>
<a name="101" href="#101">101</a>
<a name="102" href="#102">102</a> <strong class="jxr_keyword">boolean</strong> isLib = <strong class="jxr_keyword">true</strong>;
<a name="103" href="#103">103</a>
<a name="104" href="#104">104</a> <strong class="jxr_keyword">if</strong> (registerFromLib)
<a name="105" href="#105">105</a> {
<a name="106" href="#106">106</a> libraryMap.put(namespace, namespace);
<a name="107" href="#107">107</a> }
<a name="108" href="#108">108</a> <strong class="jxr_keyword">else</strong>
<a name="109" href="#109">109</a> {
<a name="110" href="#110">110</a> <em class="jxr_comment">/*</em>
<a name="111" href="#111">111</a> <em class="jxr_comment"> * now, we first want to check to see if this namespace (template)</em>
<a name="112" href="#112">112</a> <em class="jxr_comment"> * is actually a library - if so, we need to use the global namespace</em>
<a name="113" href="#113">113</a> <em class="jxr_comment"> * we don't have to do this when registering, as namespaces should</em>
<a name="114" href="#114">114</a> <em class="jxr_comment"> * be shut off. If not, the default value is true, so we still go</em>
<a name="115" href="#115">115</a> <em class="jxr_comment"> * global</em>
<a name="116" href="#116">116</a> <em class="jxr_comment"> */</em>
<a name="117" href="#117">117</a>
<a name="118" href="#118">118</a> isLib = libraryMap.containsKey(namespace);
<a name="119" href="#119">119</a> }
<a name="120" href="#120">120</a>
<a name="121" href="#121">121</a> <strong class="jxr_keyword">if</strong> (!isLib &amp;&amp; usingNamespaces(namespace))
<a name="122" href="#122">122</a> {
<a name="123" href="#123">123</a> <em class="jxr_comment">/*</em>
<a name="124" href="#124">124</a> <em class="jxr_comment"> * first, do we have a namespace hash already for this namespace?</em>
<a name="125" href="#125">125</a> <em class="jxr_comment"> * if not, add it to the namespaces, and add the VM</em>
<a name="126" href="#126">126</a> <em class="jxr_comment"> */</em>
<a name="127" href="#127">127</a>
<a name="128" href="#128">128</a> Hashtable local = getNamespace(namespace, <strong class="jxr_keyword">true</strong>);
<a name="129" href="#129">129</a> local.put(vmName, me);
<a name="130" href="#130">130</a>
<a name="131" href="#131">131</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="132" href="#132">132</a> }
<a name="133" href="#133">133</a> <strong class="jxr_keyword">else</strong>
<a name="134" href="#134">134</a> {
<a name="135" href="#135">135</a> <em class="jxr_comment">/*</em>
<a name="136" href="#136">136</a> <em class="jxr_comment"> * otherwise, add to global template. First, check if we</em>
<a name="137" href="#137">137</a> <em class="jxr_comment"> * already have it to preserve some of the autoload information</em>
<a name="138" href="#138">138</a> <em class="jxr_comment"> */</em>
<a name="139" href="#139">139</a>
<a name="140" href="#140">140</a> <a href="../../../../org/apache/velocity/runtime/VelocimacroManager.html">MacroEntry</a> exist = (MacroEntry) getNamespace(GLOBAL_NAMESPACE).get(vmName);
<a name="141" href="#141">141</a>
<a name="142" href="#142">142</a> <strong class="jxr_keyword">if</strong> (exist != <strong class="jxr_keyword">null</strong>)
<a name="143" href="#143">143</a> {
<a name="144" href="#144">144</a> me.setFromLibrary(exist.getFromLibrary());
<a name="145" href="#145">145</a> }
<a name="146" href="#146">146</a>
<a name="147" href="#147">147</a> <em class="jxr_comment">/*</em>
<a name="148" href="#148">148</a> <em class="jxr_comment"> * now add it</em>
<a name="149" href="#149">149</a> <em class="jxr_comment"> */</em>
<a name="150" href="#150">150</a>
<a name="151" href="#151">151</a> getNamespace(GLOBAL_NAMESPACE).put(vmName, me);
<a name="152" href="#152">152</a>
<a name="153" href="#153">153</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="154" href="#154">154</a> }
<a name="155" href="#155">155</a> }
<a name="156" href="#156">156</a>
<a name="157" href="#157">157</a> <em class="jxr_javadoccomment">/**</em>
<a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * gets a new living VelocimacroProxy object by the</em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * name / source template duple</em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * @param vmName Name of the VelocityMacro to look up.</em>
<a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * @param namespace Namespace in which to look up the macro.</em>
<a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * @return A proxy representing the Macro.</em>
<a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> */</em>
<a name="164" href="#164">164</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/runtime/directive/VelocimacroProxy.html">VelocimacroProxy</a> get(<strong class="jxr_keyword">final</strong> String vmName, <strong class="jxr_keyword">final</strong> String namespace)
<a name="165" href="#165">165</a> {
<a name="166" href="#166">166</a>
<a name="167" href="#167">167</a> <strong class="jxr_keyword">if</strong> (usingNamespaces(namespace))
<a name="168" href="#168">168</a> {
<a name="169" href="#169">169</a> Hashtable local = getNamespace(namespace, false);
<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"> * if we have macros defined for this template</em>
<a name="173" href="#173">173</a> <em class="jxr_comment"> */</em>
<a name="174" href="#174">174</a>
<a name="175" href="#175">175</a> <strong class="jxr_keyword">if</strong> (local != <strong class="jxr_keyword">null</strong>)
<a name="176" href="#176">176</a> {
<a name="177" href="#177">177</a> <a href="../../../../org/apache/velocity/runtime/VelocimacroManager.html">MacroEntry</a> me = (MacroEntry) local.get(vmName);
<a name="178" href="#178">178</a>
<a name="179" href="#179">179</a> <strong class="jxr_keyword">if</strong> (me != <strong class="jxr_keyword">null</strong>)
<a name="180" href="#180">180</a> {
<a name="181" href="#181">181</a> <strong class="jxr_keyword">return</strong> me.createVelocimacro(namespace);
<a name="182" href="#182">182</a> }
<a name="183" href="#183">183</a> }
<a name="184" href="#184">184</a> }
<a name="185" href="#185">185</a>
<a name="186" href="#186">186</a> <em class="jxr_comment">/*</em>
<a name="187" href="#187">187</a> <em class="jxr_comment"> * if we didn't return from there, we need to simply see</em>
<a name="188" href="#188">188</a> <em class="jxr_comment"> * if it's in the global namespace</em>
<a name="189" href="#189">189</a> <em class="jxr_comment"> */</em>
<a name="190" href="#190">190</a>
<a name="191" href="#191">191</a> <a href="../../../../org/apache/velocity/runtime/VelocimacroManager.html">MacroEntry</a> me = (MacroEntry) getNamespace(GLOBAL_NAMESPACE).get( vmName );
<a name="192" href="#192">192</a>
<a name="193" href="#193">193</a> <strong class="jxr_keyword">if</strong> (me != <strong class="jxr_keyword">null</strong>)
<a name="194" href="#194">194</a> {
<a name="195" href="#195">195</a> <strong class="jxr_keyword">return</strong> me.createVelocimacro(namespace);
<a name="196" href="#196">196</a> }
<a name="197" href="#197">197</a>
<a name="198" href="#198">198</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="199" href="#199">199</a> }
<a name="200" href="#200">200</a>
<a name="201" href="#201">201</a> <em class="jxr_javadoccomment">/**</em>
<a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * Removes the VMs and the namespace from the manager.</em>
<a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * Used when a template is reloaded to avoid</em>
<a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> * losing memory.</em>
<a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> *</em>
<a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * @param namespace namespace to dump</em>
<a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * @return boolean representing success</em>
<a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> */</em>
<a name="209" href="#209">209</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> dumpNamespace(<strong class="jxr_keyword">final</strong> String namespace)
<a name="210" href="#210">210</a> {
<a name="211" href="#211">211</a> <strong class="jxr_keyword">synchronized</strong>(<strong class="jxr_keyword">this</strong>)
<a name="212" href="#212">212</a> {
<a name="213" href="#213">213</a> <strong class="jxr_keyword">if</strong> (usingNamespaces(namespace))
<a name="214" href="#214">214</a> {
<a name="215" href="#215">215</a> Hashtable h = (Hashtable) namespaceHash.remove(namespace);
<a name="216" href="#216">216</a>
<a name="217" href="#217">217</a> <strong class="jxr_keyword">if</strong> (h == <strong class="jxr_keyword">null</strong>)
<a name="218" href="#218">218</a> {
<a name="219" href="#219">219</a> <strong class="jxr_keyword">return</strong> false;
<a name="220" href="#220">220</a> }
<a name="221" href="#221">221</a>
<a name="222" href="#222">222</a> h.clear();
<a name="223" href="#223">223</a>
<a name="224" href="#224">224</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="225" href="#225">225</a> }
<a name="226" href="#226">226</a>
<a name="227" href="#227">227</a> <strong class="jxr_keyword">return</strong> false;
<a name="228" href="#228">228</a> }
<a name="229" href="#229">229</a> }
<a name="230" href="#230">230</a>
<a name="231" href="#231">231</a> <em class="jxr_javadoccomment">/**</em>
<a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * public switch to let external user of manager to control namespace</em>
<a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * usage indep of properties. That way, for example, at startup the</em>
<a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * library files are loaded into global namespace</em>
<a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> *</em>
<a name="236" href="#236">236</a> <em class="jxr_javadoccomment"> * @param namespaceOn True if namespaces should be used.</em>
<a name="237" href="#237">237</a> <em class="jxr_javadoccomment"> */</em>
<a name="238" href="#238">238</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setNamespaceUsage(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> namespaceOn)
<a name="239" href="#239">239</a> {
<a name="240" href="#240">240</a> <strong class="jxr_keyword">this</strong>.namespacesOn = namespaceOn;
<a name="241" href="#241">241</a> }
<a name="242" href="#242">242</a>
<a name="243" href="#243">243</a> <em class="jxr_javadoccomment">/**</em>
<a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * Should macros registered from Libraries be marked special?</em>
<a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * @param registerFromLib True if macros from Libs should be marked.</em>
<a name="246" href="#246">246</a> <em class="jxr_javadoccomment"> */</em>
<a name="247" href="#247">247</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRegisterFromLib(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> registerFromLib)
<a name="248" href="#248">248</a> {
<a name="249" href="#249">249</a> <strong class="jxr_keyword">this</strong>.registerFromLib = registerFromLib;
<a name="250" href="#250">250</a> }
<a name="251" href="#251">251</a>
<a name="252" href="#252">252</a> <em class="jxr_javadoccomment">/**</em>
<a name="253" href="#253">253</a> <em class="jxr_javadoccomment"> * Should macros from the same template be inlined?</em>
<a name="254" href="#254">254</a> <em class="jxr_javadoccomment"> *</em>
<a name="255" href="#255">255</a> <em class="jxr_javadoccomment"> * @param inlineLocalMode True if macros should be inlined on the same template.</em>
<a name="256" href="#256">256</a> <em class="jxr_javadoccomment"> */</em>
<a name="257" href="#257">257</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setTemplateLocalInlineVM(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> inlineLocalMode)
<a name="258" href="#258">258</a> {
<a name="259" href="#259">259</a> <strong class="jxr_keyword">this</strong>.inlineLocalMode = inlineLocalMode;
<a name="260" href="#260">260</a> }
<a name="261" href="#261">261</a>
<a name="262" href="#262">262</a> <em class="jxr_javadoccomment">/**</em>
<a name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * returns the hash for the specified namespace. Will not create a new one</em>
<a name="264" href="#264">264</a> <em class="jxr_javadoccomment"> * if it doesn't exist</em>
<a name="265" href="#265">265</a> <em class="jxr_javadoccomment"> *</em>
<a name="266" href="#266">266</a> <em class="jxr_javadoccomment"> * @param namespace name of the namespace :)</em>
<a name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * @return namespace Hashtable of VMs or null if doesn't exist</em>
<a name="268" href="#268">268</a> <em class="jxr_javadoccomment"> */</em>
<a name="269" href="#269">269</a> <strong class="jxr_keyword">private</strong> Hashtable getNamespace(<strong class="jxr_keyword">final</strong> String namespace)
<a name="270" href="#270">270</a> {
<a name="271" href="#271">271</a> <strong class="jxr_keyword">return</strong> getNamespace(namespace, false);
<a name="272" href="#272">272</a> }
<a name="273" href="#273">273</a>
<a name="274" href="#274">274</a> <em class="jxr_javadoccomment">/**</em>
<a name="275" href="#275">275</a> <em class="jxr_javadoccomment"> * returns the hash for the specified namespace, and if it doesn't exist</em>
<a name="276" href="#276">276</a> <em class="jxr_javadoccomment"> * will create a new one and add it to the namespaces</em>
<a name="277" href="#277">277</a> <em class="jxr_javadoccomment"> *</em>
<a name="278" href="#278">278</a> <em class="jxr_javadoccomment"> * @param namespace name of the namespace :)</em>
<a name="279" href="#279">279</a> <em class="jxr_javadoccomment"> * @param addIfNew flag to add a new namespace if it doesn't exist</em>
<a name="280" href="#280">280</a> <em class="jxr_javadoccomment"> * @return namespace Hashtable of VMs or null if doesn't exist</em>
<a name="281" href="#281">281</a> <em class="jxr_javadoccomment"> */</em>
<a name="282" href="#282">282</a> <strong class="jxr_keyword">private</strong> Hashtable getNamespace(<strong class="jxr_keyword">final</strong> String namespace, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> addIfNew)
<a name="283" href="#283">283</a> {
<a name="284" href="#284">284</a> Hashtable h = (Hashtable) namespaceHash.get(namespace);
<a name="285" href="#285">285</a>
<a name="286" href="#286">286</a> <strong class="jxr_keyword">if</strong> (h == <strong class="jxr_keyword">null</strong> &amp;&amp; addIfNew)
<a name="287" href="#287">287</a> {
<a name="288" href="#288">288</a> h = addNamespace(namespace);
<a name="289" href="#289">289</a> }
<a name="290" href="#290">290</a>
<a name="291" href="#291">291</a> <strong class="jxr_keyword">return</strong> h;
<a name="292" href="#292">292</a> }
<a name="293" href="#293">293</a>
<a name="294" href="#294">294</a> <em class="jxr_javadoccomment">/**</em>
<a name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * adds a namespace to the namespaces</em>
<a name="296" href="#296">296</a> <em class="jxr_javadoccomment"> *</em>
<a name="297" href="#297">297</a> <em class="jxr_javadoccomment"> * @param namespace name of namespace to add</em>
<a name="298" href="#298">298</a> <em class="jxr_javadoccomment"> * @return Hash added to namespaces, ready for use</em>
<a name="299" href="#299">299</a> <em class="jxr_javadoccomment"> */</em>
<a name="300" href="#300">300</a> <strong class="jxr_keyword">private</strong> Hashtable addNamespace(<strong class="jxr_keyword">final</strong> String namespace)
<a name="301" href="#301">301</a> {
<a name="302" href="#302">302</a> Hashtable h = <strong class="jxr_keyword">new</strong> Hashtable();
<a name="303" href="#303">303</a> Object oh;
<a name="304" href="#304">304</a>
<a name="305" href="#305">305</a> <strong class="jxr_keyword">if</strong> ((oh = namespaceHash.put(namespace, h)) != <strong class="jxr_keyword">null</strong>)
<a name="306" href="#306">306</a> {
<a name="307" href="#307">307</a> <em class="jxr_comment">/*</em>
<a name="308" href="#308">308</a> <em class="jxr_comment"> * There was already an entry on the table, restore it!</em>
<a name="309" href="#309">309</a> <em class="jxr_comment"> * This condition should never occur, given the code</em>
<a name="310" href="#310">310</a> <em class="jxr_comment"> * and the fact that this method is private.</em>
<a name="311" href="#311">311</a> <em class="jxr_comment"> * But just in case, this way of testing for it is much</em>
<a name="312" href="#312">312</a> <em class="jxr_comment"> * more efficient than testing before hand using get().</em>
<a name="313" href="#313">313</a> <em class="jxr_comment"> */</em>
<a name="314" href="#314">314</a> namespaceHash.put(namespace, oh);
<a name="315" href="#315">315</a> <em class="jxr_comment">/*</em>
<a name="316" href="#316">316</a> <em class="jxr_comment"> * Should't we be returning the old entry (oh)?</em>
<a name="317" href="#317">317</a> <em class="jxr_comment"> * The previous code was just returning null in this case.</em>
<a name="318" href="#318">318</a> <em class="jxr_comment"> */</em>
<a name="319" href="#319">319</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="320" href="#320">320</a> }
<a name="321" href="#321">321</a>
<a name="322" href="#322">322</a> <strong class="jxr_keyword">return</strong> h;
<a name="323" href="#323">323</a> }
<a name="324" href="#324">324</a>
<a name="325" href="#325">325</a> <em class="jxr_javadoccomment">/**</em>
<a name="326" href="#326">326</a> <em class="jxr_javadoccomment"> * determines if currently using namespaces.</em>
<a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> *</em>
<a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * @param namespace currently ignored</em>
<a name="329" href="#329">329</a> <em class="jxr_javadoccomment"> * @return true if using namespaces, false if not</em>
<a name="330" href="#330">330</a> <em class="jxr_javadoccomment"> */</em>
<a name="331" href="#331">331</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> usingNamespaces(<strong class="jxr_keyword">final</strong> String namespace)
<a name="332" href="#332">332</a> {
<a name="333" href="#333">333</a> <em class="jxr_comment">/*</em>
<a name="334" href="#334">334</a> <em class="jxr_comment"> * if the big switch turns of namespaces, then ignore the rules</em>
<a name="335" href="#335">335</a> <em class="jxr_comment"> */</em>
<a name="336" href="#336">336</a>
<a name="337" href="#337">337</a> <strong class="jxr_keyword">if</strong> (!namespacesOn)
<a name="338" href="#338">338</a> {
<a name="339" href="#339">339</a> <strong class="jxr_keyword">return</strong> false;
<a name="340" href="#340">340</a> }
<a name="341" href="#341">341</a>
<a name="342" href="#342">342</a> <em class="jxr_comment">/*</em>
<a name="343" href="#343">343</a> <em class="jxr_comment"> * currently, we only support the local template namespace idea</em>
<a name="344" href="#344">344</a> <em class="jxr_comment"> */</em>
<a name="345" href="#345">345</a>
<a name="346" href="#346">346</a> <strong class="jxr_keyword">if</strong> (inlineLocalMode)
<a name="347" href="#347">347</a> {
<a name="348" href="#348">348</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="349" href="#349">349</a> }
<a name="350" href="#350">350</a>
<a name="351" href="#351">351</a> <strong class="jxr_keyword">return</strong> false;
<a name="352" href="#352">352</a> }
<a name="353" href="#353">353</a>
<a name="354" href="#354">354</a> <em class="jxr_javadoccomment">/**</em>
<a name="355" href="#355">355</a> <em class="jxr_javadoccomment"> * Return the library name for a given macro.</em>
<a name="356" href="#356">356</a> <em class="jxr_javadoccomment"> * @param vmName Name of the Macro to look up.</em>
<a name="357" href="#357">357</a> <em class="jxr_javadoccomment"> * @param namespace Namespace to look the macro up.</em>
<a name="358" href="#358">358</a> <em class="jxr_javadoccomment"> * @return The name of the library which registered this macro in a namespace.</em>
<a name="359" href="#359">359</a> <em class="jxr_javadoccomment"> */</em>
<a name="360" href="#360">360</a> <strong class="jxr_keyword">public</strong> String getLibraryName(<strong class="jxr_keyword">final</strong> String vmName, <strong class="jxr_keyword">final</strong> String namespace)
<a name="361" href="#361">361</a> {
<a name="362" href="#362">362</a> <strong class="jxr_keyword">if</strong> (usingNamespaces(namespace))
<a name="363" href="#363">363</a> {
<a name="364" href="#364">364</a> Hashtable local = getNamespace(namespace, false);
<a name="365" href="#365">365</a>
<a name="366" href="#366">366</a> <em class="jxr_comment">/*</em>
<a name="367" href="#367">367</a> <em class="jxr_comment"> * if we have this macro defined in this namespace, then</em>
<a name="368" href="#368">368</a> <em class="jxr_comment"> * it is masking the global, library-based one, so</em>
<a name="369" href="#369">369</a> <em class="jxr_comment"> * just return null</em>
<a name="370" href="#370">370</a> <em class="jxr_comment"> */</em>
<a name="371" href="#371">371</a>
<a name="372" href="#372">372</a> <strong class="jxr_keyword">if</strong> ( local != <strong class="jxr_keyword">null</strong>)
<a name="373" href="#373">373</a> {
<a name="374" href="#374">374</a> <a href="../../../../org/apache/velocity/runtime/VelocimacroManager.html">MacroEntry</a> me = (MacroEntry) local.get(vmName);
<a name="375" href="#375">375</a>
<a name="376" href="#376">376</a> <strong class="jxr_keyword">if</strong> (me != <strong class="jxr_keyword">null</strong>)
<a name="377" href="#377">377</a> {
<a name="378" href="#378">378</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="379" href="#379">379</a> }
<a name="380" href="#380">380</a> }
<a name="381" href="#381">381</a> }
<a name="382" href="#382">382</a>
<a name="383" href="#383">383</a> <em class="jxr_comment">/*</em>
<a name="384" href="#384">384</a> <em class="jxr_comment"> * if we didn't return from there, we need to simply see</em>
<a name="385" href="#385">385</a> <em class="jxr_comment"> * if it's in the global namespace</em>
<a name="386" href="#386">386</a> <em class="jxr_comment"> */</em>
<a name="387" href="#387">387</a>
<a name="388" href="#388">388</a> <a href="../../../../org/apache/velocity/runtime/VelocimacroManager.html">MacroEntry</a> me = (MacroEntry) getNamespace(GLOBAL_NAMESPACE).get(vmName);
<a name="389" href="#389">389</a>
<a name="390" href="#390">390</a> <strong class="jxr_keyword">if</strong> (me != <strong class="jxr_keyword">null</strong>)
<a name="391" href="#391">391</a> {
<a name="392" href="#392">392</a> <strong class="jxr_keyword">return</strong> me.getSourceTemplate();
<a name="393" href="#393">393</a> }
<a name="394" href="#394">394</a>
<a name="395" href="#395">395</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="396" href="#396">396</a> }
<a name="397" href="#397">397</a>
<a name="398" href="#398">398</a>
<a name="399" href="#399">399</a> <em class="jxr_javadoccomment">/**</em>
<a name="400" href="#400">400</a> <em class="jxr_javadoccomment"> * wrapper class for holding VM information</em>
<a name="401" href="#401">401</a> <em class="jxr_javadoccomment"> */</em>
<a name="402" href="#402">402</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/velocity/runtime/VelocimacroManager.html">MacroEntry</a>
<a name="403" href="#403">403</a> {
<a name="404" href="#404">404</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String vmName;
<a name="405" href="#405">405</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String[] argArray;
<a name="406" href="#406">406</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String macroBody;
<a name="407" href="#407">407</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String sourceTemplate;
<a name="408" href="#408">408</a>
<a name="409" href="#409">409</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="410" href="#410">410</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> fromLibrary = false;
<a name="411" href="#411">411</a>
<a name="412" href="#412">412</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/velocity/runtime/VelocimacroManager.html">MacroEntry</a>(<strong class="jxr_keyword">final</strong> String vmName, <strong class="jxr_keyword">final</strong> String macroBody,
<a name="413" href="#413">413</a> <strong class="jxr_keyword">final</strong> String argArray[], <strong class="jxr_keyword">final</strong> String sourceTemplate)
<a name="414" href="#414">414</a> {
<a name="415" href="#415">415</a> <strong class="jxr_keyword">this</strong>.vmName = vmName;
<a name="416" href="#416">416</a> <strong class="jxr_keyword">this</strong>.argArray = argArray;
<a name="417" href="#417">417</a> <strong class="jxr_keyword">this</strong>.macroBody = macroBody;
<a name="418" href="#418">418</a> <strong class="jxr_keyword">this</strong>.sourceTemplate = sourceTemplate;
<a name="419" href="#419">419</a> }
<a name="420" href="#420">420</a>
<a name="421" href="#421">421</a> <em class="jxr_javadoccomment">/**</em>
<a name="422" href="#422">422</a> <em class="jxr_javadoccomment"> * Has the macro been registered from a library.</em>
<a name="423" href="#423">423</a> <em class="jxr_javadoccomment"> * @param fromLibrary True if the macro was registered from a Library.</em>
<a name="424" href="#424">424</a> <em class="jxr_javadoccomment"> */</em>
<a name="425" href="#425">425</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFromLibrary(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> fromLibrary)
<a name="426" href="#426">426</a> {
<a name="427" href="#427">427</a> <strong class="jxr_keyword">this</strong>.fromLibrary = fromLibrary;
<a name="428" href="#428">428</a> }
<a name="429" href="#429">429</a>
<a name="430" href="#430">430</a> <em class="jxr_javadoccomment">/**</em>
<a name="431" href="#431">431</a> <em class="jxr_javadoccomment"> * Returns true if the macro was registered from a library.</em>
<a name="432" href="#432">432</a> <em class="jxr_javadoccomment"> * @return True if the macro was registered from a library.</em>
<a name="433" href="#433">433</a> <em class="jxr_javadoccomment"> */</em>
<a name="434" href="#434">434</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> getFromLibrary()
<a name="435" href="#435">435</a> {
<a name="436" href="#436">436</a> <strong class="jxr_keyword">return</strong> fromLibrary;
<a name="437" href="#437">437</a> }
<a name="438" href="#438">438</a>
<a name="439" href="#439">439</a> <em class="jxr_javadoccomment">/**</em>
<a name="440" href="#440">440</a> <em class="jxr_javadoccomment"> * Returns the node tree for this macro.</em>
<a name="441" href="#441">441</a> <em class="jxr_javadoccomment"> * @return The node tree for this macro.</em>
<a name="442" href="#442">442</a> <em class="jxr_javadoccomment"> */</em>
<a name="443" href="#443">443</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html">SimpleNode</a> getNodeTree()
<a name="444" href="#444">444</a> {
<a name="445" href="#445">445</a> <strong class="jxr_keyword">return</strong> nodeTree;
<a name="446" href="#446">446</a> }
<a name="447" href="#447">447</a>
<a name="448" href="#448">448</a> <em class="jxr_javadoccomment">/**</em>
<a name="449" href="#449">449</a> <em class="jxr_javadoccomment"> * Returns the source template name for this macro.</em>
<a name="450" href="#450">450</a> <em class="jxr_javadoccomment"> * @return The source template name for this macro.</em>
<a name="451" href="#451">451</a> <em class="jxr_javadoccomment"> */</em>
<a name="452" href="#452">452</a> <strong class="jxr_keyword">public</strong> String getSourceTemplate()
<a name="453" href="#453">453</a> {
<a name="454" href="#454">454</a> <strong class="jxr_keyword">return</strong> sourceTemplate;
<a name="455" href="#455">455</a> }
<a name="456" href="#456">456</a>
<a name="457" href="#457">457</a> <a href="../../../../org/apache/velocity/runtime/directive/VelocimacroProxy.html">VelocimacroProxy</a> createVelocimacro(<strong class="jxr_keyword">final</strong> String namespace)
<a name="458" href="#458">458</a> {
<a name="459" href="#459">459</a> <a href="../../../../org/apache/velocity/runtime/directive/VelocimacroProxy.html">VelocimacroProxy</a> vp = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/runtime/directive/VelocimacroProxy.html">VelocimacroProxy</a>();
<a name="460" href="#460">460</a> vp.setName(<strong class="jxr_keyword">this</strong>.vmName);
<a name="461" href="#461">461</a> vp.setArgArray(<strong class="jxr_keyword">this</strong>.argArray);
<a name="462" href="#462">462</a> vp.setMacrobody(<strong class="jxr_keyword">this</strong>.macroBody);
<a name="463" href="#463">463</a> vp.setNodeTree(<strong class="jxr_keyword">this</strong>.nodeTree);
<a name="464" href="#464">464</a> vp.setNamespace(namespace);
<a name="465" href="#465">465</a> <strong class="jxr_keyword">return</strong> vp;
<a name="466" href="#466">466</a> }
<a name="467" href="#467">467</a>
<a name="468" href="#468">468</a> <strong class="jxr_keyword">void</strong> setup(<strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</a> ica)
<a name="469" href="#469">469</a> {
<a name="470" href="#470">470</a> <em class="jxr_comment">/*</em>
<a name="471" href="#471">471</a> <em class="jxr_comment"> * if not parsed yet, parse!</em>
<a name="472" href="#472">472</a> <em class="jxr_comment"> */</em>
<a name="473" href="#473">473</a>
<a name="474" href="#474">474</a> <strong class="jxr_keyword">if</strong>( nodeTree == <strong class="jxr_keyword">null</strong>)
<a name="475" href="#475">475</a> {
<a name="476" href="#476">476</a> parseTree(ica);
<a name="477" href="#477">477</a> }
<a name="478" href="#478">478</a> }
<a name="479" href="#479">479</a>
<a name="480" href="#480">480</a> <strong class="jxr_keyword">void</strong> parseTree(<strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</a> ica)
<a name="481" href="#481">481</a> {
<a name="482" href="#482">482</a> <strong class="jxr_keyword">try</strong>
<a name="483" href="#483">483</a> {
<a name="484" href="#484">484</a> BufferedReader br = <strong class="jxr_keyword">new</strong> BufferedReader(<strong class="jxr_keyword">new</strong> StringReader(macroBody));
<a name="485" href="#485">485</a>
<a name="486" href="#486">486</a> nodeTree = rsvc.parse(br, <span class="jxr_string">"VM:"</span> + vmName, <strong class="jxr_keyword">true</strong>);
<a name="487" href="#487">487</a> nodeTree.init(ica, <strong class="jxr_keyword">null</strong>);
<a name="488" href="#488">488</a> }
<a name="489" href="#489">489</a> <strong class="jxr_keyword">catch</strong> (Exception e)
<a name="490" href="#490">490</a> {
<a name="491" href="#491">491</a> rsvc.getLog().error(<span class="jxr_string">"VelocimacroManager.parseTree() failed on VM '"</span>
<a name="492" href="#492">492</a> + vmName + <span class="jxr_string">"'"</span>, e);
<a name="493" href="#493">493</a> }
<a name="494" href="#494">494</a> }
<a name="495" href="#495">495</a> }
<a name="496" href="#496">496</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>