blob: d35dd3fe001133be8547194ad89eca731160dc1c [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: ForEach.java 468650 2006-10-28 07:03:30Z minchau $<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.Enumeration;<a name="line.24"></a>
<FONT color="green">025</FONT> import java.util.Vector;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.bcel.generic.BranchHandle;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.bcel.generic.ConstantPoolGen;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.bcel.generic.GOTO;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.bcel.generic.IFGT;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.apache.bcel.generic.InstructionHandle;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.apache.bcel.generic.InstructionList;<a name="line.32"></a>
<FONT color="green">033</FONT> import org.apache.xalan.xsltc.compiler.util.ClassGenerator;<a name="line.33"></a>
<FONT color="green">034</FONT> import org.apache.xalan.xsltc.compiler.util.ErrorMsg;<a name="line.34"></a>
<FONT color="green">035</FONT> import org.apache.xalan.xsltc.compiler.util.MethodGenerator;<a name="line.35"></a>
<FONT color="green">036</FONT> import org.apache.xalan.xsltc.compiler.util.NodeSetType;<a name="line.36"></a>
<FONT color="green">037</FONT> import org.apache.xalan.xsltc.compiler.util.NodeType;<a name="line.37"></a>
<FONT color="green">038</FONT> import org.apache.xalan.xsltc.compiler.util.ReferenceType;<a name="line.38"></a>
<FONT color="green">039</FONT> import org.apache.xalan.xsltc.compiler.util.ResultTreeType;<a name="line.39"></a>
<FONT color="green">040</FONT> import org.apache.xalan.xsltc.compiler.util.Type;<a name="line.40"></a>
<FONT color="green">041</FONT> import org.apache.xalan.xsltc.compiler.util.TypeCheckError;<a name="line.41"></a>
<FONT color="green">042</FONT> import org.apache.xalan.xsltc.compiler.util.Util;<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> * @author Jacek Ambroziak<a name="line.45"></a>
<FONT color="green">046</FONT> * @author Santiago Pericas-Geertsen<a name="line.46"></a>
<FONT color="green">047</FONT> * @author Morten Jorgensen<a name="line.47"></a>
<FONT color="green">048</FONT> */<a name="line.48"></a>
<FONT color="green">049</FONT> final class ForEach extends Instruction {<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> private Expression _select;<a name="line.51"></a>
<FONT color="green">052</FONT> private Type _type;<a name="line.52"></a>
<FONT color="green">053</FONT> <a name="line.53"></a>
<FONT color="green">054</FONT> public void display(int indent) {<a name="line.54"></a>
<FONT color="green">055</FONT> indent(indent);<a name="line.55"></a>
<FONT color="green">056</FONT> Util.println("ForEach");<a name="line.56"></a>
<FONT color="green">057</FONT> indent(indent + IndentIncrement);<a name="line.57"></a>
<FONT color="green">058</FONT> Util.println("select " + _select.toString());<a name="line.58"></a>
<FONT color="green">059</FONT> displayContents(indent + IndentIncrement);<a name="line.59"></a>
<FONT color="green">060</FONT> }<a name="line.60"></a>
<FONT color="green">061</FONT> <a name="line.61"></a>
<FONT color="green">062</FONT> public void parseContents(Parser parser) {<a name="line.62"></a>
<FONT color="green">063</FONT> _select = parser.parseExpression(this, "select", null);<a name="line.63"></a>
<FONT color="green">064</FONT> <a name="line.64"></a>
<FONT color="green">065</FONT> parseChildren(parser);<a name="line.65"></a>
<FONT color="green">066</FONT> <a name="line.66"></a>
<FONT color="green">067</FONT> // make sure required attribute(s) have been set<a name="line.67"></a>
<FONT color="green">068</FONT> if (_select.isDummy()) {<a name="line.68"></a>
<FONT color="green">069</FONT> reportError(this, parser, ErrorMsg.REQUIRED_ATTR_ERR, "select");<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> <a name="line.72"></a>
<FONT color="green">073</FONT> public Type typeCheck(SymbolTable stable) throws TypeCheckError {<a name="line.73"></a>
<FONT color="green">074</FONT> _type = _select.typeCheck(stable);<a name="line.74"></a>
<FONT color="green">075</FONT> <a name="line.75"></a>
<FONT color="green">076</FONT> if (_type instanceof ReferenceType || _type instanceof NodeType) {<a name="line.76"></a>
<FONT color="green">077</FONT> _select = new CastExpr(_select, Type.NodeSet);<a name="line.77"></a>
<FONT color="green">078</FONT> typeCheckContents(stable);<a name="line.78"></a>
<FONT color="green">079</FONT> return Type.Void;<a name="line.79"></a>
<FONT color="green">080</FONT> }<a name="line.80"></a>
<FONT color="green">081</FONT> if (_type instanceof NodeSetType||_type instanceof ResultTreeType) {<a name="line.81"></a>
<FONT color="green">082</FONT> typeCheckContents(stable);<a name="line.82"></a>
<FONT color="green">083</FONT> return Type.Void;<a name="line.83"></a>
<FONT color="green">084</FONT> }<a name="line.84"></a>
<FONT color="green">085</FONT> throw new TypeCheckError(this);<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> public void translate(ClassGenerator classGen, MethodGenerator methodGen) {<a name="line.88"></a>
<FONT color="green">089</FONT> final ConstantPoolGen cpg = classGen.getConstantPool();<a name="line.89"></a>
<FONT color="green">090</FONT> final InstructionList il = methodGen.getInstructionList();<a name="line.90"></a>
<FONT color="green">091</FONT> <a name="line.91"></a>
<FONT color="green">092</FONT> // Save current node and current iterator on the stack<a name="line.92"></a>
<FONT color="green">093</FONT> il.append(methodGen.loadCurrentNode());<a name="line.93"></a>
<FONT color="green">094</FONT> il.append(methodGen.loadIterator());<a name="line.94"></a>
<FONT color="green">095</FONT> <a name="line.95"></a>
<FONT color="green">096</FONT> // Collect sort objects associated with this instruction<a name="line.96"></a>
<FONT color="green">097</FONT> final Vector sortObjects = new Vector();<a name="line.97"></a>
<FONT color="green">098</FONT> Enumeration children = elements();<a name="line.98"></a>
<FONT color="green">099</FONT> while (children.hasMoreElements()) {<a name="line.99"></a>
<FONT color="green">100</FONT> final Object child = children.nextElement();<a name="line.100"></a>
<FONT color="green">101</FONT> if (child instanceof Sort) {<a name="line.101"></a>
<FONT color="green">102</FONT> sortObjects.addElement(child);<a name="line.102"></a>
<FONT color="green">103</FONT> }<a name="line.103"></a>
<FONT color="green">104</FONT> }<a name="line.104"></a>
<FONT color="green">105</FONT> <a name="line.105"></a>
<FONT color="green">106</FONT> if ((_type != null) &amp;&amp; (_type instanceof ResultTreeType)) {<a name="line.106"></a>
<FONT color="green">107</FONT> // Store existing DOM on stack - must be restored when loop is done<a name="line.107"></a>
<FONT color="green">108</FONT> il.append(methodGen.loadDOM());<a name="line.108"></a>
<FONT color="green">109</FONT> <a name="line.109"></a>
<FONT color="green">110</FONT> // &lt;xsl:sort&gt; cannot be applied to a result tree - issue warning<a name="line.110"></a>
<FONT color="green">111</FONT> if (sortObjects.size() &gt; 0) {<a name="line.111"></a>
<FONT color="green">112</FONT> ErrorMsg msg = new ErrorMsg(ErrorMsg.RESULT_TREE_SORT_ERR,this);<a name="line.112"></a>
<FONT color="green">113</FONT> getParser().reportError(WARNING, msg);<a name="line.113"></a>
<FONT color="green">114</FONT> }<a name="line.114"></a>
<FONT color="green">115</FONT> <a name="line.115"></a>
<FONT color="green">116</FONT> // Put the result tree on the stack (DOM)<a name="line.116"></a>
<FONT color="green">117</FONT> _select.translate(classGen, methodGen);<a name="line.117"></a>
<FONT color="green">118</FONT> // Get an iterator for the whole DOM - excluding the root node<a name="line.118"></a>
<FONT color="green">119</FONT> _type.translateTo(classGen, methodGen, Type.NodeSet);<a name="line.119"></a>
<FONT color="green">120</FONT> // Store the result tree as the default DOM<a name="line.120"></a>
<FONT color="green">121</FONT> il.append(SWAP);<a name="line.121"></a>
<FONT color="green">122</FONT> il.append(methodGen.storeDOM());<a name="line.122"></a>
<FONT color="green">123</FONT> }<a name="line.123"></a>
<FONT color="green">124</FONT> else {<a name="line.124"></a>
<FONT color="green">125</FONT> // Compile node iterator<a name="line.125"></a>
<FONT color="green">126</FONT> if (sortObjects.size() &gt; 0) {<a name="line.126"></a>
<FONT color="green">127</FONT> Sort.translateSortIterator(classGen, methodGen,<a name="line.127"></a>
<FONT color="green">128</FONT> _select, sortObjects);<a name="line.128"></a>
<FONT color="green">129</FONT> }<a name="line.129"></a>
<FONT color="green">130</FONT> else {<a name="line.130"></a>
<FONT color="green">131</FONT> _select.translate(classGen, methodGen);<a name="line.131"></a>
<FONT color="green">132</FONT> }<a name="line.132"></a>
<FONT color="green">133</FONT> <a name="line.133"></a>
<FONT color="green">134</FONT> if (_type instanceof ReferenceType == false) {<a name="line.134"></a>
<FONT color="green">135</FONT> il.append(methodGen.loadContextNode());<a name="line.135"></a>
<FONT color="green">136</FONT> il.append(methodGen.setStartNode());<a name="line.136"></a>
<FONT color="green">137</FONT> }<a name="line.137"></a>
<FONT color="green">138</FONT> }<a name="line.138"></a>
<FONT color="green">139</FONT> <a name="line.139"></a>
<FONT color="green">140</FONT> <a name="line.140"></a>
<FONT color="green">141</FONT> // Overwrite current iterator<a name="line.141"></a>
<FONT color="green">142</FONT> il.append(methodGen.storeIterator());<a name="line.142"></a>
<FONT color="green">143</FONT> <a name="line.143"></a>
<FONT color="green">144</FONT> // Give local variables (if any) default values before starting loop<a name="line.144"></a>
<FONT color="green">145</FONT> initializeVariables(classGen, methodGen);<a name="line.145"></a>
<FONT color="green">146</FONT> <a name="line.146"></a>
<FONT color="green">147</FONT> final BranchHandle nextNode = il.append(new GOTO(null));<a name="line.147"></a>
<FONT color="green">148</FONT> final InstructionHandle loop = il.append(NOP);<a name="line.148"></a>
<FONT color="green">149</FONT> <a name="line.149"></a>
<FONT color="green">150</FONT> translateContents(classGen, methodGen);<a name="line.150"></a>
<FONT color="green">151</FONT> <a name="line.151"></a>
<FONT color="green">152</FONT> nextNode.setTarget(il.append(methodGen.loadIterator()));<a name="line.152"></a>
<FONT color="green">153</FONT> il.append(methodGen.nextNode());<a name="line.153"></a>
<FONT color="green">154</FONT> il.append(DUP);<a name="line.154"></a>
<FONT color="green">155</FONT> il.append(methodGen.storeCurrentNode());<a name="line.155"></a>
<FONT color="green">156</FONT> il.append(new IFGT(loop));<a name="line.156"></a>
<FONT color="green">157</FONT> <a name="line.157"></a>
<FONT color="green">158</FONT> // Restore current DOM (if result tree was used instead for this loop)<a name="line.158"></a>
<FONT color="green">159</FONT> if ((_type != null) &amp;&amp; (_type instanceof ResultTreeType)) {<a name="line.159"></a>
<FONT color="green">160</FONT> il.append(methodGen.storeDOM()); <a name="line.160"></a>
<FONT color="green">161</FONT> }<a name="line.161"></a>
<FONT color="green">162</FONT> <a name="line.162"></a>
<FONT color="green">163</FONT> // Restore current node and current iterator from the stack<a name="line.163"></a>
<FONT color="green">164</FONT> il.append(methodGen.storeIterator());<a name="line.164"></a>
<FONT color="green">165</FONT> il.append(methodGen.storeCurrentNode());<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> /**<a name="line.168"></a>
<FONT color="green">169</FONT> * The code that is generated by nested for-each loops can appear to some<a name="line.169"></a>
<FONT color="green">170</FONT> * JVMs as if it is accessing un-initialized variables. We must add some<a name="line.170"></a>
<FONT color="green">171</FONT> * code that pushes the default variable value on the stack and pops it<a name="line.171"></a>
<FONT color="green">172</FONT> * into the variable slot. This is done by the Variable.initialize()<a name="line.172"></a>
<FONT color="green">173</FONT> * method. The code that we compile for this loop looks like this:<a name="line.173"></a>
<FONT color="green">174</FONT> *<a name="line.174"></a>
<FONT color="green">175</FONT> * initialize iterator<a name="line.175"></a>
<FONT color="green">176</FONT> * initialize variables &lt;-- HERE!!!<a name="line.176"></a>
<FONT color="green">177</FONT> * goto Iterate<a name="line.177"></a>
<FONT color="green">178</FONT> * Loop: :<a name="line.178"></a>
<FONT color="green">179</FONT> * : (code for &lt;xsl:for-each&gt; contents)<a name="line.179"></a>
<FONT color="green">180</FONT> * :<a name="line.180"></a>
<FONT color="green">181</FONT> * Iterate: node = iterator.next();<a name="line.181"></a>
<FONT color="green">182</FONT> * if (node != END) goto Loop<a name="line.182"></a>
<FONT color="green">183</FONT> */<a name="line.183"></a>
<FONT color="green">184</FONT> public void initializeVariables(ClassGenerator classGen,<a name="line.184"></a>
<FONT color="green">185</FONT> MethodGenerator methodGen) {<a name="line.185"></a>
<FONT color="green">186</FONT> final int n = elementCount();<a name="line.186"></a>
<FONT color="green">187</FONT> for (int i = 0; i &lt; n; i++) {<a name="line.187"></a>
<FONT color="green">188</FONT> final Object child = getContents().elementAt(i);<a name="line.188"></a>
<FONT color="green">189</FONT> if (child instanceof Variable) {<a name="line.189"></a>
<FONT color="green">190</FONT> Variable var = (Variable)child;<a name="line.190"></a>
<FONT color="green">191</FONT> var.initialize(classGen, methodGen);<a name="line.191"></a>
<FONT color="green">192</FONT> }<a name="line.192"></a>
<FONT color="green">193</FONT> }<a name="line.193"></a>
<FONT color="green">194</FONT> }<a name="line.194"></a>
<FONT color="green">195</FONT> <a name="line.195"></a>
<FONT color="green">196</FONT> }<a name="line.196"></a>
</PRE>
</BODY>
</HTML>