src/Pure/System/progress.scala
author wenzelm
Fri, 01 Apr 2022 17:06:10 +0200
changeset 75393 87ebf5a50283
parent 73897 0ddb5de0506e
child 76592 ec8bf1268f45
permissions -rw-r--r--
clarified formatting, for the sake of scala3;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
61276
8a4bd05c1735 clarified modules;
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/System/progress.scala
8a4bd05c1735 clarified modules;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
8a4bd05c1735 clarified modules;
wenzelm
parents:
diff changeset
     3
8a4bd05c1735 clarified modules;
wenzelm
parents:
diff changeset
     4
Progress context for system processes.
8a4bd05c1735 clarified modules;
wenzelm
parents:
diff changeset
     5
*/
8a4bd05c1735 clarified modules;
wenzelm
parents:
diff changeset
     6
8a4bd05c1735 clarified modules;
wenzelm
parents:
diff changeset
     7
package isabelle
8a4bd05c1735 clarified modules;
wenzelm
parents:
diff changeset
     8
8a4bd05c1735 clarified modules;
wenzelm
parents:
diff changeset
     9
73897
0ddb5de0506e clarified signature: prefer Java interfaces;
wenzelm
parents: 73367
diff changeset
    10
import java.util.{Map => JMap}
64201
wenzelm
parents: 64117
diff changeset
    11
import java.io.{File => JFile}
wenzelm
parents: 64117
diff changeset
    12
wenzelm
parents: 64117
diff changeset
    13
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73897
diff changeset
    14
object Progress {
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73897
diff changeset
    15
  sealed case class Theory(theory: String, session: String = "", percentage: Option[Int] = None) {
68987
e86d6e869b96 tuned signature;
wenzelm
parents: 68957
diff changeset
    16
    def message: String = print_session + print_theory + print_percentage
e86d6e869b96 tuned signature;
wenzelm
parents: 68957
diff changeset
    17
e86d6e869b96 tuned signature;
wenzelm
parents: 68957
diff changeset
    18
    def print_session: String = if (session == "") "" else session + ": "
e86d6e869b96 tuned signature;
wenzelm
parents: 68957
diff changeset
    19
    def print_theory: String = "theory " + theory
e86d6e869b96 tuned signature;
wenzelm
parents: 68957
diff changeset
    20
    def print_percentage: String =
e86d6e869b96 tuned signature;
wenzelm
parents: 68957
diff changeset
    21
      percentage match { case None => "" case Some(p) => " " + p + "%" }
68957
eef4e983fd9d clarified theory progress;
wenzelm
parents: 68951
diff changeset
    22
  }
68410
4e27f5c361d2 clarified signature: more uniform theory_message (see also d7920eb7de54);
wenzelm
parents: 68330
diff changeset
    23
}
4e27f5c361d2 clarified signature: more uniform theory_message (see also d7920eb7de54);
wenzelm
parents: 68330
diff changeset
    24
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73897
diff changeset
    25
