src/main/gov/nasa/jpf/util/StateExtensionListener.java

   1 /*
   2  * Copyright (C) 2014, United States Government, as represented by the
   3  * Administrator of the National Aeronautics and Space Administration.
   4  * All rights reserved.
   5  *
   6  * The Java Pathfinder core (jpf-core) platform is licensed under the
   7  * Apache License, Version 2.0 (the "License"); you may not use this file except
   8  * in compliance with the License. You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0.
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 package gov.nasa.jpf.util;
  19
  20 import gov.nasa.jpf.ListenerAdapter;
  21 import gov.nasa.jpf.search.Search;
  22 import gov.nasa.jpf.vm.ChoiceGenerator;
  23 import gov.nasa.jpf.vm.SystemState;
  24
  25 /**
  26  * generic listener that keeps track of state extensions, using
  27  * state ids as index values into a dynamic array of T objects
  28  *
  29  * the purpose of this utility class is to make state extensions
  30  * backtrackable, so that clients don't have to care about this
  31  */
  32 public class StateExtensionListener <T> extends ListenerAdapter {
  33   StateExtensionClient<T> client;
  34   DynamicObjectArray<T> states;
  35
  36   public StateExtensionListener (StateExtensionClient<T> cli) {
  37     client = cli;
  38     states = new DynamicObjectArray<T>();
  39
  40     // set initial state
  41     T se = client.getStateExtension();
  42     states.set(0, se);
  43   }
  44
  45   @Override
  46   public void stateAdvanced (Search search) {
  47     int idx = search.getStateId()+1;
  48
  49     T se = client.getStateExtension();
  50     states.set(idx, se);
  51   }
  52
  53   @Override
  54   public void stateBacktracked (Search search) {
  55     int idx = search.getStateId()+1;
  56
  57     T se = states.get(idx);
  58     client.restore(se);
  59   }
  60
  61   @Override
  62   public void stateRestored (Search search) {
  63     int idx = search.getStateId()+1;
  64
  65     T se = states.get(idx);
  66     client.restore(se);
  67
  68     SystemState ss = search.getVM().getSystemState();
  69     ChoiceGenerator<?> cgNext = ss.getNextChoiceGenerator();
  70     cgNext.reset();
  71   }
  72 }