src/Pure/System/isabelle_process.ML
author wenzelm
Thu, 25 Jun 2009 13:25:35 +0200
changeset 31797 203d5e61e3bc
parent 31384 ce169bd37fc0
child 32738 15bb09ca0378
permissions -rw-r--r--
renamed IsabelleProcess to Isabelle_Process; renamed IsabelleSystem to Isabelle_System;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
30173
eabece26b89b moved isabelle_process.ML, isabelle_process.scala, isar.ML, session.ML to Pure/System/ (together with associated Isar commands);
wenzelm
parents: 29522
diff changeset
     1
(*  Title:      Pure/System/isabelle_process.ML
25528
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
     3
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
     4
Isabelle process wrapper -- interaction via external program.
25631
9036ccd685b4 added output protocol specification;
wenzelm
parents: 25576
diff changeset
     5
9036ccd685b4 added output protocol specification;
wenzelm
parents: 25576
diff changeset
     6
General format of process output:
9036ccd685b4 added output protocol specification;
wenzelm
parents: 25576
diff changeset
     7
29327
e41274f6cc9d removed obsolete XML mode;
wenzelm
parents: 28498
diff changeset
     8
  (1) unmarked stdout/stderr, no line structure (output should be
25842
fdabeed7ccd9 tuned comments;
wenzelm
parents: 25841
diff changeset
     9
  processed immediately as it arrives);
25631
9036ccd685b4 added output protocol specification;
wenzelm
parents: 25576
diff changeset
    10
29327
e41274f6cc9d removed obsolete XML mode;
wenzelm
parents: 28498
diff changeset
    11
  (2) properly marked-up messages, e.g. for writeln channel
25810
bac99880fa99 output message properties: id or position;
wenzelm
parents: 25748
diff changeset
    12
bac99880fa99 output message properties: id or position;
wenzelm
parents: 25748
diff changeset
    13
  "\002A" ^ props ^ "\002,\n" ^ text ^ "\002.\n"
bac99880fa99 output message properties: id or position;
wenzelm
parents: 25748
diff changeset
    14
25841
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
    15
  where the props consist of name=value lines terminated by "\002,\n"
25810
bac99880fa99 output message properties: id or position;
wenzelm
parents: 25748
diff changeset
    16
  each, and the remaining text is any number of lines (output is
25842
fdabeed7ccd9 tuned comments;
wenzelm
parents: 25841
diff changeset
    17
  supposed to be processed in one piece);
25841
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
    18
29327
e41274f6cc9d removed obsolete XML mode;
wenzelm
parents: 28498
diff changeset
    19
  (3) special init message holds "pid" and "session" property;
e41274f6cc9d removed obsolete XML mode;
wenzelm
parents: 28498
diff changeset
    20
e41274f6cc9d removed obsolete XML mode;
wenzelm
parents: 28498
diff changeset
    21
  (4) message content is encoded in YXML format.
25528
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
    22
*)
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
    23
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
    24
signature ISABELLE_PROCESS =
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
    25
sig
26574
560d07845442 support "YXML" mode for output transfer notation;
wenzelm
parents: 26550
diff changeset
    26
  val isabelle_processN: string
28044
e4b569b53e10 explicit output stream, typically a named pipe;
wenzelm
parents: 28036
diff changeset
    27
  val init: string -> unit
25528
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
    28
end;
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
    29
31797
203d5e61e3bc renamed IsabelleProcess to Isabelle_Process;
wenzelm
parents: 31384
diff changeset
    30
structure Isabelle_Process: ISABELLE_PROCESS =
25528
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
    31
struct
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
    32
26550
a8740ad422d2 removed yxmlN for now;
wenzelm
parents: 26543
diff changeset
    33
(* print modes *)
25554
082d97057e23 added test_markup;
wenzelm
parents: 25528
diff changeset
    34
25748
55a458a31e37 added PROMPT message;
wenzelm
parents: 25631
diff changeset
    35
val isabelle_processN = "isabelle_process";
55a458a31e37 added PROMPT message;
wenzelm
parents: 25631
diff changeset
    36
26550
a8740ad422d2 removed yxmlN for now;
wenzelm
parents: 26543
diff changeset
    37
val _ = Output.add_mode isabelle_processN Output.default_output Output.default_escape;
28036
wenzelm
parents: 27986
diff changeset
    38
val _ = Markup.add_mode isabelle_processN YXML.output_markup;
25841
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
    39
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
    40
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
    41
(* message markup *)
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
    42
26527
c392354a1b79 Symbol.STX, Symbol.DEL;
wenzelm
parents: 26463
diff changeset
    43