class Progress {
73340
0ffcad1f6130 tuned --- fewer warnings;
wenzelm
parents: 72699
diff changeset
    26
  def echo(msg: String): Unit = {}
0ffcad1f6130 tuned --- fewer warnings;
wenzelm
parents: 72699
diff changeset
    27
  def echo_if(cond: Boolean, msg: String): Unit = { if (cond) echo(msg) }
0ffcad1f6130 tuned --- fewer warnings;
wenzelm
parents: 72699
diff changeset
    28
  def theory(theory: Progress.Theory): Unit = {}
0ffcad1f6130 tuned --- fewer warnings;
wenzelm
parents: 72699
diff changeset
    29
  def nodes_status(nodes_status: Document_Status.Nodes_Status): Unit = {}
64909
8007f10195af tuned signature;
wenzelm
parents: 64201
diff changeset
    30
73340
0ffcad1f6130 tuned --- fewer warnings;
wenzelm
parents: 72699
diff changeset
    31
  def echo_warning(msg: String): Unit = echo(Output.warning_text(msg))
0ffcad1f6130 tuned --- fewer warnings;
wenzelm
parents: 72699
diff changeset
    32
  def echo_error_message(msg: String): Unit = echo(Output.error_message_text(msg))
65826
0b8a6a62114f clarified interface;
wenzelm
parents: 64909
diff changeset
    33
65921
5b42937d3b2d more operations;
wenzelm
parents: 65910
diff changeset
    34
  def timeit[A](message: String = "", enabled: Boolean = true)(e: => A): A =
71601
97ccf48c2f0c misc tuning based on hints by IntelliJ IDEA;
wenzelm
parents: 71100
diff changeset
    35
    Timing.timeit(message, enabled, echo)(e)
65921
5b42937d3b2d more operations;
wenzelm
parents: 65910
diff changeset
    36
71726
a5fda30edae2 clarified signature: more uniform treatment of stopped/interrupted state;
wenzelm
parents: 71601
diff changeset
    37
  @volatile protected var is_stopped = false
73367
77ef8bef0593 clarified signature --- fewer warnings;
wenzelm
parents: 73340
diff changeset
    38
  def stop(): Unit = { is_stopped = true }
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73897
diff changeset
    39
  def stopped: Boolean = {
73367
77ef8bef0593 clarified signature --- fewer warnings;
wenzelm
parents: 73340
diff changeset
    40
    if (Thread.interrupted()) is_stopped = true
71726
a5fda30edae2 clarified signature: more uniform treatment of stopped/interrupted state;
wenzelm
parents: 71601
diff changeset
    41
    is_stopped
a5fda30edae2 clarified signature: more uniform treatment of stopped/interrupted state;
wenzelm
parents: 71601
diff changeset
    42
  }
a5fda30edae2 clarified signature: more uniform treatment of stopped/interrupted state;
wenzelm
parents: 71601
diff changeset
    43
73367
77ef8bef0593 clarified signature --- fewer warnings;
wenzelm
parents: 73340
diff changeset
    44
  def interrupt_handler[A](e: => A): A = POSIX_Interrupt.handler { stop() } { e }
73340
0ffcad1f6130 tuned --- fewer warnings;
wenzelm
parents: 72699
diff changeset
    45
  def expose_interrupt(): Unit = if (stopped) throw Exn.Interrupt()
61276
8a4bd05c1735 clarified modules;
wenzelm
parents:
diff changeset
    46
  override def toString: String = if (stopped) "Progress(stopped)" else "Progress"
64201
wenzelm
parents: 64117
diff changeset
    47
wenzelm
parents: 64117
diff changeset
    48
  def bash(script: String,
wenzelm
parents: 64117
diff changeset
    49
    cwd: JFile = null,
73897
0ddb5de0506e clarified signature: prefer Java interfaces;
wenzelm
parents: 73367
diff changeset
    50
    env: JMap[String, String] = Isabelle_System.settings(),
64201
wenzelm
parents: 64117
diff changeset
    51
    redirect: Boolean = false,
65930
9a28fc03c3fe tuned signature;
wenzelm
parents: 65921
diff changeset
    52
    echo: Boolean = false,
72599
76550282267f more interrupts, notably for running latex;
wenzelm
parents: 72574
diff changeset
    53
    watchdog: Time = Time.zero,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73897
diff changeset
    54
    strict: Boolean = true
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73897
diff changeset
    55
  ): Process_Result = {
72599
76550282267f more interrupts, notably for running latex;
wenzelm
parents: 72574
diff changeset
    56
    val result =
76550282267f more interrupts, notably for running latex;
wenzelm
parents: 72574
diff changeset
    57
      Isabelle_System.bash(script, cwd = cwd, env = env, redirect = redirect,
76550282267f more interrupts, notably for running latex;
wenzelm
parents: 72574
diff changeset
    58
        progress_stdout = echo_if(echo, _),
76550282267f more interrupts, notably for running latex;
wenzelm
parents: 72574
diff changeset
    59
        progress_stderr = echo_if(echo, _),
76550282267f more interrupts, notably for running latex;
wenzelm
parents: 72574
diff changeset
    60
        watchdog = if (watchdog.is_zero) None else Some((watchdog, _ => stopped)),
76550282267f more interrupts, notably for running latex;
wenzelm
parents: 72574
diff changeset
    61
        strict = strict)
76550282267f more interrupts, notably for running latex;
wenzelm
parents: 72574
diff changeset
    62
    if (strict && stopped) throw Exn.Interrupt() else result
64201
wenzelm
parents: 64117
diff changeset
    63
  }
61276
8a4bd05c1735 clarified modules;
wenzelm
parents:
diff changeset
    64
}
8a4bd05c1735 clarified modules;
wenzelm
parents:
diff changeset
    65
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73897
diff changeset
    66
class Console_Progress(verbose: Boolean = false, stderr: Boolean = false) extends Progress {
68951
a7b1fe2d30ad more uniform Progress, with theory() for batch-build and theory_percentage() for PIDE session;
wenzelm
parents: 68903
diff changeset
    67
  override def echo(msg: String): Unit =
71100
f31903cc57b0 clarified Console_Progress.echo: include empty lines as in other Progress instances, especially relevant for Progress.bash (e.g. "isabelle phabricator ./bin/config help");
wenzelm
parents: 69818
diff changeset
    68
    Output.writeln(msg, stdout = !stderr, include_empty = true)
64117
c2b41b073d8a build_history log files with formal meta info;
wenzelm
parents: 64049
diff changeset
    69
68957
eef4e983fd9d clarified theory progress;
wenzelm
parents: 68951
diff changeset
    70
  override def theory(theory: Progress.Theory): Unit =
eef4e983fd9d clarified theory progress;
wenzelm
parents: 68951
diff changeset
    71
    if (verbose) echo(theory.message)
61276
8a4bd05c1735 clarified modules;
wenzelm
parents:
diff changeset
    72
}
65888
29a31cf0b4bc more Progress variations;
wenzelm
parents: 65828
diff changeset
    73
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73897
diff changeset
    74
class File_Progress(path: Path, verbose: Boolean = false) extends Progress {
65888
29a31cf0b4bc more Progress variations;
wenzelm
parents: 65828
diff changeset
    75
  override def echo(msg: String): Unit =
29a31cf0b4bc more Progress variations;
wenzelm
parents: 65828
diff changeset
    76
    File.append(path, msg + "\n")
29a31cf0b4bc more Progress variations;
wenzelm
parents: 65828
diff changeset
    77
68957
eef4e983fd9d clarified theory progress;
wenzelm
parents: 68951
diff changeset
    78
  override def theory(theory: Progress.Theory): Unit =
eef4e983fd9d clarified theory progress;
wenzelm
parents: 68951
diff changeset
    79
    if (verbose) echo(theory.message)
68951
a7b1fe2d30ad more uniform Progress, with theory() for batch-build and theory_percentage() for PIDE session;
wenzelm
parents: 68903
diff changeset
    80
65888
29a31cf0b4bc more Progress variations;
wenzelm
parents: 65828
diff changeset
    81
  override def toString: String = path.toString
29a31cf0b4bc more Progress variations;
wenzelm
parents: 65828
diff changeset
    82
}