src/Pure/PIDE/protocol.ML
author wenzelm
Tue, 19 Nov 2013 19:33:27 +0100
changeset 54519 5fed81762406
parent 53192 04df1d236e1c
child 54526 92961f196d9e
permissions -rw-r--r--
maintain blobs within document state: digest + text in ML, digest-only in Scala; resolve files for command span, based on defined blobs; tuned;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
45709
87017fcbad83 clarified modules (again) -- NB: both Document and Protocol are specific to this particular prover;
wenzelm
parents: 45672
diff changeset
     1
(*  Title:      Pure/PIDE/protocol.ML
38412
c23f3abbf42d moved isar_document.ML/scala to Pure/System/ -- side-by-side with isar.ML;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
c23f3abbf42d moved isar_document.ML/scala to Pure/System/ -- side-by-side with isar.ML;
wenzelm
parents:
diff changeset
     3
45709
87017fcbad83 clarified modules (again) -- NB: both Document and Protocol are specific to this particular prover;
wenzelm
parents: 45672
diff changeset
     4
Protocol message formats for interactive proof documents.
38412
c23f3abbf42d moved isar_document.ML/scala to Pure/System/ -- side-by-side with isar.ML;
wenzelm
parents:
diff changeset
     5
*)
c23f3abbf42d moved isar_document.ML/scala to Pure/System/ -- side-by-side with isar.ML;
wenzelm
parents:
diff changeset
     6
45709
87017fcbad83 clarified modules (again) -- NB: both Document and Protocol are specific to this particular prover;
wenzelm
parents: 45672
diff changeset
     7
structure Protocol: sig end =
38412
c23f3abbf42d moved isar_document.ML/scala to Pure/System/ -- side-by-side with isar.ML;
wenzelm
parents:
diff changeset
     8
struct
c23f3abbf42d moved isar_document.ML/scala to Pure/System/ -- side-by-side with isar.ML;
wenzelm
parents:
diff changeset
     9
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38417
diff changeset
    10
val _ =
52786
9795ea654905 tuned signature;
wenzelm
parents: 52775
diff changeset
    11
  Isabelle_Process.protocol_command "Isabelle_Process.echo"
9795ea654905 tuned signature;
wenzelm
parents: 52775
diff changeset
    12
    (fn args => List.app writeln args);
9795ea654905 tuned signature;
wenzelm
parents: 52775
diff changeset
    13
9795ea654905 tuned signature;
wenzelm
parents: 52775
diff changeset
    14
val _ =
9795ea654905 tuned signature;
wenzelm
parents: 52775
diff changeset
    15
  Isabelle_Process.protocol_command "Isabelle_Process.options"
9795ea654905 tuned signature;
wenzelm
parents: 52775
diff changeset
    16
    (fn [options_yxml] =>
9795ea654905 tuned signature;
wenzelm
parents: 52775
diff changeset
    17
      let val options = Options.decode (YXML.parse_body options_yxml) in
9795ea654905 tuned signature;
wenzelm
parents: 52775
diff changeset
    18
        Options.set_default options;
9795ea654905 tuned signature;
wenzelm
parents: 52775
diff changeset
    19
        Future.ML_statistics := true;
9795ea654905 tuned signature;
wenzelm
parents: 52775
diff changeset
    20
        Multithreading.trace := Options.int options "threads_trace";
9795ea654905 tuned signature;
wenzelm
parents: 52775
diff changeset
    21
        Multithreading.max_threads := Options.int options "threads";
9795ea654905 tuned signature;
wenzelm
parents: 52775
diff changeset
    22
        Goal.parallel_proofs := (if Options.int options "parallel_proofs" > 0 then 3 else 0)
9795ea654905 tuned signature;
wenzelm
parents: 52775
diff changeset
    23
      end);
52585
ff525a38dba9 added "echo" command for demonstration purposes;
wenzelm
parents: 52579
diff changeset
    24
ff525a38dba9 added "echo" command for demonstration purposes;
wenzelm
parents: 52579
diff changeset
    25
val _ =
54519
5fed81762406 maintain blobs within document state: digest + text in ML, digest-only in Scala;
wenzelm
parents: 53192
diff changeset
    26
  Isabelle_Process.protocol_command "Document.define_blob"
5fed81762406 maintain blobs within document state: digest + text in ML, digest-only in Scala;
wenzelm
parents: 53192
diff changeset
    27
    (fn [digest, content] => Document.change_state (Document.define_blob digest content));
5fed81762406 maintain blobs within document state: digest + text in ML, digest-only in Scala;
wenzelm
parents: 53192
diff changeset
    28
