java/java-impl/src/com/intellij/codeInspection/dataFlow/instructions/Instruction.java

   1 /*
   2  * Copyright 2000-2009 JetBrains s.r.o.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /*
  18  * Created by IntelliJ IDEA.
  19  * User: max
  20  * Date: Jan 26, 2002
  21  * Time: 10:46:40 PM
  22  * To change template for new class use
  23  * Code Style | Class Templates options (Tools | IDE Options).
  24  */
  25 package com.intellij.codeInspection.dataFlow.instructions;
  26
  27 import com.intellij.codeInspection.dataFlow.DataFlowRunner;
  28 import com.intellij.codeInspection.dataFlow.DfaInstructionState;
  29 import com.intellij.codeInspection.dataFlow.DfaMemoryState;
  30 import com.intellij.codeInspection.dataFlow.InstructionVisitor;
  31 import org.jetbrains.annotations.NonNls;
  32
  33 import java.util.ArrayList;
  34
  35 public abstract class Instruction {
  36   private int myIndex;
  37   private final ArrayList<DfaMemoryState> myProcessedStates;
  38
  39   protected Instruction() {
  40     myProcessedStates = new ArrayList<DfaMemoryState>();
  41   }
  42
  43   protected final DfaInstructionState[] nextInstruction(DataFlowRunner runner, DfaMemoryState stateBefore) {
  44     return new DfaInstructionState[] {new DfaInstructionState(runner.getInstruction(getIndex() + 1), stateBefore)};
  45   }
  46
  47   public abstract DfaInstructionState[] accept(DataFlowRunner runner, DfaMemoryState stateBefore, InstructionVisitor visitor);
  48
  49   public boolean isMemoryStateProcessed(DfaMemoryState dfaMemState) {
  50     for (DfaMemoryState state : myProcessedStates) {
  51       if (dfaMemState.equals(state)) {
  52         return true;
  53       }
  54     }
  55
  56     return false;
  57   }
  58
  59   public boolean setMemoryStateProcessed(DfaMemoryState dfaMemState) {
  60     if (myProcessedStates.size() > DataFlowRunner.MAX_STATES_PER_BRANCH) return false;
  61     myProcessedStates.add(dfaMemState);
  62     return true;
  63   }
  64
  65   public void setIndex(int index) {
  66     myIndex = index;
  67   }
  68
  69   public int getIndex() {
  70     return myIndex;
  71   }
  72
  73   @NonNls
  74   public String toString() {
  75     return super.toString();
  76   }
  77 }