author | wenzelm |
Mon, 09 Sep 2024 11:41:31 +0200 | |
changeset 80823 | fb0a9fc3901f |
parent 80821 | eb383d50564b |
child 80846 | 9ed32b8a03a9 |
permissions | -rw-r--r-- |
14815 | 1 |
(* Title: Pure/General/output.ML |
62930
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
2 |
Author: Makarius |
14815 | 3 |
|
62930
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
4 |
Isabelle output channels. |
14815 | 5 |
*) |
6 |
||
7 |
signature BASIC_OUTPUT = |
|
8 |
sig |
|
18682
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
9 |
val writeln: string -> unit |
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
10 |
val tracing: string -> unit |
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
11 |
val warning: string -> unit |
59203
5f0bd5afc16d
explicit message channel for "legacy", which is nonetheless a variant of "warning";
wenzelm
parents:
59184
diff
changeset
|
12 |
val legacy_feature: string -> unit |
14815 | 13 |
end; |
14 |
||
15 |
signature OUTPUT = |
|
16 |
sig |
|
17 |
include BASIC_OUTPUT |
|
40131
7cbebd636e79
explicitly qualify type Output.output, which is a slightly odd internal feature;
wenzelm
parents:
40125
diff
changeset
|
18 |
type output = string |
80821 | 19 |
type ops = {output: string -> output * int, escape: output list -> string list} |
20 |
val default_ops: ops |
|
21 |
val add_mode: string -> ops -> unit |
|
80823 | 22 |
val get_mode: unit -> ops |
23660
18765718cf62
type output = string indicates raw system output;
wenzelm
parents:
23616
diff
changeset
|
23 |
val output_width: string -> output * int |
18765718cf62
type output = string indicates raw system output;
wenzelm
parents:
23616
diff
changeset
|
24 |
val output: string -> output |
80789
bcecb69f72fa
more scalable pretty printing: avoid exception String.Size at command "value" (line 33 of "$AFP/Iptables_Semantics/Examples/SQRL_Shorewall/Analyze_SQRL_Shorewall.thy") in AFP/c69af9cd3390;
wenzelm
parents:
73834
diff
changeset
|
25 |
val escape: output list -> string list |
44389
a3b5fdfb04a3
tuned signature -- contrast physical output primitives versus Output.raw_message;
wenzelm
parents:
44270
diff
changeset
|
26 |
val physical_stdout: output -> unit |
a3b5fdfb04a3
tuned signature -- contrast physical output primitives versus Output.raw_message;
wenzelm
parents:
44270
diff
changeset
|
27 |
val physical_stderr: output -> unit |
a3b5fdfb04a3
tuned signature -- contrast physical output primitives versus Output.raw_message;
wenzelm
parents:
44270
diff
changeset
|
28 |
val physical_writeln: output -> unit |
70991
f9f7c34b7dd4
more scalable protocol_message: use XML.body directly (Output.output hook is not required);
wenzelm
parents:
70907
diff
changeset
|
29 |
type protocol_message_fn = Output_Primitives.protocol_message_fn |
51661 | 30 |
exception Protocol_Message of Properties.T |
70991
f9f7c34b7dd4
more scalable protocol_message: use XML.body directly (Output.output hook is not required);
wenzelm
parents:
70907
diff
changeset
|
31 |
val protocol_message_undefined: protocol_message_fn |
56334
6b3739fee456
some shortcuts for chunks, which sometimes avoid bulky string output;
wenzelm
parents:
56333
diff
changeset
|
32 |
val writelns: string list -> unit |
59184
830bb7ddb3ab
explicit message channels for "state", "information";
wenzelm
parents:
58850
diff
changeset
|
33 |
val state: string -> unit |
830bb7ddb3ab
explicit message channels for "state", "information";
wenzelm
parents:
58850
diff
changeset
|
34 |
val information: string -> unit |
54387 | 35 |
val error_message': serial * string -> unit |
36 |
val error_message: string -> unit |
|
57975
c657c68a60ab
explicit system message for protocol failure -- show on Syslog panel instead of Raw Output;
wenzelm
parents:
56830
diff
changeset
|
37 |
val system_message: string -> unit |
70662 | 38 |
val status: string list -> unit |
56333
38f1422ef473
support bulk messages consisting of small string segments, which are more healthy to the Poly/ML RTS and might prevent spurious GC crashes such as MTGCProcessMarkPointers::ScanAddressesInObject;
wenzelm
parents:
56304
diff
changeset
|
39 |
val report: string list -> unit |
38f1422ef473
support bulk messages consisting of small string segments, which are more healthy to the Poly/ML RTS and might prevent spurious GC crashes such as MTGCProcessMarkPointers::ScanAddressesInObject;
wenzelm
parents:
56304
diff
changeset
|
40 |
val result: Properties.T -> string list -> unit |
70991
f9f7c34b7dd4
more scalable protocol_message: use XML.body directly (Output.output hook is not required);
wenzelm
parents:
70907
diff
changeset
|
41 |
val protocol_message: protocol_message_fn |
f9f7c34b7dd4
more scalable protocol_message: use XML.body directly (Output.output hook is not required);
wenzelm
parents:
70907
diff
changeset
|
42 |
val try_protocol_message: protocol_message_fn |
14815 | 43 |
end; |
44 |
||
55387
51f0876f61df
seal system channels at end of Pure bootstrap -- Isabelle/Scala provides official interfaces;
wenzelm
parents:
54387
diff
changeset
|
45 |
signature PRIVATE_OUTPUT = |
51f0876f61df
seal system channels at end of Pure bootstrap -- Isabelle/Scala provides official interfaces;
wenzelm
parents:
54387
diff
changeset
|
46 |
sig |
51f0876f61df
seal system channels at end of Pure bootstrap -- Isabelle/Scala provides official interfaces;
wenzelm
parents:
54387
diff
changeset
|
47 |
include OUTPUT |
56333
38f1422ef473
support bulk messages consisting of small string segments, which are more healthy to the Poly/ML RTS and might prevent spurious GC crashes such as MTGCProcessMarkPointers::ScanAddressesInObject;
wenzelm
parents:
56304
diff
changeset
|
48 |
val writeln_fn: (output list -> unit) Unsynchronized.ref |
59184
830bb7ddb3ab
explicit message channels for "state", "information";
wenzelm
parents:
58850
diff
changeset
|
49 |
val state_fn: (output list -> unit) Unsynchronized.ref |
830bb7ddb3ab
explicit message channels for "state", "information";
wenzelm
parents:
58850
diff
changeset
|
50 |
val information_fn: (output list -> unit) Unsynchronized.ref |
56333
38f1422ef473
support bulk messages consisting of small string segments, which are more healthy to the Poly/ML RTS and might prevent spurious GC crashes such as MTGCProcessMarkPointers::ScanAddressesInObject;
wenzelm
parents:
56304
diff
changeset
|
51 |
val tracing_fn: (output list -> unit) Unsynchronized.ref |
38f1422ef473
support bulk messages consisting of small string segments, which are more healthy to the Poly/ML RTS and might prevent spurious GC crashes such as MTGCProcessMarkPointers::ScanAddressesInObject;
wenzelm
parents:
56304
diff
changeset
|
52 |
val warning_fn: (output list -> unit) Unsynchronized.ref |
59203
5f0bd5afc16d
explicit message channel for "legacy", which is nonetheless a variant of "warning";
wenzelm
parents:
59184
diff
changeset
|
53 |
val legacy_fn: (output list -> unit) Unsynchronized.ref |
56333
38f1422ef473
support bulk messages consisting of small string segments, which are more healthy to the Poly/ML RTS and might prevent spurious GC crashes such as MTGCProcessMarkPointers::ScanAddressesInObject;
wenzelm
parents:
56304
diff
changeset
|
54 |
val error_message_fn: (serial * output list -> unit) Unsynchronized.ref |
57975
c657c68a60ab
explicit system message for protocol failure -- show on Syslog panel instead of Raw Output;
wenzelm
parents:
56830
diff
changeset
|
55 |
val system_message_fn: (output list -> unit) Unsynchronized.ref |
56333
38f1422ef473
support bulk messages consisting of small string segments, which are more healthy to the Poly/ML RTS and might prevent spurious GC crashes such as MTGCProcessMarkPointers::ScanAddressesInObject;
wenzelm
parents:
56304
diff
changeset
|
56 |
val status_fn: (output list -> unit) Unsynchronized.ref |
38f1422ef473
support bulk messages consisting of small string segments, which are more healthy to the Poly/ML RTS and might prevent spurious GC crashes such as MTGCProcessMarkPointers::ScanAddressesInObject;
wenzelm
parents:
56304
diff
changeset
|
57 |
val report_fn: (output list -> unit) Unsynchronized.ref |
38f1422ef473
support bulk messages consisting of small string segments, which are more healthy to the Poly/ML RTS and might prevent spurious GC crashes such as MTGCProcessMarkPointers::ScanAddressesInObject;
wenzelm
parents:
56304
diff
changeset
|
58 |
val result_fn: (Properties.T -> output list -> unit) Unsynchronized.ref |
70991
f9f7c34b7dd4
more scalable protocol_message: use XML.body directly (Output.output hook is not required);
wenzelm
parents:
70907
diff
changeset
|
59 |
val protocol_message_fn: Output_Primitives.protocol_message_fn Unsynchronized.ref |
55387
51f0876f61df
seal system channels at end of Pure bootstrap -- Isabelle/Scala provides official interfaces;
wenzelm
parents:
54387
diff
changeset
|
60 |
end; |
51f0876f61df
seal system channels at end of Pure bootstrap -- Isabelle/Scala provides official interfaces;
wenzelm
parents:
54387
diff
changeset
|
61 |
|
62930
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
62 |
structure Private_Output: PRIVATE_OUTPUT = |
14815 | 63 |
struct |
64 |
||
23616 | 65 |
(** print modes **) |
14881 | 66 |
|
23660
18765718cf62
type output = string indicates raw system output;
wenzelm
parents:
23616
diff
changeset
|
67 |
type output = string; (*raw system output*) |
18765718cf62
type output = string indicates raw system output;
wenzelm
parents:
23616
diff
changeset
|
68 |
|
80821 | 69 |
type ops = {output: string -> output * int, escape: output list -> string list}; |
70 |
||
71 |
val default_ops: ops = {output = fn s => (s, size s), escape = I}; |
|
14815 | 72 |
|
23616 | 73 |
local |
80821 | 74 |
val modes = Synchronized.var "Output.modes" (Symtab.make [("", default_ops)]); |
23616 | 75 |
in |
80821 | 76 |
fun add_mode name ops = |
62894 | 77 |
if Thread_Data.is_virtual then () |
80821 | 78 |
else Synchronized.change modes (Symtab.update_new (name, ops)); |
23616 | 79 |
fun get_mode () = |
80821 | 80 |
the_default default_ops |
43684 | 81 |
(Library.get_first (Symtab.lookup (Synchronized.value modes)) (print_mode_value ())); |
23616 | 82 |
end; |
14815 | 83 |
|
19265 | 84 |
fun output_width x = #output (get_mode ()) x; |
14815 | 85 |
val output = #1 o output_width; |
23727 | 86 |
|
23616 | 87 |
fun escape x = #escape (get_mode ()) x; |
14815 | 88 |
|
89 |
||
90 |
||
91 |
(** output channels **) |
|
92 |
||
62930
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
93 |
(* primitives -- provided via bootstrap environment *) |
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
94 |
|
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
95 |
val writeln_fn = Unsynchronized.ref Output_Primitives.writeln_fn; |
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
96 |
val state_fn = Unsynchronized.ref Output_Primitives.state_fn; |
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
97 |
val information_fn = Unsynchronized.ref Output_Primitives.information_fn; |
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
98 |
val tracing_fn = Unsynchronized.ref Output_Primitives.tracing_fn; |
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
99 |
val warning_fn = Unsynchronized.ref Output_Primitives.warning_fn; |
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
100 |
val legacy_fn = Unsynchronized.ref Output_Primitives.legacy_fn; |
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
101 |
val error_message_fn = Unsynchronized.ref Output_Primitives.error_message_fn; |
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
102 |
val system_message_fn = Unsynchronized.ref Output_Primitives.system_message_fn; |
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
103 |
val status_fn = Unsynchronized.ref Output_Primitives.status_fn; |
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
104 |
val report_fn = Unsynchronized.ref Output_Primitives.report_fn; |
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
105 |
val result_fn = Unsynchronized.ref Output_Primitives.result_fn; |
70991
f9f7c34b7dd4
more scalable protocol_message: use XML.body directly (Output.output hook is not required);
wenzelm
parents:
70907
diff
changeset
|
106 |
|
f9f7c34b7dd4
more scalable protocol_message: use XML.body directly (Output.output hook is not required);
wenzelm
parents:
70907
diff
changeset
|
107 |
type protocol_message_fn = Output_Primitives.protocol_message_fn; |
62930
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
108 |
val protocol_message_fn = Unsynchronized.ref Output_Primitives.protocol_message_fn; |
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
109 |
|
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
110 |
|
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
111 |
(* physical output -- not to be used in user-space *) |
14984 | 112 |
|
44389
a3b5fdfb04a3
tuned signature -- contrast physical output primitives versus Output.raw_message;
wenzelm
parents:
44270
diff
changeset
|
113 |
fun physical_stdout s = (TextIO.output (TextIO.stdOut, s); TextIO.flushOut TextIO.stdOut); |
a3b5fdfb04a3
tuned signature -- contrast physical output primitives versus Output.raw_message;
wenzelm
parents:
44270
diff
changeset
|
114 |
fun physical_stderr s = (TextIO.output (TextIO.stdErr, s); TextIO.flushOut TextIO.stdErr); |
14815 | 115 |
|
44389
a3b5fdfb04a3
tuned signature -- contrast physical output primitives versus Output.raw_message;
wenzelm
parents:
44270
diff
changeset
|
116 |
fun physical_writeln "" = () |
a3b5fdfb04a3
tuned signature -- contrast physical output primitives versus Output.raw_message;
wenzelm
parents:
44270
diff
changeset
|
117 |
| physical_writeln s = physical_stdout (suffix "\n" s); (*atomic output!*) |
14815 | 118 |
|
14984 | 119 |
|
120 |
(* Isabelle output channels *) |
|
121 |
||
51661 | 122 |
exception Protocol_Message of Properties.T; |
123 |
||
70991
f9f7c34b7dd4
more scalable protocol_message: use XML.body directly (Output.output hook is not required);
wenzelm
parents:
70907
diff
changeset
|
124 |
val protocol_message_undefined: Output_Primitives.protocol_message_fn = |
f9f7c34b7dd4
more scalable protocol_message: use XML.body directly (Output.output hook is not required);
wenzelm
parents:
70907
diff
changeset
|
125 |
fn props => fn _ => raise Protocol_Message props; |
70907 | 126 |
|
65301
fca593a62785
restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents:
63517
diff
changeset
|
127 |
fun init_channels () = |
fca593a62785
restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents:
63517
diff
changeset
|
128 |
(writeln_fn := (physical_writeln o implode); |
fca593a62785
restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents:
63517
diff
changeset
|
129 |
state_fn := (fn ss => ! writeln_fn ss); |
fca593a62785
restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents:
63517
diff
changeset
|
130 |
information_fn := Output_Primitives.ignore_outputs; |
fca593a62785
restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents:
63517
diff
changeset
|
131 |
tracing_fn := (fn ss => ! writeln_fn ss); |
fca593a62785
restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents:
63517
diff
changeset
|
132 |
warning_fn := (physical_writeln o prefix_lines "### " o implode); |
fca593a62785
restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents:
63517
diff
changeset
|
133 |
legacy_fn := (fn ss => ! warning_fn ss); |
fca593a62785
restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents:
63517
diff
changeset
|
134 |
error_message_fn := (fn (_, ss) => physical_writeln (prefix_lines "*** " (implode ss))); |
fca593a62785
restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents:
63517
diff
changeset
|
135 |
system_message_fn := (fn ss => ! writeln_fn ss); |
fca593a62785
restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents:
63517
diff
changeset
|
136 |
status_fn := Output_Primitives.ignore_outputs; |
fca593a62785
restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents:
63517
diff
changeset
|
137 |
report_fn := Output_Primitives.ignore_outputs; |
fca593a62785
restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents:
63517
diff
changeset
|
138 |
result_fn := (fn _ => Output_Primitives.ignore_outputs); |
70907 | 139 |
protocol_message_fn := protocol_message_undefined); |
65301
fca593a62785
restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents:
63517
diff
changeset
|
140 |
|
fca593a62785
restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents:
63517
diff
changeset
|
141 |
val _ = if Thread_Data.is_virtual then () else init_channels (); |
14815 | 142 |
|
56334
6b3739fee456
some shortcuts for chunks, which sometimes avoid bulky string output;
wenzelm
parents:
56333
diff
changeset
|
143 |
fun writelns ss = ! writeln_fn (map output ss); |
6b3739fee456
some shortcuts for chunks, which sometimes avoid bulky string output;
wenzelm
parents:
56333
diff
changeset
|
144 |
fun writeln s = writelns [s]; |
59184
830bb7ddb3ab
explicit message channels for "state", "information";
wenzelm
parents:
58850
diff
changeset
|
145 |
fun state s = ! state_fn [output s]; |
830bb7ddb3ab
explicit message channels for "state", "information";
wenzelm
parents:
58850
diff
changeset
|
146 |
fun information s = ! information_fn [output s]; |
56333
38f1422ef473
support bulk messages consisting of small string segments, which are more healthy to the Poly/ML RTS and might prevent spurious GC crashes such as MTGCProcessMarkPointers::ScanAddressesInObject;
wenzelm
parents:
56304
diff
changeset
|
147 |
fun tracing s = ! tracing_fn [output s]; |
38f1422ef473
support bulk messages consisting of small string segments, which are more healthy to the Poly/ML RTS and might prevent spurious GC crashes such as MTGCProcessMarkPointers::ScanAddressesInObject;
wenzelm
parents:
56304
diff
changeset
|
148 |
fun warning s = ! warning_fn [output s]; |
59203
5f0bd5afc16d
explicit message channel for "legacy", which is nonetheless a variant of "warning";
wenzelm
parents:
59184
diff
changeset
|
149 |
fun legacy_feature s = ! legacy_fn [output ("Legacy feature! " ^ s)]; |
56333
38f1422ef473
support bulk messages consisting of small string segments, which are more healthy to the Poly/ML RTS and might prevent spurious GC crashes such as MTGCProcessMarkPointers::ScanAddressesInObject;
wenzelm
parents:
56304
diff
changeset
|
150 |
fun error_message' (i, s) = ! error_message_fn (i, [output s]); |
54387 | 151 |
fun error_message s = error_message' (serial (), s); |
57975
c657c68a60ab
explicit system message for protocol failure -- show on Syslog panel instead of Raw Output;
wenzelm
parents:
56830
diff
changeset
|
152 |
fun system_message s = ! system_message_fn [output s]; |
70662 | 153 |
fun status ss = ! status_fn (map output ss); |
56333
38f1422ef473
support bulk messages consisting of small string segments, which are more healthy to the Poly/ML RTS and might prevent spurious GC crashes such as MTGCProcessMarkPointers::ScanAddressesInObject;
wenzelm
parents:
56304
diff
changeset
|
154 |
fun report ss = ! report_fn (map output ss); |
38f1422ef473
support bulk messages consisting of small string segments, which are more healthy to the Poly/ML RTS and might prevent spurious GC crashes such as MTGCProcessMarkPointers::ScanAddressesInObject;
wenzelm
parents:
56304
diff
changeset
|
155 |
fun result props ss = ! result_fn props (map output ss); |
70991
f9f7c34b7dd4
more scalable protocol_message: use XML.body directly (Output.output hook is not required);
wenzelm
parents:
70907
diff
changeset
|
156 |
fun protocol_message props body = ! protocol_message_fn props body; |
f9f7c34b7dd4
more scalable protocol_message: use XML.body directly (Output.output hook is not required);
wenzelm
parents:
70907
diff
changeset
|
157 |
fun try_protocol_message props body = protocol_message props body handle Protocol_Message _ => (); |
15190 | 158 |
|
14815 | 159 |
end; |
160 |
||
62930
51ac6bc389e8
shared output primitives of physical/virtual Pure;
wenzelm
parents:
62894
diff
changeset
|
161 |
structure Output: OUTPUT = Private_Output; |
32738 | 162 |
structure Basic_Output: BASIC_OUTPUT = Output; |
163 |
open Basic_Output; |