src/Pure/PIDE/protocol.ML
author wenzelm
Wed, 11 Apr 2012 11:44:21 +0200
changeset 47420 0dbe6c69eda2
parent 47404 e6e5750f1311
child 48707 ba531af91148
permissions -rw-r--r--
just one dedicated execution per document version -- NB: non-monotonicity of cancel always requires fresh update; explicit terminate_execution; tuned source structure;
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 _ =
46119
0d7172a7672c tuned signature -- emphasize special nature of protocol commands;
wenzelm
parents: 45709
diff changeset
    11
  Isabelle_Process.protocol_command "Document.define_command"
44644
317e4962dd0f clarified define_command: store name as structural information;
wenzelm
parents: 44612
diff changeset
    12
    (fn [id, name, text] =>
317e4962dd0f clarified define_command: store name as structural information;
wenzelm
parents: 44612
diff changeset
    13
      Document.change_state (Document.define_command (Document.parse_id id) name text));
38412
c23f3abbf42d moved isar_document.ML/scala to Pure/System/ -- side-by-side with isar.ML;
wenzelm
parents:
diff changeset
    14
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38417
diff changeset
    15
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
    16
  Isabelle_Process.protocol_command "Document.discontinue_execution"
b8aeab386414 less aggressive discontinue_execution before document update, to avoid unstable execs that need to be re-assigned;
wenzelm
parents: 46938
diff changeset
    17
    (fn [] => Document.discontinue_execution (Document.state ()));
b8aeab386414 less aggressive discontinue_execution before document update, to avoid unstable execs that need to be re-assigned;
wenzelm
parents: 46938
diff changeset
    18
b8aeab386414 less aggressive discontinue_execution before document update, to avoid unstable execs that need to be re-assigned;
wenzelm
parents: 46938
diff changeset
    19
val _ =
46119
0d7172a7672c tuned signature -- emphasize special nature of protocol commands;
wenzelm
parents: 45709
diff changeset
    20
  Isabelle_Process.protocol_command "Document.cancel_execution"
47404
e6e5750f1311 simplified Future.cancel/cancel_group (again) -- running threads only;
wenzelm
parents: 47388
diff changeset
    21
    (fn [] => Document.cancel_execution (Document.state ()));
44612
990ac978854c explicit cancel_execution before queueing new edits -- potential performance improvement for machines with few cores;
wenzelm
parents: 44610
diff changeset
    22
990ac978854c explicit cancel_execution before queueing new edits -- potential performance improvement for machines with few cores;
wenzelm
parents: 44610
diff changeset
    23
val _ =
46119
0d7172a7672c tuned signature -- emphasize special nature of protocol commands;
wenzelm
parents: 45709
diff changeset
    24
  Isabelle_Process.protocol_command "Document.update"