5fed81762406 maintain blobs within document state: digest + text in ML, digest-only in Scala;
wenzelm
parents: 53192
diff changeset
    29
val _ =
46119
0d7172a7672c tuned signature -- emphasize special nature of protocol commands;
wenzelm
parents: 45709
diff changeset
    30
  Isabelle_Process.protocol_command "Document.define_command"
54519
5fed81762406 maintain blobs within document state: digest + text in ML, digest-only in Scala;
wenzelm
parents: 53192
diff changeset
    31
    (fn [id, name, blobs_yxml, text] =>
5fed81762406 maintain blobs within document state: digest + text in ML, digest-only in Scala;
wenzelm
parents: 53192
diff changeset
    32
      let
5fed81762406 maintain blobs within document state: digest + text in ML, digest-only in Scala;
wenzelm
parents: 53192
diff changeset
    33
        val blobs =
5fed81762406 maintain blobs within document state: digest + text in ML, digest-only in Scala;
wenzelm
parents: 53192
diff changeset
    34
          YXML.parse_body blobs_yxml |>
5fed81762406 maintain blobs within document state: digest + text in ML, digest-only in Scala;
wenzelm
parents: 53192
diff changeset
    35
            let open XML.Decode in
5fed81762406 maintain blobs within document state: digest + text in ML, digest-only in Scala;
wenzelm
parents: 53192
diff changeset
    36
              list (variant
5fed81762406 maintain blobs within document state: digest + text in ML, digest-only in Scala;
wenzelm
parents: 53192
diff changeset
    37
               [fn ([a, b], []) => Exn.Res (a, b),
5fed81762406 maintain blobs within document state: digest + text in ML, digest-only in Scala;
wenzelm
parents: 53192
diff changeset
    38
                fn ([a], []) => Exn.Exn (ERROR a)])
5fed81762406 maintain blobs within document state: digest + text in ML, digest-only in Scala;
wenzelm
parents: 53192
diff changeset
    39
            end;
5fed81762406 maintain blobs within document state: digest + text in ML, digest-only in Scala;
wenzelm
parents: 53192
diff changeset
    40
      in
5fed81762406 maintain blobs within document state: digest + text in ML, digest-only in Scala;
wenzelm
parents: 53192
diff changeset
    41
        Document.change_state (Document.define_command (Document_ID.parse id) name blobs text)
5fed81762406 maintain blobs within document state: digest + text in ML, digest-only in Scala;
wenzelm
parents: 53192
diff changeset
    42
      end);
38412
c23f3abbf42d moved isar_document.ML/scala to Pure/System/ -- side-by-side with isar.ML;
wenzelm
parents:
diff changeset
    43
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38417
diff changeset
    44
val _ =
47343
b8aeab386414 less aggressive discontinue_execution before document update, to avoid unstable execs that need to be re-assigned;
wenzelm
parents: 46938
diff changeset
    45
  Isabelle_Process.protocol_command "Document.discontinue_execution"
52606
0d68d108d7e0 tuned signature;
wenzelm
parents: 52605
diff changeset
    46
    (fn [] => Execution.discontinue ());
47343
b8aeab386414 less aggressive discontinue_execution before document update, to avoid unstable execs that need to be re-assigned;
wenzelm
parents: 46938
diff changeset
    47
b8aeab386414 less aggressive discontinue_execution before document update, to avoid unstable execs that need to be re-assigned;
wenzelm
parents: 46938
diff changeset
    48
val _ =
52931
ac6648c0c0fb cancel_query via direct access to the exec_id of the running query process;
wenzelm
parents: 52862
diff changeset
    49
  Isabelle_Process.protocol_command "Document.cancel_exec"
ac6648c0c0fb cancel_query via direct access to the exec_id of the running query process;
wenzelm
parents: 52862
diff changeset
    50
    (fn [exec_id] => Execution.cancel (Document_ID.parse exec_id));
ac6648c0c0fb cancel_query via direct access to the exec_id of the running query process;
wenzelm
parents: 52862
diff changeset
    51
ac6648c0c0fb cancel_query via direct access to the exec_id of the running query process;
wenzelm
parents: 52862
diff changeset
    52
val _ =
46119
0d7172a7672c tuned signature -- emphasize special nature of protocol commands;
wenzelm
parents: 45709
diff changeset
    53
  Isabelle_Process.protocol_command "Document.update"
