/usr/share/doc/libserp-java/api/src-html/serp/bytecode/LocalVariableInstruction.html is in libserp-java-doc 1.15.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>package serp.bytecode;<a name="line.1"></a>
<span class="sourceLineNo">002</span><a name="line.2"></a>
<span class="sourceLineNo">003</span>import serp.bytecode.visitor.*;<a name="line.3"></a>
<span class="sourceLineNo">004</span><a name="line.4"></a>
<span class="sourceLineNo">005</span>/**<a name="line.5"></a>
<span class="sourceLineNo">006</span> * An instruction that has an argument of an index into the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * local variable table of the current frame. This includes most of the<a name="line.7"></a>
<span class="sourceLineNo">008</span> * <code>load</code> and <code>store</code> instructions.<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * <p>The local variable table size is fixed by the <code>maxLocals</code><a name="line.10"></a>
<span class="sourceLineNo">011</span> * property of the code block. Long and double types take up 2 local variable<a name="line.11"></a>
<span class="sourceLineNo">012</span> * indexes.</p><a name="line.12"></a>
<span class="sourceLineNo">013</span> *<a name="line.13"></a>
<span class="sourceLineNo">014</span> * <p>Parameter values to methods are loaded into the local variable table<a name="line.14"></a>
<span class="sourceLineNo">015</span> * prior to the execution of the first instruction. The 0 index of the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * table is set to the instance of the class the method is being invoked on.</p><a name="line.16"></a>
<span class="sourceLineNo">017</span> *<a name="line.17"></a>
<span class="sourceLineNo">018</span> * @author Abe White<a name="line.18"></a>
<span class="sourceLineNo">019</span> */<a name="line.19"></a>
<span class="sourceLineNo">020</span>public abstract class LocalVariableInstruction extends TypedInstruction {<a name="line.20"></a>
<span class="sourceLineNo">021</span> private int _index = -1;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span> LocalVariableInstruction(Code owner) {<a name="line.23"></a>
<span class="sourceLineNo">024</span> super(owner);<a name="line.24"></a>
<span class="sourceLineNo">025</span> }<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span> LocalVariableInstruction(Code owner, int opcode) {<a name="line.27"></a>
<span class="sourceLineNo">028</span> super(owner, opcode);<a name="line.28"></a>
<span class="sourceLineNo">029</span> calculateLocal();<a name="line.29"></a>
<span class="sourceLineNo">030</span> }<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span> public String getTypeName() {<a name="line.32"></a>
<span class="sourceLineNo">033</span> return null;<a name="line.33"></a>
<span class="sourceLineNo">034</span> }<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span> public TypedInstruction setType(String type) {<a name="line.36"></a>
<span class="sourceLineNo">037</span> throw new UnsupportedOperationException();<a name="line.37"></a>
<span class="sourceLineNo">038</span> }<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span> /**<a name="line.40"></a>
<span class="sourceLineNo">041</span> * Return the index of the local variable that this instruction operates on.<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span> public int getLocal() {<a name="line.43"></a>
<span class="sourceLineNo">044</span> return _index;<a name="line.44"></a>
<span class="sourceLineNo">045</span> }<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Set the index of the local variable that this instruction operates on.<a name="line.48"></a>
<span class="sourceLineNo">049</span> *<a name="line.49"></a>
<span class="sourceLineNo">050</span> * @return this instruction, for method chaining<a name="line.50"></a>
<span class="sourceLineNo">051</span> */<a name="line.51"></a>
<span class="sourceLineNo">052</span> public LocalVariableInstruction setLocal(int index) {<a name="line.52"></a>
<span class="sourceLineNo">053</span> _index = index;<a name="line.53"></a>
<span class="sourceLineNo">054</span> calculateOpcode();<a name="line.54"></a>
<span class="sourceLineNo">055</span> return this;<a name="line.55"></a>
<span class="sourceLineNo">056</span> }<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> /**<a name="line.58"></a>
<span class="sourceLineNo">059</span> * Return the parameter that this instruction operates on, or -1 if none.<a name="line.59"></a>
<span class="sourceLineNo">060</span> */<a name="line.60"></a>
<span class="sourceLineNo">061</span> public int getParam() {<a name="line.61"></a>
<span class="sourceLineNo">062</span> return getCode().getParamsIndex(getLocal());<a name="line.62"></a>
<span class="sourceLineNo">063</span> }<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> /**<a name="line.65"></a>
<span class="sourceLineNo">066</span> * Set the method parameter that this instruction operates on. This<a name="line.66"></a>
<span class="sourceLineNo">067</span> * will set both the local index and the type of the instruction based<a name="line.67"></a>
<span class="sourceLineNo">068</span> * on the current method parameters.<a name="line.68"></a>
<span class="sourceLineNo">069</span> */<a name="line.69"></a>
<span class="sourceLineNo">070</span> public LocalVariableInstruction setParam(int param) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> int local = getCode().getLocalsIndex(param);<a name="line.71"></a>
<span class="sourceLineNo">072</span> if (local != -1) {<a name="line.72"></a>
<span class="sourceLineNo">073</span> BCMethod method = getCode().getMethod();<a name="line.73"></a>
<span class="sourceLineNo">074</span> setType(method.getParamNames()[param]);<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span> return setLocal(local);<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> /**<a name="line.79"></a>
<span class="sourceLineNo">080</span> * Return the local variable object this instruction<a name="line.80"></a>
<span class="sourceLineNo">081</span> * operates on, or null if none.<a name="line.81"></a>
<span class="sourceLineNo">082</span> *<a name="line.82"></a>
<span class="sourceLineNo">083</span> * @see LocalVariableTable#getLocalVariable(int)<a name="line.83"></a>
<span class="sourceLineNo">084</span> */<a name="line.84"></a>
<span class="sourceLineNo">085</span> public LocalVariable getLocalVariable() {<a name="line.85"></a>
<span class="sourceLineNo">086</span> LocalVariableTable table = getCode().getLocalVariableTable(false);<a name="line.86"></a>
<span class="sourceLineNo">087</span> if (table == null)<a name="line.87"></a>
<span class="sourceLineNo">088</span> return null;<a name="line.88"></a>
<span class="sourceLineNo">089</span> return table.getLocalVariable(getLocal());<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> /**<a name="line.92"></a>
<span class="sourceLineNo">093</span> * Set the local variable object this instruction<a name="line.93"></a>
<span class="sourceLineNo">094</span> * operates on. This method will set both the type and local index<a name="line.94"></a>
<span class="sourceLineNo">095</span> * of this instruction from the given local variable.<a name="line.95"></a>
<span class="sourceLineNo">096</span> *<a name="line.96"></a>
<span class="sourceLineNo">097</span> * @return this instruction, for method chaining<a name="line.97"></a>
<span class="sourceLineNo">098</span> */<a name="line.98"></a>
<span class="sourceLineNo">099</span> public LocalVariableInstruction setLocalVariable(LocalVariable local) {<a name="line.99"></a>
<span class="sourceLineNo">100</span> if (local == null)<a name="line.100"></a>
<span class="sourceLineNo">101</span> return setLocal(-1);<a name="line.101"></a>
<span class="sourceLineNo">102</span> String type = local.getTypeName();<a name="line.102"></a>
<span class="sourceLineNo">103</span> if (type != null)<a name="line.103"></a>
<span class="sourceLineNo">104</span> setType(type);<a name="line.104"></a>
<span class="sourceLineNo">105</span> return setLocal(local.getLocal());<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> /**<a name="line.108"></a>
<span class="sourceLineNo">109</span> * Two local variable instructions are equal if the local index they<a name="line.109"></a>
<span class="sourceLineNo">110</span> * reference is equal or if either index is 0/unset.<a name="line.110"></a>
<span class="sourceLineNo">111</span> */<a name="line.111"></a>
<span class="sourceLineNo">112</span> public boolean equalsInstruction(Instruction other) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> if (this == other)<a name="line.113"></a>
<span class="sourceLineNo">114</span> return true;<a name="line.114"></a>
<span class="sourceLineNo">115</span> if (!getClass().equals(other.getClass()))<a name="line.115"></a>
<span class="sourceLineNo">116</span> return false;<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> LocalVariableInstruction ins = (LocalVariableInstruction) other;<a name="line.118"></a>
<span class="sourceLineNo">119</span> int index = getLocal();<a name="line.119"></a>
<span class="sourceLineNo">120</span> int insIndex = ins.getLocal();<a name="line.120"></a>
<span class="sourceLineNo">121</span> return index == -1 || insIndex == -1 || index == insIndex;<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> void read(Instruction orig) {<a name="line.124"></a>
<span class="sourceLineNo">125</span> super.read(orig);<a name="line.125"></a>
<span class="sourceLineNo">126</span> setLocal(((LocalVariableInstruction) orig).getLocal());<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> /**<a name="line.129"></a>
<span class="sourceLineNo">130</span> * Subclasses with variable opcodes can use this method to be<a name="line.130"></a>
<span class="sourceLineNo">131</span> * notified that information possibly affecting the opcode has been changed.<a name="line.131"></a>
<span class="sourceLineNo">132</span> */<a name="line.132"></a>
<span class="sourceLineNo">133</span> void calculateOpcode() {<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> /**<a name="line.136"></a>
<span class="sourceLineNo">137</span> * Subclasses can use this method to calculate<a name="line.137"></a>
<span class="sourceLineNo">138</span> * the locals index based on their opcode.<a name="line.138"></a>
<span class="sourceLineNo">139</span> */<a name="line.139"></a>
<span class="sourceLineNo">140</span> void calculateLocal() {<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span>}<a name="line.142"></a>
</pre>
</div>
</body>
</html>
|