src/Pure/Thy/sessions.ML
author wenzelm
Fri, 26 Aug 2022 11:41:59 +0200
changeset 75977 59aa034220bf
parent 75679 aa89255b704c
child 75986 27d98da31985
permissions -rw-r--r--
more robust: ensure that chapter/session/theory do not contain special notation (like "/" or "..");
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
     1
(*  Title:      Pure/Thy/sessions.ML
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
     3
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
     4
Support for session ROOT syntax.
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
     5
*)
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
     6
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
     7
signature SESSIONS =
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
     8
sig
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
     9
  val root_name: string
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    10
  val theory_name: string
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    11
  val command_parser: (Toplevel.transition -> Toplevel.transition) parser
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    12
end;
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    13
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    14
structure Sessions: SESSIONS =
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    15
struct
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    16
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    17
val root_name = "ROOT";
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    18
val theory_name = "Pure.Sessions";
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    19
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    20
local
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    21
72841
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
    22
val theory_entry = Parse.input Parse.theory_name --| Parse.opt_keyword "global";
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    23
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    24
val theories =
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    25
  Parse.$$$ "theories" |-- Parse.!!! (Scan.optional Parse.options [] -- Scan.repeat1 theory_entry);
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    26
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 67220
diff changeset
    27
val in_path =
72841
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
    28
  Parse.$$$ "(" |-- Parse.!!! (Parse.$$$ "in" |-- Parse.path_input --| Parse.$$$ ")");
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 67220
diff changeset
    29
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 70683
diff changeset
    30
val document_theories =
72841
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
    31
  Parse.$$$ "document_theories" |-- Scan.repeat1 (Parse.input Parse.theory_name);
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 70683
diff changeset
    32
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    33
val document_files =
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    34
  Parse.$$$ "document_files" |--
72841
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
    35
    Parse.!!! (Scan.optional in_path (Input.string "document") -- Scan.repeat1 Parse.path_input);
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    36
69671
2486792eaf61 support pruning of export names;
wenzelm
parents: 69349
diff changeset
    37
val prune =
2486792eaf61 support pruning of export names;
wenzelm
parents: 69349
diff changeset
    38
  Scan.optional (Parse.$$$ "[" |-- Parse.!!! (Parse.nat --| Parse.$$$ "]")) 0;
2486792eaf61 support pruning of export names;
wenzelm
parents: 69349
diff changeset
    39
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 67220
diff changeset
    40
val export_files =
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 67220
diff changeset
    41
  Parse.$$$ "export_files" |--
72841
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
    42
    Parse.!!! (Scan.optional in_path (Input.string "export") -- prune -- Scan.repeat1 Parse.embedded);
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
    43
75679
aa89255b704c support for classpath artifacts within session structure:
wenzelm
parents: 74887
diff changeset
    44
val export_classpath =
aa89255b704c support for classpath artifacts within session structure:
wenzelm
parents: 74887
diff changeset
    45
  Parse.$$$ "export_classpath" |-- Scan.repeat Parse.embedded;
aa89255b704c support for classpath artifacts within session structure:
wenzelm
parents: 74887
diff changeset
    46
72841
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
    47
fun path_source source path =
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
    48
  Input.source (Input.is_delimited source) (Path.implode path) (Input.range_of source);
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 67220
diff changeset
    49
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    50
in
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    51
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    52
val command_parser =
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    53
  Parse.session_name --
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    54
  Scan.optional (Parse.$$$ "(" |-- Parse.!!! (Scan.repeat1 Parse.name --| Parse.$$$ ")")) [] --
72841
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
    55
  Scan.optional (Parse.$$$ "in" |-- Parse.!!! Parse.path_input) (Input.string ".") --
