Google Git
Sign in
apache / velocity-site / 89c3a15cf30ab2c0dbdf8253ed5c2eb24d9b1e21 / . / engine / 1.6.1 / xref / org / apache / velocity / runtime / VelocimacroFactory.html
blob: b1a9590e5879bb0f72a48c625781bfe0431741f2 [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>VelocimacroFactory xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/velocity/runtime/VelocimacroFactory.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.StringReader;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.Vector;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a name="28" href="#28">28</a>
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang.StringUtils;
<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.Template;
<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.directive.Directive;
<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.directive.Macro;
<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.directive.VelocimacroProxy;
<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.log.LogDisplayWrapper;
<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.ParseException;
<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.node.Node;
<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"> * VelocimacroFactory.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"> * manages the set of VMs in a running Velocity engine.</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 &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="45" href="#45">45</a> <em class="jxr_javadoccomment"> * @version $Id: VelocimacroFactory.java 718442 2008-11-18 00:01:17Z 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/VelocimacroFactory.html">VelocimacroFactory</a>
<a name="48" href="#48">48</a> {
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment">/**</em>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * runtime services for this instance</em>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> */</em>
<a name="52" href="#52">52</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="53" href="#53">53</a>
<a name="54" href="#54">54</a> <em class="jxr_javadoccomment">/**</em>
<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * the log for this instance</em>
<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> */</em>
<a name="57" href="#57">57</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/velocity/runtime/log/LogDisplayWrapper.html">LogDisplayWrapper</a> log;
<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"> * VMManager : deal with namespace management</em>
<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * and actually keeps all the VM definitions</em>
<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> */</em>
<a name="63" href="#63">63</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/velocity/runtime/VelocimacroManager.html">VelocimacroManager</a> vmManager = <strong class="jxr_keyword">null</strong>;
<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"> * determines if replacement of global VMs are allowed</em>
<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * controlled by VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL</em>
<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em>
<a name="69" href="#69">69</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> replaceAllowed = false;
<a name="70" href="#70">70</a>
<a name="71" href="#71">71</a> <em class="jxr_javadoccomment">/**</em>
<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * controls if new VMs can be added. Set by</em>
<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * VM_PERM_ALLOW_INLINE Note the assumption that only</em>
<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * through inline defs can this happen.</em>
<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * additions through autoloaded VMs is allowed</em>
<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em>
<a name="77" href="#77">77</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> addNewAllowed = <strong class="jxr_keyword">true</strong>;
<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"> * sets if template-local namespace in used</em>
<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em>
<a name="82" href="#82">82</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> templateLocal = false;
<a name="83" href="#83">83</a>
<a name="84" href="#84">84</a> <em class="jxr_javadoccomment">/**</em>
<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * determines if the libraries are auto-loaded</em>
<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * when they change</em>
<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> */</em>
<a name="88" href="#88">88</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> autoReloadLibrary = false;
<a name="89" href="#89">89</a>
<a name="90" href="#90">90</a> <em class="jxr_javadoccomment">/**</em>
<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * vector of the library names</em>
<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> */</em>
<a name="93" href="#93">93</a> <strong class="jxr_keyword">private</strong> List macroLibVec = <strong class="jxr_keyword">null</strong>;
<a name="94" href="#94">94</a>
<a name="95" href="#95">95</a> <em class="jxr_javadoccomment">/**</em>
<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * map of the library Template objects</em>
<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * used for reload determination</em>
<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> */</em>
<a name="99" href="#99">99</a> <strong class="jxr_keyword">private</strong> Map libModMap;
<a name="100" href="#100">100</a>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">/**</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * C'tor for the VelociMacro factory.</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> *</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @param rsvc Reference to a runtime services object.</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> */</em>
<a name="106" href="#106">106</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/runtime/VelocimacroFactory.html">VelocimacroFactory</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</a> rsvc)
<a name="107" href="#107">107</a> {
<a name="108" href="#108">108</a> <strong class="jxr_keyword">this</strong>.rsvc = rsvc;
<a name="109" href="#109">109</a> <strong class="jxr_keyword">this</strong>.log = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/runtime/log/LogDisplayWrapper.html">LogDisplayWrapper</a>(rsvc.getLog(), <span class="jxr_string">"Velocimacro : "</span>,
<a name="110" href="#110">110</a> rsvc.getBoolean(RuntimeConstants.VM_MESSAGES_ON, <strong class="jxr_keyword">true</strong>));
<a name="111" href="#111">111</a>
<a name="112" href="#112">112</a> <em class="jxr_comment">/*</em>
<a name="113" href="#113">113</a> <em class="jxr_comment"> * we always access in a synchronized(), so we</em>
<a name="114" href="#114">114</a> <em class="jxr_comment"> * can use an unsynchronized hashmap</em>
<a name="115" href="#115">115</a> <em class="jxr_comment"> */</em>
<a name="116" href="#116">116</a> libModMap = <strong class="jxr_keyword">new</strong> HashMap();
<a name="117" href="#117">117</a> vmManager = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/runtime/VelocimacroManager.html">VelocimacroManager</a>(rsvc);
<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"> * initialize the factory - setup all permissions</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * load all global libraries.</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> */</em>
<a name="124" href="#124">124</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> initVelocimacro()
<a name="125" href="#125">125</a> {
<a name="126" href="#126">126</a> <em class="jxr_comment">/*</em>
<a name="127" href="#127">127</a> <em class="jxr_comment"> * maybe I'm just paranoid...</em>
<a name="128" href="#128">128</a> <em class="jxr_comment"> */</em>
<a name="129" href="#129">129</a> <strong class="jxr_keyword">synchronized</strong>(<strong class="jxr_keyword">this</strong>)
<a name="130" href="#130">130</a> {
<a name="131" href="#131">131</a> log.trace(<span class="jxr_string">"initialization starting."</span>);
<a name="132" href="#132">132</a>
<a name="133" href="#133">133</a> <em class="jxr_comment">/*</em>
<a name="134" href="#134">134</a> <em class="jxr_comment"> * allow replacements while we add the libraries, if exist</em>
<a name="135" href="#135">135</a> <em class="jxr_comment"> */</em>
<a name="136" href="#136">136</a> setReplacementPermission(<strong class="jxr_keyword">true</strong>);
<a name="137" href="#137">137</a>
<a name="138" href="#138">138</a> <em class="jxr_comment">/*</em>
<a name="139" href="#139">139</a> <em class="jxr_comment"> * add all library macros to the global namespace</em>
<a name="140" href="#140">140</a> <em class="jxr_comment"> */</em>
<a name="141" href="#141">141</a>
<a name="142" href="#142">142</a> vmManager.setNamespaceUsage(false);
<a name="143" href="#143">143</a>
<a name="144" href="#144">144</a> <em class="jxr_comment">/*</em>
<a name="145" href="#145">145</a> <em class="jxr_comment"> * now, if there is a global or local libraries specified, use them.</em>
<a name="146" href="#146">146</a> <em class="jxr_comment"> * All we have to do is get the template. The template will be parsed;</em>
<a name="147" href="#147">147</a> <em class="jxr_comment"> * VM's are added during the parse phase</em>
<a name="148" href="#148">148</a> <em class="jxr_comment"> */</em>
<a name="149" href="#149">149</a>
<a name="150" href="#150">150</a> Object libfiles = rsvc.getProperty(RuntimeConstants.VM_LIBRARY);
<a name="151" href="#151">151</a>
<a name="152" href="#152">152</a> <strong class="jxr_keyword">if</strong> (libfiles == <strong class="jxr_keyword">null</strong>)
<a name="153" href="#153">153</a> {
<a name="154" href="#154">154</a> log.debug(<span class="jxr_string">"\&quot;"</span> + RuntimeConstants.VM_LIBRARY +
<a name="155" href="#155">155</a> <span class="jxr_string">"\&quot; is not set. Trying default library: "</span> +
<a name="156" href="#156">156</a> RuntimeConstants.VM_LIBRARY_DEFAULT);
<a name="157" href="#157">157</a>
<a name="158" href="#158">158</a> <em class="jxr_comment">// try the default library.</em>
<a name="159" href="#159">159</a> <strong class="jxr_keyword">if</strong> (rsvc.getLoaderNameForResource(RuntimeConstants.VM_LIBRARY_DEFAULT) != <strong class="jxr_keyword">null</strong>)
<a name="160" href="#160">160</a> {
<a name="161" href="#161">161</a> libfiles = RuntimeConstants.VM_LIBRARY_DEFAULT;
<a name="162" href="#162">162</a> }
<a name="163" href="#163">163</a> <strong class="jxr_keyword">else</strong>
<a name="164" href="#164">164</a> {
<a name="165" href="#165">165</a> log.debug(<span class="jxr_string">"Default library not found."</span>);
<a name="166" href="#166">166</a> }
<a name="167" href="#167">167</a> }
<a name="168" href="#168">168</a>
<a name="169" href="#169">169</a> <strong class="jxr_keyword">if</strong>(libfiles != <strong class="jxr_keyword">null</strong>)
<a name="170" href="#170">170</a> {
<a name="171" href="#171">171</a> macroLibVec = <strong class="jxr_keyword">new</strong> ArrayList();
<a name="172" href="#172">172</a> <strong class="jxr_keyword">if</strong> (libfiles instanceof Vector)
<a name="173" href="#173">173</a> {
<a name="174" href="#174">174</a> macroLibVec.addAll((Vector)libfiles);
<a name="175" href="#175">175</a> }
<a name="176" href="#176">176</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (libfiles instanceof String)
<a name="177" href="#177">177</a> {
<a name="178" href="#178">178</a> macroLibVec.add(libfiles);
<a name="179" href="#179">179</a> }
<a name="180" href="#180">180</a>
<a name="181" href="#181">181</a> <strong class="jxr_keyword">for</strong>(<strong class="jxr_keyword">int</strong> i = 0, is = macroLibVec.size(); i &lt; is; i++)
<a name="182" href="#182">182</a> {
<a name="183" href="#183">183</a> String lib = (String) macroLibVec.get(i);
<a name="184" href="#184">184</a>
<a name="185" href="#185">185</a> <em class="jxr_comment">/*</em>
<a name="186" href="#186">186</a> <em class="jxr_comment"> * only if it's a non-empty string do we bother</em>
<a name="187" href="#187">187</a> <em class="jxr_comment"> */</em>
<a name="188" href="#188">188</a>
<a name="189" href="#189">189</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotEmpty(lib))
<a name="190" href="#190">190</a> {
<a name="191" href="#191">191</a> <em class="jxr_comment">/*</em>
<a name="192" href="#192">192</a> <em class="jxr_comment"> * let the VMManager know that the following is coming</em>
<a name="193" href="#193">193</a> <em class="jxr_comment"> * from libraries - need to know for auto-load</em>
<a name="194" href="#194">194</a> <em class="jxr_comment"> */</em>
<a name="195" href="#195">195</a>
<a name="196" href="#196">196</a> vmManager.setRegisterFromLib(<strong class="jxr_keyword">true</strong>);
<a name="197" href="#197">197</a>
<a name="198" href="#198">198</a> log.debug(<span class="jxr_string">"adding VMs from VM library : "</span> + lib);
<a name="199" href="#199">199</a>
<a name="200" href="#200">200</a> <strong class="jxr_keyword">try</strong>
<a name="201" href="#201">201</a> {
<a name="202" href="#202">202</a> <a href="../../../../org/apache/velocity/Template.html">Template</a> template = rsvc.getTemplate(lib);
<a name="203" href="#203">203</a>
<a name="204" href="#204">204</a> <em class="jxr_comment">/*</em>
<a name="205" href="#205">205</a> <em class="jxr_comment"> * save the template. This depends on the assumption</em>
<a name="206" href="#206">206</a> <em class="jxr_comment"> * that the Template object won't change - currently</em>
<a name="207" href="#207">207</a> <em class="jxr_comment"> * this is how the Resource manager works</em>
<a name="208" href="#208">208</a> <em class="jxr_comment"> */</em>
<a name="209" href="#209">209</a>
<a name="210" href="#210">210</a> <a href="../../../../org/apache/velocity/runtime/VelocimacroFactory.html">Twonk</a> twonk = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/runtime/VelocimacroFactory.html">Twonk</a>();
<a name="211" href="#211">211</a> twonk.template = template;
<a name="212" href="#212">212</a> twonk.modificationTime = template.getLastModified();
<a name="213" href="#213">213</a> libModMap.put(lib, twonk);
<a name="214" href="#214">214</a> }
<a name="215" href="#215">215</a> <strong class="jxr_keyword">catch</strong> (Exception e)
<a name="216" href="#216">216</a> {
<a name="217" href="#217">217</a> String msg = <span class="jxr_string">"Velocimacro : Error using VM library : "</span> + lib;
<a name="218" href="#218">218</a> log.error(<strong class="jxr_keyword">true</strong>, msg, e);
<a name="219" href="#219">219</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="220" href="#220">220</a> }
<a name="221" href="#221">221</a>
<a name="222" href="#222">222</a> log.trace(<span class="jxr_string">"VM library registration complete."</span>);
<a name="223" href="#223">223</a>
<a name="224" href="#224">224</a> vmManager.setRegisterFromLib(false);
<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>
<a name="229" href="#229">229</a> <em class="jxr_comment">/*</em>
<a name="230" href="#230">230</a> <em class="jxr_comment"> * now, the permissions</em>
<a name="231" href="#231">231</a> <em class="jxr_comment"> */</em>
<a name="232" href="#232">232</a>
<a name="233" href="#233">233</a>
<a name="234" href="#234">234</a> <em class="jxr_comment">/*</em>
<a name="235" href="#235">235</a> <em class="jxr_comment"> * allowinline : anything after this will be an inline macro, I think</em>
<a name="236" href="#236">236</a> <em class="jxr_comment"> * there is the question if a #include is an inline, and I think so</em>
<a name="237" href="#237">237</a> <em class="jxr_comment"> *</em>
<a name="238" href="#238">238</a> <em class="jxr_comment"> * default = true</em>
<a name="239" href="#239">239</a> <em class="jxr_comment"> */</em>
<a name="240" href="#240">240</a> setAddMacroPermission(<strong class="jxr_keyword">true</strong>);
<a name="241" href="#241">241</a>
<a name="242" href="#242">242</a> <strong class="jxr_keyword">if</strong> (!rsvc.getBoolean( RuntimeConstants.VM_PERM_ALLOW_INLINE, <strong class="jxr_keyword">true</strong>))
<a name="243" href="#243">243</a> {
<a name="244" href="#244">244</a> setAddMacroPermission(false);
<a name="245" href="#245">245</a>
<a name="246" href="#246">246</a> log.debug(<span class="jxr_string">"allowInline = false : VMs can NOT be defined inline in templates"</span>);
<a name="247" href="#247">247</a> }
<a name="248" href="#248">248</a> <strong class="jxr_keyword">else</strong>
<a name="249" href="#249">249</a> {
<a name="250" href="#250">250</a> log.debug(<span class="jxr_string">"allowInline = true : VMs can be defined inline in templates"</span>);
<a name="251" href="#251">251</a> }
<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"> * allowInlineToReplaceGlobal : allows an inline VM , if allowed at all,</em>
<a name="255" href="#255">255</a> <em class="jxr_comment"> * to replace an existing global VM</em>
<a name="256" href="#256">256</a> <em class="jxr_comment"> *</em>
<a name="257" href="#257">257</a> <em class="jxr_comment"> * default = false</em>
<a name="258" href="#258">258</a> <em class="jxr_comment"> */</em>
<a name="259" href="#259">259</a> setReplacementPermission(false);
<a name="260" href="#260">260</a>
<a name="261" href="#261">261</a> <strong class="jxr_keyword">if</strong> (rsvc.getBoolean(
<a name="262" href="#262">262</a> RuntimeConstants.VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL, false))
<a name="263" href="#263">263</a> {
<a name="264" href="#264">264</a> setReplacementPermission(<strong class="jxr_keyword">true</strong>);
<a name="265" href="#265">265</a>
<a name="266" href="#266">266</a> log.debug(<span class="jxr_string">"allowInlineToOverride = true : VMs "</span> +
<a name="267" href="#267">267</a> <span class="jxr_string">"defined inline may replace previous VM definitions"</span>);
<a name="268" href="#268">268</a> }
<a name="269" href="#269">269</a> <strong class="jxr_keyword">else</strong>
<a name="270" href="#270">270</a> {
<a name="271" href="#271">271</a> log.debug(<span class="jxr_string">"allowInlineToOverride = false : VMs "</span> +
<a name="272" href="#272">272</a> <span class="jxr_string">"defined inline may NOT replace previous VM definitions"</span>);
<a name="273" href="#273">273</a> }
<a name="274" href="#274">274</a>
<a name="275" href="#275">275</a> <em class="jxr_comment">/*</em>
<a name="276" href="#276">276</a> <em class="jxr_comment"> * now turn on namespace handling as far as permissions allow in the</em>
<a name="277" href="#277">277</a> <em class="jxr_comment"> * manager, and also set it here for gating purposes</em>
<a name="278" href="#278">278</a> <em class="jxr_comment"> */</em>
<a name="279" href="#279">279</a> vmManager.setNamespaceUsage(<strong class="jxr_keyword">true</strong>);
<a name="280" href="#280">280</a>
<a name="281" href="#281">281</a> <em class="jxr_comment">/*</em>
<a name="282" href="#282">282</a> <em class="jxr_comment"> * template-local inline VM mode : default is off</em>
<a name="283" href="#283">283</a> <em class="jxr_comment"> */</em>
<a name="284" href="#284">284</a> setTemplateLocalInline(rsvc.getBoolean(
<a name="285" href="#285">285</a> RuntimeConstants.VM_PERM_INLINE_LOCAL, false));
<a name="286" href="#286">286</a>
<a name="287" href="#287">287</a> <strong class="jxr_keyword">if</strong> (getTemplateLocalInline())
<a name="288" href="#288">288</a> {
<a name="289" href="#289">289</a> log.debug(<span class="jxr_string">"allowInlineLocal = true : VMs "</span> +
<a name="290" href="#290">290</a> <span class="jxr_string">"defined inline will be local to their defining template only."</span>);
<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> log.debug(<span class="jxr_string">"allowInlineLocal = false : VMs "</span> +
<a name="295" href="#295">295</a> <span class="jxr_string">"defined inline will be global in scope if allowed."</span>);
<a name="296" href="#296">296</a> }
<a name="297" href="#297">297</a>
<a name="298" href="#298">298</a> vmManager.setTemplateLocalInlineVM(getTemplateLocalInline());
<a name="299" href="#299">299</a>
<a name="300" href="#300">300</a> <em class="jxr_comment">/*</em>
<a name="301" href="#301">301</a> <em class="jxr_comment"> * autoload VM libraries</em>
<a name="302" href="#302">302</a> <em class="jxr_comment"> */</em>
<a name="303" href="#303">303</a> setAutoload(rsvc.getBoolean(RuntimeConstants.VM_LIBRARY_AUTORELOAD, false));
<a name="304" href="#304">304</a>
<a name="305" href="#305">305</a> <strong class="jxr_keyword">if</strong> (getAutoload())
<a name="306" href="#306">306</a> {
<a name="307" href="#307">307</a> log.debug(<span class="jxr_string">"autoload on : VM system "</span> +
<a name="308" href="#308">308</a> <span class="jxr_string">"will automatically reload global library macros"</span>);
<a name="309" href="#309">309</a> }
<a name="310" href="#310">310</a> <strong class="jxr_keyword">else</strong>
<a name="311" href="#311">311</a> {
<a name="312" href="#312">312</a> log.debug(<span class="jxr_string">"autoload off : VM system "</span> +
<a name="313" href="#313">313</a> <span class="jxr_string">"will not automatically reload global library macros"</span>);
<a name="314" href="#314">314</a> }
<a name="315" href="#315">315</a>
<a name="316" href="#316">316</a> log.trace(<span class="jxr_string">"Velocimacro : initialization complete."</span>);
<a name="317" href="#317">317</a> }
<a name="318" href="#318">318</a> }
<a name="319" href="#319">319</a>
<a name="320" href="#320">320</a> <em class="jxr_javadoccomment">/**</em>
<a name="321" href="#321">321</a> <em class="jxr_javadoccomment"> * Adds a macro to the factory.</em>
<a name="322" href="#322">322</a> <em class="jxr_javadoccomment"> * </em>
<a name="323" href="#323">323</a> <em class="jxr_javadoccomment"> * addVelocimacro(String, Node, String[] argArray, String) should be used internally</em>
<a name="324" href="#324">324</a> <em class="jxr_javadoccomment"> * instead of this.</em>
<a name="325" href="#325">325</a> <em class="jxr_javadoccomment"> *</em>
<a name="326" href="#326">326</a> <em class="jxr_javadoccomment"> * @param name Name of the Macro to add.</em>
<a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * @param macroBody String representation of the macro.</em>
<a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * @param argArray Macro arguments. First element is the macro name.</em>
<a name="329" href="#329">329</a> <em class="jxr_javadoccomment"> * @param sourceTemplate Source template from which the macro gets registered.</em>
<a name="330" href="#330">330</a> <em class="jxr_javadoccomment"> * </em>
<a name="331" href="#331">331</a> <em class="jxr_javadoccomment"> * @return true if Macro was registered successfully.</em>
<a name="332" href="#332">332</a> <em class="jxr_javadoccomment"> */</em>
<a name="333" href="#333">333</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> addVelocimacro(String name, String macroBody,
<a name="334" href="#334">334</a> String argArray[], String sourceTemplate)
<a name="335" href="#335">335</a> {
<a name="336" href="#336">336</a> <em class="jxr_comment">/*</em>
<a name="337" href="#337">337</a> <em class="jxr_comment"> * maybe we should throw an exception, maybe just tell</em>
<a name="338" href="#338">338</a> <em class="jxr_comment"> * the caller like this...</em>
<a name="339" href="#339">339</a> <em class="jxr_comment"> *</em>
<a name="340" href="#340">340</a> <em class="jxr_comment"> * I hate this : maybe exceptions are in order here...</em>
<a name="341" href="#341">341</a> <em class="jxr_comment"> * They definitely would be if this was only called by directly</em>
<a name="342" href="#342">342</a> <em class="jxr_comment"> * by users, but Velocity calls this internally.</em>
<a name="343" href="#343">343</a> <em class="jxr_comment"> */</em>
<a name="344" href="#344">344</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong> || macroBody == <strong class="jxr_keyword">null</strong> || argArray == <strong class="jxr_keyword">null</strong> ||
<a name="345" href="#345">345</a> sourceTemplate == <strong class="jxr_keyword">null</strong>)
<a name="346" href="#346">346</a> {
<a name="347" href="#347">347</a> String msg = <span class="jxr_string">"VM '"</span>+name+<span class="jxr_string">"' addition rejected : "</span>;
<a name="348" href="#348">348</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>)
<a name="349" href="#349">349</a> {
<a name="350" href="#350">350</a> msg += <span class="jxr_string">"name"</span>;
<a name="351" href="#351">351</a> }
<a name="352" href="#352">352</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (macroBody == <strong class="jxr_keyword">null</strong>)
<a name="353" href="#353">353</a> {
<a name="354" href="#354">354</a> msg += <span class="jxr_string">"macroBody"</span>;
<a name="355" href="#355">355</a> }
<a name="356" href="#356">356</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (argArray == <strong class="jxr_keyword">null</strong>)
<a name="357" href="#357">357</a> {
<a name="358" href="#358">358</a> msg += <span class="jxr_string">"argArray"</span>;
<a name="359" href="#359">359</a> }
<a name="360" href="#360">360</a> <strong class="jxr_keyword">else</strong>
<a name="361" href="#361">361</a> {
<a name="362" href="#362">362</a> msg += <span class="jxr_string">"sourceTemplate"</span>;
<a name="363" href="#363">363</a> }
<a name="364" href="#364">364</a> msg += <span class="jxr_string">" argument was null"</span>;
<a name="365" href="#365">365</a> log.error(msg);
<a name="366" href="#366">366</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(msg);
<a name="367" href="#367">367</a> }
<a name="368" href="#368">368</a>
<a name="369" href="#369">369</a> <em class="jxr_comment">/*</em>
<a name="370" href="#370">370</a> <em class="jxr_comment"> * see if the current ruleset allows this addition</em>
<a name="371" href="#371">371</a> <em class="jxr_comment"> */</em>
<a name="372" href="#372">372</a>
<a name="373" href="#373">373</a> <strong class="jxr_keyword">if</strong> (!canAddVelocimacro(name, sourceTemplate))
<a name="374" href="#374">374</a> {
<a name="375" href="#375">375</a> <strong class="jxr_keyword">return</strong> false;
<a name="376" href="#376">376</a> }
<a name="377" href="#377">377</a>
<a name="378" href="#378">378</a> <strong class="jxr_keyword">synchronized</strong> (<strong class="jxr_keyword">this</strong>)
<a name="379" href="#379">379</a> {
<a name="380" href="#380">380</a> <strong class="jxr_keyword">try</strong>
<a name="381" href="#381">381</a> {
<a name="382" href="#382">382</a> <a href="../../../../org/apache/velocity/runtime/parser/node/Node.html">Node</a> macroRootNode = rsvc.parse(<strong class="jxr_keyword">new</strong> StringReader(macroBody), sourceTemplate);
<a name="383" href="#383">383</a>
<a name="384" href="#384">384</a> vmManager.addVM(name, macroRootNode, argArray, sourceTemplate, replaceAllowed);
<a name="385" href="#385">385</a> }
<a name="386" href="#386">386</a> <strong class="jxr_keyword">catch</strong> (ParseException ex)
<a name="387" href="#387">387</a> {
<a name="388" href="#388">388</a> <em class="jxr_comment">// to keep things 1.3 compatible call toString() here</em>
<a name="389" href="#389">389</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(ex.toString());
<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">if</strong> (log.isDebugEnabled())
<a name="394" href="#394">394</a> {
<a name="395" href="#395">395</a> StringBuffer msg = <strong class="jxr_keyword">new</strong> StringBuffer(<span class="jxr_string">"added "</span>);
<a name="396" href="#396">396</a> Macro.macroToString(msg, argArray);
<a name="397" href="#397">397</a> msg.append(<span class="jxr_string">" : source = "</span>).append(sourceTemplate);
<a name="398" href="#398">398</a> log.debug(msg.toString());
<a name="399" href="#399">399</a> }
<a name="400" href="#400">400</a>
<a name="401" href="#401">401</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="402" href="#402">402</a> }
<a name="403" href="#403">403</a>
<a name="404" href="#404">404</a> <em class="jxr_javadoccomment">/**</em>
<a name="405" href="#405">405</a> <em class="jxr_javadoccomment"> * Adds a macro to the factory.</em>
<a name="406" href="#406">406</a> <em class="jxr_javadoccomment"> * </em>
<a name="407" href="#407">407</a> <em class="jxr_javadoccomment"> * @param name Name of the Macro to add.</em>
<a name="408" href="#408">408</a> <em class="jxr_javadoccomment"> * @param macroBody root node of the parsed macro AST</em>
<a name="409" href="#409">409</a> <em class="jxr_javadoccomment"> * @param argArray Name of the macro arguments. First element is the macro name.</em>
<a name="410" href="#410">410</a> <em class="jxr_javadoccomment"> * @param sourceTemplate Source template from which the macro gets registered.</em>
<a name="411" href="#411">411</a> <em class="jxr_javadoccomment"> * @return true if Macro was registered successfully.</em>
<a name="412" href="#412">412</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
<a name="413" href="#413">413</a> <em class="jxr_javadoccomment"> */</em>
<a name="414" href="#414">414</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> addVelocimacro(String name, <a href="../../../../org/apache/velocity/runtime/parser/node/Node.html">Node</a> macroBody,
<a name="415" href="#415">415</a> String argArray[], String sourceTemplate)
<a name="416" href="#416">416</a> {
<a name="417" href="#417">417</a> <em class="jxr_comment">// Called by RuntimeInstance.addVelocimacro</em>
<a name="418" href="#418">418</a>
<a name="419" href="#419">419</a> <em class="jxr_comment">/*</em>
<a name="420" href="#420">420</a> <em class="jxr_comment"> * maybe we should throw an exception, maybe just tell</em>
<a name="421" href="#421">421</a> <em class="jxr_comment"> * the caller like this...</em>
<a name="422" href="#422">422</a> <em class="jxr_comment"> *</em>
<a name="423" href="#423">423</a> <em class="jxr_comment"> * I hate this : maybe exceptions are in order here...</em>
<a name="424" href="#424">424</a> <em class="jxr_comment"> * They definitely would be if this was only called by directly</em>
<a name="425" href="#425">425</a> <em class="jxr_comment"> * by users, but Velocity calls this internally.</em>
<a name="426" href="#426">426</a> <em class="jxr_comment"> */</em>
<a name="427" href="#427">427</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong> || macroBody == <strong class="jxr_keyword">null</strong> || argArray == <strong class="jxr_keyword">null</strong> ||
<a name="428" href="#428">428</a> sourceTemplate == <strong class="jxr_keyword">null</strong>)
<a name="429" href="#429">429</a> {
<a name="430" href="#430">430</a> String msg = <span class="jxr_string">"VM '"</span>+name+<span class="jxr_string">"' addition rejected : "</span>;
<a name="431" href="#431">431</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>)
<a name="432" href="#432">432</a> {
<a name="433" href="#433">433</a> msg += <span class="jxr_string">"name"</span>;
<a name="434" href="#434">434</a> }
<a name="435" href="#435">435</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (macroBody == <strong class="jxr_keyword">null</strong>)
<a name="436" href="#436">436</a> {
<a name="437" href="#437">437</a> msg += <span class="jxr_string">"macroBody"</span>;
<a name="438" href="#438">438</a> }
<a name="439" href="#439">439</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (argArray == <strong class="jxr_keyword">null</strong>)
<a name="440" href="#440">440</a> {
<a name="441" href="#441">441</a> msg += <span class="jxr_string">"argArray"</span>;
<a name="442" href="#442">442</a> }
<a name="443" href="#443">443</a> <strong class="jxr_keyword">else</strong>
<a name="444" href="#444">444</a> {
<a name="445" href="#445">445</a> msg += <span class="jxr_string">"sourceTemplate"</span>;
<a name="446" href="#446">446</a> }
<a name="447" href="#447">447</a> msg += <span class="jxr_string">" argument was null"</span>;
<a name="448" href="#448">448</a> log.error(msg);
<a name="449" href="#449">449</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(msg);
<a name="450" href="#450">450</a> }
<a name="451" href="#451">451</a>
<a name="452" href="#452">452</a> <em class="jxr_comment">/*</em>
<a name="453" href="#453">453</a> <em class="jxr_comment"> * see if the current ruleset allows this addition</em>
<a name="454" href="#454">454</a> <em class="jxr_comment"> */</em>
<a name="455" href="#455">455</a>
<a name="456" href="#456">456</a> <strong class="jxr_keyword">if</strong> (!canAddVelocimacro(name, sourceTemplate))
<a name="457" href="#457">457</a> {
<a name="458" href="#458">458</a> <strong class="jxr_keyword">return</strong> false;
<a name="459" href="#459">459</a> }
<a name="460" href="#460">460</a>
<a name="461" href="#461">461</a> <strong class="jxr_keyword">synchronized</strong>(<strong class="jxr_keyword">this</strong>)
<a name="462" href="#462">462</a> {
<a name="463" href="#463">463</a> vmManager.addVM(name, macroBody, argArray, sourceTemplate, replaceAllowed);
<a name="464" href="#464">464</a> }
<a name="465" href="#465">465</a> <strong class="jxr_keyword">return</strong>(<strong class="jxr_keyword">true</strong>);
<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> <em class="jxr_javadoccomment">/**</em>
<a name="470" href="#470">470</a> <em class="jxr_javadoccomment"> * determines if a given macro/namespace (name, source) combo is allowed</em>
<a name="471" href="#471">471</a> <em class="jxr_javadoccomment"> * to be added</em>
<a name="472" href="#472">472</a> <em class="jxr_javadoccomment"> *</em>
<a name="473" href="#473">473</a> <em class="jxr_javadoccomment"> * @param name Name of VM to add</em>
<a name="474" href="#474">474</a> <em class="jxr_javadoccomment"> * @param sourceTemplate Source template that contains the defintion of the VM</em>
<a name="475" href="#475">475</a> <em class="jxr_javadoccomment"> * @return true if it is allowed to be added, false otherwise</em>
<a name="476" href="#476">476</a> <em class="jxr_javadoccomment"> */</em>
<a name="477" href="#477">477</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">boolean</strong> canAddVelocimacro(String name, String sourceTemplate)
<a name="478" href="#478">478</a> {
<a name="479" href="#479">479</a> <em class="jxr_comment">/*</em>
<a name="480" href="#480">480</a> <em class="jxr_comment"> * short circuit and do it if autoloader is on, and the</em>
<a name="481" href="#481">481</a> <em class="jxr_comment"> * template is one of the library templates</em>
<a name="482" href="#482">482</a> <em class="jxr_comment"> */</em>
<a name="483" href="#483">483</a>
<a name="484" href="#484">484</a> <strong class="jxr_keyword">if</strong> (autoReloadLibrary &amp;&amp; (macroLibVec != <strong class="jxr_keyword">null</strong>))
<a name="485" href="#485">485</a> {
<a name="486" href="#486">486</a> <strong class="jxr_keyword">if</strong>( macroLibVec.contains(sourceTemplate) )
<a name="487" href="#487">487</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="488" href="#488">488</a> }
<a name="489" href="#489">489</a>
<a name="490" href="#490">490</a>
<a name="491" href="#491">491</a> <em class="jxr_comment">/*</em>
<a name="492" href="#492">492</a> <em class="jxr_comment"> * maybe the rules should be in manager? I dunno. It's to manage</em>
<a name="493" href="#493">493</a> <em class="jxr_comment"> * the namespace issues first, are we allowed to add VMs at all?</em>
<a name="494" href="#494">494</a> <em class="jxr_comment"> * This trumps all.</em>
<a name="495" href="#495">495</a> <em class="jxr_comment"> */</em>
<a name="496" href="#496">496</a> <strong class="jxr_keyword">if</strong> (!addNewAllowed)
<a name="497" href="#497">497</a> {
<a name="498" href="#498">498</a> log.warn(<span class="jxr_string">"VM addition rejected : "</span>+name+<span class="jxr_string">" : inline VMs not allowed."</span>);
<a name="499" href="#499">499</a> <strong class="jxr_keyword">return</strong> false;
<a name="500" href="#500">500</a> }
<a name="501" href="#501">501</a>
<a name="502" href="#502">502</a> <em class="jxr_comment">/*</em>
<a name="503" href="#503">503</a> <em class="jxr_comment"> * are they local in scope? Then it is ok to add.</em>
<a name="504" href="#504">504</a> <em class="jxr_comment"> */</em>
<a name="505" href="#505">505</a> <strong class="jxr_keyword">if</strong> (!templateLocal)
<a name="506" href="#506">506</a> {
<a name="507" href="#507">507</a> <em class="jxr_comment">/*</em>
<a name="508" href="#508">508</a> <em class="jxr_comment"> * otherwise, if we have it already in global namespace, and they can't replace</em>
<a name="509" href="#509">509</a> <em class="jxr_comment"> * since local templates are not allowed, the global namespace is implied.</em>
<a name="510" href="#510">510</a> <em class="jxr_comment"> * remember, we don't know anything about namespace managment here, so lets</em>
<a name="511" href="#511">511</a> <em class="jxr_comment"> * note do anything fancy like trying to give it the global namespace here</em>
<a name="512" href="#512">512</a> <em class="jxr_comment"> *</em>
<a name="513" href="#513">513</a> <em class="jxr_comment"> * so if we have it, and we aren't allowed to replace, bail</em>
<a name="514" href="#514">514</a> <em class="jxr_comment"> */</em>
<a name="515" href="#515">515</a> <strong class="jxr_keyword">if</strong> (!replaceAllowed &amp;&amp; isVelocimacro(name, sourceTemplate))
<a name="516" href="#516">516</a> {
<a name="517" href="#517">517</a> <em class="jxr_comment">/*</em>
<a name="518" href="#518">518</a> <em class="jxr_comment"> * Concurrency fix: the log entry was changed to debug scope because it</em>
<a name="519" href="#519">519</a> <em class="jxr_comment"> * causes false alarms when several concurrent threads simultaneously (re)parse</em>
<a name="520" href="#520">520</a> <em class="jxr_comment"> * some macro</em>
<a name="521" href="#521">521</a> <em class="jxr_comment"> */</em>
<a name="522" href="#522">522</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled())
<a name="523" href="#523">523</a> log.debug(<span class="jxr_string">"VM addition rejected : "</span>+name+<span class="jxr_string">" : inline not allowed to replace existing VM"</span>);
<a name="524" href="#524">524</a> <strong class="jxr_keyword">return</strong> false;
<a name="525" href="#525">525</a> }
<a name="526" href="#526">526</a> }
<a name="527" href="#527">527</a>
<a name="528" href="#528">528</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="529" href="#529">529</a> }
<a name="530" href="#530">530</a>
<a name="531" href="#531">531</a> <em class="jxr_javadoccomment">/**</em>
<a name="532" href="#532">532</a> <em class="jxr_javadoccomment"> * Tells the world if a given directive string is a Velocimacro</em>
<a name="533" href="#533">533</a> <em class="jxr_javadoccomment"> * @param vm Name of the Macro.</em>
<a name="534" href="#534">534</a> <em class="jxr_javadoccomment"> * @param sourceTemplate Source template from which the macro should be loaded.</em>
<a name="535" href="#535">535</a> <em class="jxr_javadoccomment"> * @return True if the given name is a macro.</em>
<a name="536" href="#536">536</a> <em class="jxr_javadoccomment"> */</em>
<a name="537" href="#537">537</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isVelocimacro(String vm, String sourceTemplate)
<a name="538" href="#538">538</a> {
<a name="539" href="#539">539</a> <em class="jxr_comment">// synchronization removed</em>
<a name="540" href="#540">540</a> <strong class="jxr_keyword">return</strong>(vmManager.get(vm, sourceTemplate) != <strong class="jxr_keyword">null</strong>);
<a name="541" href="#541">541</a> }
<a name="542" href="#542">542</a>
<a name="543" href="#543">543</a> <em class="jxr_javadoccomment">/**</em>
<a name="544" href="#544">544</a> <em class="jxr_javadoccomment"> * actual factory : creates a Directive that will</em>
<a name="545" href="#545">545</a> <em class="jxr_javadoccomment"> * behave correctly wrt getting the framework to</em>
<a name="546" href="#546">546</a> <em class="jxr_javadoccomment"> * dig out the correct # of args</em>
<a name="547" href="#547">547</a> <em class="jxr_javadoccomment"> * @param vmName Name of the Macro.</em>
<a name="548" href="#548">548</a> <em class="jxr_javadoccomment"> * @param sourceTemplate Source template from which the macro should be loaded.</em>
<a name="549" href="#549">549</a> <em class="jxr_javadoccomment"> * @return A directive representing the Macro.</em>
<a name="550" href="#550">550</a> <em class="jxr_javadoccomment"> */</em>
<a name="551" href="#551">551</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/runtime/directive/Directive.html">Directive</a> getVelocimacro(String vmName, String sourceTemplate)
<a name="552" href="#552">552</a> {
<a name="553" href="#553">553</a> <strong class="jxr_keyword">return</strong>(getVelocimacro(vmName, sourceTemplate, <strong class="jxr_keyword">null</strong>));
<a name="554" href="#554">554</a> }
<a name="555" href="#555">555</a>
<a name="556" href="#556">556</a> <em class="jxr_javadoccomment">/**</em>
<a name="557" href="#557">557</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
<a name="558" href="#558">558</a> <em class="jxr_javadoccomment"> */</em>
<a name="559" href="#559">559</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/runtime/directive/Directive.html">Directive</a> getVelocimacro(String vmName, String sourceTemplate, String renderingTemplate)
<a name="560" href="#560">560</a> {
<a name="561" href="#561">561</a> <a href="../../../../org/apache/velocity/runtime/directive/VelocimacroProxy.html">VelocimacroProxy</a> vp = <strong class="jxr_keyword">null</strong>;
<a name="562" href="#562">562</a>
<a name="563" href="#563">563</a> vp = vmManager.get(vmName, sourceTemplate, renderingTemplate);
<a name="564" href="#564">564</a>
<a name="565" href="#565">565</a> <em class="jxr_comment">/*</em>
<a name="566" href="#566">566</a> <em class="jxr_comment"> * if this exists, and autoload is on, we need to check where this VM came from</em>
<a name="567" href="#567">567</a> <em class="jxr_comment"> */</em>
<a name="568" href="#568">568</a>
<a name="569" href="#569">569</a> <strong class="jxr_keyword">if</strong> (vp != <strong class="jxr_keyword">null</strong> &amp;&amp; autoReloadLibrary )
<a name="570" href="#570">570</a> {
<a name="571" href="#571">571</a> <strong class="jxr_keyword">synchronized</strong> (<strong class="jxr_keyword">this</strong>)
<a name="572" href="#572">572</a> {
<a name="573" href="#573">573</a> <em class="jxr_comment">/*</em>
<a name="574" href="#574">574</a> <em class="jxr_comment"> * see if this VM came from a library. Need to pass sourceTemplate in the event</em>
<a name="575" href="#575">575</a> <em class="jxr_comment"> * namespaces are set, as it could be masked by local</em>
<a name="576" href="#576">576</a> <em class="jxr_comment"> */</em>
<a name="577" href="#577">577</a>
<a name="578" href="#578">578</a> String lib = vmManager.getLibraryName(vmName, sourceTemplate);
<a name="579" href="#579">579</a>
<a name="580" href="#580">580</a> <strong class="jxr_keyword">if</strong> (lib != <strong class="jxr_keyword">null</strong>)
<a name="581" href="#581">581</a> {
<a name="582" href="#582">582</a> <strong class="jxr_keyword">try</strong>
<a name="583" href="#583">583</a> {
<a name="584" href="#584">584</a> <em class="jxr_comment">/*</em>
<a name="585" href="#585">585</a> <em class="jxr_comment"> * get the template from our map</em>
<a name="586" href="#586">586</a> <em class="jxr_comment"> */</em>
<a name="587" href="#587">587</a>
<a name="588" href="#588">588</a> <a href="../../../../org/apache/velocity/runtime/VelocimacroFactory.html">Twonk</a> tw = (Twonk) libModMap.get(lib);
<a name="589" href="#589">589</a>
<a name="590" href="#590">590</a> <strong class="jxr_keyword">if</strong> (tw != <strong class="jxr_keyword">null</strong>)
<a name="591" href="#591">591</a> {
<a name="592" href="#592">592</a> <a href="../../../../org/apache/velocity/Template.html">Template</a> template = tw.template;
<a name="593" href="#593">593</a>
<a name="594" href="#594">594</a> <em class="jxr_comment">/*</em>
<a name="595" href="#595">595</a> <em class="jxr_comment"> * now, compare the last modified time of the resource with the last</em>
<a name="596" href="#596">596</a> <em class="jxr_comment"> * modified time of the template if the file has changed, then reload.</em>
<a name="597" href="#597">597</a> <em class="jxr_comment"> * Otherwise, we should be ok.</em>
<a name="598" href="#598">598</a> <em class="jxr_comment"> */</em>
<a name="599" href="#599">599</a>
<a name="600" href="#600">600</a> <strong class="jxr_keyword">long</strong> tt = tw.modificationTime;
<a name="601" href="#601">601</a> <strong class="jxr_keyword">long</strong> ft = template.getResourceLoader().getLastModified(template);
<a name="602" href="#602">602</a>
<a name="603" href="#603">603</a> <strong class="jxr_keyword">if</strong> (ft &gt; tt)
<a name="604" href="#604">604</a> {
<a name="605" href="#605">605</a> log.debug(<span class="jxr_string">"auto-reloading VMs from VM library : "</span> + lib);
<a name="606" href="#606">606</a>
<a name="607" href="#607">607</a> <em class="jxr_comment">/*</em>
<a name="608" href="#608">608</a> <em class="jxr_comment"> * when there are VMs in a library that invoke each other, there are</em>
<a name="609" href="#609">609</a> <em class="jxr_comment"> * calls into getVelocimacro() from the init() process of the VM</em>
<a name="610" href="#610">610</a> <em class="jxr_comment"> * directive. To stop the infinite loop we save the current time</em>
<a name="611" href="#611">611</a> <em class="jxr_comment"> * reported by the resource loader and then be honest when the</em>
<a name="612" href="#612">612</a> <em class="jxr_comment"> * reload is complete</em>
<a name="613" href="#613">613</a> <em class="jxr_comment"> */</em>
<a name="614" href="#614">614</a>
<a name="615" href="#615">615</a> tw.modificationTime = ft;
<a name="616" href="#616">616</a>
<a name="617" href="#617">617</a> template = rsvc.getTemplate(lib);
<a name="618" href="#618">618</a>
<a name="619" href="#619">619</a> <em class="jxr_comment">/*</em>
<a name="620" href="#620">620</a> <em class="jxr_comment"> * and now we be honest</em>
<a name="621" href="#621">621</a> <em class="jxr_comment"> */</em>
<a name="622" href="#622">622</a>
<a name="623" href="#623">623</a> tw.template = template;
<a name="624" href="#624">624</a> tw.modificationTime = template.getLastModified();
<a name="625" href="#625">625</a>
<a name="626" href="#626">626</a> <em class="jxr_comment">/*</em>
<a name="627" href="#627">627</a> <em class="jxr_comment"> * note that we don't need to put this twonk</em>
<a name="628" href="#628">628</a> <em class="jxr_comment"> * back into the map, as we can just use the</em>
<a name="629" href="#629">629</a> <em class="jxr_comment"> * same reference and this block is synchronized</em>
<a name="630" href="#630">630</a> <em class="jxr_comment"> */</em>
<a name="631" href="#631">631</a> }
<a name="632" href="#632">632</a> }
<a name="633" href="#633">633</a> }
<a name="634" href="#634">634</a> <strong class="jxr_keyword">catch</strong> (Exception e)
<a name="635" href="#635">635</a> {
<a name="636" href="#636">636</a> String msg = <span class="jxr_string">"Velocimacro : Error using VM library : "</span> + lib;
<a name="637" href="#637">637</a> log.error(<strong class="jxr_keyword">true</strong>, msg, e);
<a name="638" href="#638">638</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="639" href="#639">639</a> }
<a name="640" href="#640">640</a>
<a name="641" href="#641">641</a> vp = vmManager.get(vmName, sourceTemplate, renderingTemplate);
<a name="642" href="#642">642</a> }
<a name="643" href="#643">643</a> }
<a name="644" href="#644">644</a> }
<a name="645" href="#645">645</a>
<a name="646" href="#646">646</a> <strong class="jxr_keyword">return</strong> vp;
<a name="647" href="#647">647</a> }
<a name="648" href="#648">648</a>
<a name="649" href="#649">649</a> <em class="jxr_javadoccomment">/**</em>
<a name="650" href="#650">650</a> <em class="jxr_javadoccomment"> * tells the vmManager to dump the specified namespace</em>
<a name="651" href="#651">651</a> <em class="jxr_javadoccomment"> * </em>
<a name="652" href="#652">652</a> <em class="jxr_javadoccomment"> * @param namespace Namespace to dump.</em>
<a name="653" href="#653">653</a> <em class="jxr_javadoccomment"> * @return True if namespace has been dumped successfully.</em>
<a name="654" href="#654">654</a> <em class="jxr_javadoccomment"> */</em>
<a name="655" href="#655">655</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> dumpVMNamespace(String namespace)
<a name="656" href="#656">656</a> {
<a name="657" href="#657">657</a> <strong class="jxr_keyword">return</strong> vmManager.dumpNamespace(namespace);
<a name="658" href="#658">658</a> }
<a name="659" href="#659">659</a>
<a name="660" href="#660">660</a> <em class="jxr_javadoccomment">/**</em>
<a name="661" href="#661">661</a> <em class="jxr_javadoccomment"> * sets permission to have VMs local in scope to their declaring template note that this is</em>
<a name="662" href="#662">662</a> <em class="jxr_javadoccomment"> * really taken care of in the VMManager class, but we need it here for gating purposes in addVM</em>
<a name="663" href="#663">663</a> <em class="jxr_javadoccomment"> * eventually, I will slide this all into the manager, maybe.</em>
<a name="664" href="#664">664</a> <em class="jxr_javadoccomment"> */</em>
<a name="665" href="#665">665</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> setTemplateLocalInline(<strong class="jxr_keyword">boolean</strong> b)
<a name="666" href="#666">666</a> {
<a name="667" href="#667">667</a> templateLocal = b;
<a name="668" href="#668">668</a> }
<a name="669" href="#669">669</a>
<a name="670" href="#670">670</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> getTemplateLocalInline()
<a name="671" href="#671">671</a> {
<a name="672" href="#672">672</a> <strong class="jxr_keyword">return</strong> templateLocal;
<a name="673" href="#673">673</a> }
<a name="674" href="#674">674</a>
<a name="675" href="#675">675</a> <em class="jxr_javadoccomment">/**</em>
<a name="676" href="#676">676</a> <em class="jxr_javadoccomment"> * sets the permission to add new macros</em>
<a name="677" href="#677">677</a> <em class="jxr_javadoccomment"> */</em>
<a name="678" href="#678">678</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> setAddMacroPermission(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> addNewAllowed)
<a name="679" href="#679">679</a> {
<a name="680" href="#680">680</a> <strong class="jxr_keyword">boolean</strong> b = <strong class="jxr_keyword">this</strong>.addNewAllowed;
<a name="681" href="#681">681</a> <strong class="jxr_keyword">this</strong>.addNewAllowed = addNewAllowed;
<a name="682" href="#682">682</a> <strong class="jxr_keyword">return</strong> b;
<a name="683" href="#683">683</a> }
<a name="684" href="#684">684</a>
<a name="685" href="#685">685</a> <em class="jxr_javadoccomment">/**</em>
<a name="686" href="#686">686</a> <em class="jxr_javadoccomment"> * sets the permission for allowing addMacro() calls to replace existing VM's</em>
<a name="687" href="#687">687</a> <em class="jxr_javadoccomment"> */</em>
<a name="688" href="#688">688</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> setReplacementPermission(<strong class="jxr_keyword">boolean</strong> arg)
<a name="689" href="#689">689</a> {
<a name="690" href="#690">690</a> <strong class="jxr_keyword">boolean</strong> b = replaceAllowed;
<a name="691" href="#691">691</a> replaceAllowed = arg;
<a name="692" href="#692">692</a> vmManager.setInlineReplacesGlobal(arg);
<a name="693" href="#693">693</a> <strong class="jxr_keyword">return</strong> b;
<a name="694" href="#694">694</a> }
<a name="695" href="#695">695</a>
<a name="696" href="#696">696</a> <em class="jxr_javadoccomment">/**</em>
<a name="697" href="#697">697</a> <em class="jxr_javadoccomment"> * set the switch for automatic reloading of</em>
<a name="698" href="#698">698</a> <em class="jxr_javadoccomment"> * global library-based VMs</em>
<a name="699" href="#699">699</a> <em class="jxr_javadoccomment"> */</em>
<a name="700" href="#700">700</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> setAutoload(<strong class="jxr_keyword">boolean</strong> b)
<a name="701" href="#701">701</a> {
<a name="702" href="#702">702</a> autoReloadLibrary = b;
<a name="703" href="#703">703</a> }
<a name="704" href="#704">704</a>
<a name="705" href="#705">705</a> <em class="jxr_javadoccomment">/**</em>
<a name="706" href="#706">706</a> <em class="jxr_javadoccomment"> * get the switch for automatic reloading of</em>
<a name="707" href="#707">707</a> <em class="jxr_javadoccomment"> * global library-based VMs</em>
<a name="708" href="#708">708</a> <em class="jxr_javadoccomment"> */</em>
<a name="709" href="#709">709</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> getAutoload()
<a name="710" href="#710">710</a> {
<a name="711" href="#711">711</a> <strong class="jxr_keyword">return</strong> autoReloadLibrary;
<a name="712" href="#712">712</a> }
<a name="713" href="#713">713</a>
<a name="714" href="#714">714</a> <em class="jxr_javadoccomment">/**</em>
<a name="715" href="#715">715</a> <em class="jxr_javadoccomment"> * small container class to hold the tuple</em>
<a name="716" href="#716">716</a> <em class="jxr_javadoccomment"> * of a template and modification time.</em>
<a name="717" href="#717">717</a> <em class="jxr_javadoccomment"> * We keep the modification time so we can</em>
<a name="718" href="#718">718</a> <em class="jxr_javadoccomment"> * 'override' it on a reload to prevent</em>
<a name="719" href="#719">719</a> <em class="jxr_javadoccomment"> * recursive reload due to inter-calling</em>
<a name="720" href="#720">720</a> <em class="jxr_javadoccomment"> * VMs in a library</em>
<a name="721" href="#721">721</a> <em class="jxr_javadoccomment"> */</em>
<a name="722" href="#722">722</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/velocity/runtime/VelocimacroFactory.html">Twonk</a>
<a name="723" href="#723">723</a> {
<a name="724" href="#724">724</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> <a href="../../../../org/apache/velocity/Template.html">Template</a> kept in this container. */</em>
<a name="725" href="#725">725</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/Template.html">Template</a> template;
<a name="726" href="#726">726</a>
<a name="727" href="#727">727</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> modification time of the template. */</em>
<a name="728" href="#728">728</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> modificationTime;
<a name="729" href="#729">729</a> }
<a name="730" href="#730">730</a> }
<a name="731" href="#731">731</a>
<a name="732" href="#732">732</a>
<a name="733" href="#733">733</a>
<a name="734" href="#734">734</a>
<a name="735" href="#735">735</a>
<a name="736" href="#736">736</a>
<a name="737" href="#737">737</a>
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>