blob: e13d5db6bb41613246e5423cedb701bbebc8bfa5 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the "License");<a name="line.6"></a>
<FONT color="green">007</FONT> * you may not use this file except in compliance with the License.<a name="line.7"></a>
<FONT color="green">008</FONT> * You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<FONT color="green">013</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<FONT color="green">014</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<FONT color="green">015</FONT> * See the License for the specific language governing permissions and<a name="line.15"></a>
<FONT color="green">016</FONT> * limitations under the License.<a name="line.16"></a>
<FONT color="green">017</FONT> */<a name="line.17"></a>
<FONT color="green">018</FONT> /*<a name="line.18"></a>
<FONT color="green">019</FONT> * $Id: CallTemplate.java 1225842 2011-12-30 15:14:35Z mrglavas $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> <a name="line.21"></a>
<FONT color="green">022</FONT> package org.apache.xalan.xsltc.compiler;<a name="line.22"></a>
<FONT color="green">023</FONT> <a name="line.23"></a>
<FONT color="green">024</FONT> import java.util.Vector;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.bcel.generic.ConstantPoolGen;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.bcel.generic.INVOKEVIRTUAL;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.bcel.generic.InstructionList;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.xalan.xsltc.compiler.util.ClassGenerator;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.xalan.xsltc.compiler.util.ErrorMsg;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.apache.xalan.xsltc.compiler.util.MethodGenerator;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.apache.xalan.xsltc.compiler.util.Type;<a name="line.32"></a>
<FONT color="green">033</FONT> import org.apache.xalan.xsltc.compiler.util.TypeCheckError;<a name="line.33"></a>
<FONT color="green">034</FONT> import org.apache.xalan.xsltc.compiler.util.Util;<a name="line.34"></a>
<FONT color="green">035</FONT> import org.apache.xml.utils.XML11Char;<a name="line.35"></a>
<FONT color="green">036</FONT> <a name="line.36"></a>
<FONT color="green">037</FONT> /**<a name="line.37"></a>
<FONT color="green">038</FONT> * @author Jacek Ambroziak<a name="line.38"></a>
<FONT color="green">039</FONT> * @author Santiago Pericas-Geertsen<a name="line.39"></a>
<FONT color="green">040</FONT> * @author Erwin Bolwidt &lt;ejb@klomp.org&gt;<a name="line.40"></a>
<FONT color="green">041</FONT> */<a name="line.41"></a>
<FONT color="green">042</FONT> final class CallTemplate extends Instruction {<a name="line.42"></a>
<FONT color="green">043</FONT> <a name="line.43"></a>
<FONT color="green">044</FONT> /**<a name="line.44"></a>
<FONT color="green">045</FONT> * Name of template to call.<a name="line.45"></a>
<FONT color="green">046</FONT> */<a name="line.46"></a>
<FONT color="green">047</FONT> private QName _name;<a name="line.47"></a>
<FONT color="green">048</FONT> <a name="line.48"></a>
<FONT color="green">049</FONT> /** <a name="line.49"></a>
<FONT color="green">050</FONT> * The array of effective parameters in this CallTemplate. An object in <a name="line.50"></a>
<FONT color="green">051</FONT> * this array can be either a WithParam or a Param if no WithParam <a name="line.51"></a>
<FONT color="green">052</FONT> * exists for a particular parameter.<a name="line.52"></a>
<FONT color="green">053</FONT> */<a name="line.53"></a>
<FONT color="green">054</FONT> private Object[] _parameters = null;<a name="line.54"></a>
<FONT color="green">055</FONT> <a name="line.55"></a>
<FONT color="green">056</FONT> /**<a name="line.56"></a>
<FONT color="green">057</FONT> * The corresponding template which this CallTemplate calls.<a name="line.57"></a>
<FONT color="green">058</FONT> */<a name="line.58"></a>
<FONT color="green">059</FONT> private Template _calleeTemplate = null;<a name="line.59"></a>
<FONT color="green">060</FONT> <a name="line.60"></a>
<FONT color="green">061</FONT> public void display(int indent) {<a name="line.61"></a>
<FONT color="green">062</FONT> indent(indent);<a name="line.62"></a>
<FONT color="green">063</FONT> System.out.print("CallTemplate");<a name="line.63"></a>
<FONT color="green">064</FONT> Util.println(" name " + _name);<a name="line.64"></a>
<FONT color="green">065</FONT> displayContents(indent + IndentIncrement);<a name="line.65"></a>
<FONT color="green">066</FONT> }<a name="line.66"></a>
<FONT color="green">067</FONT> <a name="line.67"></a>
<FONT color="green">068</FONT> public boolean hasWithParams() {<a name="line.68"></a>
<FONT color="green">069</FONT> return elementCount() &gt; 0;<a name="line.69"></a>
<FONT color="green">070</FONT> }<a name="line.70"></a>
<FONT color="green">071</FONT> <a name="line.71"></a>
<FONT color="green">072</FONT> public void parseContents(Parser parser) {<a name="line.72"></a>
<FONT color="green">073</FONT> final String name = getAttribute("name");<a name="line.73"></a>
<FONT color="green">074</FONT> if (name.length() &gt; 0) {<a name="line.74"></a>
<FONT color="green">075</FONT> if (!XML11Char.isXML11ValidQName(name)) {<a name="line.75"></a>
<FONT color="green">076</FONT> ErrorMsg err = new ErrorMsg(ErrorMsg.INVALID_QNAME_ERR, name, this);<a name="line.76"></a>
<FONT color="green">077</FONT> parser.reportError(Constants.ERROR, err); <a name="line.77"></a>
<FONT color="green">078</FONT> } <a name="line.78"></a>
<FONT color="green">079</FONT> _name = parser.getQNameIgnoreDefaultNs(name);<a name="line.79"></a>
<FONT color="green">080</FONT> }<a name="line.80"></a>
<FONT color="green">081</FONT> else {<a name="line.81"></a>
<FONT color="green">082</FONT> reportError(this, parser, ErrorMsg.REQUIRED_ATTR_ERR, "name"); <a name="line.82"></a>
<FONT color="green">083</FONT> }<a name="line.83"></a>
<FONT color="green">084</FONT> parseChildren(parser);<a name="line.84"></a>
<FONT color="green">085</FONT> }<a name="line.85"></a>
<FONT color="green">086</FONT> <a name="line.86"></a>
<FONT color="green">087</FONT> /**<a name="line.87"></a>
<FONT color="green">088</FONT> * Verify that a template with this name exists.<a name="line.88"></a>
<FONT color="green">089</FONT> */<a name="line.89"></a>
<FONT color="green">090</FONT> public Type typeCheck(SymbolTable stable) throws TypeCheckError {<a name="line.90"></a>
<FONT color="green">091</FONT> final Template template = stable.lookupTemplate(_name);<a name="line.91"></a>
<FONT color="green">092</FONT> if (template != null) {<a name="line.92"></a>
<FONT color="green">093</FONT> typeCheckContents(stable);<a name="line.93"></a>
<FONT color="green">094</FONT> }<a name="line.94"></a>
<FONT color="green">095</FONT> else {<a name="line.95"></a>
<FONT color="green">096</FONT> ErrorMsg err = new ErrorMsg(ErrorMsg.TEMPLATE_UNDEF_ERR,_name,this);<a name="line.96"></a>
<FONT color="green">097</FONT> throw new TypeCheckError(err);<a name="line.97"></a>
<FONT color="green">098</FONT> }<a name="line.98"></a>
<FONT color="green">099</FONT> return Type.Void;<a name="line.99"></a>
<FONT color="green">100</FONT> }<a name="line.100"></a>
<FONT color="green">101</FONT> <a name="line.101"></a>
<FONT color="green">102</FONT> public void translate(ClassGenerator classGen, MethodGenerator methodGen) {<a name="line.102"></a>
<FONT color="green">103</FONT> final Stylesheet stylesheet = classGen.getStylesheet();<a name="line.103"></a>
<FONT color="green">104</FONT> final ConstantPoolGen cpg = classGen.getConstantPool();<a name="line.104"></a>
<FONT color="green">105</FONT> final InstructionList il = methodGen.getInstructionList();<a name="line.105"></a>
<FONT color="green">106</FONT> <a name="line.106"></a>
<FONT color="green">107</FONT> // If there are Params in the stylesheet or WithParams in this call?<a name="line.107"></a>
<FONT color="green">108</FONT> if (stylesheet.hasLocalParams() || hasContents()) {<a name="line.108"></a>
<FONT color="green">109</FONT> _calleeTemplate = getCalleeTemplate();<a name="line.109"></a>
<FONT color="green">110</FONT> <a name="line.110"></a>
<FONT color="green">111</FONT> // Build the parameter list if the called template is simple named<a name="line.111"></a>
<FONT color="green">112</FONT> if (_calleeTemplate != null) {<a name="line.112"></a>
<FONT color="green">113</FONT> buildParameterList();<a name="line.113"></a>
<FONT color="green">114</FONT> }<a name="line.114"></a>
<FONT color="green">115</FONT> // This is only needed when the called template is not<a name="line.115"></a>
<FONT color="green">116</FONT> // a simple named template.<a name="line.116"></a>
<FONT color="green">117</FONT> else {<a name="line.117"></a>
<FONT color="green">118</FONT> // Push parameter frame<a name="line.118"></a>
<FONT color="green">119</FONT> final int push = cpg.addMethodref(TRANSLET_CLASS, <a name="line.119"></a>
<FONT color="green">120</FONT> PUSH_PARAM_FRAME,<a name="line.120"></a>
<FONT color="green">121</FONT> PUSH_PARAM_FRAME_SIG);<a name="line.121"></a>
<FONT color="green">122</FONT> il.append(classGen.loadTranslet());<a name="line.122"></a>
<FONT color="green">123</FONT> il.append(new INVOKEVIRTUAL(push));<a name="line.123"></a>
<FONT color="green">124</FONT> translateContents(classGen, methodGen);<a name="line.124"></a>
<FONT color="green">125</FONT> }<a name="line.125"></a>
<FONT color="green">126</FONT> }<a name="line.126"></a>
<FONT color="green">127</FONT> <a name="line.127"></a>
<FONT color="green">128</FONT> // Generate a valid Java method name<a name="line.128"></a>
<FONT color="green">129</FONT> final String className = stylesheet.getClassName();<a name="line.129"></a>
<FONT color="green">130</FONT> String methodName = Util.escape(_name.toString());<a name="line.130"></a>
<FONT color="green">131</FONT> <a name="line.131"></a>
<FONT color="green">132</FONT> // Load standard arguments<a name="line.132"></a>
<FONT color="green">133</FONT> il.append(classGen.loadTranslet());<a name="line.133"></a>
<FONT color="green">134</FONT> il.append(methodGen.loadDOM());<a name="line.134"></a>
<FONT color="green">135</FONT> il.append(methodGen.loadIterator());<a name="line.135"></a>
<FONT color="green">136</FONT> il.append(methodGen.loadHandler());<a name="line.136"></a>
<FONT color="green">137</FONT> il.append(methodGen.loadCurrentNode());<a name="line.137"></a>
<FONT color="green">138</FONT> <a name="line.138"></a>
<FONT color="green">139</FONT> // Initialize prefix of method signature<a name="line.139"></a>
<FONT color="green">140</FONT> StringBuffer methodSig = new StringBuffer("(" + DOM_INTF_SIG <a name="line.140"></a>
<FONT color="green">141</FONT> + NODE_ITERATOR_SIG + TRANSLET_OUTPUT_SIG + NODE_SIG);<a name="line.141"></a>
<FONT color="green">142</FONT> <a name="line.142"></a>
<FONT color="green">143</FONT> // If calling a simply named template, push actual arguments<a name="line.143"></a>
<FONT color="green">144</FONT> if (_calleeTemplate != null) {<a name="line.144"></a>
<FONT color="green">145</FONT> Vector calleeParams = _calleeTemplate.getParameters();<a name="line.145"></a>
<FONT color="green">146</FONT> int numParams = _parameters.length;<a name="line.146"></a>
<FONT color="green">147</FONT> <a name="line.147"></a>
<FONT color="green">148</FONT> for (int i = 0; i &lt; numParams; i++) {<a name="line.148"></a>
<FONT color="green">149</FONT> SyntaxTreeNode node = (SyntaxTreeNode)_parameters[i];<a name="line.149"></a>
<FONT color="green">150</FONT> methodSig.append(OBJECT_SIG); // append Object to signature<a name="line.150"></a>
<FONT color="green">151</FONT> <a name="line.151"></a>
<FONT color="green">152</FONT> // Push 'null' if Param to indicate no actual parameter specified<a name="line.152"></a>
<FONT color="green">153</FONT> if (node instanceof Param) {<a name="line.153"></a>
<FONT color="green">154</FONT> il.append(ACONST_NULL);<a name="line.154"></a>
<FONT color="green">155</FONT> }<a name="line.155"></a>
<FONT color="green">156</FONT> else { // translate WithParam<a name="line.156"></a>
<FONT color="green">157</FONT> node.translate(classGen, methodGen);<a name="line.157"></a>
<FONT color="green">158</FONT> }<a name="line.158"></a>
<FONT color="green">159</FONT> }<a name="line.159"></a>
<FONT color="green">160</FONT> }<a name="line.160"></a>
<FONT color="green">161</FONT> <a name="line.161"></a>
<FONT color="green">162</FONT> // Complete signature and generate invokevirtual call<a name="line.162"></a>
<FONT color="green">163</FONT> methodSig.append(")V");<a name="line.163"></a>
<FONT color="green">164</FONT> il.append(new INVOKEVIRTUAL(cpg.addMethodref(className,<a name="line.164"></a>
<FONT color="green">165</FONT> methodName,<a name="line.165"></a>
<FONT color="green">166</FONT> methodSig.toString())));<a name="line.166"></a>
<FONT color="green">167</FONT> <a name="line.167"></a>
<FONT color="green">168</FONT> // Do not need to call Translet.popParamFrame() if we are<a name="line.168"></a>
<FONT color="green">169</FONT> // calling a simple named template.<a name="line.169"></a>
<FONT color="green">170</FONT> if (_calleeTemplate == null &amp;&amp; (stylesheet.hasLocalParams() || hasContents())) {<a name="line.170"></a>
<FONT color="green">171</FONT> // Pop parameter frame<a name="line.171"></a>
<FONT color="green">172</FONT> final int pop = cpg.addMethodref(TRANSLET_CLASS,<a name="line.172"></a>
<FONT color="green">173</FONT> POP_PARAM_FRAME,<a name="line.173"></a>
<FONT color="green">174</FONT> POP_PARAM_FRAME_SIG);<a name="line.174"></a>
<FONT color="green">175</FONT> il.append(classGen.loadTranslet());<a name="line.175"></a>
<FONT color="green">176</FONT> il.append(new INVOKEVIRTUAL(pop));<a name="line.176"></a>
<FONT color="green">177</FONT> }<a name="line.177"></a>
<FONT color="green">178</FONT> }<a name="line.178"></a>
<FONT color="green">179</FONT> <a name="line.179"></a>
<FONT color="green">180</FONT> /**<a name="line.180"></a>
<FONT color="green">181</FONT> * Return the simple named template which this CallTemplate calls.<a name="line.181"></a>
<FONT color="green">182</FONT> * Return false if there is no matched template or the matched<a name="line.182"></a>
<FONT color="green">183</FONT> * template is not a simple named template.<a name="line.183"></a>
<FONT color="green">184</FONT> */<a name="line.184"></a>
<FONT color="green">185</FONT> public Template getCalleeTemplate() {<a name="line.185"></a>
<FONT color="green">186</FONT> Template foundTemplate<a name="line.186"></a>
<FONT color="green">187</FONT> = getXSLTC().getParser().getSymbolTable().lookupTemplate(_name);<a name="line.187"></a>
<FONT color="green">188</FONT> <a name="line.188"></a>
<FONT color="green">189</FONT> return foundTemplate.isSimpleNamedTemplate() ? foundTemplate : null;<a name="line.189"></a>
<FONT color="green">190</FONT> }<a name="line.190"></a>
<FONT color="green">191</FONT> <a name="line.191"></a>
<FONT color="green">192</FONT> /**<a name="line.192"></a>
<FONT color="green">193</FONT> * Build the list of effective parameters in this CallTemplate.<a name="line.193"></a>
<FONT color="green">194</FONT> * The parameters of the called template are put into the array first.<a name="line.194"></a>
<FONT color="green">195</FONT> * Then we visit the WithParam children of this CallTemplate and replace<a name="line.195"></a>
<FONT color="green">196</FONT> * the Param with a corresponding WithParam having the same name.<a name="line.196"></a>
<FONT color="green">197</FONT> */<a name="line.197"></a>
<FONT color="green">198</FONT> private void buildParameterList() { <a name="line.198"></a>
<FONT color="green">199</FONT> // Put the parameters from the called template into the array first.<a name="line.199"></a>
<FONT color="green">200</FONT> // This is to ensure the order of the parameters.<a name="line.200"></a>
<FONT color="green">201</FONT> Vector defaultParams = _calleeTemplate.getParameters();<a name="line.201"></a>
<FONT color="green">202</FONT> int numParams = defaultParams.size();<a name="line.202"></a>
<FONT color="green">203</FONT> _parameters = new Object[numParams];<a name="line.203"></a>
<FONT color="green">204</FONT> for (int i = 0; i &lt; numParams; i++) {<a name="line.204"></a>
<FONT color="green">205</FONT> _parameters[i] = defaultParams.elementAt(i);<a name="line.205"></a>
<FONT color="green">206</FONT> }<a name="line.206"></a>
<FONT color="green">207</FONT> <a name="line.207"></a>
<FONT color="green">208</FONT> // Replace a Param with a WithParam if they have the same name.<a name="line.208"></a>
<FONT color="green">209</FONT> int count = elementCount();<a name="line.209"></a>
<FONT color="green">210</FONT> for (int i = 0; i &lt; count; i++) {<a name="line.210"></a>
<FONT color="green">211</FONT> Object node = elementAt(i);<a name="line.211"></a>
<FONT color="green">212</FONT> <a name="line.212"></a>
<FONT color="green">213</FONT> // Ignore if not WithParam<a name="line.213"></a>
<FONT color="green">214</FONT> if (node instanceof WithParam) {<a name="line.214"></a>
<FONT color="green">215</FONT> WithParam withParam = (WithParam)node;<a name="line.215"></a>
<FONT color="green">216</FONT> QName name = withParam.getName();<a name="line.216"></a>
<FONT color="green">217</FONT> <a name="line.217"></a>
<FONT color="green">218</FONT> // Search for a Param with the same name<a name="line.218"></a>
<FONT color="green">219</FONT> for (int k = 0; k &lt; numParams; k++) {<a name="line.219"></a>
<FONT color="green">220</FONT> Object object = _parameters[k];<a name="line.220"></a>
<FONT color="green">221</FONT> if (object instanceof Param <a name="line.221"></a>
<FONT color="green">222</FONT> &amp;&amp; ((Param)object).getName().equals(name)) {<a name="line.222"></a>
<FONT color="green">223</FONT> withParam.setDoParameterOptimization(true);<a name="line.223"></a>
<FONT color="green">224</FONT> _parameters[k] = withParam;<a name="line.224"></a>
<FONT color="green">225</FONT> break;<a name="line.225"></a>
<FONT color="green">226</FONT> }<a name="line.226"></a>
<FONT color="green">227</FONT> else if (object instanceof WithParam <a name="line.227"></a>
<FONT color="green">228</FONT> &amp;&amp; ((WithParam)object).getName().equals(name)) {<a name="line.228"></a>
<FONT color="green">229</FONT> withParam.setDoParameterOptimization(true);<a name="line.229"></a>
<FONT color="green">230</FONT> _parameters[k] = withParam; <a name="line.230"></a>
<FONT color="green">231</FONT> break;<a name="line.231"></a>
<FONT color="green">232</FONT> }<a name="line.232"></a>
<FONT color="green">233</FONT> } <a name="line.233"></a>
<FONT color="green">234</FONT> }<a name="line.234"></a>
<FONT color="green">235</FONT> }<a name="line.235"></a>
<FONT color="green">236</FONT> }<a name="line.236"></a>
<FONT color="green">237</FONT> }<a name="line.237"></a>
<FONT color="green">238</FONT> <a name="line.238"></a>
</PRE>
</BODY>
</HTML>