67220
0049bed35f5a more markup;
wenzelm
parents: 67215
diff changeset
    56
  (Parse.$$$ "=" |--
69349
7cef9e386ffe more accurate positions for "name" (quoted string) and "embedded" (cartouche): refer to content without delimiters, which is e.g. relevant for systematic selection/renaming of scope groups;
wenzelm
parents: 68808
diff changeset
    57
    Parse.!!! (Scan.option (Parse.session_name --| Parse.!!! (Parse.$$$ "+")) --
74887
56247fdb8bbb discontinued old-style {* verbatim *} tokens;
wenzelm
parents: 72841
diff changeset
    58
      Scan.optional (Parse.$$$ "description" |-- Parse.!!! (Parse.input Parse.embedded)) Input.empty --
67220
0049bed35f5a more markup;
wenzelm
parents: 67215
diff changeset
    59
      Scan.optional (Parse.$$$ "options" |-- Parse.!!! Parse.options) [] --
0049bed35f5a more markup;
wenzelm
parents: 67215
diff changeset
    60
      Scan.optional (Parse.$$$ "sessions" |--
69349
7cef9e386ffe more accurate positions for "name" (quoted string) and "embedded" (cartouche): refer to content without delimiters, which is e.g. relevant for systematic selection/renaming of scope groups;
wenzelm
parents: 68808
diff changeset
    61
        Parse.!!! (Scan.repeat1 Parse.session_name)) [] --
72841
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
    62
      Scan.optional (Parse.$$$ "directories" |-- Parse.!!! (Scan.repeat1 Parse.path_input)) [] --
67220
0049bed35f5a more markup;
wenzelm
parents: 67215
diff changeset
    63
      Scan.repeat theories --
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 70683
diff changeset
    64
      Scan.optional document_theories [] --
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 67220
diff changeset
    65
      Scan.repeat document_files --
75679
aa89255b704c support for classpath artifacts within session structure:
wenzelm
parents: 74887
diff changeset
    66
      Scan.repeat export_files --
aa89255b704c support for classpath artifacts within session structure:
wenzelm
parents: 74887
diff changeset
    67
      Scan.optional export_classpath []))
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 70683
diff changeset
    68
  >> (fn (((((session, _), _), dir),
75679
aa89255b704c support for classpath artifacts within session structure:
wenzelm
parents: 74887
diff changeset
    69
          ((((((((((parent, descr), options), sessions), directories), theories),
aa89255b704c support for classpath artifacts within session structure:
wenzelm
parents: 74887
diff changeset
    70
            document_theories), document_files), export_files), _)))) =>
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    71
    Toplevel.keep (fn state =>
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    72
      let
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    73
        val ctxt = Toplevel.context_of state;
70049
c1226e4c273e tuned signature;
wenzelm
parents: 69671
diff changeset
    74
        val session_dir = Resources.check_dir ctxt NONE dir;
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    75
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    76
        val _ =
67220
0049bed35f5a more markup;
wenzelm
parents: 67215
diff changeset
    77
          (the_list parent @ sessions) |> List.app (fn arg =>
0049bed35f5a more markup;
wenzelm
parents: 67215
diff changeset
    78
            ignore (Resources.check_session ctxt arg)
0049bed35f5a more markup;
wenzelm
parents: 67215
diff changeset
    79
              handle ERROR msg => Output.error_message msg);
0049bed35f5a more markup;
wenzelm
parents: 67215
diff changeset
    80
0049bed35f5a more markup;
wenzelm
parents: 67215
diff changeset
    81
        val _ =
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    82
          Context_Position.report ctxt
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    83
            (Position.range_position (Symbol_Pos.range (Input.source_explode descr)))
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    84
            Markup.comment;
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    85
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    86
        val _ =
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    87
          (options @ maps #1 theories) |> List.app (fn (x, y) =>
67220
0049bed35f5a more markup;
wenzelm
parents: 67215
diff changeset
    88
            ignore (Completion.check_option_value ctxt x y (Options.default ()))
0049bed35f5a more markup;
wenzelm
parents: 67215
diff changeset
    89
              handle ERROR msg => Output.error_message msg);
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    90
72841
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
    91
        fun check_thy source =
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
    92
          ignore (Resources.check_file ctxt (SOME Path.current) source)
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 70683
diff changeset
    93
            handle ERROR msg => Output.error_message msg;
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 70683
diff changeset
    94
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    95
        val _ =
72841
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
    96
          maps #2 theories |> List.app (fn source =>
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
    97
            let
72841
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
    98
              val s = Input.string_of source;
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
    99
              val pos = Input.pos_of source;
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
   100
              val {node_name, theory_name, ...} =
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
   101
                Resources.import_name session session_dir s
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
   102
                  handle ERROR msg => error (msg ^ Position.here pos);
72841
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
   103
              val thy_path = the_default node_name (Resources.find_theory_file theory_name);
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
   104
            in check_thy (path_source source thy_path) end);
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
   105
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
   106
        val _ =
70681
a6c0f2d106c8 disallow overlapping session directories;
wenzelm
parents: 70678
diff changeset
   107
          directories |> List.app (ignore o Resources.check_dir ctxt (SOME session_dir));
70668
9cac4dec0da9 support for explicit session directories;
wenzelm
parents: 70049
diff changeset
   108
9cac4dec0da9 support for explicit session directories;
wenzelm
parents: 70049
diff changeset
   109
        val _ =
72841
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
   110
          document_theories |> List.app (fn source =>
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
   111
            let
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
   112
              val thy = Input.string_of source;
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
   113
              val pos = Input.pos_of source;
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
   114
            in
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
   115
              (case Resources.find_theory_file thy of
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
   116
                NONE => Output.error_message ("Unknown theory " ^ quote thy ^ Position.here pos)
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
   117
              | SOME path => check_thy (path_source source path))
fd8d82c4433b more accurate markup (refining 1c59b555ac4a);
wenzelm
parents: 72600
diff changeset
   118
            end);
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 70683
diff changeset
   119
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 70683
diff changeset
   120
        val _ =
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
   121
          document_files |> List.app (fn (doc_dir, doc_files) =>
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
   122
            let
70049
c1226e4c273e tuned signature;
wenzelm
parents: 69671
diff changeset
   123
              val dir = Resources.check_dir ctxt (SOME session_dir) doc_dir;
c1226e4c273e tuned signature;
wenzelm
parents: 69671
diff changeset
   124
              val _ = List.app (ignore o Resources.check_file ctxt (SOME dir)) doc_files;
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
   125
            in () end);
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 67220
diff changeset
   126
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 67220
diff changeset
   127
        val _ =
69671
2486792eaf61 support pruning of export names;
wenzelm
parents: 69349
diff changeset
   128
          export_files |> List.app (fn ((export_dir, _), _) =>
70049
c1226e4c273e tuned signature;
wenzelm
parents: 69671
diff changeset
   129
            ignore (Resources.check_path ctxt (SOME session_dir) export_dir));
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
   130
      in () end));
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
   131
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
   132
end;
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
   133
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents:
diff changeset
   134
end;