//
// Copyright (C) 2013 United States Government as represented by the
// Administrator of the National Aeronautics and Space Administration
// (NASA).  All Rights Reserved.
//
// This software is distributed under the NASA Open Source Agreement
// (NOSA), version 1.3.  The NOSA has been approved by the Open Source
// Initiative.  See the file NOSA-1.3-JPF at the top of the distribution
// directory tree for the complete NOSA document.
//
// THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY OF ANY
// KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT
// LIMITED TO, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL CONFORM TO
// SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR
// A PARTICULAR PURPOSE, OR FREEDOM FROM INFRINGEMENT, ANY WARRANTY THAT
// THE SUBJECT SOFTWARE WILL BE ERROR FREE, OR ANY WARRANTY THAT
// DOCUMENTATION, IF PROVIDED, WILL CONFORM TO THE SUBJECT SOFTWARE.
//

package gov.nasa.jpf.vm.choice;

import java.util.Arrays;
import java.util.Comparator;

import gov.nasa.jpf.JPFException;
import gov.nasa.jpf.vm.ThreadChoiceGenerator;
import gov.nasa.jpf.vm.ThreadInfo;

/**
 * a ThreadChoiceFromSet that reschedules the specified thread with exceptions
 */
public class ExceptionThreadChoiceFromSet extends ThreadChoiceFromSet {

  protected ThreadInfo exceptionThread;
  protected String[] exceptions;
  
  public ExceptionThreadChoiceFromSet (String id, ThreadInfo[] runnables, ThreadInfo exceptionThread, String[] exceptionClsNames){
    super(id);
    
    this.exceptionThread = exceptionThread;
    
    values = new ThreadInfo[runnables.length + exceptionClsNames.length];
    exceptions = new String[values.length];
    
    System.arraycopy(runnables, 0, values, 0, runnables.length);
    for (int i=0, j=runnables.length; i<exceptionClsNames.length; i++, j++){
      values[j] = exceptionThread;
      exceptions[j] = exceptionClsNames[i];
    }
    
    isSchedulingPoint = true; // not much use otherwise
  }
  
  public String getExceptionForCurrentChoice(){
    if ((count >= 0) && (count < values.length)) {
      return exceptions[count];
    } else {
      return null;
    }
  }
  
  @Override
  public ThreadChoiceGenerator reorder (Comparator<ThreadInfo> comparator){
    ThreadInfo[] newValues = values.clone();
    Arrays.sort(newValues, comparator);
    
    // we don't really reorder occurrences of the exceptionThread, but since the Comparator 
    // only knows ThreadInfos that shouldn't matter
    String[] newExceptions = new String[exceptions.length];
    for (int i=0, j=-1; i<newValues.length; i++){
      if (newValues[i] == exceptionThread){
        for (j++; exceptions[j] == null; j++);
        newExceptions[i] = exceptions[j];
      }
    }

    try {
      ExceptionThreadChoiceFromSet reorderedCG = (ExceptionThreadChoiceFromSet)clone();
      reorderedCG.values = newValues;
      reorderedCG.exceptions = newExceptions;
      reorderedCG.count = -1;
      
      return reorderedCG;
      
    } catch (CloneNotSupportedException cnsx){
      throw new JPFException("clone of ExceptionalThreadChoice failed");
    }
  }
  
  @Override
  public ThreadChoiceFromSet randomize () {
    for (int i = values.length - 1; i > 0; i--) {
      int j = random.nextInt(i + 1);
      ThreadInfo tmp = values[i];
      values[i] = values[j];
      values[j] = tmp;
      
      String tmpX = exceptions[i];
      exceptions[i] = exceptions[j];
      exceptions[j] = tmpX;
    }
    return this;
  }
}