blob: 435d205c9a75b4d93b60962ae32d0e6bbea942f7 [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: KeyCall.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.bcel.generic.PUSH;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.xalan.xsltc.compiler.util.ClassGenerator;<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.StringType;<a name="line.32"></a>
<FONT color="green">033</FONT> import org.apache.xalan.xsltc.compiler.util.Type;<a name="line.33"></a>
<FONT color="green">034</FONT> import org.apache.xalan.xsltc.compiler.util.TypeCheckError;<a name="line.34"></a>
<FONT color="green">035</FONT> <a name="line.35"></a>
<FONT color="green">036</FONT> /**<a name="line.36"></a>
<FONT color="green">037</FONT> * @author Morten Jorgensen<a name="line.37"></a>
<FONT color="green">038</FONT> * @author Santiago Pericas-Geertsen<a name="line.38"></a>
<FONT color="green">039</FONT> */<a name="line.39"></a>
<FONT color="green">040</FONT> final class KeyCall extends FunctionCall {<a name="line.40"></a>
<FONT color="green">041</FONT> <a name="line.41"></a>
<FONT color="green">042</FONT> /**<a name="line.42"></a>
<FONT color="green">043</FONT> * The name of the key.<a name="line.43"></a>
<FONT color="green">044</FONT> */<a name="line.44"></a>
<FONT color="green">045</FONT> private Expression _name;<a name="line.45"></a>
<FONT color="green">046</FONT> <a name="line.46"></a>
<FONT color="green">047</FONT> /**<a name="line.47"></a>
<FONT color="green">048</FONT> * The value to look up in the key/index.<a name="line.48"></a>
<FONT color="green">049</FONT> */<a name="line.49"></a>
<FONT color="green">050</FONT> private Expression _value;<a name="line.50"></a>
<FONT color="green">051</FONT> <a name="line.51"></a>
<FONT color="green">052</FONT> /**<a name="line.52"></a>
<FONT color="green">053</FONT> * The value's data type.<a name="line.53"></a>
<FONT color="green">054</FONT> */<a name="line.54"></a>
<FONT color="green">055</FONT> private Type _valueType; // The value's data type<a name="line.55"></a>
<FONT color="green">056</FONT> <a name="line.56"></a>
<FONT color="green">057</FONT> /**<a name="line.57"></a>
<FONT color="green">058</FONT> * Expanded qname when name is literal.<a name="line.58"></a>
<FONT color="green">059</FONT> */<a name="line.59"></a>
<FONT color="green">060</FONT> private QName _resolvedQName = null;<a name="line.60"></a>
<FONT color="green">061</FONT> <a name="line.61"></a>
<FONT color="green">062</FONT> /**<a name="line.62"></a>
<FONT color="green">063</FONT> * Get the parameters passed to function:<a name="line.63"></a>
<FONT color="green">064</FONT> * key(String name, String value)<a name="line.64"></a>
<FONT color="green">065</FONT> * key(String name, NodeSet value)<a name="line.65"></a>
<FONT color="green">066</FONT> * The 'arguments' vector should contain two parameters for key() calls,<a name="line.66"></a>
<FONT color="green">067</FONT> * one holding the key name and one holding the value(s) to look up. The<a name="line.67"></a>
<FONT color="green">068</FONT> * vector has only one parameter for id() calls (the key name is always<a name="line.68"></a>
<FONT color="green">069</FONT> * "##id" for id() calls).<a name="line.69"></a>
<FONT color="green">070</FONT> *<a name="line.70"></a>
<FONT color="green">071</FONT> * @param fname The function name (should be 'key' or 'id')<a name="line.71"></a>
<FONT color="green">072</FONT> * @param arguments A vector containing the arguments the the function<a name="line.72"></a>
<FONT color="green">073</FONT> */<a name="line.73"></a>
<FONT color="green">074</FONT> public KeyCall(QName fname, Vector arguments) {<a name="line.74"></a>
<FONT color="green">075</FONT> super(fname, arguments);<a name="line.75"></a>
<FONT color="green">076</FONT> switch(argumentCount()) {<a name="line.76"></a>
<FONT color="green">077</FONT> case 1:<a name="line.77"></a>
<FONT color="green">078</FONT> _name = null;<a name="line.78"></a>
<FONT color="green">079</FONT> _value = argument(0);<a name="line.79"></a>
<FONT color="green">080</FONT> break;<a name="line.80"></a>
<FONT color="green">081</FONT> case 2:<a name="line.81"></a>
<FONT color="green">082</FONT> _name = argument(0);<a name="line.82"></a>
<FONT color="green">083</FONT> _value = argument(1);<a name="line.83"></a>
<FONT color="green">084</FONT> break;<a name="line.84"></a>
<FONT color="green">085</FONT> default:<a name="line.85"></a>
<FONT color="green">086</FONT> _name = _value = null;<a name="line.86"></a>
<FONT color="green">087</FONT> break;<a name="line.87"></a>
<FONT color="green">088</FONT> }<a name="line.88"></a>
<FONT color="green">089</FONT> }<a name="line.89"></a>
<FONT color="green">090</FONT> <a name="line.90"></a>
<FONT color="green">091</FONT> /**<a name="line.91"></a>
<FONT color="green">092</FONT> * If this call to key() is in a top-level element like another variable<a name="line.92"></a>
<FONT color="green">093</FONT> * or param, add a dependency between that top-level element and the <a name="line.93"></a>
<FONT color="green">094</FONT> * referenced key. For example,<a name="line.94"></a>
<FONT color="green">095</FONT> *<a name="line.95"></a>
<FONT color="green">096</FONT> * &lt;xsl:key name="x" .../&gt;<a name="line.96"></a>
<FONT color="green">097</FONT> * &lt;xsl:variable name="y" select="key('x', 1)"/&gt;<a name="line.97"></a>
<FONT color="green">098</FONT> *<a name="line.98"></a>
<FONT color="green">099</FONT> * and assuming this class represents "key('x', 1)", add a reference <a name="line.99"></a>
<FONT color="green">100</FONT> * between variable y and key x. Note that if 'x' is unknown statically<a name="line.100"></a>
<FONT color="green">101</FONT> * in key('x', 1), there's nothing we can do at this point.<a name="line.101"></a>
<FONT color="green">102</FONT> */<a name="line.102"></a>
<FONT color="green">103</FONT> public void addParentDependency() {<a name="line.103"></a>
<FONT color="green">104</FONT> // If name unknown statically, there's nothing we can do<a name="line.104"></a>
<FONT color="green">105</FONT> if (_resolvedQName == null) return;<a name="line.105"></a>
<FONT color="green">106</FONT> <a name="line.106"></a>
<FONT color="green">107</FONT> SyntaxTreeNode node = this;<a name="line.107"></a>
<FONT color="green">108</FONT> while (node != null &amp;&amp; node instanceof TopLevelElement == false) {<a name="line.108"></a>
<FONT color="green">109</FONT> node = node.getParent();<a name="line.109"></a>
<FONT color="green">110</FONT> }<a name="line.110"></a>
<FONT color="green">111</FONT> <a name="line.111"></a>
<FONT color="green">112</FONT> TopLevelElement parent = (TopLevelElement) node; <a name="line.112"></a>
<FONT color="green">113</FONT> if (parent != null) {<a name="line.113"></a>
<FONT color="green">114</FONT> parent.addDependency(getSymbolTable().getKey(_resolvedQName));<a name="line.114"></a>
<FONT color="green">115</FONT> } <a name="line.115"></a>
<FONT color="green">116</FONT> }<a name="line.116"></a>
<FONT color="green">117</FONT> <a name="line.117"></a>
<FONT color="green">118</FONT> /**<a name="line.118"></a>
<FONT color="green">119</FONT> * Type check the parameters for the id() or key() function.<a name="line.119"></a>
<FONT color="green">120</FONT> * The index name (for key() call only) must be a string or convertable<a name="line.120"></a>
<FONT color="green">121</FONT> * to a string, and the lookup-value must be a string or a node-set.<a name="line.121"></a>
<FONT color="green">122</FONT> * @param stable The parser's symbol table<a name="line.122"></a>
<FONT color="green">123</FONT> * @throws TypeCheckError When the parameters have illegal type<a name="line.123"></a>
<FONT color="green">124</FONT> */<a name="line.124"></a>
<FONT color="green">125</FONT> public Type typeCheck(SymbolTable stable) throws TypeCheckError {<a name="line.125"></a>
<FONT color="green">126</FONT> final Type returnType = super.typeCheck(stable);<a name="line.126"></a>
<FONT color="green">127</FONT> <a name="line.127"></a>
<FONT color="green">128</FONT> // Run type check on the key name (first argument) - must be a string,<a name="line.128"></a>
<FONT color="green">129</FONT> // and if it is not it must be converted to one using string() rules.<a name="line.129"></a>
<FONT color="green">130</FONT> if (_name != null) {<a name="line.130"></a>
<FONT color="green">131</FONT> final Type nameType = _name.typeCheck(stable); <a name="line.131"></a>
<FONT color="green">132</FONT> <a name="line.132"></a>
<FONT color="green">133</FONT> if (_name instanceof LiteralExpr) {<a name="line.133"></a>
<FONT color="green">134</FONT> final LiteralExpr literal = (LiteralExpr) _name;<a name="line.134"></a>
<FONT color="green">135</FONT> _resolvedQName = <a name="line.135"></a>
<FONT color="green">136</FONT> getParser().getQNameIgnoreDefaultNs(literal.getValue());<a name="line.136"></a>
<FONT color="green">137</FONT> }<a name="line.137"></a>
<FONT color="green">138</FONT> else if (nameType instanceof StringType == false) {<a name="line.138"></a>
<FONT color="green">139</FONT> _name = new CastExpr(_name, Type.String);<a name="line.139"></a>
<FONT color="green">140</FONT> }<a name="line.140"></a>
<FONT color="green">141</FONT> }<a name="line.141"></a>
<FONT color="green">142</FONT> <a name="line.142"></a>
<FONT color="green">143</FONT> // Run type check on the value for this key. This value can be of<a name="line.143"></a>
<FONT color="green">144</FONT> // any data type, so this should never cause any type-check errors.<a name="line.144"></a>
<FONT color="green">145</FONT> // If the value is a reference, then we have to defer the decision<a name="line.145"></a>
<FONT color="green">146</FONT> // of how to process it until run-time.<a name="line.146"></a>
<FONT color="green">147</FONT> // If the value is known not to be a node-set, then it should be<a name="line.147"></a>
<FONT color="green">148</FONT> // converted to a string before the lookup is done. If the value is <a name="line.148"></a>
<FONT color="green">149</FONT> // known to be a node-set then this process (convert to string, then<a name="line.149"></a>
<FONT color="green">150</FONT> // do lookup) should be applied to every node in the set, and the<a name="line.150"></a>
<FONT color="green">151</FONT> // result from all lookups should be added to the resulting node-set.<a name="line.151"></a>
<FONT color="green">152</FONT> _valueType = _value.typeCheck(stable);<a name="line.152"></a>
<FONT color="green">153</FONT> <a name="line.153"></a>
<FONT color="green">154</FONT> if (_valueType != Type.NodeSet<a name="line.154"></a>
<FONT color="green">155</FONT> &amp;&amp; _valueType != Type.Reference<a name="line.155"></a>
<FONT color="green">156</FONT> &amp;&amp; _valueType != Type.String) {<a name="line.156"></a>
<FONT color="green">157</FONT> _value = new CastExpr(_value, Type.String);<a name="line.157"></a>
<FONT color="green">158</FONT> _valueType = _value.typeCheck(stable);<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> // If in a top-level element, create dependency to the referenced key<a name="line.161"></a>
<FONT color="green">162</FONT> addParentDependency();<a name="line.162"></a>
<FONT color="green">163</FONT> <a name="line.163"></a>
<FONT color="green">164</FONT> return returnType;<a name="line.164"></a>
<FONT color="green">165</FONT> }<a name="line.165"></a>
<FONT color="green">166</FONT> <a name="line.166"></a>
<FONT color="green">167</FONT> /**<a name="line.167"></a>
<FONT color="green">168</FONT> * This method is called when the constructor is compiled in<a name="line.168"></a>
<FONT color="green">169</FONT> * Stylesheet.compileConstructor() and not as the syntax tree is traversed.<a name="line.169"></a>
<FONT color="green">170</FONT> * &lt;p&gt;This method will generate byte code that produces an iterator<a name="line.170"></a>
<FONT color="green">171</FONT> * for the nodes in the node set for the key or id function call.<a name="line.171"></a>
<FONT color="green">172</FONT> * @param classGen The Java class generator<a name="line.172"></a>
<FONT color="green">173</FONT> * @param methodGen The method generator<a name="line.173"></a>
<FONT color="green">174</FONT> */<a name="line.174"></a>
<FONT color="green">175</FONT> public void translate(ClassGenerator classGen,<a name="line.175"></a>
<FONT color="green">176</FONT> MethodGenerator methodGen) {<a name="line.176"></a>
<FONT color="green">177</FONT> final ConstantPoolGen cpg = classGen.getConstantPool();<a name="line.177"></a>
<FONT color="green">178</FONT> final InstructionList il = methodGen.getInstructionList();<a name="line.178"></a>
<FONT color="green">179</FONT> <a name="line.179"></a>
<FONT color="green">180</FONT> // Returns the KeyIndex object of a given name<a name="line.180"></a>
<FONT color="green">181</FONT> final int getKeyIndex = cpg.addMethodref(TRANSLET_CLASS,<a name="line.181"></a>
<FONT color="green">182</FONT> "getKeyIndex",<a name="line.182"></a>
<FONT color="green">183</FONT> "(Ljava/lang/String;)"+<a name="line.183"></a>
<FONT color="green">184</FONT> KEY_INDEX_SIG);<a name="line.184"></a>
<FONT color="green">185</FONT> <a name="line.185"></a>
<FONT color="green">186</FONT> // KeyIndex.setDom(Dom) =&gt; void<a name="line.186"></a>
<FONT color="green">187</FONT> final int keyDom = cpg.addMethodref(KEY_INDEX_CLASS,<a name="line.187"></a>
<FONT color="green">188</FONT> "setDom",<a name="line.188"></a>
<FONT color="green">189</FONT> "("+DOM_INTF_SIG+")V");<a name="line.189"></a>
<FONT color="green">190</FONT> <a name="line.190"></a>
<FONT color="green">191</FONT> // Initialises a KeyIndex to return nodes with specific values<a name="line.191"></a>
<FONT color="green">192</FONT> final int getKeyIterator =<a name="line.192"></a>
<FONT color="green">193</FONT> cpg.addMethodref(KEY_INDEX_CLASS,<a name="line.193"></a>
<FONT color="green">194</FONT> "getKeyIndexIterator",<a name="line.194"></a>
<FONT color="green">195</FONT> "(" + _valueType.toSignature() + "Z)"<a name="line.195"></a>
<FONT color="green">196</FONT> + KEY_INDEX_ITERATOR_SIG);<a name="line.196"></a>
<FONT color="green">197</FONT> <a name="line.197"></a>
<FONT color="green">198</FONT> // Initialise the index specified in the first parameter of key()<a name="line.198"></a>
<FONT color="green">199</FONT> il.append(classGen.loadTranslet());<a name="line.199"></a>
<FONT color="green">200</FONT> if (_name == null) {<a name="line.200"></a>
<FONT color="green">201</FONT> il.append(new PUSH(cpg,"##id"));<a name="line.201"></a>
<FONT color="green">202</FONT> } else if (_resolvedQName != null) {<a name="line.202"></a>
<FONT color="green">203</FONT> il.append(new PUSH(cpg, _resolvedQName.toString()));<a name="line.203"></a>
<FONT color="green">204</FONT> } else {<a name="line.204"></a>
<FONT color="green">205</FONT> _name.translate(classGen, methodGen);<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> // Generate following byte code:<a name="line.208"></a>
<FONT color="green">209</FONT> //<a name="line.209"></a>
<FONT color="green">210</FONT> // KeyIndex ki = translet.getKeyIndex(_name)<a name="line.210"></a>
<FONT color="green">211</FONT> // ki.setDom(translet.dom);<a name="line.211"></a>
<FONT color="green">212</FONT> // ki.getKeyIndexIterator(_value, true) - for key()<a name="line.212"></a>
<FONT color="green">213</FONT> // OR<a name="line.213"></a>
<FONT color="green">214</FONT> // ki.getKeyIndexIterator(_value, false) - for id()<a name="line.214"></a>
<FONT color="green">215</FONT> il.append(new INVOKEVIRTUAL(getKeyIndex));<a name="line.215"></a>
<FONT color="green">216</FONT> il.append(DUP);<a name="line.216"></a>
<FONT color="green">217</FONT> il.append(methodGen.loadDOM());<a name="line.217"></a>
<FONT color="green">218</FONT> il.append(new INVOKEVIRTUAL(keyDom));<a name="line.218"></a>
<FONT color="green">219</FONT> <a name="line.219"></a>
<FONT color="green">220</FONT> _value.translate(classGen, methodGen);<a name="line.220"></a>
<FONT color="green">221</FONT> il.append((_name != null) ? ICONST_1: ICONST_0);<a name="line.221"></a>
<FONT color="green">222</FONT> il.append(new INVOKEVIRTUAL(getKeyIterator));<a name="line.222"></a>
<FONT color="green">223</FONT> }<a name="line.223"></a>
<FONT color="green">224</FONT> }<a name="line.224"></a>
</PRE>
</BODY>
</HTML>