author | wenzelm |
Sun, 15 Apr 2007 14:31:59 +0200 | |
changeset 22699 | 938c1011ac94 |
parent 22585 | 16af5cb012e7 |
child 22826 | 0f4c501a691e |
permissions | -rw-r--r-- |
14815 | 1 |
(* Title: Pure/General/output.ML |
2 |
ID: $Id$ |
|
3 |
Author: Makarius, Hagia Maria Sion Abbey (Jerusalem) |
|
4 |
||
22585 | 5 |
Output channels and timing messages. |
14815 | 6 |
*) |
7 |
||
8 |
signature BASIC_OUTPUT = |
|
9 |
sig |
|
18682
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
10 |
val writeln: string -> unit |
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
11 |
val priority: string -> unit |
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
12 |
val tracing: string -> unit |
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
13 |
val warning: string -> unit |
14869 | 14 |
val timing: bool ref |
14815 | 15 |
val cond_timeit: bool -> (unit -> 'a) -> 'a |
16 |
val timeit: (unit -> 'a) -> 'a |
|
17 |
val timeap: ('a -> 'b) -> 'a -> 'b |
|
18 |
val timeap_msg: string -> ('a -> 'b) -> 'a -> 'b |
|
16726
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
19 |
val time_accumulator: string -> ('a -> 'b) -> 'a -> 'b |
14815 | 20 |
end; |
21 |
||
22 |
signature OUTPUT = |
|
23 |
sig |
|
24 |
include BASIC_OUTPUT |
|
25 |
val output_width: string -> string * real |
|
26 |
val output: string -> string |
|
19265 | 27 |
val keyword_width: bool -> string -> string * real |
28 |
val keyword: bool -> string -> string |
|
14815 | 29 |
val indent: string * int -> string |
30 |
val raw: string -> string |
|
22585 | 31 |
val std_output: string -> unit |
32 |
val std_error: string -> unit |
|
33 |
val immediate_output: string -> unit |
|
34 |
val writeln_default: string -> unit |
|
35 |
val writeln_fn: (string -> unit) ref |
|
36 |
val priority_fn: (string -> unit) ref |
|
37 |
val tracing_fn: (string -> unit) ref |
|
38 |
val warning_fn: (string -> unit) ref |
|
39 |
val error_fn: (string -> unit) ref |
|
40 |
val debug_fn: (string -> unit) ref |
|
41 |
val debugging: bool ref |
|
42 |
val no_warnings: ('a -> 'b) -> 'a -> 'b |
|
18682
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
43 |
exception TOPLEVEL_ERROR |
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
44 |
val do_toplevel_errors: bool ref |
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
45 |
val toplevel_errors: ('a -> 'b) -> 'a -> 'b |
18716 | 46 |
val ML_errors: ('a -> 'b) -> 'a -> 'b |
22130 | 47 |
val debug: (unit -> string) -> unit |
18682
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
48 |
val error_msg: string -> unit |
20926 | 49 |
val ml_output: (string -> unit) * (string -> unit) |
14815 | 50 |
val add_mode: string -> |
19265 | 51 |
(string -> string * real) * (bool -> string -> string * real) * |
52 |
(string * int -> string) * (string -> string) -> unit |
|
16726
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
53 |
val accumulated_time: unit -> unit |
14815 | 54 |
end; |
55 |
||
56 |
structure Output: OUTPUT = |
|
57 |
struct |
|
58 |
||
22585 | 59 |
(** output functions **) |
14881 | 60 |
|
14955 | 61 |
type mode_fns = |
19265 | 62 |
{output: string -> string * real, |
63 |
keyword: bool -> string -> string * real, |
|
14955 | 64 |
indent: string * int -> string, |
65 |
raw: string -> string}; |
|
66 |
||
67 |
val modes = ref (Symtab.empty: mode_fns Symtab.table); |
|
14815 | 68 |
|
18682
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
69 |
fun lookup_mode name = Symtab.lookup (! modes) name; |
14815 | 70 |
|
18682
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
71 |
exception MISSING_DEFAULT_OUTPUT; |
14815 | 72 |
|
73 |
fun get_mode () = |
|
15531 | 74 |
(case Library.get_first lookup_mode (! print_mode) of SOME p => p |
75 |
| NONE => |
|
76 |
(case lookup_mode "" of SOME p => p |
|
77 |
| NONE => raise MISSING_DEFAULT_OUTPUT)); (*sys_error would require output again!*) |
|
14815 | 78 |
|
19265 | 79 |
fun output_width x = #output (get_mode ()) x; |
14815 | 80 |
val output = #1 o output_width; |
19265 | 81 |
fun keyword_width b x = #keyword (get_mode ()) b x; |
82 |
val keyword = #1 oo keyword_width; |
|
14955 | 83 |
fun indent x = #indent (get_mode ()) x; |
84 |
fun raw x = #raw (get_mode ()) x; |
|
14815 | 85 |
|
86 |
||
87 |
||
88 |
(** output channels **) |
|
89 |
||
14984 | 90 |
(* output primitives -- normally NOT used directly!*) |
91 |
||
14815 | 92 |
fun std_output s = (TextIO.output (TextIO.stdOut, s); TextIO.flushOut TextIO.stdOut); |
93 |
fun std_error s = (TextIO.output (TextIO.stdErr, s); TextIO.flushOut TextIO.stdErr); |
|
94 |
||
14984 | 95 |
val immediate_output = std_output o output; |
14815 | 96 |
val writeln_default = std_output o suffix "\n"; |
97 |
||
14984 | 98 |
|
99 |
(* Isabelle output channels *) |
|
100 |
||
14815 | 101 |
val writeln_fn = ref writeln_default; |
102 |
val priority_fn = ref (fn s => ! writeln_fn s); |
|
103 |
val tracing_fn = ref (fn s => ! writeln_fn s); |
|
104 |
val warning_fn = ref (std_output o suffix "\n" o prefix_lines "### "); |
|
105 |
val error_fn = ref (std_output o suffix "\n" o prefix_lines "*** "); |
|
15190 | 106 |
val debug_fn = ref (std_output o suffix "\n" o prefix_lines "::: "); |
14815 | 107 |
|
108 |
fun writeln s = ! writeln_fn (output s); |
|
109 |
fun priority s = ! priority_fn (output s); |
|
110 |
fun tracing s = ! tracing_fn (output s); |
|
111 |
fun warning s = ! warning_fn (output s); |
|
15190 | 112 |
|
16191 | 113 |
fun no_warnings f = setmp warning_fn (K ()) f; |
114 |
||
22130 | 115 |
val debugging = ref false; |
116 |
fun debug s = if ! debugging then ! debug_fn (output (s ())) else () |
|
15190 | 117 |
|
14815 | 118 |
fun error_msg s = ! error_fn (output s); |
18682
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
119 |
|
20926 | 120 |
val ml_output = (writeln, error_msg); |
121 |
||
14815 | 122 |
|
18682
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
123 |
(* toplevel errors *) |
14815 | 124 |
|
18682
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
125 |
exception TOPLEVEL_ERROR; |
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
126 |
|
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
127 |
val do_toplevel_errors = ref true; |
14815 | 128 |
|
18682
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
129 |
fun toplevel_errors f x = |
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
130 |
if ! do_toplevel_errors then |
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
131 |
f x handle ERROR msg => (error_msg msg; raise TOPLEVEL_ERROR) |
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
132 |
else f x; |
14815 | 133 |
|
18716 | 134 |
fun ML_errors f = setmp do_toplevel_errors true (toplevel_errors f); |
135 |
||
18682
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
136 |
|
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
137 |
(* add_mode *) |
14815 | 138 |
|
19265 | 139 |
fun add_mode name (output, keyword, indent, raw) = |
18682
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
140 |
(if is_none (lookup_mode name) then () |
216692feebab
removed special ERROR handling stuff (transform_error etc.);
wenzelm
parents:
17539
diff
changeset
|
141 |
else warning ("Redeclaration of symbol print mode: " ^ quote name); |
19265 | 142 |
change modes (Symtab.update (name, |
143 |
{output = output, keyword = keyword, indent = indent, raw = raw}))); |
|
14815 | 144 |
|
145 |
||
146 |
||
147 |
(** timing **) |
|
148 |
||
14869 | 149 |
(*global timing mode*) |
150 |
val timing = ref false; |
|
151 |
||
14815 | 152 |
(*a conditional timing function: applies f to () and, if the flag is true, |
153 |
prints its runtime on warning channel*) |
|
154 |
fun cond_timeit flag f = |
|
155 |
if flag then |
|
21295
63552bc99cfb
tuned names of start_timing,/end_timing/check_timer;
wenzelm
parents:
20926
diff
changeset
|
156 |
let val start = start_timing () |
14815 | 157 |
val result = f () |
22585 | 158 |
in warning (end_timing start); result end |
14815 | 159 |
else f (); |
160 |
||
161 |
(*unconditional timing function*) |
|
162 |
fun timeit x = cond_timeit true x; |
|
163 |
||
164 |
(*timed application function*) |
|
165 |
fun timeap f x = timeit (fn () => f x); |
|
22585 | 166 |
fun timeap_msg s f x = (warning s; timeap f x); |
14815 | 167 |
|
14978 | 168 |
|
169 |
(* accumulated timing *) |
|
170 |
||
171 |
local |
|
172 |
||
173 |
datatype time_info = TI of |
|
16726
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
174 |
{name: string, |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
175 |
timer: Timer.cpu_timer, |
14978 | 176 |
sys: Time.time, |
177 |
usr: Time.time, |
|
178 |
gc: Time.time, |
|
179 |
count: int}; |
|
180 |
||
16726
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
181 |
fun time_init name = ref (TI |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
182 |
{name = name, |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
183 |
timer = Timer.startCPUTimer (), |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
184 |
sys = Time.zeroTime, |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
185 |
usr = Time.zeroTime, |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
186 |
gc = Time.zeroTime, |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
187 |
count = 0}); |
14978 | 188 |
|
16726
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
189 |
fun time_reset (r as ref (TI {name, ...})) = r := ! (time_init name); |
14978 | 190 |
|
191 |
fun time_check (ref (TI r)) = r; |
|
192 |
||
16726
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
193 |
fun time_add ti f x = |
14978 | 194 |
let |
16726
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
195 |
fun add_diff time time1 time2 = |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
196 |
Time.+ (time, Time.- (time2, time1) handle Time.Time => Time.zeroTime); |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
197 |
val {name, timer, sys, usr, gc, count} = time_check ti; |
21295
63552bc99cfb
tuned names of start_timing,/end_timing/check_timer;
wenzelm
parents:
20926
diff
changeset
|
198 |
val (sys1, usr1, gc1) = check_timer timer; |
14978 | 199 |
val result = capture f x; |
21295
63552bc99cfb
tuned names of start_timing,/end_timing/check_timer;
wenzelm
parents:
20926
diff
changeset
|
200 |
val (sys2, usr2, gc2) = check_timer timer; |
14978 | 201 |
in |
16726
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
202 |
ti := TI |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
203 |
{name = name, |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
204 |
timer = timer, |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
205 |
sys = add_diff sys sys1 sys2, |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
206 |
usr = add_diff usr usr1 usr2, |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
207 |
gc = add_diff gc gc1 gc2, |
14978 | 208 |
count = count + 1}; |
209 |
release result |
|
210 |
end; |
|
211 |
||
16726
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
212 |
fun time_finish ti = |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
213 |
let |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
214 |
fun secs prfx time = prfx ^ Time.toString time; |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
215 |
val {name, timer, sys, usr, gc, count} = time_check ti; |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
216 |
in |
22585 | 217 |
warning ("Total of " ^ quote name ^ ": " ^ |
16726
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
218 |
secs "User " usr ^ secs " GC " gc ^ secs " All " (Time.+ (sys, Time.+ (usr, gc))) ^ |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
219 |
" secs in " ^ string_of_int count ^ " calls"); |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
220 |
time_reset ti |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
221 |
end; |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
222 |
|
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
223 |
val time_finish_hooks = ref ([]: (unit -> unit) list); |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
224 |
|
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
225 |
in |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
226 |
|
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
227 |
fun time_accumulator name = |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
228 |
let val ti = time_init name in |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
229 |
change time_finish_hooks (cons (fn () => time_finish ti)); |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
230 |
time_add ti |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
231 |
end; |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
232 |
|
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
233 |
fun accumulated_time () = List.app (fn f => f ()) (! time_finish_hooks); |
4399016bf13e
added time_accumulator and accumulated_time supercede
wenzelm
parents:
16683
diff
changeset
|
234 |
|
14978 | 235 |
end; |
236 |
||
14815 | 237 |
end; |
238 |
||
239 |
structure BasicOutput: BASIC_OUTPUT = Output; |
|
240 |
open BasicOutput; |