fun special ch = Symbol.STX ^ ch;
25810
bac99880fa99 output message properties: id or position;
wenzelm
parents: 25748
diff changeset
    44
val special_sep = special ",";
25576
ee11881606b7 special_end: replaced Z by dot;
wenzelm
parents: 25565
diff changeset
    45
val special_end = special ".";
25554
082d97057e23 added test_markup;
wenzelm
parents: 25528
diff changeset
    46
25841
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
    47
local
25810
bac99880fa99 output message properties: id or position;
wenzelm
parents: 25748
diff changeset
    48
26574
560d07845442 support "YXML" mode for output transfer notation;
wenzelm
parents: 26550
diff changeset
    49
fun clean_string bad str =
560d07845442 support "YXML" mode for output transfer notation;
wenzelm
parents: 26550
diff changeset
    50
  if exists_string (member (op =) bad) str then
560d07845442 support "YXML" mode for output transfer notation;
wenzelm
parents: 26550
diff changeset
    51
    translate_string (fn c => if member (op =) bad c then Symbol.DEL else c) str
560d07845442 support "YXML" mode for output transfer notation;
wenzelm
parents: 26550
diff changeset
    52
  else str;
560d07845442 support "YXML" mode for output transfer notation;
wenzelm
parents: 26550
diff changeset
    53
26550
a8740ad422d2 removed yxmlN for now;
wenzelm
parents: 26543
diff changeset
    54
fun message_props props =
26574
560d07845442 support "YXML" mode for output transfer notation;
wenzelm
parents: 26550
diff changeset
    55
  let val clean = clean_string [Symbol.STX, "\n", "\r"]
25841
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
    56
  in implode (map (fn (x, y) => clean x ^ "=" ^ clean y ^ special_sep ^ "\n") props) end;
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
    57
29327
e41274f6cc9d removed obsolete XML mode;
wenzelm
parents: 28498
diff changeset
    58
fun message_pos trees = trees |> get_first
e41274f6cc9d removed obsolete XML mode;
wenzelm
parents: 28498
diff changeset
    59
  (fn XML.Elem (name, atts, ts) =>
e41274f6cc9d removed obsolete XML mode;
wenzelm
parents: 28498
diff changeset
    60
        if name = Markup.positionN then SOME (Position.of_properties atts)
e41274f6cc9d removed obsolete XML mode;
wenzelm
parents: 28498
diff changeset
    61
        else message_pos ts
e41274f6cc9d removed obsolete XML mode;
wenzelm
parents: 28498
diff changeset
    62
    | _ => NONE);
25554
082d97057e23 added test_markup;
wenzelm
parents: 25528
diff changeset
    63
28044
e4b569b53e10 explicit output stream, typically a named pipe;
wenzelm
parents: 28036
diff changeset
    64
fun output out_stream s = NAMED_CRITICAL "IO" (fn () =>
28182
bfd7a8700676 out_stream: block-buffered, with separate autoflush thread (every 50ms);
wenzelm
parents: 28137
diff changeset
    65
  (TextIO.output (out_stream, s); TextIO.output (out_stream, "\n")));
28044
e4b569b53e10 explicit output stream, typically a named pipe;
wenzelm
parents: 28036
diff changeset
    66
25554
082d97057e23 added test_markup;
wenzelm
parents: 25528
diff changeset
    67
in
082d97057e23 added test_markup;
wenzelm
parents: 25528
diff changeset
    68
29522
793766d4c1b5 moved message markup into Scala layer -- reduced redundancy;
wenzelm
parents: 29328
diff changeset
    69
fun message _ _ "" = ()
793766d4c1b5 moved message markup into Scala layer -- reduced redundancy;
wenzelm
parents: 29328
diff changeset
    70
  | message out_stream ch body =
27844
86f0f91471d0 message: ignored if body empty;
wenzelm
parents: 27604
diff changeset
    71
      let
29328
eba7f9f3b06d tuned message_text;
wenzelm
parents: 29327
diff changeset
    72
        val pos = the_default Position.none (message_pos (YXML.parse_body body));
27844
86f0f91471d0 message: ignored if body empty;
wenzelm
parents: 27604
diff changeset
    73
        val props =
86f0f91471d0 message: ignored if body empty;
wenzelm
parents: 27604
diff changeset
    74
          Position.properties_of (Position.thread_data ())
86f0f91471d0 message: ignored if body empty;
wenzelm
parents: 27604
diff changeset
    75
          |> Position.default_properties pos;
