/usr/share/doc/libserp-java/api/src-html/serp/bytecode/Instruction.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 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 | <!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 java.io.*;<a name="line.3"></a>
<span class="sourceLineNo">004</span>import java.util.*;<a name="line.4"></a>
<span class="sourceLineNo">005</span><a name="line.5"></a>
<span class="sourceLineNo">006</span>import serp.bytecode.lowlevel.*;<a name="line.6"></a>
<span class="sourceLineNo">007</span>import serp.bytecode.visitor.*;<a name="line.7"></a>
<span class="sourceLineNo">008</span><a name="line.8"></a>
<span class="sourceLineNo">009</span>/**<a name="line.9"></a>
<span class="sourceLineNo">010</span> * An opcode in a method of a class.<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * @author Abe White<a name="line.12"></a>
<span class="sourceLineNo">013</span> */<a name="line.13"></a>
<span class="sourceLineNo">014</span>public class Instruction extends CodeEntry implements BCEntity, VisitAcceptor {<a name="line.14"></a>
<span class="sourceLineNo">015</span> private Code _owner = null;<a name="line.15"></a>
<span class="sourceLineNo">016</span> private int _opcode = Constants.NOP;<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span> Instruction(Code owner) {<a name="line.18"></a>
<span class="sourceLineNo">019</span> _owner = owner;<a name="line.19"></a>
<span class="sourceLineNo">020</span> }<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span> Instruction(Code owner, int opcode) {<a name="line.22"></a>
<span class="sourceLineNo">023</span> _owner = owner;<a name="line.23"></a>
<span class="sourceLineNo">024</span> _opcode = opcode;<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> /**<a name="line.27"></a>
<span class="sourceLineNo">028</span> * Return the code block that owns this instruction.<a name="line.28"></a>
<span class="sourceLineNo">029</span> */<a name="line.29"></a>
<span class="sourceLineNo">030</span> public Code getCode() {<a name="line.30"></a>
<span class="sourceLineNo">031</span> return _owner;<a name="line.31"></a>
<span class="sourceLineNo">032</span> }<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span> /**<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Return the name of this instruction.<a name="line.35"></a>
<span class="sourceLineNo">036</span> */<a name="line.36"></a>
<span class="sourceLineNo">037</span> public String getName() {<a name="line.37"></a>
<span class="sourceLineNo">038</span> return Constants.OPCODE_NAMES[_opcode];<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> /**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * Return the opcode this instruction represents.<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span> public int getOpcode() {<a name="line.44"></a>
<span class="sourceLineNo">045</span> return _opcode;<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> /**<a name="line.48"></a>
<span class="sourceLineNo">049</span> * Set the opcode this instruction represents. For internal use only.<a name="line.49"></a>
<span class="sourceLineNo">050</span> *<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @return this instruction, for method chaining<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span> Instruction setOpcode(int opcode) {<a name="line.53"></a>
<span class="sourceLineNo">054</span> _opcode = opcode;<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 index in the method code byte block at which this opcode<a name="line.59"></a>
<span class="sourceLineNo">060</span> * starts. Note that this information may be out of date if the code<a name="line.60"></a>
<span class="sourceLineNo">061</span> * block has been modified since last read/written.<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span> public int getByteIndex() {<a name="line.63"></a>
<span class="sourceLineNo">064</span> if (_owner != null)<a name="line.64"></a>
<span class="sourceLineNo">065</span> return _owner.getByteIndex(this);<a name="line.65"></a>
<span class="sourceLineNo">066</span> return 0;<a name="line.66"></a>
<span class="sourceLineNo">067</span> }<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> /**<a name="line.69"></a>
<span class="sourceLineNo">070</span> * Notification that a change has been made to this instruction that<a name="line.70"></a>
<span class="sourceLineNo">071</span> * alters the structure of the code block, invalidating byte indexes.<a name="line.71"></a>
<span class="sourceLineNo">072</span> */<a name="line.72"></a>
<span class="sourceLineNo">073</span> void invalidateByteIndexes() {<a name="line.73"></a>
<span class="sourceLineNo">074</span> if (_owner != null)<a name="line.74"></a>
<span class="sourceLineNo">075</span> _owner.invalidateByteIndexes();<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<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> * Return the line number of this instruction, or null if none. This<a name="line.79"></a>
<span class="sourceLineNo">080</span> * method is subject to the validity constraints of {@link #getByteIndex}.<a name="line.80"></a>
<span class="sourceLineNo">081</span> *<a name="line.81"></a>
<span class="sourceLineNo">082</span> * @see LineNumberTable#getLineNumber(Instruction)<a name="line.82"></a>
<span class="sourceLineNo">083</span> */<a name="line.83"></a>
<span class="sourceLineNo">084</span> public LineNumber getLineNumber() {<a name="line.84"></a>
<span class="sourceLineNo">085</span> LineNumberTable table = _owner.getLineNumberTable(false);<a name="line.85"></a>
<span class="sourceLineNo">086</span> if (table == null)<a name="line.86"></a>
<span class="sourceLineNo">087</span> return null;<a name="line.87"></a>
<span class="sourceLineNo">088</span> return table.getLineNumber(this);<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<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> * Return the length in bytes of this opcode, including all arguments.<a name="line.92"></a>
<span class="sourceLineNo">093</span> * For many opcodes this method relies on an up-to-date byte index.<a name="line.93"></a>
<span class="sourceLineNo">094</span> */<a name="line.94"></a>
<span class="sourceLineNo">095</span> int getLength() {<a name="line.95"></a>
<span class="sourceLineNo">096</span> return 1;<a name="line.96"></a>
<span class="sourceLineNo">097</span> }<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> /**<a name="line.99"></a>
<span class="sourceLineNo">100</span> * Return the logical number of stack positions changed by this<a name="line.100"></a>
<span class="sourceLineNo">101</span> * instruction. In other words, ignore weirdness with longs and doubles<a name="line.101"></a>
<span class="sourceLineNo">102</span> * taking two stack positions.<a name="line.102"></a>
<span class="sourceLineNo">103</span> */<a name="line.103"></a>
<span class="sourceLineNo">104</span> public int getLogicalStackChange() {<a name="line.104"></a>
<span class="sourceLineNo">105</span> return getStackChange();<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> * Return the number of stack positions this instruction pushes<a name="line.109"></a>
<span class="sourceLineNo">110</span> * or pops during its execution.<a name="line.110"></a>
<span class="sourceLineNo">111</span> *<a name="line.111"></a>
<span class="sourceLineNo">112</span> * @return 0 if the stack is not affected by this instruction, a<a name="line.112"></a>
<span class="sourceLineNo">113</span> * positive number if it pushes onto the stack, and a negative<a name="line.113"></a>
<span class="sourceLineNo">114</span> * number if it pops from the stack<a name="line.114"></a>
<span class="sourceLineNo">115</span> */<a name="line.115"></a>
<span class="sourceLineNo">116</span> public int getStackChange() {<a name="line.116"></a>
<span class="sourceLineNo">117</span> return 0;<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> /**<a name="line.120"></a>
<span class="sourceLineNo">121</span> * Instructions are equal if their opcodes are the same. Subclasses<a name="line.121"></a>
<span class="sourceLineNo">122</span> * should override this method to perform a template comparison:<a name="line.122"></a>
<span class="sourceLineNo">123</span> * instructions should compare equal to other instructions of the same<a name="line.123"></a>
<span class="sourceLineNo">124</span> * type where the data is either the same or the data is unset.<a name="line.124"></a>
<span class="sourceLineNo">125</span> */<a name="line.125"></a>
<span class="sourceLineNo">126</span> public boolean equalsInstruction(Instruction other) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> if (other == this)<a name="line.127"></a>
<span class="sourceLineNo">128</span> return true;<a name="line.128"></a>
<span class="sourceLineNo">129</span> return other.getOpcode() == getOpcode();<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> public Project getProject() {<a name="line.132"></a>
<span class="sourceLineNo">133</span> return _owner.getProject();<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> public ConstantPool getPool() {<a name="line.136"></a>
<span class="sourceLineNo">137</span> return _owner.getPool();<a name="line.137"></a>
<span class="sourceLineNo">138</span> }<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span> public ClassLoader getClassLoader() {<a name="line.140"></a>
<span class="sourceLineNo">141</span> return _owner.getClassLoader();<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span> public boolean isValid() {<a name="line.144"></a>
<span class="sourceLineNo">145</span> return _owner != null;<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> public void acceptVisit(BCVisitor visit) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span> void invalidate() {<a name="line.151"></a>
<span class="sourceLineNo">152</span> _owner = null;<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> /**<a name="line.155"></a>
<span class="sourceLineNo">156</span> * Copy the given instruction data.<a name="line.156"></a>
<span class="sourceLineNo">157</span> */<a name="line.157"></a>
<span class="sourceLineNo">158</span> void read(Instruction orig) {<a name="line.158"></a>
<span class="sourceLineNo">159</span> }<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span> /**<a name="line.161"></a>
<span class="sourceLineNo">162</span> * Read the arguments for this opcode from the given stream.<a name="line.162"></a>
<span class="sourceLineNo">163</span> * This method should be overridden by opcodes that take arguments.<a name="line.163"></a>
<span class="sourceLineNo">164</span> */<a name="line.164"></a>
<span class="sourceLineNo">165</span> void read(DataInput in) throws IOException {<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span> /**<a name="line.168"></a>
<span class="sourceLineNo">169</span> * Write the arguments for this opcode to the given stream.<a name="line.169"></a>
<span class="sourceLineNo">170</span> * This method should be overridden by opcodes that take arguments.<a name="line.170"></a>
<span class="sourceLineNo">171</span> */<a name="line.171"></a>
<span class="sourceLineNo">172</span> void write(DataOutput out) throws IOException {<a name="line.172"></a>
<span class="sourceLineNo">173</span> }<a name="line.173"></a>
<span class="sourceLineNo">174</span>}<a name="line.174"></a>
</pre>
</div>
</body>
</html>
|