src/Pure/General/output.scala
author wenzelm
Fri, 01 Apr 2022 17:06:10 +0200
changeset 75393 87ebf5a50283
parent 73340 0ffcad1f6130
child 77500 bbb78dba6f68
permissions -rw-r--r--
clarified formatting, for the sake of scala3;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
57453
77d13a98f1c8 clarified quasi-generic PIDE;
wenzelm
parents: 56831
diff changeset
     1
/*  Title:      Pure/General/output.scala
56782
433cf57550fa more systematic Isabelle output, like in classic Isabelle/ML (without markup);
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
433cf57550fa more systematic Isabelle output, like in classic Isabelle/ML (without markup);
wenzelm
parents:
diff changeset
     3
62930
51ac6bc389e8 shared output primitives of physical/virtual Pure;
wenzelm
parents: 62553
diff changeset
     4
Isabelle output channels.
56782
433cf57550fa more systematic Isabelle output, like in classic Isabelle/ML (without markup);
wenzelm
parents:
diff changeset
     5
*/
433cf57550fa more systematic Isabelle output, like in classic Isabelle/ML (without markup);
wenzelm
parents:
diff changeset
     6
433cf57550fa more systematic Isabelle output, like in classic Isabelle/ML (without markup);
wenzelm
parents:
diff changeset
     7
package isabelle
433cf57550fa more systematic Isabelle output, like in classic Isabelle/ML (without markup);
wenzelm
parents:
diff changeset
     8
433cf57550fa more systematic Isabelle output, like in classic Isabelle/ML (without markup);
wenzelm
parents:
diff changeset
     9
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73340
diff changeset
    10
object Output {
59671
9715eb8e9408 more precise position information in Isabelle/Scala, with YXML markup as in Isabelle/ML;
wenzelm
parents: 57453
diff changeset
    11
  def clean_yxml(msg: String): String =
62938
79f41fbdf74a clean message more thoroughly;
wenzelm
parents: 62930
diff changeset
    12
    try { XML.content(Protocol_Message.clean_reports(YXML.parse_body(msg))) }
59671
9715eb8e9408 more precise position information in Isabelle/Scala, with YXML markup as in Isabelle/ML;
wenzelm
parents: 57453
diff changeset
    13
    catch { case ERROR(_) => msg }
56782
433cf57550fa more systematic Isabelle output, like in classic Isabelle/ML (without markup);
wenzelm
parents:
diff changeset
    14
59671
9715eb8e9408 more precise position information in Isabelle/Scala, with YXML markup as in Isabelle/ML;
wenzelm
parents: 57453
diff changeset
    15
  def writeln_text(msg: String): String = clean_yxml(msg)
65828
02dd430d80c5 tuned signature;
wenzelm
parents: 64370
diff changeset
    16
71647
7b0656fa783b clarified signature;
wenzelm
parents: 71164
diff changeset
    17
  def warning_prefix(s: String): String = Library.prefix_lines("### ", s)
7b0656fa783b clarified signature;
wenzelm
parents: 71164
diff changeset
    18
  def warning_text(msg: String): String = warning_prefix(clean_yxml(msg))
65828
02dd430d80c5 tuned signature;
wenzelm
parents: 64370
diff changeset
    19
71647
7b0656fa783b clarified signature;
wenzelm
parents: 71164
diff changeset
    20
  def error_prefix(s: String): String = Library.prefix_lines("*** ", s)
7b0656fa783b clarified signature;
wenzelm
parents: 71164
diff changeset
    21
  def error_message_text(msg: String): String = error_prefix(clean_yxml(msg))
59671
9715eb8e9408 more precise position information in Isabelle/Scala, with YXML markup as in Isabelle/ML;
wenzelm
parents: 57453
diff changeset
    22
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73340
diff changeset
    23
  def writeln(msg: String, stdout: Boolean = false, include_empty: Boolean = false): 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: 67178
diff changeset
    24
    if (msg.nonEmpty || include_empty) {
67178
70576478bda9 avoid println with its extra CR on Windows;
wenzelm
parents: 65828
diff changeset
    25
      if (stdout) Console.print(writeln_text(msg) + "\n")
70576478bda9 avoid println with its extra CR on Windows;
wenzelm
parents: 65828
diff changeset
    26
      else Console.err.print(writeln_text(msg) + "\n")
62553
d2e0d626fb96 tuned signature;
wenzelm
parents: 62297
diff changeset
    27
    }
d2e0d626fb96 tuned signature;
wenzelm
parents: 62297
diff changeset
    28
  }
d2e0d626fb96 tuned signature;
wenzelm
parents: 62297
diff changeset
    29
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73340
diff changeset
    30
  def warning(msg: String, stdout: Boolean = false, include_empty: Boolean = false): 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: 67178
diff changeset
    31
    if (msg.nonEmpty || include_empty) {
67178
70576478bda9 avoid println with its extra CR on Windows;
wenzelm
parents: 65828
diff changeset
    32
      if (stdout) Console.print(warning_text(msg) + "\n")
70576478bda9 avoid println with its extra CR on Windows;
wenzelm
parents: 65828
diff changeset
    33
      else Console.err.print(warning_text(msg) + "\n")
62553
d2e0d626fb96 tuned signature;
wenzelm
parents: 62297
diff changeset
    34
    }
d2e0d626fb96 tuned signature;
wenzelm
parents: 62297
diff changeset
    35
  }
d2e0d626fb96 tuned signature;
wenzelm
parents: 62297
diff changeset
    36
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73340
diff changeset
    37
  def error_message(msg: String, stdout: Boolean = false, include_empty: Boolean = false): 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: 67178
diff changeset
    38
    if (msg.nonEmpty || include_empty) {
67178
70576478bda9 avoid println with its extra CR on Windows;
wenzelm
parents: 65828
diff changeset
    39
      if (stdout) Console.print(error_message_text(msg) + "\n")
70576478bda9 avoid println with its extra CR on Windows;
wenzelm
parents: 65828
diff changeset
    40
      else Console.err.print(error_message_text(msg) + "\n")
62553
d2e0d626fb96 tuned signature;
wenzelm
parents: 62297
diff changeset
    41
    }
d2e0d626fb96 tuned signature;
wenzelm
parents: 62297
diff changeset
    42
  }
56782
433cf57550fa more systematic Isabelle output, like in classic Isabelle/ML (without markup);
wenzelm
parents:
diff changeset
    43
}