src/Pure/GUI/gui_thread.scala
author wenzelm
Mon, 01 Mar 2021 22:22:12 +0100
changeset 73340 0ffcad1f6130
parent 73120 c3589f2dff31
child 75393 87ebf5a50283
permissions -rw-r--r--
tuned --- fewer warnings;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
57612
990ffb84489b clarified module name: facilitate alternative GUI frameworks;
wenzelm
parents: 56773
diff changeset
     1
/*  Title:      Pure/GUI/gui_thread.scala
29202
2454172eddae Swing utilities.
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
2454172eddae Swing utilities.
wenzelm
parents:
diff changeset
     3
57613
4c6d44a3a079 tuned comments;
wenzelm
parents: 57612
diff changeset
     4
Evaluation within the GUI thread (for AWT/Swing).
29202
2454172eddae Swing utilities.
wenzelm
parents:
diff changeset
     5
*/
2454172eddae Swing utilities.
wenzelm
parents:
diff changeset
     6
2454172eddae Swing utilities.
wenzelm
parents:
diff changeset
     7
package isabelle
2454172eddae Swing utilities.
wenzelm
parents:
diff changeset
     8
55618
995162143ef4 tuned imports;
wenzelm
parents: 53853
diff changeset
     9
56773
5c7ade7a1e74 removed dead code;
wenzelm
parents: 56770
diff changeset
    10
import javax.swing.SwingUtilities
31942
63466160ff27 renamed Delay to Swing_Thread.delay (action is executed within AWT thread!);
wenzelm
parents: 31862
diff changeset
    11
29202
2454172eddae Swing utilities.
wenzelm
parents:
diff changeset
    12
57612
990ffb84489b clarified module name: facilitate alternative GUI frameworks;
wenzelm
parents: 56773
diff changeset
    13
