src/Pure/Thy/sessions.scala
author wenzelm
Mon, 04 Apr 2022 23:33:14 +0200
changeset 75405 b13ab7d11b90
parent 75394 42267c650205
child 75406 85e8b4c2b9a9
permissions -rw-r--r--
clarified signature: avoid ambiguity in scala3;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/Thy/sessions.scala
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
     3
65430
4433d189a77d tuned comment;
wenzelm
parents: 65429
diff changeset
     4
Cumulative session information.
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
     5
*/
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
     6
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
     7
package isabelle
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
     8
65461
b6c2e30dc018 support for known theories files (according to multiple uses);
wenzelm
parents: 65457
diff changeset
     9
import java.io.{File => JFile}
62704
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
    10
import java.nio.ByteBuffer
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
    11
import java.nio.channels.FileChannel
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
    12
import java.nio.file.StandardOpenOption
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
    13
73364
6bf6160a2c54 proper scala.collection.immutable;
wenzelm
parents: 73359
diff changeset
    14
import scala.collection.immutable.{SortedSet, SortedMap}
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
    15
import scala.collection.mutable
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
    16
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
    17
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
    18
object Sessions {
67284
0094d938c53b tuned signature;
wenzelm
parents: 67219
diff changeset
    19
  /* session and theory names */
62883
b04e9fe29223 clarified ML bootstrap;
wenzelm
parents: 62864
diff changeset
    20
72837
2c26c283f3ee PIDE support for session ROOTS;
wenzelm
parents: 72832
diff changeset
    21
  val ROOTS: Path = Path.explode("ROOTS")
72832
03803bbfdca3 tuned signature;
wenzelm
parents: 72816
diff changeset
    22
  val ROOT: Path = Path.explode("ROOT")
03803bbfdca3 tuned signature;
wenzelm
parents: 72816
diff changeset
    23
72837
2c26c283f3ee PIDE support for session ROOTS;
wenzelm
parents: 72832
diff changeset
    24
  val roots_name: String = "ROOTS"
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents: 67210
diff changeset
    25
  val root_name: String = "ROOT"
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents: 67210
diff changeset
    26
  val theory_name: String = "Pure.Sessions"
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents: 67210
diff changeset
    27
69762
58fb0d779583 support for session information via virtual file-system;
wenzelm
parents: 69671
diff changeset
    28
  val UNSORTED = "Unsorted"
65445
e9e7f5f5794c more qualifier treatment, but in the end it is still ignored;
wenzelm
parents: 65441
diff changeset
    29
  val DRAFT = "Draft"
e9e7f5f5794c more qualifier treatment, but in the end it is still ignored;
wenzelm
parents: 65441
diff changeset
    30
65360
wenzelm
parents: 65359
diff changeset
    31
  def is_pure(name: String): Boolean = name == Thy_Header.PURE
64856
5e9bf964510a clarified modules;
wenzelm
parents: 63996
diff changeset
    32
67284
0094d938c53b tuned signature;
wenzelm
parents: 67219
diff changeset
    33
0094d938c53b tuned signature;
wenzelm
parents: 67219
diff changeset
    34
  def exclude_session(name: String): Boolean = name == "" || name == DRAFT
0094d938c53b tuned signature;
wenzelm
parents: 67219
diff changeset
    35
67286
417e081322ae avoid clash with special files in HTML output;
wenzelm
parents: 67284
diff changeset
    36
  def exclude_theory(name: String): Boolean =
67290
98b6cd12f963 implicit thy_load context for bibtex files;
wenzelm
parents: 67286
diff changeset
    37
    name == root_name || name == "README" || name == "index" || name == "bib"
67284
0094d938c53b tuned signature;
wenzelm
parents: 67219
diff changeset
    38
0094d938c53b tuned signature;
wenzelm
parents: 67219
diff changeset
    39
72837
2c26c283f3ee PIDE support for session ROOTS;
wenzelm
parents: 72832
diff changeset
    40
  /* ROOTS file format */
2c26c283f3ee PIDE support for session ROOTS;
wenzelm
parents: 72832
diff changeset
    41
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
    42
  class File_Format extends isabelle.File_Format {
72837
2c26c283f3ee PIDE support for session ROOTS;
wenzelm
parents: 72832
diff changeset
    43
    val format_name: String = roots_name
2c26c283f3ee PIDE support for session ROOTS;
wenzelm
parents: 72832
diff changeset
    44
    val file_ext = ""
72839
a597300290de clarified File_Format.detect: needs to operate on full node name;
wenzelm
parents: 72837
diff changeset
    45
a597300290de clarified File_Format.detect: needs to operate on full node name;
wenzelm
parents: 72837
diff changeset
    46
    override def detect(name: String): Boolean =
a597300290de clarified File_Format.detect: needs to operate on full node name;
wenzelm
parents: 72837
diff changeset
    47
      Thy_Header.split_file_name(name) match {
a597300290de clarified File_Format.detect: needs to operate on full node name;
wenzelm
parents: 72837
diff changeset
    48
        case Some((_, file_name)) => file_name == roots_name
a597300290de clarified File_Format.detect: needs to operate on full node name;
wenzelm
parents: 72837
diff changeset
    49
        case None => false
a597300290de clarified File_Format.detect: needs to operate on full node name;
wenzelm
parents: 72837
diff changeset
    50
      }
72837
2c26c283f3ee PIDE support for session ROOTS;
wenzelm
parents: 72832
diff changeset
    51
2c26c283f3ee PIDE support for session ROOTS;
wenzelm
parents: 72832
diff changeset
    52
    override def theory_suffix: String = "ROOTS_file"
2c26c283f3ee PIDE support for session ROOTS;
wenzelm
parents: 72832
diff changeset
    53
    override def theory_content(name: String): String =
2c26c283f3ee PIDE support for session ROOTS;
wenzelm
parents: 72832
diff changeset
    54
      """theory "ROOTS" imports Pure begin ROOTS_file """ +
2c26c283f3ee PIDE support for session ROOTS;
wenzelm
parents: 72832
diff changeset
    55
        Outer_Syntax.quote_string(name) + """ end"""
2c26c283f3ee PIDE support for session ROOTS;
wenzelm
parents: 72832
diff changeset
    56
  }
2c26c283f3ee PIDE support for session ROOTS;
wenzelm
parents: 72832
diff changeset
    57
2c26c283f3ee PIDE support for session ROOTS;
wenzelm
parents: 72832
diff changeset
    58
67284
0094d938c53b tuned signature;
wenzelm
parents: 67219
diff changeset
    59
  /* base info and source dependencies */
0094d938c53b tuned signature;
wenzelm
parents: 67219
diff changeset
    60
65495
60d4fbed2b1f tuned signature;
wenzelm
parents: 65490
diff changeset
    61
  sealed case class Base(
66571
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
    62
    pos: Position.T = Position.none,
70681
a6c0f2d106c8 disallow overlapping session directories;
wenzelm
parents: 70679
diff changeset
    63
    session_directories: Map[JFile, String] = Map.empty,
65495
60d4fbed2b1f tuned signature;
wenzelm
parents: 65490
diff changeset
    64
    global_theories: Map[String, String] = Map.empty,
72323
e36f94e2eb6b some support for document preparation in Isabelle/Scala;
wenzelm
parents: 72068
diff changeset
    65
    session_theories: List[Document.Node.Name] = Nil,
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
    66
    document_theories: List[Document.Node.Name] = Nil,
66717
67dbf5cdc056 more informative loaded_theories: dependencies and syntax;
wenzelm
parents: 66716
diff changeset
    67
    loaded_theories: Graph[String, Outer_Syntax] = Graph.string,
70687
086575316fd5 eliminated pointless theory graph (reverting parts of a56eab490f4e): it caused problems with loaded vs. non-loaded node names, e.g. for theory Pure (see also 29bb1ebb188f);
wenzelm
parents: 70686
diff changeset
    68
    used_theories: List[(Document.Node.Name, Options)] = Nil,
72816
ea4f86914cb2 support for PIDE markup for auxiliary files ("blobs");
wenzelm
parents: 72799
diff changeset
    69
    load_commands: Map[Document.Node.Name, List[Command_Span.Span]] = Map.empty,
70740
525c18b8ed53 clarified data structures;
wenzelm
parents: 70739
diff changeset
    70
    known_theories: Map[String, Document.Node.Entry] = Map.empty,
525c18b8ed53 clarified data structures;
wenzelm
parents: 70739
diff changeset
    71
    known_loaded_files: Map[String, List[Path]] = Map.empty,
66720
b07192253605 tuned signature;
wenzelm
parents: 66719
diff changeset
    72
    overall_syntax: Outer_Syntax = Outer_Syntax.empty,
66744
fec1504e5f03 persistent storage of imported_sources;
wenzelm
parents: 66743
diff changeset
    73
    imported_sources: List[(Path, SHA1.Digest)] = Nil,
65495
60d4fbed2b1f tuned signature;
wenzelm
parents: 65490
diff changeset
    74
    sources: List[(Path, SHA1.Digest)] = Nil,
66822
4642cf4a7ebb tuned signature;
wenzelm
parents: 66819
diff changeset
    75
    session_graph_display: Graph_Display.Graph = Graph_Display.empty_graph,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
    76
    errors: List[String] = Nil
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
    77
  ) {
69102
4b06a20b13b5 tuned output -- avoid bombing of Scala toplevel, e.g. for AFP deps;
wenzelm
parents: 69080
diff changeset
    78
    override def toString: String =
4b06a20b13b5 tuned output -- avoid bombing of Scala toplevel, e.g. for AFP deps;
wenzelm
parents: 69080
diff changeset
    79
      "Sessions.Base(loaded_theories = " + loaded_theories.size +
4b06a20b13b5 tuned output -- avoid bombing of Scala toplevel, e.g. for AFP deps;
wenzelm
parents: 69080
diff changeset
    80
        ", used_theories = " + used_theories.length + ")"
4b06a20b13b5 tuned output -- avoid bombing of Scala toplevel, e.g. for AFP deps;
wenzelm
parents: 69080
diff changeset
    81
66967
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
    82
    def theory_qualifier(name: String): String =
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
    83
      global_theories.getOrElse(name, Long_Name.qualifier(name))
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
    84
    def theory_qualifier(name: Document.Node.Name): String = theory_qualifier(name.theory)
66966
f3f9a492bee6 clarified signature;
wenzelm
parents: 66965
diff changeset
    85
66717
67dbf5cdc056 more informative loaded_theories: dependencies and syntax;
wenzelm
parents: 66716
diff changeset
    86
    def loaded_theory(name: String): Boolean = loaded_theories.defined(name)
66712
4c98c929a12a session-qualified theory names are mandatory;
wenzelm
parents: 66701
diff changeset
    87
    def loaded_theory(name: Document.Node.Name): Boolean = loaded_theory(name.theory)
65432
wenzelm
parents: 65430
diff changeset
    88
66717
67dbf5cdc056 more informative loaded_theories: dependencies and syntax;
wenzelm
parents: 66716
diff changeset
    89
    def loaded_theory_syntax(name: String): Option[Outer_Syntax] =
67dbf5cdc056 more informative loaded_theories: dependencies and syntax;
wenzelm
parents: 66716
diff changeset
    90
      if (loaded_theory(name)) Some(loaded_theories.get_node(name)) else None
67dbf5cdc056 more informative loaded_theories: dependencies and syntax;
wenzelm
parents: 66716
diff changeset
    91
    def loaded_theory_syntax(name: Document.Node.Name): Option[Outer_Syntax] =
67dbf5cdc056 more informative loaded_theories: dependencies and syntax;
wenzelm
parents: 66716
diff changeset
    92
      loaded_theory_syntax(name.theory)
67dbf5cdc056 more informative loaded_theories: dependencies and syntax;
wenzelm
parents: 66716
diff changeset
    93
72669
5e7916535860 generate theory HTML in Isabelle/Scala;
wenzelm
parents: 72666
diff changeset
    94
    def theory_syntax(name: Document.Node.Name): Outer_Syntax =
5e7916535860 generate theory HTML in Isabelle/Scala;
wenzelm
parents: 72666
diff changeset
    95
      loaded_theory_syntax(name) getOrElse overall_syntax
5e7916535860 generate theory HTML in Isabelle/Scala;
wenzelm
parents: 72666
diff changeset
    96
66770
122df1fde073 clarified node_syntax (amending ae38b8c0fdd9): default to overall_syntax, e.g. relevant for command spans wrt. bad header;
wenzelm
parents: 66764
diff changeset
    97
    def node_syntax(nodes: Document.Nodes, name: Document.Node.Name): Outer_Syntax =
122df1fde073 clarified node_syntax (amending ae38b8c0fdd9): default to overall_syntax, e.g. relevant for command spans wrt. bad header;
wenzelm
parents: 66764
diff changeset
    98
      nodes(name).syntax orElse loaded_theory_syntax(name) getOrElse overall_syntax
65355
403eabd73c9a tuned signature;
wenzelm
parents: 65326
diff changeset
    99
  }
64856
5e9bf964510a clarified modules;
wenzelm
parents: 63996
diff changeset
   100
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   101
  sealed case class Deps(sessions_structure: Structure, session_bases: Map[String, Base]) {
69102
4b06a20b13b5 tuned output -- avoid bombing of Scala toplevel, e.g. for AFP deps;
wenzelm
parents: 69080
diff changeset
   102
    override def toString: String = "Sessions.Deps(" + sessions_structure + ")"
4b06a20b13b5 tuned output -- avoid bombing of Scala toplevel, e.g. for AFP deps;
wenzelm
parents: 69080
diff changeset
   103
65463
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   104
    def is_empty: Boolean = session_bases.isEmpty
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   105
    def apply(name: String): Base = session_bases(name)
66988
7f8c1dd7576a support alternative ancestor session;
wenzelm
parents: 66987
diff changeset
   106
    def get(name: String): Option[Base] = session_bases.get(name)
66744
fec1504e5f03 persistent storage of imported_sources;
wenzelm
parents: 66743
diff changeset
   107
fec1504e5f03 persistent storage of imported_sources;
wenzelm
parents: 66743
diff changeset
   108
    def imported_sources(name: String): List[SHA1.Digest] =
fec1504e5f03 persistent storage of imported_sources;
wenzelm
parents: 66743
diff changeset
   109
      session_bases(name).imported_sources.map(_._2)
fec1504e5f03 persistent storage of imported_sources;
wenzelm
parents: 66743
diff changeset
   110
fec1504e5f03 persistent storage of imported_sources;
wenzelm
parents: 66743
diff changeset
   111
    def sources(name: String): List[SHA1.Digest] =
fec1504e5f03 persistent storage of imported_sources;
wenzelm
parents: 66743
diff changeset
   112
      session_bases(name).sources.map(_._2)
66571
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
   113
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
   114
    def errors: List[String] =
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
   115
      (for {
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
   116
        (name, base) <- session_bases.iterator
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
   117
        if base.errors.nonEmpty
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
   118
      } yield cat_lines(base.errors) +
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
   119
          "\nThe error(s) above occurred in session " + quote(name) + Position.here(base.pos)
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
   120
      ).toList
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
   121
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
   122
    def check_errors: Deps =
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
   123
      errors match {
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
   124
        case Nil => this
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
   125
        case errs => error(cat_lines(errs))
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
   126
      }
65251
4b0a43afc3fb clarified modules;
wenzelm
parents: 64856
diff changeset
   127
  }
64856
5e9bf964510a clarified modules;
wenzelm
parents: 63996
diff changeset
   128
67052
caf87d4b9b61 tuned signature;
wenzelm
parents: 67029
diff changeset
   129
  def deps(sessions_structure: Structure,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   130
    progress: Progress = new Progress,
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   131
    inlined_files: Boolean = false,
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   132
    verbose: Boolean = false,
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   133
    list_files: Boolean = false,
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   134
    check_keywords: Set[String] = Set.empty
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   135
  ): Deps = {
66743
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   136
    var cache_sources = Map.empty[JFile, SHA1.Digest]
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   137
    def check_sources(paths: List[Path]): List[(Path, SHA1.Digest)] = {
66743
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   138
      for {
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   139
        path <- paths
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   140
        file = path.file
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   141
        if cache_sources.isDefinedAt(file) || file.isFile
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   142
      }
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   143
      yield {
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   144
        cache_sources.get(file) match {
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   145
          case Some(digest) => (path, digest)
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   146
          case None =>
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   147
            val digest = SHA1.digest(file)
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   148
            cache_sources = cache_sources + (file -> digest)
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   149
            (path, digest)
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   150
        }
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   151
      }
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   152
    }
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   153
65463
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   154
    val session_bases =
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   155
      sessions_structure.imports_topological_order.foldLeft(Map("" -> sessions_structure.bootstrap)) {
67023
e27e05d6f2a7 tuned signature;
wenzelm
parents: 67018
diff changeset
   156
        case (session_bases, session_name) =>
67880
e59220a075de tuned signature;
wenzelm
parents: 67869
diff changeset
   157
          progress.expose_interrupt()
65251
4b0a43afc3fb clarified modules;
wenzelm
parents: 64856
diff changeset
   158
67024
wenzelm
parents: 67023
diff changeset
   159
          val info = sessions_structure(session_name)
65463
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   160
          try {
72066
ba5b37671528 clarified signature;
wenzelm
parents: 72065
diff changeset
   161
            val deps_base = info.deps_base(session_bases)
ba5b37671528 clarified signature;
wenzelm
parents: 72065
diff changeset
   162
            val resources = new Resources(sessions_structure, deps_base)
65251
4b0a43afc3fb clarified modules;
wenzelm
parents: 64856
diff changeset
   163
65463
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   164
            if (verbose || list_files) {
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   165
              val groups =
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   166
                if (info.groups.isEmpty) ""
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   167
                else info.groups.mkString(" (", " ", ")")
72670
4db9411c859c tuned signature;
wenzelm
parents: 72669
diff changeset
   168
              progress.echo("Session " + info.chapter_session + groups)
65463
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   169
            }
65251
4b0a43afc3fb clarified modules;
wenzelm
parents: 64856
diff changeset
   170
69008
d55783ea6cf6 more detailed session dependencies, with conditions for theories;
wenzelm
parents: 68841
diff changeset
   171
            val dependencies = resources.session_dependencies(info)
65251
4b0a43afc3fb clarified modules;
wenzelm
parents: 64856
diff changeset
   172
67053
wenzelm
parents: 67052
diff changeset
   173
            val overall_syntax = dependencies.overall_syntax
65251
4b0a43afc3fb clarified modules;
wenzelm
parents: 64856
diff changeset
   174
72323
e36f94e2eb6b some support for document preparation in Isabelle/Scala;
wenzelm
parents: 72068
diff changeset
   175
            val session_theories =
72565
wenzelm
parents: 72375
diff changeset
   176
              dependencies.theories.filter(name => deps_base.theory_qualifier(name) == session_name)
72323
e36f94e2eb6b some support for document preparation in Isabelle/Scala;
wenzelm
parents: 72068
diff changeset
   177
67059
df7d728103f1 tuned signature;
wenzelm
parents: 67053
diff changeset
   178
            val theory_files = dependencies.theories.map(_.path)
72068
4768b1facec2 clarified errors: avoid hiding of import_errors/dir_errors by their consequences (file-access problems);
wenzelm
parents: 72067
diff changeset
   179
72816
ea4f86914cb2 support for PIDE markup for auxiliary files ("blobs");
wenzelm
parents: 72799
diff changeset
   180
            dependencies.load_commands
ea4f86914cb2 support for PIDE markup for auxiliary files ("blobs");
wenzelm
parents: 72799
diff changeset
   181
ea4f86914cb2 support for PIDE markup for auxiliary files ("blobs");
wenzelm
parents: 72799
diff changeset
   182
            val (load_commands, load_commands_errors) =
ea4f86914cb2 support for PIDE markup for auxiliary files ("blobs");
wenzelm
parents: 72799
diff changeset
   183
              try { if (inlined_files) (dependencies.load_commands, Nil) else (Nil, Nil) }
72068
4768b1facec2 clarified errors: avoid hiding of import_errors/dir_errors by their consequences (file-access problems);
wenzelm
parents: 72067
diff changeset
   184
              catch { case ERROR(msg) => (Nil, List(msg)) }
65251
4b0a43afc3fb clarified modules;
wenzelm
parents: 64856
diff changeset
   185
72816
ea4f86914cb2 support for PIDE markup for auxiliary files ("blobs");
wenzelm
parents: 72799
diff changeset
   186
            val loaded_files =
ea4f86914cb2 support for PIDE markup for auxiliary files ("blobs");
wenzelm
parents: 72799
diff changeset
   187
              load_commands.map({ case (name, spans) => dependencies.loaded_files(name, spans) })
ea4f86914cb2 support for PIDE markup for auxiliary files ("blobs");
wenzelm
parents: 72799
diff changeset
   188
66742
wenzelm
parents: 66737
diff changeset
   189
            val session_files =
66701
d181f8a0e857 maintain loaded_files for each theory;
wenzelm
parents: 66696
diff changeset
   190
              (theory_files ::: loaded_files.flatMap(_._2) :::
65463
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   191
                info.document_files.map(file => info.dir + file._1 + file._2)).map(_.expand)
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   192
67053
wenzelm
parents: 67052
diff changeset
   193
            val imported_files = if (inlined_files) dependencies.imported_files else Nil
66743
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   194
65463
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   195
            if (list_files)
66742
wenzelm
parents: 66737
diff changeset
   196
              progress.echo(cat_lines(session_files.map(_.implode).sorted.map("  " + _)))
65463
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   197
66719
d37efafd55b5 clarified theory syntax vs. overall session syntax;
wenzelm
parents: 66718
diff changeset
   198
            if (check_keywords.nonEmpty) {
d37efafd55b5 clarified theory syntax vs. overall session syntax;
wenzelm
parents: 66718
diff changeset
   199
              Check_Keywords.check_keywords(
66720
b07192253605 tuned signature;
wenzelm
parents: 66719
diff changeset
   200
                progress, overall_syntax.keywords, check_keywords, theory_files)
66719
d37efafd55b5 clarified theory syntax vs. overall session syntax;
wenzelm
parents: 66718
diff changeset
   201
            }
65251
4b0a43afc3fb clarified modules;
wenzelm
parents: 64856
diff changeset
   202
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   203
            val session_graph_display: Graph_Display.Graph = {
65507
decdb95bd007 clarified session graph: collapse theories from other sessions;
wenzelm
parents: 65500
diff changeset
   204
              def session_node(name: String): Graph_Display.Node =
decdb95bd007 clarified session graph: collapse theories from other sessions;
wenzelm
parents: 65500
diff changeset
   205
                Graph_Display.Node("[" + name + "]", "session." + name)
decdb95bd007 clarified session graph: collapse theories from other sessions;
wenzelm
parents: 65500
diff changeset
   206
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   207
              def node(name: Document.Node.Name): Graph_Display.Node = {
72066
ba5b37671528 clarified signature;
wenzelm
parents: 72065
diff changeset
   208
                val qualifier = deps_base.theory_qualifier(name)
66780
bf54ca580bf2 theory qualifier is always session name (see also 31e8a86971a8);
wenzelm
parents: 66770
diff changeset
   209
                if (qualifier == info.name)
65507
decdb95bd007 clarified session graph: collapse theories from other sessions;
wenzelm
parents: 65500
diff changeset
   210
                  Graph_Display.Node(name.theory_base_name, "theory." + name.theory)
65528
d15d302da7f0 proper theory_qualifier;
wenzelm
parents: 65525
diff changeset
   211
                else session_node(qualifier)
65507
decdb95bd007 clarified session graph: collapse theories from other sessions;
wenzelm
parents: 65500
diff changeset
   212
              }
decdb95bd007 clarified session graph: collapse theories from other sessions;
wenzelm
parents: 65500
diff changeset
   213
70946
79d23e6436d0 clarified session_graph_display: restrict sessions to actually required theories;
wenzelm
parents: 70869
diff changeset
   214
              val required_sessions =
79d23e6436d0 clarified session_graph_display: restrict sessions to actually required theories;
wenzelm
parents: 70869
diff changeset
   215
                dependencies.loaded_theories.all_preds(dependencies.theories.map(_.theory))
72066
ba5b37671528 clarified signature;
wenzelm
parents: 72065
diff changeset
   216
                  .map(theory => deps_base.theory_qualifier(theory))
71574
95460356d633 avoid premature crash due to missing session parents/imports;
wenzelm
parents: 71569
diff changeset
   217
                  .filter(name => name != info.name && sessions_structure.defined(name))
70946
79d23e6436d0 clarified session_graph_display: restrict sessions to actually required theories;
wenzelm
parents: 70869
diff changeset
   218
79d23e6436d0 clarified session_graph_display: restrict sessions to actually required theories;
wenzelm
parents: 70869
diff changeset
   219
              val required_subgraph =
79d23e6436d0 clarified session_graph_display: restrict sessions to actually required theories;
wenzelm
parents: 70869
diff changeset
   220
                sessions_structure.imports_graph
79d23e6436d0 clarified session_graph_display: restrict sessions to actually required theories;
wenzelm
parents: 70869
diff changeset
   221
                  .restrict(sessions_structure.imports_graph.all_preds(required_sessions).toSet)
79d23e6436d0 clarified session_graph_display: restrict sessions to actually required theories;
wenzelm
parents: 70869
diff changeset
   222
                  .transitive_closure
79d23e6436d0 clarified session_graph_display: restrict sessions to actually required theories;
wenzelm
parents: 70869
diff changeset
   223
                  .restrict(required_sessions.toSet)
79d23e6436d0 clarified session_graph_display: restrict sessions to actually required theories;
wenzelm
parents: 70869
diff changeset
   224
                  .transitive_reduction_acyclic
65507
decdb95bd007 clarified session graph: collapse theories from other sessions;
wenzelm
parents: 65500
diff changeset
   225
decdb95bd007 clarified session graph: collapse theories from other sessions;
wenzelm
parents: 65500
diff changeset
   226
              val graph0 =
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   227
                required_subgraph.topological_order.foldLeft(Graph_Display.empty_graph) {
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   228
                  case (g, session) =>
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   229
                    val a = session_node(session)
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   230
                    val bs = required_subgraph.imm_preds(session).toList.map(session_node)
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   231
                    bs.foldLeft((a :: bs).foldLeft(g)(_.default_node(_, Nil)))(_.add_edge(_, a))
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   232
                }
65507
decdb95bd007 clarified session graph: collapse theories from other sessions;
wenzelm
parents: 65500
diff changeset
   233
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   234
              dependencies.entries.foldLeft(graph0) {
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   235
                case (g, entry) =>
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   236
                  val a = node(entry.name)
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   237
                  val bs = entry.header.imports.map(node).filterNot(_ == a)
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   238
                  bs.foldLeft((a :: bs).foldLeft(g)(_.default_node(_, Nil)))(_.add_edge(_, a))
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   239
              }
65507
decdb95bd007 clarified session graph: collapse theories from other sessions;
wenzelm
parents: 65500
diff changeset
   240
            }
decdb95bd007 clarified session graph: collapse theories from other sessions;
wenzelm
parents: 65500
diff changeset
   241
70740
525c18b8ed53 clarified data structures;
wenzelm
parents: 70739
diff changeset
   242
            val known_theories =
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   243
              dependencies.entries.iterator.map(entry => entry.name.theory -> entry).
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   244
                foldLeft(deps_base.known_theories)(_ + _)
70740
525c18b8ed53 clarified data structures;
wenzelm
parents: 70739
diff changeset
   245
72066
ba5b37671528 clarified signature;
wenzelm
parents: 72065
diff changeset
   246
            val known_loaded_files = deps_base.known_loaded_files ++ loaded_files
66701
d181f8a0e857 maintain loaded_files for each theory;
wenzelm
parents: 66696
diff changeset
   247
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   248
            val import_errors = {
72067
17507b48b6f5 clarified errors: avoid accidental import from other session that happens to be within overall selection (notably "isabelle build -a");
wenzelm
parents: 72066
diff changeset
   249
              val known_sessions =
17507b48b6f5 clarified errors: avoid accidental import from other session that happens to be within overall selection (notably "isabelle build -a");
wenzelm
parents: 72066
diff changeset
   250
                sessions_structure.imports_requirements(List(session_name)).toSet
17507b48b6f5 clarified errors: avoid accidental import from other session that happens to be within overall selection (notably "isabelle build -a");
wenzelm
parents: 72066
diff changeset
   251
              for {
17507b48b6f5 clarified errors: avoid accidental import from other session that happens to be within overall selection (notably "isabelle build -a");
wenzelm
parents: 72066
diff changeset
   252
                name <- dependencies.theories
17507b48b6f5 clarified errors: avoid accidental import from other session that happens to be within overall selection (notably "isabelle build -a");
wenzelm
parents: 72066
diff changeset
   253
                qualifier = deps_base.theory_qualifier(name)
17507b48b6f5 clarified errors: avoid accidental import from other session that happens to be within overall selection (notably "isabelle build -a");
wenzelm
parents: 72066
diff changeset
   254
                if !known_sessions(qualifier)
17507b48b6f5 clarified errors: avoid accidental import from other session that happens to be within overall selection (notably "isabelle build -a");
wenzelm
parents: 72066
diff changeset
   255
              } yield "Bad import of theory " + quote(name.toString) +
17507b48b6f5 clarified errors: avoid accidental import from other session that happens to be within overall selection (notably "isabelle build -a");
wenzelm
parents: 72066
diff changeset
   256
                ": need to include sessions " + quote(qualifier) + " in ROOT"
17507b48b6f5 clarified errors: avoid accidental import from other session that happens to be within overall selection (notably "isabelle build -a");
wenzelm
parents: 72066
diff changeset
   257
            }
17507b48b6f5 clarified errors: avoid accidental import from other session that happens to be within overall selection (notably "isabelle build -a");
wenzelm
parents: 72066
diff changeset
   258
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   259
            val document_errors =
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   260
              info.document_theories.flatMap(
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   261
              {
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   262
                case (thy, pos) =>
74812
wenzelm
parents: 74810
diff changeset
   263
                  val build_hierarchy =
72647
fd6dc1a4b9ca more robust, e.g. for "isabelle build_doc system";
wenzelm
parents: 72634
diff changeset
   264
                    if (sessions_structure.build_graph.defined(session_name)) {
74812
wenzelm
parents: 74810
diff changeset
   265
                      sessions_structure.build_hierarchy(session_name)
72647
fd6dc1a4b9ca more robust, e.g. for "isabelle build_doc system";
wenzelm
parents: 72634
diff changeset
   266
                    }
fd6dc1a4b9ca more robust, e.g. for "isabelle build_doc system";
wenzelm
parents: 72634
diff changeset
   267
                    else Nil
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   268
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   269
                  def err(msg: String): Option[String] =
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   270
                    Some(msg + " " + quote(thy) + Position.here(pos))
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   271
72604
wenzelm
parents: 72603
diff changeset
   272
                  known_theories.get(thy).map(_.name) match {
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   273
                    case None => err("Unknown document theory")
72604
wenzelm
parents: 72603
diff changeset
   274
                    case Some(name) =>
wenzelm
parents: 72603
diff changeset
   275
                      val qualifier = deps_base.theory_qualifier(name)
wenzelm
parents: 72603
diff changeset
   276
                      if (session_theories.contains(name)) {
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   277
                        err("Redundant document theory from this session:")
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   278
                      }
74812
wenzelm
parents: 74810
diff changeset
   279
                      else if (build_hierarchy.contains(qualifier)) None
72604
wenzelm
parents: 72603
diff changeset
   280
                      else if (dependencies.theories.contains(name)) None
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   281
                      else err("Document theory from other session not imported properly:")
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   282
                  }
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   283
              })
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   284
            val document_theories =
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   285
              info.document_theories.map({ case (thy, _) => known_theories(thy).name })
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   286
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   287
            val dir_errors = {
70681
a6c0f2d106c8 disallow overlapping session directories;
wenzelm
parents: 70679
diff changeset
   288
              val ok = info.dirs.map(_.canonical_file).toSet
70679
7b6e6d61204a clarified messages;
wenzelm
parents: 70678
diff changeset
   289
              val bad =
7b6e6d61204a clarified messages;
wenzelm
parents: 70678
diff changeset
   290
                (for {
72565
wenzelm
parents: 72375
diff changeset
   291
                  name <- session_theories.iterator
70719
b3f61e166763 more errors;
wenzelm
parents: 70715
diff changeset
   292
                  path = name.master_dir_path
70676
73812c598a26 check session directories;
wenzelm
parents: 70674
diff changeset
   293
                  if !ok(path.canonical_file)
70679
7b6e6d61204a clarified messages;
wenzelm
parents: 70678
diff changeset
   294
                  path1 = File.relative_path(info.dir.canonical, path).getOrElse(path)
7b6e6d61204a clarified messages;
wenzelm
parents: 70678
diff changeset
   295
                } yield (path1, name)).toList
71602
wenzelm
parents: 71601
diff changeset
   296
              val bad_dirs = (for { (path1, _) <- bad } yield path1.toString).distinct.sorted
70679
7b6e6d61204a clarified messages;
wenzelm
parents: 70678
diff changeset
   297
7b6e6d61204a clarified messages;
wenzelm
parents: 70678
diff changeset
   298
              val errs1 =
7b6e6d61204a clarified messages;
wenzelm
parents: 70678
diff changeset
   299
                for { (path1, name) <- bad }
7b6e6d61204a clarified messages;
wenzelm
parents: 70678
diff changeset
   300
                yield "Implicit use of directory " + path1 + " for theory " + quote(name.toString)
7b6e6d61204a clarified messages;
wenzelm
parents: 70678
diff changeset
   301
              val errs2 =
7b6e6d61204a clarified messages;
wenzelm
parents: 70678
diff changeset
   302
                if (bad_dirs.isEmpty) Nil
7b6e6d61204a clarified messages;
wenzelm
parents: 70678
diff changeset
   303
                else List("Implicit use of session directories: " + commas(bad_dirs))
70693
0fec12eabad0 session directories need to exist;
wenzelm
parents: 70687
diff changeset
   304
              val errs3 = for (p <- info.dirs if !p.is_dir) yield "No such directory: " + p
70719
b3f61e166763 more errors;
wenzelm
parents: 70715
diff changeset
   305
              val errs4 =
b3f61e166763 more errors;
wenzelm
parents: 70715
diff changeset
   306
                (for {
72565
wenzelm
parents: 72375
diff changeset
   307
                  name <- session_theories.iterator
70719
b3f61e166763 more errors;
wenzelm
parents: 70715
diff changeset
   308
                  name1 <- resources.find_theory_node(name.theory)
b3f61e166763 more errors;
wenzelm
parents: 70715
diff changeset
   309
                  if name.node != name1.node
b3f61e166763 more errors;
wenzelm
parents: 70715
diff changeset
   310
                } yield "Incoherent theory file import:\n  " + name.path + " vs. \n  " + name1.path)
b3f61e166763 more errors;
wenzelm
parents: 70715
diff changeset
   311
                .toList
70693
0fec12eabad0 session directories need to exist;
wenzelm
parents: 70687
diff changeset
   312
70719
b3f61e166763 more errors;
wenzelm
parents: 70715
diff changeset
   313
              errs1 ::: errs2 ::: errs3 ::: errs4
70676
73812c598a26 check session directories;
wenzelm
parents: 70674
diff changeset
   314
            }
73812c598a26 check session directories;
wenzelm
parents: 70674
diff changeset
   315
66743
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   316
            val sources_errors =
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   317
              for (p <- session_files if !p.is_file) yield "No such file: " + p
66604
1af360d1cad2 tolerate more errors (cf. 1e5ae735e026);
wenzelm
parents: 66575
diff changeset
   318
69904
6f5bd59f75f4 more sanity checks;
wenzelm
parents: 69857
diff changeset
   319
            val path_errors =
6f5bd59f75f4 more sanity checks;
wenzelm
parents: 69857
diff changeset
   320
              try { Path.check_case_insensitive(session_files ::: imported_files); Nil }
6f5bd59f75f4 more sanity checks;
wenzelm
parents: 69857
diff changeset
   321
              catch { case ERROR(msg) => List(msg) }
6f5bd59f75f4 more sanity checks;
wenzelm
parents: 69857
diff changeset
   322
67297
86a099f896fc formal check of @{cite} bibtex entries -- only in batch-mode session builds;
wenzelm
parents: 67290
diff changeset
   323
            val bibtex_errors =
86a099f896fc formal check of @{cite} bibtex entries -- only in batch-mode session builds;
wenzelm
parents: 67290
diff changeset
   324
              try { info.bibtex_entries; Nil }
86a099f896fc formal check of @{cite} bibtex entries -- only in batch-mode session builds;
wenzelm
parents: 67290
diff changeset
   325
              catch { case ERROR(msg) => List(msg) }
86a099f896fc formal check of @{cite} bibtex entries -- only in batch-mode session builds;
wenzelm
parents: 67290
diff changeset
   326
65463
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   327
            val base =
66571
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
   328
              Base(
0fdeb24e535e clarified errors;
wenzelm
parents: 66243
diff changeset
   329
                pos = info.pos,
70673
b0172698d0d3 theory_name based on session_directories: no need for expensive all_known;
wenzelm
parents: 70672
diff changeset
   330
                session_directories = sessions_structure.session_directories,
70671
cb1776c8e216 clarified signature: retain global session information, unaffected by later restriction;
wenzelm
parents: 70668
diff changeset
   331
                global_theories = sessions_structure.global_theories,
72323
e36f94e2eb6b some support for document preparation in Isabelle/Scala;
wenzelm
parents: 72068
diff changeset
   332
                session_theories = session_theories,
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   333
                document_theories = document_theories,
67053
wenzelm
parents: 67052
diff changeset
   334
                loaded_theories = dependencies.loaded_theories,
72062
d0909b5d88eb tuned signature;
wenzelm
parents: 71971
diff changeset
   335
                used_theories = dependencies.theories_adjunct,
72816
ea4f86914cb2 support for PIDE markup for auxiliary files ("blobs");
wenzelm
parents: 72799
diff changeset
   336
                load_commands = load_commands.toMap,
70740
525c18b8ed53 clarified data structures;
wenzelm
parents: 70739
diff changeset
   337
                known_theories = known_theories,
525c18b8ed53 clarified data structures;
wenzelm
parents: 70739
diff changeset
   338
                known_loaded_files = known_loaded_files,
66720
b07192253605 tuned signature;
wenzelm
parents: 66719
diff changeset
   339
                overall_syntax = overall_syntax,
66744
fec1504e5f03 persistent storage of imported_sources;
wenzelm
parents: 66743
diff changeset
   340
                imported_sources = check_sources(imported_files),
66743
ff05d922bc34 cache sources: invoke SHA1.digest at most once;
wenzelm
parents: 66742
diff changeset
   341
                sources = check_sources(session_files),
66822
4642cf4a7ebb tuned signature;
wenzelm
parents: 66819
diff changeset
   342
                session_graph_display = session_graph_display,
72816
ea4f86914cb2 support for PIDE markup for auxiliary files ("blobs");
wenzelm
parents: 72799
diff changeset
   343
                errors = dependencies.errors ::: load_commands_errors ::: import_errors :::
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   344
                  document_errors ::: dir_errors ::: sources_errors ::: path_errors :::
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   345
                  bibtex_errors)
65251
4b0a43afc3fb clarified modules;
wenzelm
parents: 64856
diff changeset
   346
65519
d244d8f8e13f store Sessions.Info.name;
wenzelm
parents: 65517
diff changeset
   347
            session_bases + (info.name -> base)
65463
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   348
          }
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   349
          catch {
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   350
            case ERROR(msg) =>
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   351
              cat_error(msg, "The error(s) above occurred in session " +
65519
d244d8f8e13f store Sessions.Info.name;
wenzelm
parents: 65517
diff changeset
   352
                quote(info.name) + Position.here(info.pos))
65463
104502de757c more informative known_files: known_theories within the local session directory come first;
wenzelm
parents: 65461
diff changeset
   353
          }
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   354
      }
65251
4b0a43afc3fb clarified modules;
wenzelm
parents: 64856
diff changeset
   355
70686
9cde8c4ea5a5 discontinued obsolete "isabelle imports" and all_known data;
wenzelm
parents: 70685
diff changeset
   356
    Deps(sessions_structure, session_bases)
65372
b722ee40c26c refer to global_theories from all sessions, before selection;
wenzelm
parents: 65371
diff changeset
   357
  }
65251
4b0a43afc3fb clarified modules;
wenzelm
parents: 64856
diff changeset
   358
66963
1c3d0c12bb51 clarified signature;
wenzelm
parents: 66962
diff changeset
   359
1c3d0c12bb51 clarified signature;
wenzelm
parents: 66962
diff changeset
   360
  /* base info */
1c3d0c12bb51 clarified signature;
wenzelm
parents: 66962
diff changeset
   361
66974
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   362
  sealed case class Base_Info(
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   363
    session: String,
67052
caf87d4b9b61 tuned signature;
wenzelm
parents: 67029
diff changeset
   364
    sessions_structure: Structure,
66975
ca73d44d51aa do not store bulky Session.Deps;
wenzelm
parents: 66974
diff changeset
   365
    errors: List[String],
66974
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   366
    base: Base,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   367
    infos: List[Info]
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   368
  ) {
72627
8d83acc5062e clarified signature;
wenzelm
parents: 72626
diff changeset
   369
    def check: Base_Info = if (errors.isEmpty) this else error(cat_lines(errors))
66974
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   370
  }
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   371
67846
wenzelm
parents: 67493
diff changeset
   372
  def base_info(options: Options,
wenzelm
parents: 67493
diff changeset
   373
    session: String,
71726
a5fda30edae2 clarified signature: more uniform treatment of stopped/interrupted state;
wenzelm
parents: 71642
diff changeset
   374
    progress: Progress = new Progress,
65428
f8dd71a0791a support for all_known_theories of all sessions;
wenzelm
parents: 65427
diff changeset
   375
    dirs: List[Path] = Nil,
67922
9e668ae81f97 clarified signature: prefer selective include_sessions;
wenzelm
parents: 67880
diff changeset
   376
    include_sessions: List[String] = Nil,
68370
bcdc47c9d4af clarified signature;
wenzelm
parents: 68318
diff changeset
   377
    session_ancestor: Option[String] = None,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   378
    session_requirements: Boolean = false
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   379
  ): Base_Info = {
67026
687c822ee5e3 tuned signature;
wenzelm
parents: 67025
diff changeset
   380
    val full_sessions = load_structure(options, dirs = dirs)
65372
b722ee40c26c refer to global_theories from all sessions, before selection;
wenzelm
parents: 65371
diff changeset
   381
66990
b23adab22e67 allow unrelated ancestor;
wenzelm
parents: 66988
diff changeset
   382
    val selected_sessions =
68370
bcdc47c9d4af clarified signature;
wenzelm
parents: 68318
diff changeset
   383
      full_sessions.selection(Selection(sessions = session :: session_ancestor.toList))
66974
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   384
    val info = selected_sessions(session)
68370
bcdc47c9d4af clarified signature;
wenzelm
parents: 68318
diff changeset
   385
    val ancestor = session_ancestor orElse info.parent
66963
1c3d0c12bb51 clarified signature;
wenzelm
parents: 66962
diff changeset
   386
66974
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   387
    val (session1, infos1) =
68370
bcdc47c9d4af clarified signature;
wenzelm
parents: 68318
diff changeset
   388
      if (session_requirements && ancestor.isDefined) {
70671
cb1776c8e216 clarified signature: retain global session information, unaffected by later restriction;
wenzelm
parents: 70668
diff changeset
   389
        val deps = Sessions.deps(selected_sessions, progress = progress)
66974
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   390
        val base = deps(session)
66968
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   391
66988
7f8c1dd7576a support alternative ancestor session;
wenzelm
parents: 66987
diff changeset
   392
        val ancestor_loaded =
7f8c1dd7576a support alternative ancestor session;
wenzelm
parents: 66987
diff changeset
   393
          deps.get(ancestor.get) match {
66990
b23adab22e67 allow unrelated ancestor;
wenzelm
parents: 66988
diff changeset
   394
            case Some(ancestor_base)
b23adab22e67 allow unrelated ancestor;
wenzelm
parents: 66988
diff changeset
   395
            if !selected_sessions.imports_requirements(List(ancestor.get)).contains(session) =>
71601
97ccf48c2f0c misc tuning based on hints by IntelliJ IDEA;
wenzelm
parents: 71599
diff changeset
   396
              ancestor_base.loaded_theories.defined _
66990
b23adab22e67 allow unrelated ancestor;
wenzelm
parents: 66988
diff changeset
   397
            case _ =>
66988
7f8c1dd7576a support alternative ancestor session;
wenzelm
parents: 66987
diff changeset
   398
              error("Bad ancestor " + quote(ancestor.get) + " for session " + quote(session))
7f8c1dd7576a support alternative ancestor session;
wenzelm
parents: 66987
diff changeset
   399
          }
66974
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   400
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   401
        val required_theories =
66968
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   402
          for {
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   403
            thy <- base.loaded_theories.keys
66988
7f8c1dd7576a support alternative ancestor session;
wenzelm
parents: 66987
diff changeset
   404
            if !ancestor_loaded(thy) && base.theory_qualifier(thy) != session
66968
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   405
          }
66974
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   406
          yield thy
66968
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   407
66988
7f8c1dd7576a support alternative ancestor session;
wenzelm
parents: 66987
diff changeset
   408
        if (required_theories.isEmpty) (ancestor.get, Nil)
66968
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   409
        else {
68370
bcdc47c9d4af clarified signature;
wenzelm
parents: 68318
diff changeset
   410
          val other_name = info.name + "_requirements(" + ancestor.get + ")"
71569
391ea80ff27c more robust re-use of $ISABELLE_TMP_PREFIX (amending c1597167563e);
wenzelm
parents: 70946
diff changeset
   411
          Isabelle_System.isabelle_tmp_prefix()
391ea80ff27c more robust re-use of $ISABELLE_TMP_PREFIX (amending c1597167563e);
wenzelm
parents: 70946
diff changeset
   412
66974
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   413
          (other_name,
66968
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   414
            List(
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   415
              make_info(info.options,
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   416
                dir_selected = false,
70685
c1597167563e avoid duplicate directories wrt. synthetic session;
wenzelm
parents: 70684
diff changeset
   417
                dir = Path.explode("$ISABELLE_TMP_PREFIX"),
66968
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   418
                chapter = info.chapter,
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   419
                Session_Entry(
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   420
                  pos = info.pos,
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   421
                  name = other_name,
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   422
                  groups = info.groups,
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   423
                  path = ".",
66988
7f8c1dd7576a support alternative ancestor session;
wenzelm
parents: 66987
diff changeset
   424
                  parent = ancestor,
66974
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   425
                  description = "Required theory imports from other sessions",
66968
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   426
                  options = Nil,
66991
fc87d3becd69 proper deps;
wenzelm
parents: 66990
diff changeset
   427
                  imports = info.deps,
70678
36c8c32346cb clarified syntax: 'directories' and 'theories' belong together;
wenzelm
parents: 70676
diff changeset
   428
                  directories = Nil,
66974
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   429
                  theories = List((Nil, required_theories.map(thy => ((thy, Position.none), false)))),
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   430
                  document_theories = Nil,
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68221
diff changeset
   431
                  document_files = Nil,
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68221
diff changeset
   432
                  export_files = Nil))))
66968
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   433
        }
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   434
      }
66974
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   435
      else (session, Nil)
66968
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
   436
66974
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   437
    val full_sessions1 =
b14c24b31f45 avoid duplicate invocation of expensive Sessions.deps on full_sessions;
wenzelm
parents: 66970
diff changeset
   438
      if (infos1.isEmpty) full_sessions
67026
687c822ee5e3 tuned signature;
wenzelm
parents: 67025
diff changeset
   439
      else load_structure(options, dirs = dirs, infos = infos1)
66987
352b23c97ac8 support focus_session, for much faster startup of Isabelle/jEdit;
wenzelm
parents: 66984
diff changeset
   440
352b23c97ac8 support focus_session, for much faster startup of Isabelle/jEdit;
wenzelm
parents: 66984
diff changeset
   441
    val selected_sessions1 =
70683
8c7706b053c7 find theory files via session structure: much faster Prover IDE startup;
wenzelm
parents: 70681
diff changeset
   442
      full_sessions1.selection(Selection(sessions = session1 :: session :: include_sessions))
66964
9f2de457b95e clarified signature;
wenzelm
parents: 66963
diff changeset
   443
70683
8c7706b053c7 find theory files via session structure: much faster Prover IDE startup;
wenzelm
parents: 70681
diff changeset
   444
    val deps1 = Sessions.deps(selected_sessions1, progress = progress)
66964
9f2de457b95e clarified signature;
wenzelm
parents: 66963
diff changeset
   445
71599
23d0a45a9283 clarified signature;
wenzelm
parents: 71595
diff changeset
   446
    Base_Info(session1, full_sessions1, deps1.errors, deps1(session1), infos1)
65251
4b0a43afc3fb clarified modules;
wenzelm
parents: 64856
diff changeset
   447
  }
4b0a43afc3fb clarified modules;
wenzelm
parents: 64856
diff changeset
   448
4b0a43afc3fb clarified modules;
wenzelm
parents: 64856
diff changeset
   449
65415
8cd54b18b68b clarified signature: tree structure is not essential;
wenzelm
parents: 65410
diff changeset
   450
  /* cumulative session info */
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   451
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   452
  sealed case class Info(
65519
d244d8f8e13f store Sessions.Info.name;
wenzelm
parents: 65517
diff changeset
   453
    name: String,
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   454
    chapter: String,
66829
5baca4c94737 tuned signature;
wenzelm
parents: 66828
diff changeset
   455
    dir_selected: Boolean,
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   456
    pos: Position.T,
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   457
    groups: List[String],
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   458
    dir: Path,
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   459
    parent: Option[String],
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   460
    description: String,
70681
a6c0f2d106c8 disallow overlapping session directories;
wenzelm
parents: 70679
diff changeset
   461
    directories: List[Path],
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   462
    options: Options,
65420
695d4e22345a support for static session imports, without affect build hierarchy;
wenzelm
parents: 65419
diff changeset
   463
    imports: List[String],
65517
1544e61e5314 more position information;
wenzelm
parents: 65507
diff changeset
   464
    theories: List[(Options, List[(String, Position.T)])],
65374
a5b38d8d3c1e tuned syntax;
wenzelm
parents: 65373
diff changeset
   465
    global_theories: List[String],
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   466
    document_theories: List[(String, Position.T)],
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   467
    document_files: List[(Path, Path)],
69671
2486792eaf61 support pruning of export names;
wenzelm
parents: 69560
diff changeset
   468
    export_files: List[(Path, Int, List[String])],
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   469
    meta_digest: SHA1.Digest
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   470
  ) {
72670
4db9411c859c tuned signature;
wenzelm
parents: 72669
diff changeset
   471
    def chapter_session: String = chapter + "/" + name
4db9411c859c tuned signature;
wenzelm
parents: 72669
diff changeset
   472
73042
22f5a6283477 tuned signature;
wenzelm
parents: 73033
diff changeset
   473
    def relative_path(info1: Info): String =
22f5a6283477 tuned signature;
wenzelm
parents: 73033
diff changeset
   474
      if (name == info1.name) ""
22f5a6283477 tuned signature;
wenzelm
parents: 73033
diff changeset
   475
      else if (chapter == info1.chapter) "../" + info1.name + "/"
22f5a6283477 tuned signature;
wenzelm
parents: 73033
diff changeset
   476
      else "../../" + info1.chapter_session + "/"
22f5a6283477 tuned signature;
wenzelm
parents: 73033
diff changeset
   477
66828
3c936ebebc23 tuned signature;
wenzelm
parents: 66823
diff changeset
   478
    def deps: List[String] = parent.toList ::: imports
3c936ebebc23 tuned signature;
wenzelm
parents: 66823
diff changeset
   479
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   480
    def deps_base(session_bases: String => Base): Base = {
72066
ba5b37671528 clarified signature;
wenzelm
parents: 72065
diff changeset
   481
      val parent_base = session_bases(parent.getOrElse(""))
ba5b37671528 clarified signature;
wenzelm
parents: 72065
diff changeset
   482
      val imports_bases = imports.map(session_bases)
ba5b37671528 clarified signature;
wenzelm
parents: 72065
diff changeset
   483
      parent_base.copy(
ba5b37671528 clarified signature;
wenzelm
parents: 72065
diff changeset
   484
        known_theories =
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   485
          (for {
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   486
            base <- imports_bases.iterator
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   487
            (_, entry) <- base.known_theories.iterator
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   488
          } yield (entry.name.theory -> entry)).foldLeft(parent_base.known_theories)(_ + _),
72066
ba5b37671528 clarified signature;
wenzelm
parents: 72065
diff changeset
   489
        known_loaded_files =
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   490
          imports_bases.iterator.map(_.known_loaded_files).
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   491
            foldLeft(parent_base.known_loaded_files)(_ ++ _))
72066
ba5b37671528 clarified signature;
wenzelm
parents: 72065
diff changeset
   492
    }
ba5b37671528 clarified signature;
wenzelm
parents: 72065
diff changeset
   493
70681
a6c0f2d106c8 disallow overlapping session directories;
wenzelm
parents: 70679
diff changeset
   494
    def dirs: List[Path] = dir :: directories
70668
9cac4dec0da9 support for explicit session directories;
wenzelm
parents: 70650
diff changeset
   495
73701
d83e7e444b43 ignore session build timeout, notably in AFP;
wenzelm
parents: 73700
diff changeset
   496
    def timeout_ignored: Boolean =
d83e7e444b43 ignore session build timeout, notably in AFP;
wenzelm
parents: 73700
diff changeset
   497
      !options.bool("timeout_build") || Time.seconds(options.real("timeout")) < Time.ms(1)
d83e7e444b43 ignore session build timeout, notably in AFP;
wenzelm
parents: 73700
diff changeset
   498
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   499
    def timeout: Time = Time.seconds(options.real("timeout") * options.real("timeout_scale"))
67297
86a099f896fc formal check of @{cite} bibtex entries -- only in batch-mode session builds;
wenzelm
parents: 67290
diff changeset
   500
72574
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   501
    def document_enabled: Boolean =
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   502
      options.string("document") match {
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   503
        case "" | "false" => false
73826
72900f34dbb3 allow system option short form NAME for NAME=true for type string, not just bool;
wenzelm
parents: 73815
diff changeset
   504
        case "pdf" | "true" => true
72574
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   505
        case doc => error("Bad document specification " + quote(doc))
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   506
      }
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   507
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   508
    def document_variants: List[Document_Build.Document_Variant] = {
72574
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   509
      val variants =
72649
4ba5b1b08dd5 clarified signature: more explicit types;
wenzelm
parents: 72648
diff changeset
   510
        Library.space_explode(':', options.string("document_variants")).
73718
ecb31c3bf980 clarified modules;
wenzelm
parents: 73701
diff changeset
   511
          map(Document_Build.Document_Variant.parse)
72649
4ba5b1b08dd5 clarified signature: more explicit types;
wenzelm
parents: 72648
diff changeset
   512
4ba5b1b08dd5 clarified signature: more explicit types;
wenzelm
parents: 72648
diff changeset
   513
      val dups = Library.duplicates(variants.map(_.name))
72574
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   514
      if (dups.nonEmpty) error("Duplicate document variants: " + commas_quote(dups))
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   515
72649
4ba5b1b08dd5 clarified signature: more explicit types;
wenzelm
parents: 72648
diff changeset
   516
      variants
4ba5b1b08dd5 clarified signature: more explicit types;
wenzelm
parents: 72648
diff changeset
   517
    }
4ba5b1b08dd5 clarified signature: more explicit types;
wenzelm
parents: 72648
diff changeset
   518
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   519
    def documents: List[Document_Build.Document_Variant] = {
72672
573ccec4dbac tuned signature;
wenzelm
parents: 72670
diff changeset
   520
      val variants = document_variants
72574
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   521
      if (!document_enabled || document_files.isEmpty) Nil else variants
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   522
    }
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   523
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   524
    def document_output: Option[Path] =
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   525
      options.string("document_output") match {
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   526
        case "" => None
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   527
        case s => Some(dir + Path.explode(s))
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   528
      }
d892f6d66402 build documents in Isabelle/Scala, based on generated tex files as session exports;
wenzelm
parents: 72571
diff changeset
   529
72648
1cbac4ae934d more explicit presentation directory;
wenzelm
parents: 72647
diff changeset
   530
    def browser_info: Boolean = options.bool("browser_info")
1cbac4ae934d more explicit presentation directory;
wenzelm
parents: 72647
diff changeset
   531
72613
d01ea9e3bd2d clarified bibtex_entries: refer to overall session structure;
wenzelm
parents: 72604
diff changeset
   532
    lazy val bibtex_entries: List[Text.Info[String]] =
67297
86a099f896fc formal check of @{cite} bibtex entries -- only in batch-mode session builds;
wenzelm
parents: 67290
diff changeset
   533
      (for {
86a099f896fc formal check of @{cite} bibtex entries -- only in batch-mode session builds;
wenzelm
parents: 67290
diff changeset
   534
        (document_dir, file) <- document_files.iterator
69366
b6dacf6eabe3 clarified signature;
wenzelm
parents: 69255
diff changeset
   535
        if Bibtex.is_bibtex(file.file_name)
67297
86a099f896fc formal check of @{cite} bibtex entries -- only in batch-mode session builds;
wenzelm
parents: 67290
diff changeset
   536
        info <- Bibtex.entries(File.read(dir + document_dir + file)).iterator
86a099f896fc formal check of @{cite} bibtex entries -- only in batch-mode session builds;
wenzelm
parents: 67290
diff changeset
   537
      } yield info).toList
70859
6e6254bbce1f split into standard partitions, for improved scalability;
wenzelm
parents: 70796
diff changeset
   538
70869
1d063b7f7928 incorporate sessions with record_proofs;
wenzelm
parents: 70867
diff changeset
   539
    def record_proofs: Boolean = options.int("record_proofs") >= 2
1d063b7f7928 incorporate sessions with record_proofs;
wenzelm
parents: 70867
diff changeset
   540
70859
6e6254bbce1f split into standard partitions, for improved scalability;
wenzelm
parents: 70796
diff changeset
   541
    def is_afp: Boolean = chapter == AFP.chapter
6e6254bbce1f split into standard partitions, for improved scalability;
wenzelm
parents: 70796
diff changeset
   542
    def is_afp_bulky: Boolean = is_afp && groups.exists(AFP.groups_bulky.contains)
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   543
  }
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   544
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   545
  def make_info(
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   546
    options: Options,
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   547
    dir_selected: Boolean,
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   548
    dir: Path,
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   549
    chapter: String,
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   550
    entry: Session_Entry
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   551
  ): Info = {
66967
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   552
    try {
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   553
      val name = entry.name
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   554
67284
0094d938c53b tuned signature;
wenzelm
parents: 67219
diff changeset
   555
      if (exclude_session(name)) error("Bad session name")
66967
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   556
      if (is_pure(name) && entry.parent.isDefined) error("Illegal parent session")
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   557
      if (!is_pure(name) && !entry.parent.isDefined) error("Missing parent session")
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   558
70672
e4bba654d085 clarified session_directories: relative to session_path, with overlapping information;
wenzelm
parents: 70671
diff changeset
   559
      val session_path = dir + Path.explode(entry.path)
70681
a6c0f2d106c8 disallow overlapping session directories;
wenzelm
parents: 70679
diff changeset
   560
      val directories = entry.directories.map(dir => session_path + Path.explode(dir))
70668
9cac4dec0da9 support for explicit session directories;
wenzelm
parents: 70650
diff changeset
   561
66967
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   562
      val session_options = options ++ entry.options
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   563
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   564
      val theories =
67216
99815211970c disallow theory name "ROOT";
wenzelm
parents: 67215
diff changeset
   565
        entry.theories.map({ case (opts, thys) =>
99815211970c disallow theory name "ROOT";
wenzelm
parents: 67215
diff changeset
   566
          (session_options ++ opts,
99815211970c disallow theory name "ROOT";
wenzelm
parents: 67215
diff changeset
   567
            thys.map({ case ((thy, pos), _) =>
67284
0094d938c53b tuned signature;
wenzelm
parents: 67219
diff changeset
   568
              if (exclude_theory(thy))
67216
99815211970c disallow theory name "ROOT";
wenzelm
parents: 67215
diff changeset
   569
                error("Bad theory name " + quote(thy) + Position.here(pos))
99815211970c disallow theory name "ROOT";
wenzelm
parents: 67215
diff changeset
   570
              else (thy, pos) })) })
66967
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   571
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   572
      val global_theories =
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   573
        for { (_, thys) <- entry.theories; ((thy, pos), global) <- thys if global }
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   574
        yield {
69366
b6dacf6eabe3 clarified signature;
wenzelm
parents: 69255
diff changeset
   575
          val thy_name = Path.explode(thy).file_name
66967
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   576
          if (Long_Name.is_qualified(thy_name))
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   577
            error("Bad qualified name for global theory " +
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   578
              quote(thy_name) + Position.here(pos))
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   579
          else thy_name
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   580
        }
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   581
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   582
      val conditions =
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   583
        theories.flatMap(thys => space_explode(',', thys._1.string("condition"))).distinct.sorted.
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   584
          map(x => (x, Isabelle_System.getenv(x) != ""))
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   585
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   586
      val document_files =
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   587
        entry.document_files.map({ case (s1, s2) => (Path.explode(s1), Path.explode(s2)) })
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   588
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68221
diff changeset
   589
      val export_files =
69671
2486792eaf61 support pruning of export names;
wenzelm
parents: 69560
diff changeset
   590
        entry.export_files.map({ case (dir, prune, pats) => (Path.explode(dir), prune, pats) })
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68221
diff changeset
   591
66967
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   592
      val meta_digest =
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   593
        SHA1.digest(
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   594
          (name, chapter, entry.parent, entry.directories, entry.options, entry.imports,
72666
945cee776e79 proper meta_digest: avoid non-portable position information;
wenzelm
parents: 72653
diff changeset
   595
            entry.theories_no_position, conditions, entry.document_theories_no_position,
945cee776e79 proper meta_digest: avoid non-portable position information;
wenzelm
parents: 72653
diff changeset
   596
            entry.document_files)
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   597
          .toString)
66967
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   598
70672
e4bba654d085 clarified session_directories: relative to session_path, with overlapping information;
wenzelm
parents: 70671
diff changeset
   599
      Info(name, chapter, dir_selected, entry.pos, entry.groups, session_path,
70668
9cac4dec0da9 support for explicit session directories;
wenzelm
parents: 70650
diff changeset
   600
        entry.parent, entry.description, directories, session_options,
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   601
        entry.imports, theories, global_theories, entry.document_theories, document_files,
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   602
        export_files, meta_digest)
66967
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   603
    }
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   604
    catch {
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   605
      case ERROR(msg) =>
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   606
        error(msg + "\nThe error(s) above occurred in session entry " +
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   607
          quote(entry.name) + Position.here(entry.pos))
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   608
    }
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   609
  }
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   610
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   611
  object Selection {
65422
b606c98e6d10 tuned signature;
wenzelm
parents: 65420
diff changeset
   612
    val empty: Selection = Selection()
65525
360063716c71 more operations;
wenzelm
parents: 65524
diff changeset
   613
    val all: Selection = Selection(all_sessions = true)
70788
b254a95b6e77 tuned signature;
wenzelm
parents: 70740
diff changeset
   614
    def session(session: String): Selection = Selection(sessions = List(session))
65419
457e4fbed731 explicit Sessions.Selection;
wenzelm
parents: 65415
diff changeset
   615
  }
457e4fbed731 explicit Sessions.Selection;
wenzelm
parents: 65415
diff changeset
   616
457e4fbed731 explicit Sessions.Selection;
wenzelm
parents: 65415
diff changeset
   617
  sealed case class Selection(
457e4fbed731 explicit Sessions.Selection;
wenzelm
parents: 65415
diff changeset
   618
    requirements: Boolean = false,
457e4fbed731 explicit Sessions.Selection;
wenzelm
parents: 65415
diff changeset
   619
    all_sessions: Boolean = false,
66737
2edc0c42c883 option -B for "isabelle build" and "isabelle imports";
wenzelm
parents: 66736
diff changeset
   620
    base_sessions: List[String] = Nil,
65419
457e4fbed731 explicit Sessions.Selection;
wenzelm
parents: 65415
diff changeset
   621
    exclude_session_groups: List[String] = Nil,
457e4fbed731 explicit Sessions.Selection;
wenzelm
parents: 65415
diff changeset
   622
    exclude_sessions: List[String] = Nil,
457e4fbed731 explicit Sessions.Selection;
wenzelm
parents: 65415
diff changeset
   623
    session_groups: List[String] = Nil,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   624
    sessions: List[String] = Nil
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   625
  ) {
66736
148891036469 more standard merge operation;
wenzelm
parents: 66722
diff changeset
   626
    def ++ (other: Selection): Selection =
65422
b606c98e6d10 tuned signature;
wenzelm
parents: 65420
diff changeset
   627
      Selection(
b606c98e6d10 tuned signature;
wenzelm
parents: 65420
diff changeset
   628
        requirements = requirements || other.requirements,
b606c98e6d10 tuned signature;
wenzelm
parents: 65420
diff changeset
   629
        all_sessions = all_sessions || other.all_sessions,
66737
2edc0c42c883 option -B for "isabelle build" and "isabelle imports";
wenzelm
parents: 66736
diff changeset
   630
        base_sessions = Library.merge(base_sessions, other.base_sessions),
66736
148891036469 more standard merge operation;
wenzelm
parents: 66722
diff changeset
   631
        exclude_session_groups = Library.merge(exclude_session_groups, other.exclude_session_groups),
148891036469 more standard merge operation;
wenzelm
parents: 66722
diff changeset
   632
        exclude_sessions = Library.merge(exclude_sessions, other.exclude_sessions),
148891036469 more standard merge operation;
wenzelm
parents: 66722
diff changeset
   633
        session_groups = Library.merge(session_groups, other.session_groups),
148891036469 more standard merge operation;
wenzelm
parents: 66722
diff changeset
   634
        sessions = Library.merge(sessions, other.sessions))
65419
457e4fbed731 explicit Sessions.Selection;
wenzelm
parents: 65415
diff changeset
   635
  }
457e4fbed731 explicit Sessions.Selection;
wenzelm
parents: 65415
diff changeset
   636
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   637
  object Structure {
72858
cb0c407fbc6e added "isabelle log": print messages from build database;
wenzelm
parents: 72855
diff changeset
   638
    val empty: Structure = make(Nil)
cb0c407fbc6e added "isabelle log": print messages from build database;
wenzelm
parents: 72855
diff changeset
   639
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   640
    def make(infos: List[Info]): Structure = {
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   641
      def add_edges(
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   642
        graph: Graph[String, Info],
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   643
        kind: String,
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   644
        edges: Info => Iterable[String]
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   645
      ) : Graph[String, Info] = {
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   646
        def add_edge(pos: Position.T, name: String, g: Graph[String, Info], parent: String) = {
72855
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   647
          if (!g.defined(parent))
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   648
            error("Bad " + kind + " session " + quote(parent) + " for " +
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   649
              quote(name) + Position.here(pos))
65420
695d4e22345a support for static session imports, without affect build hierarchy;
wenzelm
parents: 65419
diff changeset
   650
72855
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   651
          try { g.add_edge_acyclic(parent, name) }
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   652
          catch {
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   653
            case exn: Graph.Cycles[_] =>
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   654
              error(cat_lines(exn.cycles.map(cycle =>
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   655
                "Cyclic session dependency of " +
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   656
                  cycle.map(c => quote(c.toString)).mkString(" via "))) + Position.here(pos))
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   657
          }
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   658
        }
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   659
        graph.iterator.foldLeft(graph) {
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   660
          case (g, (name, (info, _))) =>
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   661
            edges(info).foldLeft(g)(add_edge(info.pos, name, _, _))
65420
695d4e22345a support for static session imports, without affect build hierarchy;
wenzelm
parents: 65419
diff changeset
   662
        }
695d4e22345a support for static session imports, without affect build hierarchy;
wenzelm
parents: 65419
diff changeset
   663
      }
695d4e22345a support for static session imports, without affect build hierarchy;
wenzelm
parents: 65419
diff changeset
   664
72855
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   665
      val info_graph =
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   666
        infos.foldLeft(Graph.string[Info]) {
72855
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   667
          case (graph, info) =>
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   668
            if (graph.defined(info.name))
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   669
              error("Duplicate session " + quote(info.name) + Position.here(info.pos) +
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   670
                Position.here(graph.get_node(info.name).pos))
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   671
            else graph.new_node(info.name, info)
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   672
        }
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   673
      val build_graph = add_edges(info_graph, "parent", _.parent)
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   674
      val imports_graph = add_edges(build_graph, "imports", _.imports)
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   675
72855
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   676
      val session_positions: List[(String, Position.T)] =
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   677
        (for ((name, (info, _)) <- info_graph.iterator) yield (name, info.pos)).toList
70683
8c7706b053c7 find theory files via session structure: much faster Prover IDE startup;
wenzelm
parents: 70681
diff changeset
   678
72855
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   679
      val session_directories: Map[JFile, String] =
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   680
        (for {
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   681
          session <- imports_graph.topological_order.iterator
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   682
          info = info_graph.get_node(session)
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   683
          dir <- info.dirs.iterator
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   684
        } yield (info, dir)).foldLeft(Map.empty[JFile, String]) {
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   685
            case (dirs, (info, dir)) =>
72855
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   686
              val session = info.name
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   687
              val canonical_dir = dir.canonical_file
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   688
              dirs.get(canonical_dir) match {
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   689
                case Some(session1) =>
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   690
                  val info1 = info_graph.get_node(session1)
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   691
                  error("Duplicate use of directory " + dir +
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   692
                    "\n  for session " + quote(session1) + Position.here(info1.pos) +
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   693
                    "\n  vs. session " + quote(session) + Position.here(info.pos))
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   694
                case None => dirs + (canonical_dir -> session)
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   695
              }
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   696
          }
70671
cb1776c8e216 clarified signature: retain global session information, unaffected by later restriction;
wenzelm
parents: 70668
diff changeset
   697
72855
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   698
      val global_theories: Map[String, String] =
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   699
        (for {
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   700
          session <- imports_graph.topological_order.iterator
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   701
          info = info_graph.get_node(session)
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   702
          thy <- info.global_theories.iterator }
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   703
          yield (info, thy)).foldLeft(Thy_Header.bootstrap_global_theories.toMap) {
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   704
            case (global, (info, thy)) =>
72855
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   705
              val qualifier = info.name
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   706
              global.get(thy) match {
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   707
                case Some(qualifier1) if qualifier != qualifier1 =>
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   708
                  error("Duplicate global theory " + quote(thy) + Position.here(info.pos))
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   709
                case _ => global + (thy -> qualifier)
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   710
              }
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   711
          }
70671
cb1776c8e216 clarified signature: retain global session information, unaffected by later restriction;
wenzelm
parents: 70668
diff changeset
   712
72855
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   713
      new Structure(
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   714
        session_positions, session_directories, global_theories, build_graph, imports_graph)
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
   715
    }
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   716
  }
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   717
67052
caf87d4b9b61 tuned signature;
wenzelm
parents: 67029
diff changeset
   718
  final class Structure private[Sessions](
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   719
    val session_positions: List[(String, Position.T)],
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   720
    val session_directories: Map[JFile, String],
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   721
    val global_theories: Map[String, String],
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   722
    val build_graph: Graph[String, Info],
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   723
    val imports_graph: Graph[String, Info]
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   724
  ) {
69524
fa94f2b2a877 clarified sessions_deps, according to Isabelle/MMT usage;
wenzelm
parents: 69393
diff changeset
   725
    sessions_structure =>
fa94f2b2a877 clarified sessions_deps, according to Isabelle/MMT usage;
wenzelm
parents: 69393
diff changeset
   726
72845
60f56f623be2 tuned signature;
wenzelm
parents: 72839
diff changeset
   727
    def bootstrap: Base =
60f56f623be2 tuned signature;
wenzelm
parents: 72839
diff changeset
   728
      Base(
60f56f623be2 tuned signature;
wenzelm
parents: 72839
diff changeset
   729
        session_directories = session_directories,
60f56f623be2 tuned signature;
wenzelm
parents: 72839
diff changeset
   730
        global_theories = global_theories,
60f56f623be2 tuned signature;
wenzelm
parents: 72839
diff changeset
   731
        overall_syntax = Thy_Header.bootstrap_syntax)
60f56f623be2 tuned signature;
wenzelm
parents: 72839
diff changeset
   732
70683
8c7706b053c7 find theory files via session structure: much faster Prover IDE startup;
wenzelm
parents: 70681
diff changeset
   733
    def dest_session_directories: List[(String, String)] =
8c7706b053c7 find theory files via session structure: much faster Prover IDE startup;
wenzelm
parents: 70681
diff changeset
   734
      for ((file, session) <- session_directories.toList)
8c7706b053c7 find theory files via session structure: much faster Prover IDE startup;
wenzelm
parents: 70681
diff changeset
   735
        yield (File.standard_path(file), session)
8c7706b053c7 find theory files via session structure: much faster Prover IDE startup;
wenzelm
parents: 70681
diff changeset
   736
69762
58fb0d779583 support for session information via virtual file-system;
wenzelm
parents: 69671
diff changeset
   737
    lazy val chapters: SortedMap[String, List[Info]] =
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   738
      build_graph.iterator.foldLeft(SortedMap.empty[String, List[Info]]) {
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   739
        case (chs, (_, (info, _))) =>
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   740
          chs + (info.chapter -> (info :: chs.getOrElse(info.chapter, Nil)))
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
   741
      }
69762
58fb0d779583 support for session information via virtual file-system;
wenzelm
parents: 69671
diff changeset
   742
66823
f529719cc47d operations for graph display;
wenzelm
parents: 66822
diff changeset
   743
    def build_graph_display: Graph_Display.Graph = Graph_Display.make_graph(build_graph)
f529719cc47d operations for graph display;
wenzelm
parents: 66822
diff changeset
   744
    def imports_graph_display: Graph_Display.Graph = Graph_Display.make_graph(imports_graph)
f529719cc47d operations for graph display;
wenzelm
parents: 66822
diff changeset
   745
67025
961285f581e6 clarifified selection: always wrt. build_graph structure;
wenzelm
parents: 67024
diff changeset
   746
    def defined(name: String): Boolean = imports_graph.defined(name)
65420
695d4e22345a support for static session imports, without affect build hierarchy;
wenzelm
parents: 65419
diff changeset
   747
    def apply(name: String): Info = imports_graph.get_node(name)
67025
961285f581e6 clarifified selection: always wrt. build_graph structure;
wenzelm
parents: 67024
diff changeset
   748
    def get(name: String): Option[Info] = if (defined(name)) Some(apply(name)) else None
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   749
70859
6e6254bbce1f split into standard partitions, for improved scalability;
wenzelm
parents: 70796
diff changeset
   750
    def theory_qualifier(name: String): String =
6e6254bbce1f split into standard partitions, for improved scalability;
wenzelm
parents: 70796
diff changeset
   751
      global_theories.getOrElse(name, Long_Name.qualifier(name))
6e6254bbce1f split into standard partitions, for improved scalability;
wenzelm
parents: 70796
diff changeset
   752
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   753
    def check_sessions(names: List[String]): Unit = {
71601
97ccf48c2f0c misc tuning based on hints by IntelliJ IDEA;
wenzelm
parents: 71599
diff changeset
   754
      val bad_sessions = SortedSet(names.filterNot(defined): _*).toList
68542
02df6c68a8cb clarified error;
wenzelm
parents: 68523
diff changeset
   755
      if (bad_sessions.nonEmpty)
02df6c68a8cb clarified error;
wenzelm
parents: 68523
diff changeset
   756
        error("Undefined session(s): " + commas_quote(bad_sessions))
02df6c68a8cb clarified error;
wenzelm
parents: 68523
diff changeset
   757
    }
02df6c68a8cb clarified error;
wenzelm
parents: 68523
diff changeset
   758
68733
76e339ef60e3 more uniform checks;
wenzelm
parents: 68732
diff changeset
   759
    def check_sessions(sel: Selection): Unit =
76e339ef60e3 more uniform checks;
wenzelm
parents: 68732
diff changeset
   760
      check_sessions(sel.base_sessions ::: sel.exclude_sessions ::: sel.sessions)
76e339ef60e3 more uniform checks;
wenzelm
parents: 68732
diff changeset
   761
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   762
    private def selected(graph: Graph[String, Info], sel: Selection): List[String] = {
68733
76e339ef60e3 more uniform checks;
wenzelm
parents: 68732
diff changeset
   763
      check_sessions(sel)
76e339ef60e3 more uniform checks;
wenzelm
parents: 68732
diff changeset
   764
68732
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   765
      val select_group = sel.session_groups.toSet
68734
c14a2cc9b5ef isabelle build options -c -x -B refer to imports_graph;
wenzelm
parents: 68733
diff changeset
   766
      val select_session = sel.sessions.toSet ++ imports_graph.all_succs(sel.base_sessions)
68732
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   767
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   768
      val selected0 =
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   769
        if (sel.all_sessions) graph.keys
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   770
        else {
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   771
          (for {
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   772
            (name, (info, _)) <- graph.iterator
74810
d540c36cd0d2 tuned (see also e0d1d9203275);
wenzelm
parents: 74809
diff changeset
   773
            if info.dir_selected || select_session(name) || info.groups.exists(select_group)
68732
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   774
          } yield name).toList
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   775
        }
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   776
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   777
      if (sel.requirements) (graph.all_preds(selected0).toSet -- selected0).toList
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   778
      else selected0
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   779
    }
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   780
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   781
    def selection(sel: Selection): Structure = {
68733
76e339ef60e3 more uniform checks;
wenzelm
parents: 68732
diff changeset
   782
      check_sessions(sel)
67025
961285f581e6 clarifified selection: always wrt. build_graph structure;
wenzelm
parents: 67024
diff changeset
   783
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   784
      val excluded = {
68732
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   785
        val exclude_group = sel.exclude_session_groups.toSet
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   786
        val exclude_group_sessions =
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   787
          (for {
68734
c14a2cc9b5ef isabelle build options -c -x -B refer to imports_graph;
wenzelm
parents: 68733
diff changeset
   788
            (name, (info, _)) <- imports_graph.iterator
c14a2cc9b5ef isabelle build options -c -x -B refer to imports_graph;
wenzelm
parents: 68733
diff changeset
   789
            if imports_graph.get_node(name).groups.exists(exclude_group)
68732
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   790
          } yield name).toList
68734
c14a2cc9b5ef isabelle build options -c -x -B refer to imports_graph;
wenzelm
parents: 68733
diff changeset
   791
        imports_graph.all_succs(exclude_group_sessions ::: sel.exclude_sessions).toSet
68732
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   792
      }
67027
wenzelm
parents: 67026
diff changeset
   793
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   794
      def restrict(graph: Graph[String, Info]): Graph[String, Info] = {
68732
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   795
        val sessions = graph.all_preds(selected(graph, sel)).filterNot(excluded)
67029
d6d9fd2559ce clarified signature (again);
wenzelm
parents: 67028
diff changeset
   796
        graph.restrict(graph.all_preds(sessions).toSet)
67025
961285f581e6 clarifified selection: always wrt. build_graph structure;
wenzelm
parents: 67024
diff changeset
   797
      }
961285f581e6 clarifified selection: always wrt. build_graph structure;
wenzelm
parents: 67024
diff changeset
   798
70671
cb1776c8e216 clarified signature: retain global session information, unaffected by later restriction;
wenzelm
parents: 70668
diff changeset
   799
      new Structure(
70683
8c7706b053c7 find theory files via session structure: much faster Prover IDE startup;
wenzelm
parents: 70681
diff changeset
   800
        session_positions, session_directories, global_theories,
8c7706b053c7 find theory files via session structure: much faster Prover IDE startup;
wenzelm
parents: 70681
diff changeset
   801
        restrict(build_graph), restrict(imports_graph))
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   802
    }
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   803
72571
ab4a0b19648a tuned signature;
wenzelm
parents: 72565
diff changeset
   804
    def selection(session: String): Structure = selection(Selection.session(session))
ab4a0b19648a tuned signature;
wenzelm
parents: 72565
diff changeset
   805
69524
fa94f2b2a877 clarified sessions_deps, according to Isabelle/MMT usage;
wenzelm
parents: 69393
diff changeset
   806
    def selection_deps(
fa94f2b2a877 clarified sessions_deps, according to Isabelle/MMT usage;
wenzelm
parents: 69393
diff changeset
   807
      selection: Selection,
71726
a5fda30edae2 clarified signature: more uniform treatment of stopped/interrupted state;
wenzelm
parents: 71642
diff changeset
   808
      progress: Progress = new Progress,
69524
fa94f2b2a877 clarified sessions_deps, according to Isabelle/MMT usage;
wenzelm
parents: 69393
diff changeset
   809
      loading_sessions: Boolean = false,
68304
09270aa40884 tuned signature;
wenzelm
parents: 68294
diff changeset
   810
      inlined_files: Boolean = false,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   811
      verbose: Boolean = false
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   812
    ): Deps = {
69524
fa94f2b2a877 clarified sessions_deps, according to Isabelle/MMT usage;
wenzelm
parents: 69393
diff changeset
   813
      val deps =
70869
1d063b7f7928 incorporate sessions with record_proofs;
wenzelm
parents: 70867
diff changeset
   814
        Sessions.deps(sessions_structure.selection(selection),
69524
fa94f2b2a877 clarified sessions_deps, according to Isabelle/MMT usage;
wenzelm
parents: 69393
diff changeset
   815
          progress = progress, inlined_files = inlined_files, verbose = verbose)
fa94f2b2a877 clarified sessions_deps, according to Isabelle/MMT usage;
wenzelm
parents: 69393
diff changeset
   816
fa94f2b2a877 clarified sessions_deps, according to Isabelle/MMT usage;
wenzelm
parents: 69393
diff changeset
   817
      if (loading_sessions) {
fa94f2b2a877 clarified sessions_deps, according to Isabelle/MMT usage;
wenzelm
parents: 69393
diff changeset
   818
        val selection_size = deps.sessions_structure.build_graph.size
fa94f2b2a877 clarified sessions_deps, according to Isabelle/MMT usage;
wenzelm
parents: 69393
diff changeset
   819
        if (selection_size > 1) progress.echo("Loading " + selection_size + " sessions ...")
fa94f2b2a877 clarified sessions_deps, according to Isabelle/MMT usage;
wenzelm
parents: 69393
diff changeset
   820
      }
fa94f2b2a877 clarified sessions_deps, according to Isabelle/MMT usage;
wenzelm
parents: 69393
diff changeset
   821
fa94f2b2a877 clarified sessions_deps, according to Isabelle/MMT usage;
wenzelm
parents: 69393
diff changeset
   822
      deps
68304
09270aa40884 tuned signature;
wenzelm
parents: 68294
diff changeset
   823
    }
09270aa40884 tuned signature;
wenzelm
parents: 68294
diff changeset
   824
68732
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   825
    def build_selection(sel: Selection): List[String] = selected(build_graph, sel)
67029
d6d9fd2559ce clarified signature (again);
wenzelm
parents: 67028
diff changeset
   826
    def build_descendants(ss: List[String]): List[String] = build_graph.all_succs(ss)
72065
11dc8929832d clarified order --- proper sorting of requirements;
wenzelm
parents: 72064
diff changeset
   827
    def build_requirements(ss: List[String]): List[String] = build_graph.all_preds_rev(ss)
67029
d6d9fd2559ce clarified signature (again);
wenzelm
parents: 67028
diff changeset
   828
    def build_topological_order: List[String] = build_graph.topological_order
74809
48fda7ee1973 clarified signature;
wenzelm
parents: 74731
diff changeset
   829
    def build_hierarchy(session: String): List[String] = build_graph.all_preds(List(session))
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   830
68732
5472f4409fe6 tuned signature;
wenzelm
parents: 68542
diff changeset
   831
    def imports_selection(sel: Selection): List[String] = selected(imports_graph, sel)
67029
d6d9fd2559ce clarified signature (again);
wenzelm
parents: 67028
diff changeset
   832
    def imports_descendants(ss: List[String]): List[String] = imports_graph.all_succs(ss)
72065
11dc8929832d clarified order --- proper sorting of requirements;
wenzelm
parents: 72064
diff changeset
   833
    def imports_requirements(ss: List[String]): List[String] = imports_graph.all_preds_rev(ss)
67029
d6d9fd2559ce clarified signature (again);
wenzelm
parents: 67028
diff changeset
   834
    def imports_topological_order: List[String] = imports_graph.topological_order
74809
48fda7ee1973 clarified signature;
wenzelm
parents: 74731
diff changeset
   835
    def imports_hierarchy(session: String): List[String] = imports_graph.all_preds(List(session))
65420
695d4e22345a support for static session imports, without affect build hierarchy;
wenzelm
parents: 65419
diff changeset
   836
72613
d01ea9e3bd2d clarified bibtex_entries: refer to overall session structure;
wenzelm
parents: 72604
diff changeset
   837
    def bibtex_entries: List[(String, List[String])] =
d01ea9e3bd2d clarified bibtex_entries: refer to overall session structure;
wenzelm
parents: 72604
diff changeset
   838
      build_topological_order.flatMap(name =>
d01ea9e3bd2d clarified bibtex_entries: refer to overall session structure;
wenzelm
parents: 72604
diff changeset
   839
        apply(name).bibtex_entries match {
d01ea9e3bd2d clarified bibtex_entries: refer to overall session structure;
wenzelm
parents: 72604
diff changeset
   840
          case Nil => None
d01ea9e3bd2d clarified bibtex_entries: refer to overall session structure;
wenzelm
parents: 72604
diff changeset
   841
          case entries => Some(name -> entries.map(_.info))
d01ea9e3bd2d clarified bibtex_entries: refer to overall session structure;
wenzelm
parents: 72604
diff changeset
   842
        })
d01ea9e3bd2d clarified bibtex_entries: refer to overall session structure;
wenzelm
parents: 72604
diff changeset
   843
65420
695d4e22345a support for static session imports, without affect build hierarchy;
wenzelm
parents: 65419
diff changeset
   844
    override def toString: String =
67052
caf87d4b9b61 tuned signature;
wenzelm
parents: 67029
diff changeset
   845
      imports_graph.keys_iterator.mkString("Sessions.Structure(", ", ", ")")
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   846
  }
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   847
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   848
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   849
  /* parser */
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   850
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   851
  private val CHAPTER = "chapter"
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   852
  private val SESSION = "session"
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   853
  private val IN = "in"
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   854
  private val DESCRIPTION = "description"
70668
9cac4dec0da9 support for explicit session directories;
wenzelm
parents: 70650
diff changeset
   855
  private val DIRECTORIES = "directories"
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   856
  private val OPTIONS = "options"
65420
695d4e22345a support for static session imports, without affect build hierarchy;
wenzelm
parents: 65419
diff changeset
   857
  private val SESSIONS = "sessions"
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   858
  private val THEORIES = "theories"
65374
a5b38d8d3c1e tuned syntax;
wenzelm
parents: 65373
diff changeset
   859
  private val GLOBAL = "global"
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   860
  private val DOCUMENT_THEORIES = "document_theories"
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   861
  private val DOCUMENT_FILES = "document_files"
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68221
diff changeset
   862
  private val EXPORT_FILES = "export_files"
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   863
71601
97ccf48c2f0c misc tuning based on hints by IntelliJ IDEA;
wenzelm
parents: 71599
diff changeset
   864
  val root_syntax: Outer_Syntax =
70668
9cac4dec0da9 support for explicit session directories;
wenzelm
parents: 70650
diff changeset
   865
    Outer_Syntax.empty + "(" + ")" + "+" + "," + "=" + "[" + "]" +
70681
a6c0f2d106c8 disallow overlapping session directories;
wenzelm
parents: 70679
diff changeset
   866
      GLOBAL + IN +
63443
c037248d54e8 clarified keywords;
wenzelm
parents: 63022
diff changeset
   867
      (CHAPTER, Keyword.THY_DECL) +
c037248d54e8 clarified keywords;
wenzelm
parents: 63022
diff changeset
   868
      (SESSION, Keyword.THY_DECL) +
c037248d54e8 clarified keywords;
wenzelm
parents: 63022
diff changeset
   869
      (DESCRIPTION, Keyword.QUASI_COMMAND) +
70668
9cac4dec0da9 support for explicit session directories;
wenzelm
parents: 70650
diff changeset
   870
      (DIRECTORIES, Keyword.QUASI_COMMAND) +
63443
c037248d54e8 clarified keywords;
wenzelm
parents: 63022
diff changeset
   871
      (OPTIONS, Keyword.QUASI_COMMAND) +
65420
695d4e22345a support for static session imports, without affect build hierarchy;
wenzelm
parents: 65419
diff changeset
   872
      (SESSIONS, Keyword.QUASI_COMMAND) +
63443
c037248d54e8 clarified keywords;
wenzelm
parents: 63022
diff changeset
   873
      (THEORIES, Keyword.QUASI_COMMAND) +
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   874
      (DOCUMENT_THEORIES, Keyword.QUASI_COMMAND) +
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68221
diff changeset
   875
      (DOCUMENT_FILES, Keyword.QUASI_COMMAND) +
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68221
diff changeset
   876
      (EXPORT_FILES, Keyword.QUASI_COMMAND)
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   877
66818
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   878
  abstract class Entry
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   879
  sealed case class Chapter(name: String) extends Entry
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   880
  sealed case class Session_Entry(
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   881
    pos: Position.T,
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   882
    name: String,
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   883
    groups: List[String],
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   884
    path: String,
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   885
    parent: Option[String],
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   886
    description: String,
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   887
    options: List[Options.Spec],
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   888
    imports: List[String],
70681
a6c0f2d106c8 disallow overlapping session directories;
wenzelm
parents: 70679
diff changeset
   889
    directories: List[String],
66818
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   890
    theories: List[(List[Options.Spec], List[((String, Position.T), Boolean)])],
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   891
    document_theories: List[(String, Position.T)],
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68221
diff changeset
   892
    document_files: List[(String, String)],
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   893
    export_files: List[(String, Int, List[String])]
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   894
  ) extends Entry {
66818
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   895
    def theories_no_position: List[(List[Options.Spec], List[(String, Boolean)])] =
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   896
      theories.map({ case (a, b) => (a, b.map({ case ((c, _), d) => (c, d) })) })
72666
945cee776e79 proper meta_digest: avoid non-portable position information;
wenzelm
parents: 72653
diff changeset
   897
    def document_theories_no_position: List[String] =
945cee776e79 proper meta_digest: avoid non-portable position information;
wenzelm
parents: 72653
diff changeset
   898
      document_theories.map(_._1)
66818
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   899
  }
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   900
75405
b13ab7d11b90 clarified signature: avoid ambiguity in scala3;
wenzelm
parents: 75394
diff changeset
   901
  private object Parsers extends Options.Parsers {
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   902
    private val chapter: Parser[Chapter] = {
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   903
      val chapter_name = atom("chapter name", _.is_name)
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   904
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   905
      command(CHAPTER) ~! chapter_name ^^ { case _ ~ a => Chapter(a) }
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   906
    }
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   907
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   908
    private val session_entry: Parser[Session_Entry] = {
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   909
      val option =
67210
wenzelm
parents: 67097
diff changeset
   910
        option_name ~ opt($$$("=") ~! option_value ^^ { case _ ~ x => x }) ^^
wenzelm
parents: 67097
diff changeset
   911
          { case x ~ y => (x, y) }
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   912
      val options = $$$("[") ~> rep1sep(option, $$$(",")) <~ $$$("]")
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   913
65374
a5b38d8d3c1e tuned syntax;
wenzelm
parents: 65373
diff changeset
   914
      val theory_entry =
70668
9cac4dec0da9 support for explicit session directories;
wenzelm
parents: 70650
diff changeset
   915
        position(theory_name) ~ opt_keyword(GLOBAL) ^^ { case x ~ y => (x, y) }
65374
a5b38d8d3c1e tuned syntax;
wenzelm
parents: 65373
diff changeset
   916
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   917
      val theories =
65374
a5b38d8d3c1e tuned syntax;
wenzelm
parents: 65373
diff changeset
   918
        $$$(THEORIES) ~!
66970
13857f49d215 clarified ROOT syntax: 'sessions' and 'theories' are optional, but need to be non-empty;
wenzelm
parents: 66969
diff changeset
   919
          ((options | success(Nil)) ~ rep1(theory_entry)) ^^
65374
a5b38d8d3c1e tuned syntax;
wenzelm
parents: 65373
diff changeset
   920
          { case _ ~ (x ~ y) => (x, y) }
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   921
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68221
diff changeset
   922
      val in_path = $$$("(") ~! ($$$(IN) ~ path ~ $$$(")")) ^^ { case _ ~ (_ ~ x ~ _) => x }
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68221
diff changeset
   923
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   924
      val document_theories =
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   925
        $$$(DOCUMENT_THEORIES) ~! rep1(position(name)) ^^ { case _ ~ x => x }
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   926
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   927
      val document_files =
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   928
        $$$(DOCUMENT_FILES) ~!
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68221
diff changeset
   929
          ((in_path | success("document")) ~ rep1(path)) ^^ { case _ ~ (x ~ y) => y.map((x, _)) }
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68221
diff changeset
   930
69671
2486792eaf61 support pruning of export names;
wenzelm
parents: 69560
diff changeset
   931
      val prune = $$$("[") ~! (nat ~ $$$("]")) ^^ { case _ ~ (x ~ _) => x } | success(0)
2486792eaf61 support pruning of export names;
wenzelm
parents: 69560
diff changeset
   932
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68221
diff changeset
   933
      val export_files =
69671
2486792eaf61 support pruning of export names;
wenzelm
parents: 69560
diff changeset
   934
        $$$(EXPORT_FILES) ~! ((in_path | success("export")) ~ prune ~ rep1(embedded)) ^^
2486792eaf61 support pruning of export names;
wenzelm
parents: 69560
diff changeset
   935
          { case _ ~ (x ~ y ~ z) => (x, y, z) }
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   936
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   937
      command(SESSION) ~!
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   938
        (position(session_name) ~
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   939
          (($$$("(") ~! (rep1(name) <~ $$$(")")) ^^ { case _ ~ x => x }) | success(Nil)) ~
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   940
          (($$$(IN) ~! path ^^ { case _ ~ x => x }) | success(".")) ~
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   941
          ($$$("=") ~!
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   942
            (opt(session_name ~! $$$("+") ^^ { case x ~ _ => x }) ~
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   943
              (($$$(DESCRIPTION) ~! text ^^ { case _ ~ x => x }) | success("")) ~
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   944
              (($$$(OPTIONS) ~! options ^^ { case _ ~ x => x }) | success(Nil)) ~
66970
13857f49d215 clarified ROOT syntax: 'sessions' and 'theories' are optional, but need to be non-empty;
wenzelm
parents: 66969
diff changeset
   945
              (($$$(SESSIONS) ~! rep1(session_name)  ^^ { case _ ~ x => x }) | success(Nil)) ~
70681
a6c0f2d106c8 disallow overlapping session directories;
wenzelm
parents: 70679
diff changeset
   946
              (($$$(DIRECTORIES) ~! rep1(path) ^^ { case _ ~ x => x }) | success(Nil)) ~
66970
13857f49d215 clarified ROOT syntax: 'sessions' and 'theories' are optional, but need to be non-empty;
wenzelm
parents: 66969
diff changeset
   947
              rep(theories) ~
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   948
              (opt(document_theories) ^^ (x => x.getOrElse(Nil))) ~
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68221
diff changeset
   949
              (rep(document_files) ^^ (x => x.flatten)) ~
72600
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   950
              rep(export_files)))) ^^
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   951
        { case _ ~ ((a, pos) ~ b ~ c ~ (_ ~ (d ~ e ~ f ~ g ~ h ~ i ~ j ~ k ~ l))) =>
2fa4f25d9d07 official support for document theories from other sessions;
wenzelm
parents: 72574
diff changeset
   952
            Session_Entry(pos, a, b, c, d, e, f, g, h, i, j, k, l) }
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   953
    }
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   954
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   955
    def parse_root(path: Path): List[Entry] = {
66764
006deaf5c3dc process ROOT files only once, which allows duplicate (or overlapping) session root directories;
wenzelm
parents: 66759
diff changeset
   956
      val toks = Token.explode(root_syntax.keywords, File.read(path))
006deaf5c3dc process ROOT files only once, which allows duplicate (or overlapping) session root directories;
wenzelm
parents: 66759
diff changeset
   957
      val start = Token.Pos.file(path.implode)
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   958
66764
006deaf5c3dc process ROOT files only once, which allows duplicate (or overlapping) session root directories;
wenzelm
parents: 66759
diff changeset
   959
      parse_all(rep(chapter | session_entry), Token.reader(toks, start)) match {
66818
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   960
        case Success(result, _) => result
66764
006deaf5c3dc process ROOT files only once, which allows duplicate (or overlapping) session root directories;
wenzelm
parents: 66759
diff changeset
   961
        case bad => error(bad.toString)
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   962
      }
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   963
    }
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   964
  }
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   965
75405
b13ab7d11b90 clarified signature: avoid ambiguity in scala3;
wenzelm
parents: 75394
diff changeset
   966
  def parse_root(path: Path): List[Entry] = Parsers.parse_root(path)
66819
wenzelm
parents: 66818
diff changeset
   967
wenzelm
parents: 66818
diff changeset
   968
  def parse_root_entries(path: Path): List[Session_Entry] =
75405
b13ab7d11b90 clarified signature: avoid ambiguity in scala3;
wenzelm
parents: 75394
diff changeset
   969
    for (entry <- Parsers.parse_root(path) if entry.isInstanceOf[Session_Entry])
66819
wenzelm
parents: 66818
diff changeset
   970
    yield entry.asInstanceOf[Session_Entry]
66818
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   971
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   972
  def read_root(options: Options, select: Boolean, path: Path): List[Info] = {
69762
58fb0d779583 support for session information via virtual file-system;
wenzelm
parents: 69671
diff changeset
   973
    var entry_chapter = UNSORTED
66960
d62f1f03868a tuned signature;
wenzelm
parents: 66959
diff changeset
   974
    val infos = new mutable.ListBuffer[Info]
66819
wenzelm
parents: 66818
diff changeset
   975
    parse_root(path).foreach {
66818
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   976
      case Chapter(name) => entry_chapter = name
66967
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   977
      case entry: Session_Entry =>
e365c91c72a9 synthesize session with all required theories from other session imports;
wenzelm
parents: 66966
diff changeset
   978
        infos += make_info(options, select, path.dir, entry_chapter, entry)
66818
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   979
    }
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   980
    infos.toList
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   981
  }
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   982
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
   983
  def parse_roots(roots: Path): List[String] = {
66818
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   984
    for {
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   985
      line <- split_lines(File.read(roots))
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   986
      if !(line == "" || line.startsWith("#"))
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   987
    } yield line
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   988
  }
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
   989
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   990
62635
4854a38061de tuned signature;
wenzelm
parents: 62633
diff changeset
   991
  /* load sessions from certain directories */
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   992
73814
c8b4a4f69068 clarified check (refining fc828f64da5b): etc/settings or etc/components is not strictly required according to "init_component", and notable components only have session ROOTS (e.g. AFP/thys);
wenzelm
parents: 73718
diff changeset
   993
  def is_session_dir(dir: Path): Boolean =
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   994
    (dir + ROOT).is_file || (dir + ROOTS).is_file
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   995
75297
fc4d07587695 more robust errors -- on foreground process instead of background server;
wenzelm
parents: 74812
diff changeset
   996
  def check_session_dir(dir: Path): Path =
65468
c41791ad75c3 early check and normalization of session directory, e.g. relevant for path information passed to ML process, which may have a different CWD;
wenzelm
parents: 65463
diff changeset
   997
    if (is_session_dir(dir)) File.pwd() + dir.expand
73311
54262af6d310 clarified message;
wenzelm
parents: 73310
diff changeset
   998
    else error("Bad session root directory (missing ROOT or ROOTS): " + dir.expand.toString)
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
   999
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1000
  def directories(dirs: List[Path], select_dirs: List[Path]): List[(Boolean, Path)] = {
73815
43882e34c038 clarified modules;
wenzelm
parents: 73814
diff changeset
  1001
    val default_dirs = Components.directories().filter(is_session_dir)
68746
f95e2f145ea5 canonical session directories in correspondence to Known.files;
wenzelm
parents: 68734
diff changeset
  1002
    for { (select, dir) <- (default_dirs ::: dirs).map((false, _)) ::: select_dirs.map((true, _)) }
f95e2f145ea5 canonical session directories in correspondence to Known.files;
wenzelm
parents: 68734
diff changeset
  1003
    yield (select, dir.canonical)
65561
741b1d3930c0 support for Mercurial manifest check;
wenzelm
parents: 65560
diff changeset
  1004
  }
741b1d3930c0 support for Mercurial manifest check;
wenzelm
parents: 65560
diff changeset
  1005
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1006
  def load_structure(
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1007
    options: Options,
66968
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
  1008
    dirs: List[Path] = Nil,
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66967
diff changeset
  1009
    select_dirs: List[Path] = Nil,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1010
    infos: List[Info] = Nil
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1011
  ): Structure = {
66764
006deaf5c3dc process ROOT files only once, which allows duplicate (or overlapping) session root directories;
wenzelm
parents: 66759
diff changeset
  1012
    def load_dir(select: Boolean, dir: Path): List[(Boolean, Path)] =
62635
4854a38061de tuned signature;
wenzelm
parents: 62633
diff changeset
  1013
      load_root(select, dir) ::: load_roots(select, dir)
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1014
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1015
    def load_root(select: Boolean, dir: Path): List[(Boolean, Path)] = {
66764
006deaf5c3dc process ROOT files only once, which allows duplicate (or overlapping) session root directories;
wenzelm
parents: 66759
diff changeset
  1016
      val root = dir + ROOT
006deaf5c3dc process ROOT files only once, which allows duplicate (or overlapping) session root directories;
wenzelm
parents: 66759
diff changeset
  1017
      if (root.is_file) List((select, root)) else Nil
006deaf5c3dc process ROOT files only once, which allows duplicate (or overlapping) session root directories;
wenzelm
parents: 66759
diff changeset
  1018
    }
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1019
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1020
    def load_roots(select: Boolean, dir: Path): List[(Boolean, Path)] = {
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1021
      val roots = dir + ROOTS
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1022
      if (roots.is_file) {
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1023
        for {
66818
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
  1024
          entry <- parse_roots(roots)
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1025
          dir1 =
66818
5bc903a60932 clarified signature: public access to ROOT file syntax;
wenzelm
parents: 66780
diff changeset
  1026
            try { check_session_dir(dir + Path.explode(entry)) }
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1027
            catch {
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1028
              case ERROR(msg) =>
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1029
                error(msg + "\nThe error(s) above occurred in session catalog " + roots.toString)
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1030
            }
66764
006deaf5c3dc process ROOT files only once, which allows duplicate (or overlapping) session root directories;
wenzelm
parents: 66759
diff changeset
  1031
          res <- load_dir(select, dir1)
006deaf5c3dc process ROOT files only once, which allows duplicate (or overlapping) session root directories;
wenzelm
parents: 66759
diff changeset
  1032
        } yield res
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1033
      }
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1034
      else Nil
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1035
    }
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1036
66764
006deaf5c3dc process ROOT files only once, which allows duplicate (or overlapping) session root directories;
wenzelm
parents: 66759
diff changeset
  1037
    val roots =
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1038
      for {
65561
741b1d3930c0 support for Mercurial manifest check;
wenzelm
parents: 65560
diff changeset
  1039
        (select, dir) <- directories(dirs, select_dirs)
66764
006deaf5c3dc process ROOT files only once, which allows duplicate (or overlapping) session root directories;
wenzelm
parents: 66759
diff changeset
  1040
        res <- load_dir(select, check_session_dir(dir))
006deaf5c3dc process ROOT files only once, which allows duplicate (or overlapping) session root directories;
wenzelm
parents: 66759
diff changeset
  1041
      } yield res
006deaf5c3dc process ROOT files only once, which allows duplicate (or overlapping) session root directories;
wenzelm
parents: 66759
diff changeset
  1042
006deaf5c3dc process ROOT files only once, which allows duplicate (or overlapping) session root directories;
wenzelm
parents: 66759
diff changeset
  1043
    val unique_roots =
73359
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
  1044
      roots.foldLeft(Map.empty[JFile, (Boolean, Path)]) {
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
  1045
        case (m, (select, path)) =>
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
  1046
          val file = path.canonical_file
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
  1047
          m.get(file) match {
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
  1048
            case None => m + (file -> (select, path))
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
  1049
            case Some((select1, path1)) => m + (file -> (select1 || select, path1))
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
  1050
          }
d8a0e996614b tuned --- fewer warnings;
wenzelm
parents: 73357
diff changeset
  1051
      }.toList.map(_._2)
66764
006deaf5c3dc process ROOT files only once, which allows duplicate (or overlapping) session root directories;
wenzelm
parents: 66759
diff changeset
  1052
72855
e0f6fa6ff3d0 tuned signature;
wenzelm
parents: 72854
diff changeset
  1053
    Structure.make(unique_roots.flatMap(p => read_root(options, p._1, p._2)) ::: infos)
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1054
  }
62632
cd991ba01ffd clarified modules;
wenzelm
parents: 62631
diff changeset
  1055
cd991ba01ffd clarified modules;
wenzelm
parents: 62631
diff changeset
  1056
71808
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1057
  /* Isabelle tool wrapper */
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1058
72763
3cc73d00553c added document antiquotation @{tool};
wenzelm
parents: 72760
diff changeset
  1059
  val isabelle_tool = Isabelle_Tool("sessions", "explore structure of Isabelle sessions",
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1060
    Scala_Project.here,
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1061
    { args =>
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1062
      var base_sessions: List[String] = Nil
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1063
      var select_dirs: List[Path] = Nil
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1064
      var requirements = false
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1065
      var exclude_session_groups: List[String] = Nil
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1066
      var all_sessions = false
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1067
      var dirs: List[Path] = Nil
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1068
      var session_groups: List[String] = Nil
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1069
      var exclude_sessions: List[String] = Nil
71808
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1070
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1071
      val getopts = Getopts("""
71808
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1072
Usage: isabelle sessions [OPTIONS] [SESSIONS ...]
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1073
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1074
  Options are:
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1075
    -B NAME      include session NAME and all descendants
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1076
    -D DIR       include session directory and select its sessions
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1077
    -R           refer to requirements of selected sessions
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1078
    -X NAME      exclude sessions from group NAME and all descendants
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1079
    -a           select all sessions
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1080
    -d DIR       include session directory
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1081
    -g NAME      select session group NAME
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1082
    -x NAME      exclude session NAME and all descendants
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1083
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1084
  Explore the structure of Isabelle sessions and print result names in
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1085
  topological order (on stdout).
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1086
""",
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1087
        "B:" -> (arg => base_sessions = base_sessions ::: List(arg)),
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1088
        "D:" -> (arg => select_dirs = select_dirs ::: List(Path.explode(arg))),
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1089
        "R" -> (_ => requirements = true),
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1090
        "X:" -> (arg => exclude_session_groups = exclude_session_groups ::: List(arg)),
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1091
        "a" -> (_ => all_sessions = true),
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1092
        "d:" -> (arg => dirs = dirs ::: List(Path.explode(arg))),
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1093
        "g:" -> (arg => session_groups = session_groups ::: List(arg)),
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1094
        "x:" -> (arg => exclude_sessions = exclude_sessions ::: List(arg)))
71808
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1095
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1096
      val sessions = getopts(args)
71808
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1097
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1098
      val options = Options.init()
71808
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1099
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1100
      val selection =
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1101
        Selection(requirements = requirements, all_sessions = all_sessions, base_sessions = base_sessions,
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1102
          exclude_session_groups = exclude_session_groups, exclude_sessions = exclude_sessions,
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1103
          session_groups = session_groups, sessions = sessions)
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1104
      val sessions_structure =
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1105
        load_structure(options, dirs = dirs, select_dirs = select_dirs).selection(selection)
71808
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1106
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1107
      for (name <- sessions_structure.imports_topological_order) {
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1108
        Output.writeln(name, stdout = true)
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1109
      }
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1110
    })
71808
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1111
e2ad50885887 added "isabelle sessions" tool;
wenzelm
parents: 71726
diff changeset
  1112
62637
0189fe0f6452 support for Poly/ML heap hierarchy, which saves a lot of disk space;
wenzelm
parents: 62636
diff changeset
  1113
62704
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1114
  /** heap file with SHA1 digest **/
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1115
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1116
  private val sha1_prefix = "SHA1:"
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1117
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1118
  def read_heap_digest(heap: Path): Option[String] = {
62704
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1119
    if (heap.is_file) {
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1120
      using(FileChannel.open(heap.java_path, StandardOpenOption.READ)) { file =>
62704
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1121
        val len = file.size
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1122
        val n = sha1_prefix.length + SHA1.digest_length
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1123
        if (len >= n) {
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1124
          file.position(len - n)
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1125
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1126
          val buf = ByteBuffer.allocate(n)
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1127
          var i = 0
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1128
          var m = 0
75382
81673c441ce3 tuned: eliminted do-while for the sake of scala3;
wenzelm
parents: 75310
diff changeset
  1129
          var cont = true
81673c441ce3 tuned: eliminted do-while for the sake of scala3;
wenzelm
parents: 75310
diff changeset
  1130
          while (cont) {
62704
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1131
            m = file.read(buf)
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1132
            if (m != -1) i += m
75382
81673c441ce3 tuned: eliminted do-while for the sake of scala3;
wenzelm
parents: 75310
diff changeset
  1133
            cont = (m != -1 && n > i)
62704
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1134
          }
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1135
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1136
          if (i == n) {
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1137
            val prefix = new String(buf.array(), 0, sha1_prefix.length, UTF8.charset)
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1138
            val s = new String(buf.array(), sha1_prefix.length, SHA1.digest_length, UTF8.charset)
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1139
            if (prefix == sha1_prefix) Some(s) else None
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1140
          }
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1141
          else None
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1142
        }
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1143
        else None
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1144
      }
62704
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1145
    }
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1146
    else None
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1147
  }
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1148
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1149
  def write_heap_digest(heap: Path): String =
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1150
    read_heap_digest(heap) match {
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1151
      case None =>
75310
42baf7ffa088 tuned signature;
wenzelm
parents: 75297
diff changeset
  1152
        val s = SHA1.digest(heap).toString
62704
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1153
        File.append(heap, sha1_prefix + s)
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1154
        s
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1155
      case Some(s) => s
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1156
    }
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1157
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1158
478b49f0d726 proper SHA1 digest as annex to heap file: Poly/ML reads precise segment length;
wenzelm
parents: 62637
diff changeset
  1159
62637
0189fe0f6452 support for Poly/ML heap hierarchy, which saves a lot of disk space;
wenzelm
parents: 62636
diff changeset
  1160
  /** persistent store **/
62632
cd991ba01ffd clarified modules;
wenzelm
parents: 62631
diff changeset
  1161
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1162
  object Session_Info {
66857
f8f42289c4df tuned signature;
wenzelm
parents: 66848
diff changeset
  1163
    val session_name = SQL.Column.string("session_name").make_primary_key
65326
cb7cb57c7ce1 proper primary key;
wenzelm
parents: 65324
diff changeset
  1164
65296
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1165
    // Build_Log.Session_Info
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1166
    val session_timing = SQL.Column.bytes("session_timing")
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1167
    val command_timings = SQL.Column.bytes("command_timings")
66873
9953ae603a23 provide theory timing information, similar to command timing but always considered relevant;
wenzelm
parents: 66857
diff changeset
  1168
    val theory_timings = SQL.Column.bytes("theory_timings")
65296
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1169
    val ml_statistics = SQL.Column.bytes("ml_statistics")
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1170
    val task_statistics = SQL.Column.bytes("task_statistics")
65934
5f202ba9f590 store errors in build db;
wenzelm
parents: 65857
diff changeset
  1171
    val errors = SQL.Column.bytes("errors")
65296
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1172
    val build_log_columns =
66873
9953ae603a23 provide theory timing information, similar to command timing but always considered relevant;
wenzelm
parents: 66857
diff changeset
  1173
      List(session_name, session_timing, command_timings, theory_timings,
9953ae603a23 provide theory timing information, similar to command timing but always considered relevant;
wenzelm
parents: 66857
diff changeset
  1174
        ml_statistics, task_statistics, errors)
65296
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1175
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1176
    // Build.Session_Info
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1177
    val sources = SQL.Column.string("sources")
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1178
    val input_heaps = SQL.Column.string("input_heaps")
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1179
    val output_heap = SQL.Column.string("output_heap")
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1180
    val return_code = SQL.Column.int("return_code")
66746
888a51e77c6e sources_stamp refers to full sources;
wenzelm
parents: 66744
diff changeset
  1181
    val build_columns = List(sources, input_heaps, output_heap, return_code)
65296
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1182
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1183
    val table = SQL.Table("isabelle_session_info", build_log_columns ::: build_columns)
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1184
  }
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1185
72682
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1186
  class Database_Context private[Sessions](
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1187
    val store: Sessions.Store,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1188
    database_server: Option[SQL.Database]
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1189
  ) extends AutoCloseable {
74731
161e84e6b40a just one cache, via HTML_Context, via Sessions.Store or Session;
wenzelm
parents: 74696
diff changeset
  1190
    def cache: Term.Cache = store.cache
72683
b5e6f0d137a7 clarified signature: prefer Database_Context;
wenzelm
parents: 72682
diff changeset
  1191
73367
77ef8bef0593 clarified signature --- fewer warnings;
wenzelm
parents: 73364
diff changeset
  1192
    def close(): Unit = database_server.foreach(_.close())
72682
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1193
72715
2615b8c05337 clarified signature --- avoid repeated open_database on server;
wenzelm
parents: 72696
diff changeset
  1194
    def output_database[A](session: String)(f: SQL.Database => A): A =
2615b8c05337 clarified signature --- avoid repeated open_database on server;
wenzelm
parents: 72696
diff changeset
  1195
      database_server match {
2615b8c05337 clarified signature --- avoid repeated open_database on server;
wenzelm
parents: 72696
diff changeset
  1196
        case Some(db) => f(db)
2615b8c05337 clarified signature --- avoid repeated open_database on server;
wenzelm
parents: 72696
diff changeset
  1197
        case None => using(store.open_database(session, output = true))(f)
2615b8c05337 clarified signature --- avoid repeated open_database on server;
wenzelm
parents: 72696
diff changeset
  1198
      }
2615b8c05337 clarified signature --- avoid repeated open_database on server;
wenzelm
parents: 72696
diff changeset
  1199
72716
7cef6b1a6682 clarified signature;
wenzelm
parents: 72715
diff changeset
  1200
    def input_database[A](session: String)(f: (SQL.Database, String) => Option[A]): Option[A] =
7cef6b1a6682 clarified signature;
wenzelm
parents: 72715
diff changeset
  1201
      database_server match {
7cef6b1a6682 clarified signature;
wenzelm
parents: 72715
diff changeset
  1202
        case Some(db) => f(db, session)
7cef6b1a6682 clarified signature;
wenzelm
parents: 72715
diff changeset
  1203
        case None =>
7cef6b1a6682 clarified signature;
wenzelm
parents: 72715
diff changeset
  1204
          store.try_open_database(session) match {
7cef6b1a6682 clarified signature;
wenzelm
parents: 72715
diff changeset
  1205
            case Some(db) => using(db)(f(_, session))
7cef6b1a6682 clarified signature;
wenzelm
parents: 72715
diff changeset
  1206
            case None => None
7cef6b1a6682 clarified signature;
wenzelm
parents: 72715
diff changeset
  1207
          }
7cef6b1a6682 clarified signature;
wenzelm
parents: 72715
diff changeset
  1208
      }
7cef6b1a6682 clarified signature;
wenzelm
parents: 72715
diff changeset
  1209
72854
6c660f05f70c clarified signature;
wenzelm
parents: 72847
diff changeset
  1210
    def read_export(
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1211
      sessions: List[String],
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1212
      theory_name: String,
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1213
      name: String
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1214
    ): Option[Export.Entry] = {
72682
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1215
      val attempts =
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1216
        database_server match {
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1217
          case Some(db) =>
72854
6c660f05f70c clarified signature;
wenzelm
parents: 72847
diff changeset
  1218
            sessions.view.map(session_name =>
73031
f93f0597f4fb clarified signature: absorb XZ.Cache into XML.Cache;
wenzelm
parents: 73024
diff changeset
  1219
              Export.read_entry(db, store.cache, session_name, theory_name, name))
72682
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1220
          case None =>
72854
6c660f05f70c clarified signature;
wenzelm
parents: 72847
diff changeset
  1221
            sessions.view.map(session_name =>
72682
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1222
              store.try_open_database(session_name) match {
72847
9dda93a753b1 clarified signature: provide XZ.Cache where Export.Entry is created;
wenzelm
parents: 72845
diff changeset
  1223
                case Some(db) =>
73031
f93f0597f4fb clarified signature: absorb XZ.Cache into XML.Cache;
wenzelm
parents: 73024
diff changeset
  1224
                  using(db)(Export.read_entry(_, store.cache, session_name, theory_name, name))
72682
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1225
                case None => None
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1226
              })
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1227
        }
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1228
      attempts.collectFirst({ case Some(entry) => entry })
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1229
    }
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1230
72854
6c660f05f70c clarified signature;
wenzelm
parents: 72847
diff changeset
  1231
    def get_export(
6c660f05f70c clarified signature;
wenzelm
parents: 72847
diff changeset
  1232
        session_hierarchy: List[String], theory_name: String, name: String): Export.Entry =
6c660f05f70c clarified signature;
wenzelm
parents: 72847
diff changeset
  1233
      read_export(session_hierarchy, theory_name, name) getOrElse
6c660f05f70c clarified signature;
wenzelm
parents: 72847
diff changeset
  1234
        Export.empty_entry(theory_name, name)
72682
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1235
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1236
    override def toString: String = {
72682
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1237
      val s =
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1238
        database_server match {
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1239
          case Some(db) => db.toString
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1240
          case None => "input_dirs = " + store.input_dirs.map(_.absolute).mkString(", ")
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1241
        }
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1242
      "Database_Context(" + s + ")"
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1243
    }
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1244
  }
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1245
74731
161e84e6b40a just one cache, via HTML_Context, via Sessions.Store or Session;
wenzelm
parents: 74696
diff changeset
  1246
  def store(options: Options, cache: Term.Cache = Term.Cache.make()): Store =
73031
f93f0597f4fb clarified signature: absorb XZ.Cache into XML.Cache;
wenzelm
parents: 73024
diff changeset
  1247
    new Store(options, cache)
62632
cd991ba01ffd clarified modules;
wenzelm
parents: 62631
diff changeset
  1248
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1249
  class Store private[Sessions](val options: Options, val cache: Term.Cache) {
72634
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1250
    store =>
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1251
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1252
    override def toString: String = "Store(output_dir = " + output_dir.absolute + ")"
68219
c0341c0080e2 clarified store directories;
wenzelm
parents: 68218
diff changeset
  1253
c0341c0080e2 clarified store directories;
wenzelm
parents: 68218
diff changeset
  1254
c0341c0080e2 clarified store directories;
wenzelm
parents: 68218
diff changeset
  1255
    /* directories */
c0341c0080e2 clarified store directories;
wenzelm
parents: 68218
diff changeset
  1256
68523
ccacc84e0251 clarified settings -- avoid hard-wired directories;
wenzelm
parents: 68483
diff changeset
  1257
    val system_output_dir: Path = Path.explode("$ISABELLE_HEAPS_SYSTEM/$ML_IDENTIFIER")
ccacc84e0251 clarified settings -- avoid hard-wired directories;
wenzelm
parents: 68483
diff changeset
  1258
    val user_output_dir: Path = Path.explode("$ISABELLE_HEAPS/$ML_IDENTIFIER")
68219
c0341c0080e2 clarified store directories;
wenzelm
parents: 68218
diff changeset
  1259
69854
cc0b3e177b49 system option "system_heaps" supersedes various command-line options for "system build mode";
wenzelm
parents: 69812
diff changeset
  1260
    def system_heaps: Boolean = options.bool("system_heaps")
cc0b3e177b49 system option "system_heaps" supersedes various command-line options for "system build mode";
wenzelm
parents: 69812
diff changeset
  1261
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1262
    val output_dir: Path =
69854
cc0b3e177b49 system option "system_heaps" supersedes various command-line options for "system build mode";
wenzelm
parents: 69812
diff changeset
  1263
      if (system_heaps) system_output_dir else user_output_dir
68219
c0341c0080e2 clarified store directories;
wenzelm
parents: 68218
diff changeset
  1264
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1265
    val input_dirs: List[Path] =
69854
cc0b3e177b49 system option "system_heaps" supersedes various command-line options for "system build mode";
wenzelm
parents: 69812
diff changeset
  1266
      if (system_heaps) List(system_output_dir)
68219
c0341c0080e2 clarified store directories;
wenzelm
parents: 68218
diff changeset
  1267
      else List(user_output_dir, system_output_dir)
62632
cd991ba01ffd clarified modules;
wenzelm
parents: 62631
diff changeset
  1268
72648
1cbac4ae934d more explicit presentation directory;
wenzelm
parents: 72647
diff changeset
  1269
    def presentation_dir: Path =
69854
cc0b3e177b49 system option "system_heaps" supersedes various command-line options for "system build mode";
wenzelm
parents: 69812
diff changeset
  1270
      if (system_heaps) Path.explode("$ISABELLE_BROWSER_INFO_SYSTEM")
62632
cd991ba01ffd clarified modules;
wenzelm
parents: 62631
diff changeset
  1271
      else Path.explode("$ISABELLE_BROWSER_INFO")
cd991ba01ffd clarified modules;
wenzelm
parents: 62631
diff changeset
  1272
62637
0189fe0f6452 support for Poly/ML heap hierarchy, which saves a lot of disk space;
wenzelm
parents: 62636
diff changeset
  1273
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1274
    /* file names */
65298
wenzelm
parents: 65297
diff changeset
  1275
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1276
    def heap(name: String): Path = Path.basic(name)
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1277
    def database(name: String): Path = Path.basic("log") + Path.basic(name).ext("db")
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1278
    def log(name: String): Path = Path.basic("log") + Path.basic(name)
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1279
    def log_gz(name: String): Path = log(name).ext("gz")
62637
0189fe0f6452 support for Poly/ML heap hierarchy, which saves a lot of disk space;
wenzelm
parents: 62636
diff changeset
  1280
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1281
    def output_heap(name: String): Path = output_dir + heap(name)
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1282
    def output_database(name: String): Path = output_dir + database(name)
68086
9e1c670301b8 cleanup session output before starting build job;
wenzelm
parents: 68018
diff changeset
  1283
    def output_log(name: String): Path = output_dir + log(name)
9e1c670301b8 cleanup session output before starting build job;
wenzelm
parents: 68018
diff changeset
  1284
    def output_log_gz(name: String): Path = output_dir + log_gz(name)
9e1c670301b8 cleanup session output before starting build job;
wenzelm
parents: 68018
diff changeset
  1285
73340
0ffcad1f6130 tuned --- fewer warnings;
wenzelm
parents: 73311
diff changeset
  1286
    def prepare_output_dir(): Unit = Isabelle_System.make_directory(output_dir + Path.basic("log"))
68220
8fc4e3d1df86 clarified store.clean_output: cleanup user_output_dir even in system_mode;
wenzelm
parents: 68219
diff changeset
  1287
62637
0189fe0f6452 support for Poly/ML heap hierarchy, which saves a lot of disk space;
wenzelm
parents: 62636
diff changeset
  1288
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1289
    /* heap */
62637
0189fe0f6452 support for Poly/ML heap hierarchy, which saves a lot of disk space;
wenzelm
parents: 62636
diff changeset
  1290
68212
5a59fded83c7 clarified heap vs. database operations: discontinued correlation of directory;
wenzelm
parents: 68210
diff changeset
  1291
    def find_heap(name: String): Option[Path] =
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1292
      input_dirs.map(_ + heap(name)).find(_.is_file)
68212
5a59fded83c7 clarified heap vs. database operations: discontinued correlation of directory;
wenzelm
parents: 68210
diff changeset
  1293
5a59fded83c7 clarified heap vs. database operations: discontinued correlation of directory;
wenzelm
parents: 68210
diff changeset
  1294
    def find_heap_digest(name: String): Option[String] =
71601
97ccf48c2f0c misc tuning based on hints by IntelliJ IDEA;
wenzelm
parents: 71599
diff changeset
  1295
      find_heap(name).flatMap(read_heap_digest)
62632
cd991ba01ffd clarified modules;
wenzelm
parents: 62631
diff changeset
  1296
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1297
    def the_heap(name: String): Path =
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1298
      find_heap(name) getOrElse
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1299
        error("Missing heap image for session " + quote(name) + " -- expected in:\n" +
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1300
          cat_lines(input_dirs.map(dir => "  " + dir.expand.implode)))
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1301
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1302
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1303
    /* database */
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1304
72634
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1305
    def database_server: Boolean = options.bool("build_database_server")
65281
c70e7d24a16d SQL database operations for combined session info;
wenzelm
parents: 65278
diff changeset
  1306
72634
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1307
    def open_database_server(): SQL.Database =
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1308
      PostgreSQL.open_database(
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1309
        user = options.string("build_database_user"),
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1310
        password = options.string("build_database_password"),
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1311
        database = options.string("build_database_name"),
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1312
        host = options.string("build_database_host"),
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1313
        port = options.int("build_database_port"),
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1314
        ssh =
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1315
          options.proper_string("build_database_ssh_host").map(ssh_host =>
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1316
            SSH.open_session(options,
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1317
              host = ssh_host,
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1318
              user = options.string("build_database_ssh_user"),
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1319
              port = options.int("build_database_ssh_port"))),
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1320
        ssh_close = true)
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1321
72854
6c660f05f70c clarified signature;
wenzelm
parents: 72847
diff changeset
  1322
    def open_database_context(): Database_Context =
6c660f05f70c clarified signature;
wenzelm
parents: 72847
diff changeset
  1323
      new Database_Context(store, if (database_server) Some(open_database_server()) else None)
72682
e0443773ef1a clarified modules;
wenzelm
parents: 72672
diff changeset
  1324
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1325
    def try_open_database(name: String, output: Boolean = false): Option[SQL.Database] = {
72634
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1326
      def check(db: SQL.Database): Option[SQL.Database] =
73367
77ef8bef0593 clarified signature --- fewer warnings;
wenzelm
parents: 73364
diff changeset
  1327
        if (output || session_info_exists(db)) Some(db) else { db.close(); None }
72634
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1328
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1329
      if (database_server) check(open_database_server())
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1330
      else if (output) Some(SQLite.open_database(output_database(name)))
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1331
      else {
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1332
        (for {
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1333
          dir <- input_dirs.view
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1334
          path = dir + database(name) if path.is_file
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1335
          db <- check(SQLite.open_database(path))
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1336
        } yield db).headOption
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1337
      }
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1338
    }
68212
5a59fded83c7 clarified heap vs. database operations: discontinued correlation of directory;
wenzelm
parents: 68210
diff changeset
  1339
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1340
    def open_database(name: String, output: Boolean = false): SQL.Database =
72634
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1341
      try_open_database(name, output = output) getOrElse
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1342
        error("Missing build database for session " + quote(name))
68205
9a8949f71fd4 tuned signature;
wenzelm
parents: 68204
diff changeset
  1343
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1344
    def clean_output(name: String): (Boolean, Boolean) = {
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1345
      val relevant_db =
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1346
        database_server && {
72634
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1347
          try_open_database(name) match {
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1348
            case Some(db) =>
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1349
              try {
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1350
                db.transaction {
72634
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1351
                  val relevant_db = session_info_defined(db, name)
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1352
                  init_session_info(db, name)
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1353
                  relevant_db
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1354
                }
73367
77ef8bef0593 clarified signature --- fewer warnings;
wenzelm
parents: 73364
diff changeset
  1355
              } finally { db.close() }
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1356
            case None => false
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1357
          }
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1358
        }
68212
5a59fded83c7 clarified heap vs. database operations: discontinued correlation of directory;
wenzelm
parents: 68210
diff changeset
  1359
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1360
      val del =
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1361
        for {
69854
cc0b3e177b49 system option "system_heaps" supersedes various command-line options for "system build mode";
wenzelm
parents: 69812
diff changeset
  1362
          dir <-
cc0b3e177b49 system option "system_heaps" supersedes various command-line options for "system build mode";
wenzelm
parents: 69812
diff changeset
  1363
            (if (system_heaps) List(user_output_dir, system_output_dir) else List(user_output_dir))
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1364
          file <- List(heap(name), database(name), log(name), log_gz(name))
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1365
          path = dir + file if path.is_file
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1366
        } yield path.file.delete
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1367
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1368
      val relevant = relevant_db || del.nonEmpty
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1369
      val ok = del.forall(b => b)
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1370
      (relevant, ok)
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1371
    }
65287
75999f2a0c38 tuned message;
wenzelm
parents: 65286
diff changeset
  1372
75999f2a0c38 tuned message;
wenzelm
parents: 65286
diff changeset
  1373
68218
wenzelm
parents: 68217
diff changeset
  1374
    /* SQL database content */
wenzelm
parents: 68217
diff changeset
  1375
wenzelm
parents: 68217
diff changeset
  1376
    def read_bytes(db: SQL.Database, name: String, column: SQL.Column): Bytes =
wenzelm
parents: 68217
diff changeset
  1377
      db.using_statement(Session_Info.table.select(List(column),
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1378
        Session_Info.session_name.where_equal(name))) { stmt =>
68218
wenzelm
parents: 68217
diff changeset
  1379
        val res = stmt.execute_query()
wenzelm
parents: 68217
diff changeset
  1380
        if (!res.next()) Bytes.empty else res.bytes(column)
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1381
      }
68218
wenzelm
parents: 68217
diff changeset
  1382
wenzelm
parents: 68217
diff changeset
  1383
    def read_properties(db: SQL.Database, name: String, column: SQL.Column): List[Properties.T] =
73031
f93f0597f4fb clarified signature: absorb XZ.Cache into XML.Cache;
wenzelm
parents: 73024
diff changeset
  1384
      Properties.uncompress(read_bytes(db, name, column), cache = cache)
68218
wenzelm
parents: 68217
diff changeset
  1385
wenzelm
parents: 68217
diff changeset
  1386
65296
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1387
    /* session info */
65281
c70e7d24a16d SQL database operations for combined session info;
wenzelm
parents: 65278
diff changeset
  1388
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1389
    def init_session_info(db: SQL.Database, name: String): Unit = {
68086
9e1c670301b8 cleanup session output before starting build job;
wenzelm
parents: 68018
diff changeset
  1390
      db.transaction {
9e1c670301b8 cleanup session output before starting build job;
wenzelm
parents: 68018
diff changeset
  1391
        db.create_table(Session_Info.table)
9e1c670301b8 cleanup session output before starting build job;
wenzelm
parents: 68018
diff changeset
  1392
        db.using_statement(
73367
77ef8bef0593 clarified signature --- fewer warnings;
wenzelm
parents: 73364
diff changeset
  1393
          Session_Info.table.delete(Session_Info.session_name.where_equal(name)))(_.execute())
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1394
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1395
        db.create_table(Export.Data.table)
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1396
        db.using_statement(
73367
77ef8bef0593 clarified signature --- fewer warnings;
wenzelm
parents: 73364
diff changeset
  1397
          Export.Data.table.delete(Export.Data.session_name.where_equal(name)))(_.execute())
72653
ea35afdb1366 store documents within session database, instead of browser_info directory;
wenzelm
parents: 72652
diff changeset
  1398
73718
ecb31c3bf980 clarified modules;
wenzelm
parents: 73701
diff changeset
  1399
        db.create_table(Document_Build.Data.table)
72653
ea35afdb1366 store documents within session database, instead of browser_info directory;
wenzelm
parents: 72652
diff changeset
  1400
        db.using_statement(
73718
ecb31c3bf980 clarified modules;
wenzelm
parents: 73701
diff changeset
  1401
          Document_Build.Data.table.delete(
ecb31c3bf980 clarified modules;
wenzelm
parents: 73701
diff changeset
  1402
            Document_Build.Data.session_name.where_equal(name)))(_.execute())
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1403
      }
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1404
    }
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1405
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1406
    def session_info_exists(db: SQL.Database): Boolean = {
72634
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1407
      val tables = db.tables
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1408
      tables.contains(Session_Info.table.name) &&
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1409
      tables.contains(Export.Data.table.name)
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1410
    }
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1411
5cea0993ee4f clarified access to single database server vs. collection of database files;
wenzelm
parents: 72627
diff changeset
  1412
    def session_info_defined(db: SQL.Database, name: String): Boolean =
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1413
      db.transaction {
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1414
        session_info_exists(db) && {
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1415
          db.using_statement(
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1416
            Session_Info.table.select(List(Session_Info.session_name),
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1417
              Session_Info.session_name.where_equal(name)))(stmt => stmt.execute_query().next())
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
  1418
        }
68086
9e1c670301b8 cleanup session output before starting build job;
wenzelm
parents: 68018
diff changeset
  1419
      }
9e1c670301b8 cleanup session output before starting build job;
wenzelm
parents: 68018
diff changeset
  1420
65296
a71db30f3b2d tuned signature;
wenzelm
parents: 65295
diff changeset
  1421
    def write_session_info(
65318
342efc382558 eliminated somewhat redundant inlined name (despite a7aa17a1f721);
wenzelm
parents: 65298
diff changeset
  1422
      db: SQL.Database,
65320
52861eebf58d access table via session_name: db may in principle contain multiple entries;
wenzelm
parents: 65318
diff changeset
  1423
      name: String,
65318
342efc382558 eliminated somewhat redundant inlined name (despite a7aa17a1f721);
wenzelm
parents: 65298
diff changeset
  1424
      build_log: Build_Log.Session_Info,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1425
      build: Build.Session_Info
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1426
    ): Unit = {
65281
c70e7d24a16d SQL database operations for combined session info;
wenzelm
parents: 65278
diff changeset
  1427
      db.transaction {
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1428
        db.using_statement(Session_Info.table.insert()) { stmt =>
65748
1f4a80e80c88 tuned signature;
wenzelm
parents: 65740
diff changeset
  1429
          stmt.string(1) = name
65857
5d29d93766ef clarified use of XML.Cache;
wenzelm
parents: 65833
diff changeset
  1430
          stmt.bytes(2) = Properties.encode(build_log.session_timing)
73031
f93f0597f4fb clarified signature: absorb XZ.Cache into XML.Cache;
wenzelm
parents: 73024
diff changeset
  1431
          stmt.bytes(3) = Properties.compress(build_log.command_timings, cache = cache.xz)
f93f0597f4fb clarified signature: absorb XZ.Cache into XML.Cache;
wenzelm
parents: 73024
diff changeset
  1432
          stmt.bytes(4) = Properties.compress(build_log.theory_timings, cache = cache.xz)
f93f0597f4fb clarified signature: absorb XZ.Cache into XML.Cache;
wenzelm
parents: 73024
diff changeset
  1433
          stmt.bytes(5) = Properties.compress(build_log.ml_statistics, cache = cache.xz)
f93f0597f4fb clarified signature: absorb XZ.Cache into XML.Cache;
wenzelm
parents: 73024
diff changeset
  1434
          stmt.bytes(6) = Properties.compress(build_log.task_statistics, cache = cache.xz)
f93f0597f4fb clarified signature: absorb XZ.Cache into XML.Cache;
wenzelm
parents: 73024
diff changeset
  1435
          stmt.bytes(7) = Build_Log.compress_errors(build_log.errors, cache = cache.xz)
66873
9953ae603a23 provide theory timing information, similar to command timing but always considered relevant;
wenzelm
parents: 66857
diff changeset
  1436
          stmt.string(8) = build.sources
9953ae603a23 provide theory timing information, similar to command timing but always considered relevant;
wenzelm
parents: 66857
diff changeset
  1437
          stmt.string(9) = cat_lines(build.input_heaps)
9953ae603a23 provide theory timing information, similar to command timing but always considered relevant;
wenzelm
parents: 66857
diff changeset
  1438
          stmt.string(10) = build.output_heap getOrElse ""
9953ae603a23 provide theory timing information, similar to command timing but always considered relevant;
wenzelm
parents: 66857
diff changeset
  1439
          stmt.int(11) = build.return_code
65281
c70e7d24a16d SQL database operations for combined session info;
wenzelm
parents: 65278
diff changeset
  1440
          stmt.execute()
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1441
        }
65281
c70e7d24a16d SQL database operations for combined session info;
wenzelm
parents: 65278
diff changeset
  1442
      }
c70e7d24a16d SQL database operations for combined session info;
wenzelm
parents: 65278
diff changeset
  1443
    }
c70e7d24a16d SQL database operations for combined session info;
wenzelm
parents: 65278
diff changeset
  1444
65320
52861eebf58d access table via session_name: db may in principle contain multiple entries;
wenzelm
parents: 65318
diff changeset
  1445
    def read_session_timing(db: SQL.Database, name: String): Properties.T =
73031
f93f0597f4fb clarified signature: absorb XZ.Cache into XML.Cache;
wenzelm
parents: 73024
diff changeset
  1446
      Properties.decode(read_bytes(db, name, Session_Info.session_timing), cache = cache)
65286
b661543a0de6 clarified signature;
wenzelm
parents: 65285
diff changeset
  1447
65320
52861eebf58d access table via session_name: db may in principle contain multiple entries;
wenzelm
parents: 65318
diff changeset
  1448
    def read_command_timings(db: SQL.Database, name: String): List[Properties.T] =
52861eebf58d access table via session_name: db may in principle contain multiple entries;
wenzelm
parents: 65318
diff changeset
  1449
      read_properties(db, name, Session_Info.command_timings)
65286
b661543a0de6 clarified signature;
wenzelm
parents: 65285
diff changeset
  1450
66873
9953ae603a23 provide theory timing information, similar to command timing but always considered relevant;
wenzelm
parents: 66857
diff changeset
  1451
    def read_theory_timings(db: SQL.Database, name: String): List[Properties.T] =
9953ae603a23 provide theory timing information, similar to command timing but always considered relevant;
wenzelm
parents: 66857
diff changeset
  1452
      read_properties(db, name, Session_Info.theory_timings)
9953ae603a23 provide theory timing information, similar to command timing but always considered relevant;
wenzelm
parents: 66857
diff changeset
  1453
65320
52861eebf58d access table via session_name: db may in principle contain multiple entries;
wenzelm
parents: 65318
diff changeset
  1454
    def read_ml_statistics(db: SQL.Database, name: String): List[Properties.T] =
52861eebf58d access table via session_name: db may in principle contain multiple entries;
wenzelm
parents: 65318
diff changeset
  1455
      read_properties(db, name, Session_Info.ml_statistics)
65286
b661543a0de6 clarified signature;
wenzelm
parents: 65285
diff changeset
  1456
65320
52861eebf58d access table via session_name: db may in principle contain multiple entries;
wenzelm
parents: 65318
diff changeset
  1457
    def read_task_statistics(db: SQL.Database, name: String): List[Properties.T] =
52861eebf58d access table via session_name: db may in principle contain multiple entries;
wenzelm
parents: 65318
diff changeset
  1458
      read_properties(db, name, Session_Info.task_statistics)
65286
b661543a0de6 clarified signature;
wenzelm
parents: 65285
diff changeset
  1459
72738
a4d7da18ac5c store timings for used_theories in canonical order, with reconstructed store.read_theories;
wenzelm
parents: 72716
diff changeset
  1460
    def read_theories(db: SQL.Database, name: String): List[String] =
a4d7da18ac5c store timings for used_theories in canonical order, with reconstructed store.read_theories;
wenzelm
parents: 72716
diff changeset
  1461
      read_theory_timings(db, name).flatMap(Markup.Name.unapply)
a4d7da18ac5c store timings for used_theories in canonical order, with reconstructed store.read_theories;
wenzelm
parents: 72716
diff changeset
  1462
65937
fde7b5d209d5 store errors in build_history logs and database;
wenzelm
parents: 65934
diff changeset
  1463
    def read_errors(db: SQL.Database, name: String): List[String] =
73033
d2690444c00a clarified caching;
wenzelm
parents: 73031
diff changeset
  1464
      Build_Log.uncompress_errors(read_bytes(db, name, Session_Info.errors), cache = cache)
65937
fde7b5d209d5 store errors in build_history logs and database;
wenzelm
parents: 65934
diff changeset
  1465
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 75382
diff changeset
  1466
    def read_build(db: SQL.Database, name: String): Option[Build.Session_Info] = {
66957
82d13ba817b2 more permissive: db could be empty after hard crash;
wenzelm
parents: 66914
diff changeset
  1467
      if (db.tables.contains(Session_Info.table.name)) {
82d13ba817b2 more permissive: db could be empty after hard crash;
wenzelm
parents: 66914
diff changeset
  1468
        db.using_statement(Session_Info.table.select(Session_Info.build_columns,
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1469
          Session_Info.session_name.where_equal(name))) { stmt =>
66957
82d13ba817b2 more permissive: db could be empty after hard crash;
wenzelm
parents: 66914
diff changeset
  1470
          val res = stmt.execute_query()
82d13ba817b2 more permissive: db could be empty after hard crash;
wenzelm
parents: 66914
diff changeset
  1471
          if (!res.next()) None
82d13ba817b2 more permissive: db could be empty after hard crash;
wenzelm
parents: 66914
diff changeset
  1472
          else {
82d13ba817b2 more permissive: db could be empty after hard crash;
wenzelm
parents: 66914
diff changeset
  1473
            Some(
82d13ba817b2 more permissive: db could be empty after hard crash;
wenzelm
parents: 66914
diff changeset
  1474
              Build.Session_Info(
82d13ba817b2 more permissive: db could be empty after hard crash;
wenzelm
parents: 66914
diff changeset
  1475
                res.string(Session_Info.sources),
82d13ba817b2 more permissive: db could be empty after hard crash;
wenzelm
parents: 66914
diff changeset
  1476
                split_lines(res.string(Session_Info.input_heaps)),
82d13ba817b2 more permissive: db could be empty after hard crash;
wenzelm
parents: 66914
diff changeset
  1477
                res.string(Session_Info.output_heap) match { case "" => None case s => Some(s) },
82d13ba817b2 more permissive: db could be empty after hard crash;
wenzelm
parents: 66914
diff changeset
  1478
                res.int(Session_Info.return_code)))
82d13ba817b2 more permissive: db could be empty after hard crash;
wenzelm
parents: 66914
diff changeset
  1479
          }
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
  1480
        }
66957
82d13ba817b2 more permissive: db could be empty after hard crash;
wenzelm
parents: 66914
diff changeset
  1481
      }
82d13ba817b2 more permissive: db could be empty after hard crash;
wenzelm
parents: 66914
diff changeset
  1482
      else None
66744
fec1504e5f03 persistent storage of imported_sources;
wenzelm
parents: 66743
diff changeset
  1483
    }
65281
c70e7d24a16d SQL database operations for combined session info;
wenzelm
parents: 65278
diff changeset
  1484
  }
62631
c39614ddb80b clarified modules;
wenzelm
parents:
diff changeset
  1485
}