29522
793766d4c1b5 moved message markup into Scala layer -- reduced redundancy;
wenzelm
parents: 29328
diff changeset
    76
        val txt = clean_string [Symbol.STX] body;
28044
e4b569b53e10 explicit output stream, typically a named pipe;
wenzelm
parents: 28036
diff changeset
    77
      in output out_stream (special ch ^ message_props props ^ txt ^ special_end) end;
25554
082d97057e23 added test_markup;
wenzelm
parents: 25528
diff changeset
    78
28044
e4b569b53e10 explicit output stream, typically a named pipe;
wenzelm
parents: 28036
diff changeset
    79
fun init_message out_stream =
25841
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
    80
  let
28491
c5420429a5aa plain process_id function;
wenzelm
parents: 28343
diff changeset
    81
    val pid = (Markup.pidN, process_id ());
27972
a87be8fcb25c symbolic message markup;
wenzelm
parents: 27961
diff changeset
    82
    val session = (Markup.sessionN, List.last (Session.id ()) handle List.Empty => "unknown");
29522
793766d4c1b5 moved message markup into Scala layer -- reduced redundancy;
wenzelm
parents: 29328
diff changeset
    83
    val text = Session.welcome ();
28343
7b605b8b7196 protocol change: remapped message codes to make room for nested system messages (e.g. for protocol proxy);
wenzelm
parents: 28342
diff changeset
    84
  in output out_stream (special "A" ^ message_props [pid, session] ^ text ^ special_end) end;
25748
55a458a31e37 added PROMPT message;
wenzelm
parents: 25631
diff changeset
    85
25554
082d97057e23 added test_markup;
wenzelm
parents: 25528
diff changeset
    86
end;
082d97057e23 added test_markup;
wenzelm
parents: 25528
diff changeset
    87
082d97057e23 added test_markup;
wenzelm
parents: 25528
diff changeset
    88
25841
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
    89
(* channels *)
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
    90
28188
51ccf7fa6f18 auto_flush stdout, stderr as well;
wenzelm
parents: 28182
diff changeset
    91
local
51ccf7fa6f18 auto_flush stdout, stderr as well;
wenzelm
parents: 28182
diff changeset
    92
51ccf7fa6f18 auto_flush stdout, stderr as well;
wenzelm
parents: 28182
diff changeset
    93
fun auto_flush stream =
51ccf7fa6f18 auto_flush stdout, stderr as well;
wenzelm
parents: 28182
diff changeset
    94
  let
28189
fbad2eb5be9e auto_flush: uniform block buffering for all output streams;
wenzelm
parents: 28188
diff changeset
    95
    val _ = TextIO.StreamIO.setBufferMode (TextIO.getOutstream stream, IO.BLOCK_BUF);
28188
51ccf7fa6f18 auto_flush stdout, stderr as well;
wenzelm
parents: 28182
diff changeset
    96
    fun loop () =
51ccf7fa6f18 auto_flush stdout, stderr as well;
wenzelm
parents: 28182
diff changeset
    97
      (OS.Process.sleep (Time.fromMilliseconds 50); try TextIO.flushOut stream; loop ());
51ccf7fa6f18 auto_flush stdout, stderr as well;
wenzelm
parents: 28182
diff changeset
    98
  in loop end;
51ccf7fa6f18 auto_flush stdout, stderr as well;
wenzelm
parents: 28182
diff changeset
    99
51ccf7fa6f18 auto_flush stdout, stderr as well;
wenzelm
parents: 28182
diff changeset
   100
in
51ccf7fa6f18 auto_flush stdout, stderr as well;
wenzelm
parents: 28182
diff changeset
   101
28044
e4b569b53e10 explicit output stream, typically a named pipe;
wenzelm
parents: 28036
diff changeset
   102
fun setup_channels out =
28189
fbad2eb5be9e auto_flush: uniform block buffering for all output streams;
wenzelm
parents: 28188
diff changeset
   103
  let
fbad2eb5be9e auto_flush: uniform block buffering for all output streams;
wenzelm
parents: 28188
diff changeset
   104
    val out_stream =
fbad2eb5be9e auto_flush: uniform block buffering for all output streams;
wenzelm
parents: 28188
diff changeset
   105
      if out = "-" then TextIO.stdOut
fbad2eb5be9e auto_flush: uniform block buffering for all output streams;
wenzelm
parents: 28188
diff changeset
   106
      else
fbad2eb5be9e auto_flush: uniform block buffering for all output streams;
wenzelm
parents: 28188
diff changeset
   107
        let
fbad2eb5be9e auto_flush: uniform block buffering for all output streams;
wenzelm
parents: 28188
diff changeset
   108
          val path = File.platform_path (Path.explode out);
