FinallyInstruction.java

/*
 * Copyright 2003-2011 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package jetbrains.mps.lang.dataFlow.framework.instructions;

import jetbrains.mps.lang.dataFlow.framework.ProgramState;
import jetbrains.mps.lang.dataFlow.framework.Program.TryFinallyInfo;

import java.util.List;
import java.util.ArrayList;

public class FinallyInstruction extends Instruction {
  protected TryFinallyInfo myInfo;
  protected final List<RetInstruction> myReturns = new ArrayList<RetInstruction>();
  protected final List<TryFinallyInfo> myChildTryFinallies = new ArrayList<TryFinallyInfo>();

  public FinallyInstruction() {
  }

  public FinallyInstruction(String ruleNodeReference) {
    super(ruleNodeReference);
  }

  @Override
  public String commandPresentation() {
    return "finally";
  }

  @Override
  public void buildCaches() {
    super.buildCaches();
    for (TryFinallyInfo info : getProgram().getBlockInfos()) {
      if (info.getFinally() == this) {
        myInfo = info;
        break;
      }
    }

    int start = myInfo.getTry().getIndex();
    int end = myInfo.getFinally().getIndex();
    for (Instruction i : getProgram().getInstructions().subList(start + 1, end)) {
      if (i instanceof RetInstruction &&
        i.getEnclosingBlock() == myInfo &&
        i.isBefore(this)) {
        myReturns.add((RetInstruction) i);
      }
    }

    for (TryFinallyInfo info : getProgram().getBlockInfos()) {
      if (info.getParent() == myInfo) {
        myChildTryFinallies.add(info);
      }
    }
  }

  @Override
  public List<ProgramState> pred(ProgramState s) {
    if (s.isReturnMode()) {
      List<ProgramState> result = new ArrayList<ProgramState>();
      for (RetInstruction ret : myReturns) {
        result.add(new ProgramState(ret, false));
        result.add(new ProgramState(ret, true));
      }
      for (TryFinallyInfo childInfo : myChildTryFinallies) {
        if (childInfo.getEndTry().isBefore(this)) {
          result.add(new ProgramState(childInfo.getEndTry(), true));
        }
      }
      result.addAll(super.pred(s));
      return result;
    } else {
      return super.pred(s);
    }
  }
}