object GUI_Thread
29202
2454172eddae Swing utilities.
wenzelm
parents:
diff changeset
    14
{
56773
5c7ade7a1e74 removed dead code;
wenzelm
parents: 56770
diff changeset
    15
  /* context check */
32494
4ab2292e452a explicit checks;
wenzelm
parents: 31942
diff changeset
    16
66094
24658c9d7c78 more general dispatcher operations;
wenzelm
parents: 64370
diff changeset
    17
  def assert[A](body: => A): A =
52859
f31624cc4467 tuned signature;
wenzelm
parents: 52477
diff changeset
    18
  {
71716
wenzelm
parents: 71704
diff changeset
    19
    Predef.assert(SwingUtilities.isEventDispatchThread)
52859
f31624cc4467 tuned signature;
wenzelm
parents: 52477
diff changeset
    20
    body
f31624cc4467 tuned signature;
wenzelm
parents: 52477
diff changeset
    21
  }
32494
4ab2292e452a explicit checks;
wenzelm
parents: 31942
diff changeset
    22
66094
24658c9d7c78 more general dispatcher operations;
wenzelm
parents: 64370
diff changeset
    23
  def require[A](body: => A): A =
52859
f31624cc4467 tuned signature;
wenzelm
parents: 52477
diff changeset
    24
  {
73120
c3589f2dff31 more informative errors: simplify diagnosis of spurious failures reported by users;
wenzelm
parents: 71716
diff changeset
    25
    Predef.require(SwingUtilities.isEventDispatchThread, "GUI thread expected")
52859
f31624cc4467 tuned signature;
wenzelm
parents: 52477
diff changeset
    26
    body
f31624cc4467 tuned signature;
wenzelm
parents: 52477
diff changeset
    27
  }
52477
025b3777e592 tuned signature;
wenzelm
parents: 49251
diff changeset
    28
32494
4ab2292e452a explicit checks;
wenzelm
parents: 31942
diff changeset
    29
56773
5c7ade7a1e74 removed dead code;
wenzelm
parents: 56770
diff changeset
    30
  /* event dispatch queue */
31942
63466160ff27 renamed Delay to Swing_Thread.delay (action is executed within AWT thread!);
wenzelm
parents: 31862
diff changeset
    31
34026
0cb44ac299f8 added future;
wenzelm
parents: 32501
diff changeset
    32
  def now[A](body: => A): A =
0cb44ac299f8 added future;
wenzelm
parents: 32501
diff changeset
    33
  {
71716
wenzelm
parents: 71704
diff changeset
    34
    if (SwingUtilities.isEventDispatchThread) body
48000
880f1693299a further attempts to simplify/robustify Swing_Thread.now, to avoid spurious physical race conditions on Java 6 / Mac OS X;
wenzelm
parents: 47989
diff changeset
    35
    else {
71716
wenzelm
parents: 71704
diff changeset
    36
      lazy val result = assert { Exn.capture(body) }
wenzelm
parents: 71704
diff changeset
    37
      SwingUtilities.invokeAndWait(() => result)
48000
880f1693299a further attempts to simplify/robustify Swing_Thread.now, to avoid spurious physical race conditions on Java 6 / Mac OS X;
wenzelm
parents: 47989
diff changeset
    38
      Exn.release(result)
880f1693299a further attempts to simplify/robustify Swing_Thread.now, to avoid spurious physical race conditions on Java 6 / Mac OS X;
wenzelm
parents: 47989
diff changeset
    39
    }
29649
8b0c1397868e more robust treatment of SwingUtilities.isEventDispatchThread;
wenzelm
parents: 29202
diff changeset
    40
  }
29202
2454172eddae Swing utilities.
wenzelm
parents:
diff changeset
    41
73340
0ffcad1f6130 tuned --- fewer warnings;
wenzelm
parents: 73120
diff changeset
    42
  def later(body: => Unit): Unit =
34299
68716caa7745 Swing_Thread.future: plain Future.value if this is already Swing;
wenzelm
parents: 34217
diff changeset
    43
  {
71716
wenzelm
parents: 71704
diff changeset
    44
    if (SwingUtilities.isEventDispatchThread) body
wenzelm
parents: 71704
diff changeset
    45
    else SwingUtilities.invokeLater(() => body)
29649
8b0c1397868e more robust treatment of SwingUtilities.isEventDispatchThread;
wenzelm
parents: 29202
diff changeset
    46
  }
31942
63466160ff27 renamed Delay to Swing_Thread.delay (action is executed within AWT thread!);
wenzelm
parents: 31862
diff changeset
    47
67129
0262a378d5d6 added GUI_Thread.future (similar to JFX_GUI.Thread.future): useful for experimentation with Scala console in Isabelle/jEdit;
wenzelm
parents: 66094
diff changeset
    48
  def future[A](body: => A): Future[A] =
0262a378d5d6 added GUI_Thread.future (similar to JFX_GUI.Thread.future): useful for experimentation with Scala console in Isabelle/jEdit;
wenzelm
parents: 66094
diff changeset
    49
  {
71716
wenzelm
parents: 71704
diff changeset
    50
    if (SwingUtilities.isEventDispatchThread) Future.value(body)
67129
0262a378d5d6 added GUI_Thread.future (similar to JFX_GUI.Thread.future): useful for experimentation with Scala console in Isabelle/jEdit;
wenzelm
parents: 66094
diff changeset
    51
    else {
0262a378d5d6 added GUI_Thread.future (similar to JFX_GUI.Thread.future): useful for experimentation with Scala console in Isabelle/jEdit;
wenzelm
parents: 66094
diff changeset
    52
      val promise = Future.promise[A]
0262a378d5d6 added GUI_Thread.future (similar to JFX_GUI.Thread.future): useful for experimentation with Scala console in Isabelle/jEdit;
wenzelm
parents: 66094
diff changeset
    53
      later { promise.fulfill_result(Exn.capture(body)) }
0262a378d5d6 added GUI_Thread.future (similar to JFX_GUI.Thread.future): useful for experimentation with Scala console in Isabelle/jEdit;
wenzelm
parents: 66094
diff changeset
    54
      promise
0262a378d5d6 added GUI_Thread.future (similar to JFX_GUI.Thread.future): useful for experimentation with Scala console in Isabelle/jEdit;
wenzelm
parents: 66094
diff changeset
    55
    }
0262a378d5d6 added GUI_Thread.future (similar to JFX_GUI.Thread.future): useful for experimentation with Scala console in Isabelle/jEdit;
wenzelm
parents: 66094
diff changeset
    56
  }
29202
2454172eddae Swing utilities.
wenzelm
parents:
diff changeset
    57
}