44157
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    25
    (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
    26
      let
47404
e6e5750f1311 simplified Future.cancel/cancel_group (again) -- running threads only;
wenzelm
parents: 47388
diff changeset
    27
        val _ = Document.cancel_execution state;
e6e5750f1311 simplified Future.cancel/cancel_group (again) -- running threads only;
wenzelm
parents: 47388
diff changeset
    28
38418
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38417
diff changeset
    29
        val old_id = Document.parse_id old_id_string;
9a7af64d71bb more explicit / functional ML version of document model;
wenzelm
parents: 38417
diff changeset
    30
        val new_id = Document.parse_id new_id_string;
44157
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    31
        val edits =
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    32
          YXML.parse_body edits_yxml |>
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    33
            let open XML.Decode in
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    34
              list (pair string
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    35
                (variant
44185
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44182
diff changeset
    36
                 [fn ([], []) => Document.Clear,
44157
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    37
                  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
    38
                  fn ([], a) =>
46938
cda018294515 some support for outer syntax keyword declarations within theory header;
wenzelm
parents: 46774
diff changeset
    39
                    let
cda018294515 some support for outer syntax keyword declarations within theory header;
wenzelm
parents: 46774
diff changeset
    40
                      val ((((master, name), imports), keywords), uses) =
cda018294515 some support for outer syntax keyword declarations within theory header;
wenzelm
parents: 46774
diff changeset
    41
                        pair (pair (pair (pair string string) (list string))
cda018294515 some support for outer syntax keyword declarations within theory header;
wenzelm
parents: 46774
diff changeset
    42
                          (list (pair string (option (pair string (list string))))))
cda018294515 some support for outer syntax keyword declarations within theory header;
wenzelm
parents: 46774
diff changeset
    43
                          (list (pair string bool)) a;
cda018294515 some support for outer syntax keyword declarations within theory header;
wenzelm
parents: 46774
diff changeset
    44
                      val res =
cda018294515 some support for outer syntax keyword declarations within theory header;
wenzelm
parents: 46774
diff changeset
    45
                        Exn.capture (fn () =>
cda018294515 some support for outer syntax keyword declarations within theory header;
wenzelm
parents: 46774
diff changeset
    46
                          (master, Thy_Header.make name imports keywords
cda018294515 some support for outer syntax keyword declarations within theory header;
wenzelm
parents: 46774
diff changeset
    47
                            (map (apfst Path.explode) uses))) ();
cda018294515 some support for outer syntax keyword declarations within theory header;
wenzelm
parents: 46774
diff changeset
    48
                    in Document.Header res end,
44384
8f6054a63f96 some support for editor perspective;
wenzelm
parents: 44301
diff changeset
    49
                  fn ([a], []) => Document.Header (Exn.Exn (ERROR a)),
8f6054a63f96 some support for editor perspective;
wenzelm
parents: 44301
diff changeset
    50
                  fn (a, []) => Document.Perspective (map int_atom a)]))
44157
a21d3e1e64fd uniform treatment of header edits as document edits;
wenzelm
parents: 44156
diff changeset
    51
            end;
38412
c23f3abbf42d moved isar_document.ML/scala to Pure/System/ -- side-by-side with isar.ML;
wenzelm
parents:
diff changeset
    52
47420
0dbe6c69eda2 just one dedicated execution per document version -- NB: non-monotonicity of cancel always requires fresh update;
wenzelm
parents: 47404
diff changeset
    53
        val (assignment, state') = Document.update old_id new_id edits state;
44436
546adfa8a6fc update_perspective without actual edits, bypassing the full state assignment protocol;
wenzelm
parents: 44384
diff changeset
    54
        val _ =
46774
38f113b052b1 clarified terminology of raw protocol messages;
wenzelm
parents: 46119
diff changeset
    55
          Output.protocol_message Isabelle_Markup.assign_execs
44661
383c9d758a56 raw message function "assign_execs" avoids full overhead of decoding and caching message body;
wenzelm
parents: 44660
diff changeset
    56
            ((new_id, assignment) |>
44476
e8a87398f35d propagate information about last command with exec state assignment through document model;
wenzelm
parents: 44436
diff changeset
    57
              let open XML.Encode
47388
fe4b245af74c discontinued obsolete last_execs (cf. cd3ab7625519);
wenzelm
parents: 47346
diff changeset
    58
              in pair int (list (pair int (option int))) end
44661
383c9d758a56 raw message function "assign_execs" avoids full overhead of decoding and caching message body;
wenzelm
parents: 44660
diff changeset
    59
              |> YXML.string_of_body);
47420
0dbe6c69eda2 just one dedicated execution per document version -- NB: non-monotonicity of cancel always requires fresh update;
wenzelm
parents: 47404
diff changeset
    60
0dbe6c69eda2 just one dedicated execution per document version -- NB: non-monotonicity of cancel always requires fresh update;
wenzelm
parents: 47404
diff changeset
    61
        val _ = Document.start_execution state';
0dbe6c69eda2 just one dedicated execution per document version -- NB: non-monotonicity of cancel always requires fresh update;
wenzelm
parents: 47404
diff changeset
    62
      in state' end));
38412
c23f3abbf42d moved isar_document.ML/scala to Pure/System/ -- side-by-side with isar.ML;
wenzelm
parents:
diff changeset
    63
43748
c70bd78ec83c JVM method invocation service via Scala layer;
wenzelm
parents: 43731
diff changeset
    64
val _ =
46119
0d7172a7672c tuned signature -- emphasize special nature of protocol commands;
wenzelm
parents: 45709
diff changeset
    65
  Isabelle_Process.protocol_command "Document.remove_versions"
44673
2fa51ac191bc Document.remove_versions on ML side;
wenzelm
parents: 44661
diff changeset
    66
    (fn [versions_yxml] => Document.change_state (fn state =>
2fa51ac191bc Document.remove_versions on ML side;
wenzelm
parents: 44661
diff changeset
    67
      let
2fa51ac191bc Document.remove_versions on ML side;
wenzelm
parents: 44661
diff changeset
    68
        val versions =
2fa51ac191bc Document.remove_versions on ML side;
wenzelm
parents: 44661
diff changeset
    69
          YXML.parse_body versions_yxml |>
2fa51ac191bc Document.remove_versions on ML side;
wenzelm
parents: 44661
diff changeset
    70
            let open XML.Decode in list int end;
44676
7de87f1ae965 Document.removed_versions on Scala side;
wenzelm
parents: 44673
diff changeset
    71
        val state1 = Document.remove_versions versions state;
46774
38f113b052b1 clarified terminology of raw protocol messages;
wenzelm
parents: 46119
diff changeset
    72
        val _ = Output.protocol_message Isabelle_Markup.removed_versions versions_yxml;
44676
7de87f1ae965 Document.removed_versions on Scala side;
wenzelm
parents: 44673
diff changeset
    73
      in state1 end));
44673
2fa51ac191bc Document.remove_versions on ML side;
wenzelm
parents: 44661
diff changeset
    74
2fa51ac191bc Document.remove_versions on ML side;
wenzelm
parents: 44661
diff changeset
    75
val _ =
46119
0d7172a7672c tuned signature -- emphasize special nature of protocol commands;
wenzelm
parents: 45709
diff changeset
    76
  Isabelle_Process.protocol_command "Document.invoke_scala"
43748
c70bd78ec83c JVM method invocation service via Scala layer;
wenzelm
parents: 43731
diff changeset
    77
    (fn [id, tag, res] => Invoke_Scala.fulfill_method id tag res);
c70bd78ec83c JVM method invocation service via Scala layer;
wenzelm
parents: 43731
diff changeset
    78
38412
c23f3abbf42d moved isar_document.ML/scala to Pure/System/ -- side-by-side with isar.ML;
wenzelm
parents:
diff changeset
    79
end;
c23f3abbf42d moved isar_document.ML/scala to Pure/System/ -- side-by-side with isar.ML;
wenzelm
parents:
diff changeset
    80