// DtracePartitioner.java
package daikon.tools;

import java.io.BufferedReader;
import java.io.Closeable;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.StringTokenizer;
import org.checkerframework.checker.calledmethods.qual.EnsuresCalledMethods;
import org.checkerframework.checker.lock.qual.GuardSatisfied;
import org.checkerframework.checker.mustcall.qual.CreatesMustCallFor;
import org.checkerframework.checker.mustcall.qual.Owning;
import org.plumelib.util.FilesPlume;
import org.plumelib.util.Partitioner;

/**
 * This class partitions Daikon trace files so that invocations of the same program point are
 * grouped together for use with random selection.
 */
public class DtracePartitioner implements Closeable, Partitioner<String, String>, Iterator<String> {

  /** The system-specific line separator. */
  private static final String lineSep = System.lineSeparator();

  /** reading from the file as a lazy iterator */
  private @Owning BufferedReader br;

  /** the name of the Daikon trace file */
  private String filename;

  /**
   * @param filename the Daikon trace file to be partitioned
   */
  public DtracePartitioner(String filename) {
    try {
      this.filename = filename;
      // System.out.printf("trying with file %s%n", filename);
      br = FilesPlume.newBufferedFileReader(filename);

    } catch (IOException e) {
      e.printStackTrace();
      throw new Error(e);
    }
  }

  /** Releases resources held by this. */
  @EnsuresCalledMethods(value = "br", methods = "close")
  @Override
  public void close(@GuardSatisfied DtracePartitioner this) throws IOException {
    br.close();
  }

  @Override
  public boolean hasNext(@GuardSatisfied DtracePartitioner this) {
    try {
      return br.ready();
    } catch (IOException e) {
      e.printStackTrace();
      return false;
    }
  }

  /** Not implemented, because this class does not modify the underlying trace file. */
  @Override
  public void remove(@GuardSatisfied DtracePartitioner this) {
    throw new UnsupportedOperationException("Can not remove");
  }

  @Override
  public String next(@GuardSatisfied DtracePartitioner this) {
    try {
      String ret = grabNextInvocation();
      if (ret.indexOf("EXIT") != -1) {
        if (!br.ready()) {
          return "";
        }
        return next();
      } else {
        return ret;
      }
    } catch (IOException e) {
      throw new UncheckedIOException(e);
    }
  }

  /**
   * Grabs the next invocation in the Daikon trace file by interpreting a blank line as the
   * invocation delimter. Note that multiple blank lines between invocations might occur, so the
   * callee is responsible for checking if the returned String is a blank line.
   */
  private String grabNextInvocation(@GuardSatisfied DtracePartitioner this) throws IOException {
    StringBuilder sb = new StringBuilder();
    while (br.ready()) {
      String line = br.readLine();
      assert line != null; // because br.ready() = true
      line = line.trim();
      if (line.equals("")) {
        break;
      }
      sb.append(line).append(lineSep);
    }
    return sb.toString();
  }

  /** Returns the program point name given by the input invocation. */
  @Override
  public String assignToBucket(String invocation) {
    if (invocation.indexOf(lineSep) == -1) {
      // was: return null;
      throw new Error("No lineSep: " + invocation);
    }
    return invocation.substring(0, invocation.indexOf(lineSep));
  }

  /**
   * Same as {@link #patchValues(List, boolean)} with second arg=false.
   *
   * @param enters a list of program point names
   * @return an ArrayList containing all of the elements of 'enters'. The original order is NOT
   *     guaranteed.
   */
  @CreatesMustCallFor("this")
  public List<String> patchValues(List<String> enters) {
    return patchValues(enters, false);
  }

  /**
   * Finds the exits that correspond to Enters.
   *
   * <p>Modifies: none
   *
   * @param enters a list of program point names
   * @param includeUnreturnedEnters ensures that any ENTER ppt invocations will definitely have a
   *     corresponding EXIT ppt invocation following them
   * @return an ArrayList containing all of the elements of 'enters'. The original order is NOT
   *     guaranteed.
   */
  @CreatesMustCallFor("this")
  public List<String> patchValues(List<String> enters, boolean includeUnreturnedEnters) {
    try {
      System.out.println("Entering patchValues");
      // Keep a list of enters that are so far unmatched
      Set<String> unreturned = new HashSet<>(enters);

      // Build a hashmap of values to watch
      HashMap<Object /*String or Integer*/, String> nonceMap = new HashMap<>();
      for (String enterStr : enters) {
        // it could be an OBJECT or CLASS invocation ppt, ignore those
        // by putting them in the HashMap to themselves, they'll
        // be reaped up later
        if (enterStr.indexOf("ENTER") == -1) {
          nonceMap.put(enterStr, enterStr);
          // no way for OBJECT or CLASS to be unresolved
          unreturned.remove(enterStr);
          continue;
        }

        // get the nonce of this invocation and use it
        // as the key in the nonceMap, which maps
        // nonces --> ENTER half of invocation
        int theNonce = calcNonce(enterStr);
        nonceMap.put(theNonce, enterStr);
      }

      br.close();
      // look for EXIT half of invocations and augment
      // the values of nonceMap so that the map eventually
      // maps nonces --> full invocations with ENTER / EXIT
      br = FilesPlume.newBufferedFileReader(filename);
      while (br.ready()) {
        String nextInvo = grabNextInvocation();
        if (nextInvo.indexOf("EXIT") == -1) {
          continue;
        }
        int invoNonce = calcNonce(nextInvo);
        Integer key = invoNonce;
        String enterInvo = nonceMap.get(key);
        if (enterInvo != null) {
          nonceMap.put(key, enterInvo + lineSep + nextInvo);
          unreturned.remove(enterInvo);
        }
      }

      // Return a list of all the invocations where matching ENTER and
      // EXIT points were found as well as the OBJECT and CLASS
      // invocations.
      ArrayList<String> al = new ArrayList<>();
      for (String s : nonceMap.values()) {
        al.add(s);
      }
      // add in the invocations that were never resolved because no
      // matching EXIT invocation exists.
      if (!includeUnreturnedEnters) {
        al.removeAll(unreturned);
      }
      return al;

    } catch (IOException e) {
      throw new UncheckedIOException(e);
    }
  }

  private int calcNonce(String invocation) {
    StringTokenizer st = new StringTokenizer(invocation, lineSep);
    while (st.hasMoreTokens()) {
      String line = st.nextToken();
      if (line.equals("this_invocation_nonce")) {
        return Integer.parseInt(st.nextToken());
      }
    }
    throw new RuntimeException("This invocation didn't contain a nonce: " + invocation);
  }
}
