org.jmol.thread.TimeoutThread Maven / Gradle / Ivy

Go to download
/* $RCSfile$
 * $Author$
 * $Date$
 * $Revision$
 *
 * Copyright (C) 2011  The Jmol Development Team
 *
 * Contact: [email protected]
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 *  02110-1301, USA.
 */

package org.jmol.thread;

import java.util.Map;

import javajs.util.SB;

import org.jmol.viewer.Viewer;

public class TimeoutThread extends JmolThread {
  public String script;
  private int status;
  private boolean triggered = true;
  
  /**
   * @param vwr 
   * @param name 
   * @param ms 
   * @param script 
   * @j2sIgnoreSuperConstructor
   * 
   */
  public TimeoutThread(Viewer vwr, String name, int ms, String script) {
    setViewer(vwr, name);
    this.name = name; // no appended info
    set(ms, script);
  }
  
  private void set(int ms, String script) {
    sleepTime = ms;
    if (script != null)
      this.script = script; 
  }

  @Override
  public String toString() {
    return "timeout name=" + name + " executions=" + status + " mSec=" + sleepTime 
    + " secRemaining=" + (targetTime - System.currentTimeMillis())/1000f + " script=" + script;      
  }
  
  @Override
  protected void run1(int mode) throws InterruptedException {
    while (true) {
      //System.out.println("timeoutthread run1 " + name + " " + mode + " " + System.currentTimeMillis() + " " + targetTime);
      switch (mode) {
      case INIT:
        if (!isJS)
          Thread.currentThread().setPriority(Thread.MIN_PRIORITY);
        targetTime = System.currentTimeMillis() + Math.abs(sleepTime);
        mode = MAIN;
        break;
      case MAIN:
        if (checkInterrupted(null) || script == null || script.length() == 0)
          return;
        // 26-millisecond check allows
        if (!runSleep(26, CHECK1))
          return;
        mode = CHECK1;
        break;
      case CHECK1:
        // JavaScript-only
        mode = (System.currentTimeMillis() < targetTime ? MAIN : CHECK2);
        break;
      case CHECK2:
        // Time's up!
        currentTime = System.currentTimeMillis();
        if (vwr.timeouts.get(name) == null)
          return;
        status++;
        boolean continuing = (sleepTime < 0);
        if (continuing)
          targetTime = System.currentTimeMillis() + Math.abs(sleepTime);
        else
          vwr.timeouts.remove(name);
        if (triggered) {
          triggered = false;
          // script execution of "timeout ID ;" triggers the timeout again
          if (name.equals("_SET_IN_MOTION_")) {
            vwr.checkInMotion(2);
          } else {
            vwr.evalStringQuiet((continuing ? script + ";\ntimeout ID \""
                + name + "\";" : script));
          }
        }
        mode = (continuing ? MAIN : FINISH);
        break;
      case FINISH:
        vwr.timeouts.remove(name);
        return;
      }
    }
  }

  public static void clear(Map timeouts) {
    for (Object o: timeouts.values()) {
      TimeoutThread t = (TimeoutThread) o;
      if (!t.script.equals("exitJmol"))
        t.interrupt();
    }
    timeouts.clear();
  }

  public static void setTimeout(Viewer vwr, Map timeouts, String name, int mSec, String script) {
    TimeoutThread t = (TimeoutThread) timeouts.get(name);
    if (mSec == 0) {
      if (t != null) {
        t.interrupt();
        timeouts.remove(name);
      }
      return;
    }
    if (t != null) {
      t.set(mSec, script);
      return;
    }
    t = new TimeoutThread(vwr, name, mSec, script);
    timeouts.put(name, t);
    t.start();
  }

  public static void trigger(Map timeouts, String name) {
    TimeoutThread t = (TimeoutThread) timeouts.get(name);
    if (t != null)
      t.triggered = (t.sleepTime < 0);
  }

  public static String showTimeout(Map timeouts, String name) {
    SB sb = new SB();
    if (timeouts != null) {
      for (Object o: timeouts.values()) {
        TimeoutThread t = (TimeoutThread) o;
        if (name == null || t.name.equalsIgnoreCase(name))
          sb.append(t.toString()).append("\n");
      }
    }
    return (sb.length() > 0 ? sb.toString() : "");
  }
  
}