fbad2eb5be9e auto_flush: uniform block buffering for all output streams;
wenzelm
parents: 28188
diff changeset
   109
          val out_stream = TextIO.openOut path;  (*fifo blocks until reader is ready*)
fbad2eb5be9e auto_flush: uniform block buffering for all output streams;
wenzelm
parents: 28188
diff changeset
   110
          val _ = OS.FileSys.remove path;  (*prevent alien access, indicate writer is ready*)
28242
f978c8e75118 SimpleThread.fork;
wenzelm
parents: 28189
diff changeset
   111
          val _ = SimpleThread.fork false (auto_flush TextIO.stdOut);
28189
fbad2eb5be9e auto_flush: uniform block buffering for all output streams;
wenzelm
parents: 28188
diff changeset
   112
        in out_stream end;
28242
f978c8e75118 SimpleThread.fork;
wenzelm
parents: 28189
diff changeset
   113
    val _ = SimpleThread.fork false (auto_flush out_stream);
f978c8e75118 SimpleThread.fork;
wenzelm
parents: 28189
diff changeset
   114
    val _ = SimpleThread.fork false (auto_flush TextIO.stdErr);
28044
e4b569b53e10 explicit output stream, typically a named pipe;
wenzelm
parents: 28036
diff changeset
   115
  in
29522
793766d4c1b5 moved message markup into Scala layer -- reduced redundancy;
wenzelm
parents: 29328
diff changeset
   116
    Output.status_fn   := message out_stream "B";
793766d4c1b5 moved message markup into Scala layer -- reduced redundancy;
wenzelm
parents: 29328
diff changeset
   117
    Output.writeln_fn  := message out_stream "C";
793766d4c1b5 moved message markup into Scala layer -- reduced redundancy;
wenzelm
parents: 29328
diff changeset
   118
    Output.priority_fn := message out_stream "D";
793766d4c1b5 moved message markup into Scala layer -- reduced redundancy;
wenzelm
parents: 29328
diff changeset
   119
    Output.tracing_fn  := message out_stream "E";
793766d4c1b5 moved message markup into Scala layer -- reduced redundancy;
wenzelm
parents: 29328
diff changeset
   120
    Output.warning_fn  := message out_stream "F";
793766d4c1b5 moved message markup into Scala layer -- reduced redundancy;
wenzelm
parents: 29328
diff changeset
   121
    Output.error_fn    := message out_stream "G";
793766d4c1b5 moved message markup into Scala layer -- reduced redundancy;
wenzelm
parents: 29328
diff changeset
   122
    Output.debug_fn    := message out_stream "H";
28498
cb1b43edb5ed eliminated prompt messages;
wenzelm
parents: 28491
diff changeset
   123
    Output.prompt_fn   := ignore;
28044
e4b569b53e10 explicit output stream, typically a named pipe;
wenzelm
parents: 28036
diff changeset
   124
    out_stream
e4b569b53e10 explicit output stream, typically a named pipe;
wenzelm
parents: 28036
diff changeset
   125
  end;
25841
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
   126
28188
51ccf7fa6f18 auto_flush stdout, stderr as well;
wenzelm
parents: 28182
diff changeset
   127
end;
51ccf7fa6f18 auto_flush stdout, stderr as well;
wenzelm
parents: 28182
diff changeset
   128
25841
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
   129
25554
082d97057e23 added test_markup;
wenzelm
parents: 25528
diff changeset
   130
(* init *)
082d97057e23 added test_markup;
wenzelm
parents: 25528
diff changeset
   131
28044
e4b569b53e10 explicit output stream, typically a named pipe;
wenzelm
parents: 28036
diff changeset
   132
fun init out =
25841
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
   133
 (change print_mode (update (op =) isabelle_processN);
28044
e4b569b53e10 explicit output stream, typically a named pipe;
wenzelm
parents: 28036
diff changeset
   134
  setup_channels out |> init_message;
28342
d0db291f7194 init: OuterKeyword.report;
wenzelm
parents: 28242
diff changeset
   135
  OuterKeyword.report ();
31384
ce169bd37fc0 IsabelleProcess: emit status "ready" after initialization and reports;
wenzelm
parents: 30173
diff changeset
   136
  Output.status (Markup.markup Markup.ready "");
26643
99f5407c05ef Isar.toplevel_loop: separate init/welcome flag;
wenzelm
parents: 26607
diff changeset
   137
  Isar.toplevel_loop {init = true, welcome = false, sync = true, secure = true});
25528
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
   138
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
   139
end;