src/Pure/General/logger.scala
author wenzelm
Sat, 04 Mar 2023 23:43:53 +0100
changeset 77511 3d6db917bd1b
parent 77286 6435b0fd48b5
child 79767 52b5c7c8e6d9
permissions -rw-r--r--
clarified modules;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
64606
a871fa7c24fc clarified modules;
wenzelm
parents: 64605
diff changeset
     1
/*  Title:      Pure/General/logger.scala
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     3
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     4
Minimal logging support.
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     5
*/
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     6
64606
a871fa7c24fc clarified modules;
wenzelm
parents: 64605
diff changeset
     7
package isabelle
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     8
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     9
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73777
diff changeset
    10
object Logger {
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    11
  def make(log_file: Option[Path]): Logger =
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    12
    log_file match { case Some(file) => new File_Logger(file) case None => No_Logger }
73777
52e43a93d51f clarified system_log: make this work independently of the particular "isabelle build" command-line (e.g. "isabelle mirabelle");
wenzelm
parents: 73340
diff changeset
    13
52e43a93d51f clarified system_log: make this work independently of the particular "isabelle build" command-line (e.g. "isabelle mirabelle");
wenzelm
parents: 73340
diff changeset
    14
  def make(progress: Progress): Logger =
52e43a93d51f clarified system_log: make this work independently of the particular "isabelle build" command-line (e.g. "isabelle mirabelle");
wenzelm
parents: 73340
diff changeset
    15
    new Logger { def apply(msg: => String): Unit = progress.echo(msg) }
77511
3d6db917bd1b clarified modules;
wenzelm
parents: 77286
diff changeset
    16
3d6db917bd1b clarified modules;
wenzelm
parents: 77286
diff changeset
    17
  def make_system_log(progress: Progress, options: Options): Logger =
3d6db917bd1b clarified modules;
wenzelm
parents: 77286
diff changeset
    18
    options.string("system_log") match {
3d6db917bd1b clarified modules;
wenzelm
parents: 77286
diff changeset
    19
      case "" => No_Logger
3d6db917bd1b clarified modules;
wenzelm
parents: 77286
diff changeset
    20
      case "-" => make(progress)
3d6db917bd1b clarified modules;
wenzelm
parents: 77286
diff changeset
    21
      case log_file => make(Some(Path.explode(log_file)))
3d6db917bd1b clarified modules;
wenzelm
parents: 77286
diff changeset
    22
    }
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    23
}
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    24
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73777
diff changeset
    25
trait Logger {
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    26
  def apply(msg: => String): Unit
65921
5b42937d3b2d more operations;
wenzelm
parents: 64606
diff changeset
    27
76593
badb5264f7b9 clarified signature: just one level of arguments to avoid type-inference problems;
wenzelm
parents: 76592
diff changeset
    28
  def timeit[A](body: => A,
76592
ec8bf1268f45 tuned signature: more operations;
wenzelm
parents: 75393
diff changeset
    29
    message: Exn.Result[A] => String = null,
ec8bf1268f45 tuned signature: more operations;
wenzelm
parents: 75393
diff changeset
    30
    enabled: Boolean = true
76593
badb5264f7b9 clarified signature: just one level of arguments to avoid type-inference problems;
wenzelm
parents: 76592
diff changeset
    31
  ): A = Timing.timeit(body, message = message, enabled = enabled, output = apply(_))
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    32
}
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    33
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73777
diff changeset
    34
object No_Logger extends Logger {
73340
0ffcad1f6130 tuned --- fewer warnings;
wenzelm
parents: 65921
diff changeset
    35
  def apply(msg: => String): Unit = {}
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    36
}
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    37
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73777
diff changeset
    38
class File_Logger(path: Path) extends Logger {
73340
0ffcad1f6130 tuned --- fewer warnings;
wenzelm
parents: 65921
diff changeset
    39
  def apply(msg: => String): Unit = synchronized { File.append(path, msg + "\n") }
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    40
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    41
  override def toString: String = path.toString
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    42
}
77182
25dbf5bec91e more logging;
wenzelm
parents: 76593
diff changeset
    43
25dbf5bec91e more logging;
wenzelm
parents: 76593
diff changeset
    44
class System_Logger extends Logger {
77286
6435b0fd48b5 more robust;
wenzelm
parents: 77182
diff changeset
    45
  def apply(msg: => String): Unit = synchronized {
77182
25dbf5bec91e more logging;
wenzelm
parents: 76593
diff changeset
    46
    if (Platform.is_windows) System.out.println(msg)
25dbf5bec91e more logging;
wenzelm
parents: 76593
diff changeset
    47
    else System.console.writer.println(msg)
77286
6435b0fd48b5 more robust;
wenzelm
parents: 77182
diff changeset
    48
  }
77182
25dbf5bec91e more logging;
wenzelm
parents: 76593
diff changeset
    49
}