44157
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    54
    (fn [old_id_string, new_id_string, edits_yxml] => Document.change_state (fn state =>
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38417
diff changeset
    55
      let
52606
0d68d108d7e0 tuned signature;
wenzelm
parents: 52605
diff changeset
    56
        val _ = Execution.discontinue ();
47404
e6e5750f1311 simplified Future.cancel/cancel_group (again) -- running threads only;
wenzelm
parents: 47388
diff changeset
    57
52530
99dd8b4ef3fe explicit module Document_ID as source of globally unique identifiers across ML/Scala;
wenzelm
parents: 52527
diff changeset
    58
        val old_id = Document_ID.parse old_id_string;
99dd8b4ef3fe explicit module Document_ID as source of globally unique identifiers across ML/Scala;
wenzelm
parents: 52527
diff changeset
    59
        val new_id = Document_ID.parse new_id_string;
44157
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    60
        val edits =
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    61
          YXML.parse_body edits_yxml |>
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    62
            let open XML.Decode in
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    63
              list (pair string
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    64
                (variant
48755
393a37003851 apply all text edits to each node, before determining the resulting doc_edits -- allow several iterations to consolidate spans etc.;
wenzelm
parents: 48707
diff changeset
    65
                 [fn ([], []) => Document.Clear,  (* FIXME unused !? *)
44157
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    66
                  fn ([], a) => Document.Edits (list (pair (option int) (option int)) a),
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    67
                  fn ([], a) =>
46938
cda018294515 some support for outer syntax keyword declarations within theory header;
wenzelm
parents: 46774
diff changeset
    68
                    let
51294
0850d43cb355 discontinued obsolete header "files" -- these are loaded explicitly after exploring dependencies;
wenzelm
parents: 51293
diff changeset
    69
                      val (master, (name, (imports, (keywords, errors)))) =
48707
ba531af91148 simplified Document.Node.Header -- internalized errors;
wenzelm
parents: 47420
diff changeset
    70
                        pair string (pair string (pair (list string)
48864
3ee314ae1e0a added keyword kind "thy_load" (with optional list of file extensions);
wenzelm
parents: 48755
diff changeset
    71
                          (pair (list (pair string
3ee314ae1e0a added keyword kind "thy_load" (with optional list of file extensions);
wenzelm
parents: 48755
diff changeset
    72
                            (option (pair (pair string (list string)) (list string)))))
51294
0850d43cb355 discontinued obsolete header "files" -- these are loaded explicitly after exploring dependencies;
wenzelm
parents: 51293
diff changeset
    73
                            (list string)))) a;
48927
ef462b5558eb theory def/ref position reports, which enable hyperlinks etc.;
wenzelm
parents: 48864
diff changeset
    74
                      val imports' = map (rpair Position.none) imports;
51294
0850d43cb355 discontinued obsolete header "files" -- these are loaded explicitly after exploring dependencies;
wenzelm
parents: 51293
diff changeset
    75
                      val header = Thy_Header.make (name, Position.none) imports' keywords;
0850d43cb355 discontinued obsolete header "files" -- these are loaded explicitly after exploring dependencies;
wenzelm
parents: 51293
diff changeset
    76
                    in Document.Deps (master, header, errors) end,
52849
199e9fa5a5c2 maintain overlays within node perspective;
wenzelm
parents: 52808
diff changeset
    77
                  fn (a :: b, c) =>
199e9fa5a5c2 maintain overlays within node perspective;
wenzelm
parents: 52808
diff changeset
    78
                    Document.Perspective (bool_atom a, map int_atom b,
52862
930ce8eacb87 tuned signature -- more uniform treatment of overlays as command mapping;
wenzelm
parents: 52849
diff changeset
    79
                      list (pair int (pair string (list string))) c)]))
44157
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    80
            end;
38412
c23f3abbf42d moved isar_document.ML/scala to Pure/System/ -- side-by-side with isar.ML;
wenzelm
parents:
diff changeset
    81
52655
3b2b1ef13979 more careful termination of removed execs, leaving running execs undisturbed;
wenzelm
parents: 52607
diff changeset
    82
        val (removed, assign_update, state') = Document.update old_id new_id edits state;
3b2b1ef13979 more careful termination of removed execs, leaving running execs undisturbed;
wenzelm
parents: 52607
diff changeset
    83
        val _ = List.app Execution.terminate removed;
53192
04df1d236e1c maintain goal forks as part of global execution;
wenzelm
parents: 52931
diff changeset
    84
        val _ = Execution.purge removed;
52655
3b2b1ef13979 more careful termination of removed execs, leaving running execs undisturbed;
wenzelm
parents: 52607
diff changeset
    85
        val _ = List.app Isabelle_Process.reset_tracing removed;
52601
55e62a25a7ce tuned -- cleanup before publishing assignment;
wenzelm
parents: 52596
diff changeset
    86
55e62a25a7ce tuned -- cleanup before publishing assignment;
wenzelm
parents: 52596
diff changeset
    87
        val _ =
55e62a25a7ce tuned -- cleanup before publishing assignment;
wenzelm
parents: 52596
diff changeset
    88
          Output.protocol_message Markup.assign_update
55e62a25a7ce tuned -- cleanup before publishing assignment;
wenzelm
parents: 52596
diff changeset
    89
            ((new_id, assign_update) |>
55e62a25a7ce tuned -- cleanup before publishing assignment;
wenzelm
parents: 52596
diff changeset
    90
              let open XML.Encode
55e62a25a7ce tuned -- cleanup before publishing assignment;
wenzelm
parents: 52596
diff changeset
    91
              in pair int (list (pair int (list int))) end
55e62a25a7ce tuned -- cleanup before publishing assignment;
wenzelm
parents: 52596
diff changeset
    92
              |> YXML.string_of_body);
52774
627fb639a2d9 maintain explicit execution frontier: avoid conflict with former task via static dependency;
wenzelm
parents: 52765
diff changeset
    93
      in Document.start_execution state' end));
38412
c23f3abbf42d moved isar_document.ML/scala to Pure/System/ -- side-by-side with isar.ML;
wenzelm
parents:
diff changeset
    94
43748
c70bd78ec83c JVM method invocation service via Scala layer;
wenzelm
parents: 43731
diff changeset
    95
val _ =
46119
0d7172a7672c tuned signature -- emphasize special nature of protocol commands;
wenzelm
parents: 45709
diff changeset
    96
  Isabelle_Process.protocol_command "Document.remove_versions"
44673
2fa51ac191bc Document.remove_versions on ML side;
wenzelm
parents: 44661
diff changeset
    97
    (fn [versions_yxml] => Document.change_state (fn state =>
2fa51ac191bc Document.remove_versions on ML side;
wenzelm
parents: 44661
diff changeset
    98
      let
2fa51ac191bc Document.remove_versions on ML side;
wenzelm
parents: 44661
diff changeset
    99
        val versions =
2fa51ac191bc Document.remove_versions on ML side;
wenzelm
parents: 44661
diff changeset
   100
          YXML.parse_body versions_yxml |>
2fa51ac191bc Document.remove_versions on ML side;
wenzelm
parents: 44661
diff changeset
   101
            let open XML.Decode in list int end;
44676
7de87f1ae965 Document.removed_versions on Scala side;
wenzelm
parents: 44673
diff changeset
   102
        val state1 = Document.remove_versions versions state;
50201
c26369c9eda6 Isabelle-specific implementation of quasi-abstract markup elements -- back to module arrangement before d83797ef0d2d;
wenzelm
parents: 49931
diff changeset
   103
        val _ = Output.protocol_message Markup.removed_versions versions_yxml;
44676
7de87f1ae965 Document.removed_versions on Scala side;
wenzelm
parents: 44673
diff changeset
   104
      in state1 end));
44673
2fa51ac191bc Document.remove_versions on ML side;
wenzelm
parents: 44661
diff changeset
   105
2fa51ac191bc Document.remove_versions on ML side;
wenzelm
parents: 44661
diff changeset
   106
val _ =
50498
6647ba2775c1 support dialog via document content;
wenzelm
parents: 50201
diff changeset
   107
  Isabelle_Process.protocol_command "Document.dialog_result"
50500
c94bba7906d2 identify dialogs via official serial and maintain as result message;
wenzelm
parents: 50498
diff changeset
   108
    (fn [serial, result] =>
c94bba7906d2 identify dialogs via official serial and maintain as result message;
wenzelm
parents: 50498
diff changeset
   109
      Active.dialog_result (Markup.parse_int serial) result
52775
e0169f13bd37 keep memo_exec execution running, which is important to cancel goal forks eventually;
wenzelm
parents: 52774
diff changeset
   110
        handle exn => if Exn.is_interrupt exn then () (*sic!*) else reraise exn);
50498
6647ba2775c1 support dialog via document content;
wenzelm
parents: 50201
diff changeset
   111
38412
c23f3abbf42d moved isar_document.ML/scala to Pure/System/ -- side-by-side with isar.ML;
wenzelm
parents:
diff changeset
   112
end;
c23f3abbf42d moved isar_document.ML/scala to Pure/System/ -- side-by-side with isar.ML;
wenzelm
parents:
diff changeset
   113