001    
002    /*
003     * THIS FILE IS MACHINE_GENERATED. DO NOT EDIT.
004     * See InstructionFormats.template, InstructionFormatList.dat,
005     * OperatorList.dat, etc.
006     */
007    
008    package org.jikesrvm.compilers.opt.ir;
009    
010    import org.jikesrvm.Configuration;
011    import org.jikesrvm.compilers.opt.ir.operand.ia32.IA32ConditionOperand; //NOPMD
012    import org.jikesrvm.compilers.opt.ir.operand.*;
013    
014    /**
015     * The GetStatic InstructionFormat class.
016     *
017     * The header comment for {@link Instruction} contains
018     * an explanation of the role of InstructionFormats in the
019     * opt compiler's IR.
020     */
021    @SuppressWarnings("unused")  // Machine generated code is never 100% clean
022    public final class GetStatic extends InstructionFormat {
023      /**
024       * InstructionFormat identification method for GetStatic.
025       * @param i an instruction
026       * @return <code>true</code> if the InstructionFormat of the argument
027       *         instruction is GetStatic or <code>false</code>
028       *         if it is not.
029       */
030      public static boolean conforms(Instruction i) {
031        return conforms(i.operator);
032      }
033      /**
034       * InstructionFormat identification method for GetStatic.
035       * @param o an instruction
036       * @return <code>true</code> if the InstructionFormat of the argument
037       *         operator is GetStatic or <code>false</code>
038       *         if it is not.
039       */
040      public static boolean conforms(Operator o) {
041        return o.format == GetStatic_format;
042      }
043    
044      /**
045       * Get the operand called Result from the
046       * argument instruction. Note that the returned operand
047       * will still point to its containing instruction.
048       * @param i the instruction to fetch the operand from
049       * @return the operand called Result
050       */
051      public static RegisterOperand getResult(Instruction i) {
052        if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GetStatic");
053        return (RegisterOperand) i.getOperand(0);
054      }
055      /**
056       * Get the operand called Result from the argument
057       * instruction clearing its instruction pointer. The returned
058       * operand will not point to any containing instruction.
059       * @param i the instruction to fetch the operand from
060       * @return the operand called Result
061       */
062      public static RegisterOperand getClearResult(Instruction i) {
063        if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GetStatic");
064        return (RegisterOperand) i.getClearOperand(0);
065      }
066      /**
067       * Set the operand called Result in the argument
068       * instruction to the argument operand. The operand will
069       * now point to the argument instruction as its containing
070       * instruction.
071       * @param i the instruction in which to store the operand
072       * @param Result the operand to store
073       */
074      public static void setResult(Instruction i, RegisterOperand Result) {
075        if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GetStatic");
076        i.putOperand(0, Result);
077      }
078      /**
079       * Return the index of the operand called Result
080       * in the argument instruction.
081       * @param i the instruction to access.
082       * @return the index of the operand called Result
083       *         in the argument instruction
084       */
085      public static int indexOfResult(Instruction i) {
086        if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GetStatic");
087        return 0;
088      }
089      /**
090       * Does the argument instruction have a non-null
091       * operand named Result?
092       * @param i the instruction to access.
093       * @return <code>true</code> if the instruction has an non-null
094       *         operand named Result or <code>false</code>
095       *         if it does not.
096       */
097      public static boolean hasResult(Instruction i) {
098        if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GetStatic");
099        return i.getOperand(0) != null;
100      }
101    
102      /**
103       * Get the operand called Offset from the
104       * argument instruction. Note that the returned operand
105       * will still point to its containing instruction.
106       * @param i the instruction to fetch the operand from
107       * @return the operand called Offset
108       */
109      public static Operand getOffset(Instruction i) {
110        if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GetStatic");
111        return (Operand) i.getOperand(1);
112      }
113      /**
114       * Get the operand called Offset from the argument
115       * instruction clearing its instruction pointer. The returned
116       * operand will not point to any containing instruction.
117       * @param i the instruction to fetch the operand from
118       * @return the operand called Offset
119       */
120      public static Operand getClearOffset(Instruction i) {
121        if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GetStatic");
122        return (Operand) i.getClearOperand(1);
123      }
124      /**
125       * Set the operand called Offset in the argument
126       * instruction to the argument operand. The operand will
127       * now point to the argument instruction as its containing
128       * instruction.
129       * @param i the instruction in which to store the operand
130       * @param Offset the operand to store
131       */
132      public static void setOffset(Instruction i, Operand Offset) {
133        if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GetStatic");
134        i.putOperand(1, Offset);
135      }
136      /**
137       * Return the index of the operand called Offset
138       * in the argument instruction.
139       * @param i the instruction to access.
140       * @return the index of the operand called Offset
141       *         in the argument instruction
142       */
143      public static int indexOfOffset(Instruction i) {
144        if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GetStatic");
145        return 1;
146      }
147      /**
148       * Does the argument instruction have a non-null
149       * operand named Offset?
150       * @param i the instruction to access.
151       * @return <code>true</code> if the instruction has an non-null
152       *         operand named Offset or <code>false</code>
153       *         if it does not.
154       */
155      public static boolean hasOffset(Instruction i) {
156        if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GetStatic");
157        return i.getOperand(1) != null;
158      }
159    
160      /**
161       * Get the operand called Location from the
162       * argument instruction. Note that the returned operand
163       * will still point to its containing instruction.
164       * @param i the instruction to fetch the operand from
165       * @return the operand called Location
166       */
167      public static LocationOperand getLocation(Instruction i) {
168        if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GetStatic");
169        return (LocationOperand) i.getOperand(2);
170      }
171      /**
172       * Get the operand called Location from the argument
173       * instruction clearing its instruction pointer. The returned
174       * operand will not point to any containing instruction.
175       * @param i the instruction to fetch the operand from
176       * @return the operand called Location
177       */
178      public static LocationOperand getClearLocation(Instruction i) {
179        if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GetStatic");
180        return (LocationOperand) i.getClearOperand(2);
181      }
182      /**
183       * Set the operand called Location in the argument
184       * instruction to the argument operand. The operand will
185       * now point to the argument instruction as its containing
186       * instruction.
187       * @param i the instruction in which to store the operand
188       * @param Location the operand to store
189       */
190      public static void setLocation(Instruction i, LocationOperand Location) {
191        if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GetStatic");
192        i.putOperand(2, Location);
193      }
194      /**
195       * Return the index of the operand called Location
196       * in the argument instruction.
197       * @param i the instruction to access.
198       * @return the index of the operand called Location
199       *         in the argument instruction
200       */
201      public static int indexOfLocation(Instruction i) {
202        if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GetStatic");
203        return 2;
204      }
205      /**
206       * Does the argument instruction have a non-null
207       * operand named Location?
208       * @param i the instruction to access.
209       * @return <code>true</code> if the instruction has an non-null
210       *         operand named Location or <code>false</code>
211       *         if it does not.
212       */
213      public static boolean hasLocation(Instruction i) {
214        if (Configuration.ExtremeAssertions && !conforms(i)) fail(i, "GetStatic");
215        return i.getOperand(2) != null;
216      }
217    
218    
219      /**
220       * Create an instruction of the GetStatic instruction format.
221       * @param o the instruction's operator
222       * @param Result the instruction's Result operand
223       * @param Offset the instruction's Offset operand
224       * @param Location the instruction's Location operand
225       * @return the newly created GetStatic instruction
226       */
227      public static Instruction create(Operator o
228                       , RegisterOperand Result
229                       , Operand Offset
230                       , LocationOperand Location
231                    )
232      {
233        if (Configuration.ExtremeAssertions && !conforms(o)) fail(o, "GetStatic");
234        Instruction i = new Instruction(o, 5);
235        i.putOperand(0, Result);
236        i.putOperand(1, Offset);
237        i.putOperand(2, Location);
238        return i;
239      }
240    
241      /**
242       * Mutate the argument instruction into an instruction of the
243       * GetStatic instruction format having the specified
244       * operator and operands.
245       * @param i the instruction to mutate
246       * @param o the instruction's operator
247       * @param Result the instruction's Result operand
248       * @param Offset the instruction's Offset operand
249       * @param Location the instruction's Location operand
250       * @return the mutated instruction
251       */
252      public static Instruction mutate(Instruction i, Operator o
253                       , RegisterOperand Result
254                       , Operand Offset
255                       , LocationOperand Location
256                    )
257      {
258        if (Configuration.ExtremeAssertions && !conforms(o)) fail(o, "GetStatic");
259        i.operator = o;
260        i.putOperand(0, Result);
261        i.putOperand(1, Offset);
262        i.putOperand(2, Location);
263        return i;
264      }
265    }
266