src/Pure/Thy/sessions.scala
author wenzelm
Tue Nov 07 17:16:53 2017 +0100 (19 months ago)
changeset 67028 c4e678c2df3c
parent 67027 d4f245bea081
child 67029 d6d9fd2559ce
permissions -rw-r--r--
clarified exclusion: operate on completed selection, as last step;
wenzelm@62631
     1
/*  Title:      Pure/Thy/sessions.scala
wenzelm@62631
     2
    Author:     Makarius
wenzelm@62631
     3
wenzelm@65430
     4
Cumulative session information.
wenzelm@62631
     5
*/
wenzelm@62631
     6
wenzelm@62631
     7
package isabelle
wenzelm@62631
     8
wenzelm@65461
     9
import java.io.{File => JFile}
wenzelm@62704
    10
import java.nio.ByteBuffer
wenzelm@62704
    11
import java.nio.channels.FileChannel
wenzelm@62704
    12
import java.nio.file.StandardOpenOption
wenzelm@62631
    13
wenzelm@62631
    14
import scala.collection.SortedSet
wenzelm@62631
    15
import scala.collection.mutable
wenzelm@62631
    16
wenzelm@62631
    17
wenzelm@62631
    18
object Sessions
wenzelm@62631
    19
{
wenzelm@65360
    20
  /* base info and source dependencies */
wenzelm@62883
    21
wenzelm@65445
    22
  val DRAFT = "Draft"
wenzelm@65445
    23
wenzelm@65360
    24
  def is_pure(name: String): Boolean = name == Thy_Header.PURE
wenzelm@64856
    25
wenzelm@65495
    26
  object Known
wenzelm@64856
    27
  {
wenzelm@65495
    28
    val empty: Known = Known()
wenzelm@65360
    29
wenzelm@66701
    30
    def make(local_dir: Path, bases: List[Base],
wenzelm@66701
    31
      theories: List[Document.Node.Name] = Nil,
wenzelm@66701
    32
      loaded_files: List[(String, List[Path])] = Nil): Known =
wenzelm@65427
    33
    {
wenzelm@65463
    34
      def bases_iterator(local: Boolean) =
wenzelm@65463
    35
        for {
wenzelm@65463
    36
          base <- bases.iterator
wenzelm@65499
    37
          (_, name) <- (if (local) base.known.theories_local else base.known.theories).iterator
wenzelm@65463
    38
        } yield name
wenzelm@65463
    39
wenzelm@65463
    40
      def local_theories_iterator =
wenzelm@65463
    41
      {
wenzelm@65833
    42
        val local_path = local_dir.canonical_file.toPath
wenzelm@66716
    43
        theories.iterator.filter(name => name.path.canonical_file.toPath.startsWith(local_path))
wenzelm@65463
    44
      }
wenzelm@65427
    45
wenzelm@65461
    46
      val known_theories =
wenzelm@65463
    47
        (Map.empty[String, Document.Node.Name] /: (bases_iterator(false) ++ theories.iterator))({
wenzelm@65461
    48
          case (known, name) =>
wenzelm@65461
    49
            known.get(name.theory) match {
wenzelm@65461
    50
              case Some(name1) if name != name1 =>
wenzelm@65461
    51
                error("Duplicate theory " + quote(name.node) + " vs. " + quote(name1.node))
wenzelm@65461
    52
              case _ => known + (name.theory -> name)
wenzelm@65461
    53
            }
wenzelm@65461
    54
          })
wenzelm@65463
    55
      val known_theories_local =
wenzelm@65463
    56
        (Map.empty[String, Document.Node.Name] /:
wenzelm@65463
    57
            (bases_iterator(true) ++ local_theories_iterator))({
wenzelm@65463
    58
          case (known, name) => known + (name.theory -> name)
wenzelm@65463
    59
        })
wenzelm@65461
    60
      val known_files =
wenzelm@65463
    61
        (Map.empty[JFile, List[Document.Node.Name]] /:
wenzelm@65463
    62
            (bases_iterator(true) ++ bases_iterator(false) ++ theories.iterator))({
wenzelm@65461
    63
          case (known, name) =>
wenzelm@66716
    64
            val file = name.path.canonical_file
wenzelm@65463
    65
            val theories1 = known.getOrElse(file, Nil)
wenzelm@65463
    66
            if (theories1.exists(name1 => name.node == name1.node && name.theory == name1.theory))
wenzelm@65461
    67
              known
wenzelm@65463
    68
            else known + (file -> (name :: theories1))
wenzelm@65427
    69
        })
wenzelm@66701
    70
wenzelm@66701
    71
      val known_loaded_files =
wenzelm@66701
    72
        (loaded_files.toMap /: bases.map(base => base.known.loaded_files))(_ ++ _)
wenzelm@66701
    73
wenzelm@65495
    74
      Known(known_theories, known_theories_local,
wenzelm@66701
    75
        known_files.iterator.map(p => (p._1, p._2.reverse)).toMap,
wenzelm@66701
    76
        known_loaded_files)
wenzelm@65427
    77
    }
wenzelm@64856
    78
  }
wenzelm@64856
    79
wenzelm@65495
    80
  sealed case class Known(
wenzelm@65499
    81
    theories: Map[String, Document.Node.Name] = Map.empty,
wenzelm@65499
    82
    theories_local: Map[String, Document.Node.Name] = Map.empty,
wenzelm@66701
    83
    files: Map[JFile, List[Document.Node.Name]] = Map.empty,
wenzelm@66701
    84
    loaded_files: Map[String, List[Path]] = Map.empty)
wenzelm@65355
    85
  {
wenzelm@65495
    86
    def platform_path: Known =
wenzelm@65499
    87
      copy(theories = for ((a, b) <- theories) yield (a, b.map(File.platform_path(_))),
wenzelm@65499
    88
        theories_local = for ((a, b) <- theories_local) yield (a, b.map(File.platform_path(_))),
wenzelm@65499
    89
        files = for ((a, b) <- files) yield (a, b.map(c => c.map(File.platform_path(_)))))
wenzelm@65524
    90
wenzelm@66668
    91
    def standard_path: Known =
wenzelm@66668
    92
      copy(theories = for ((a, b) <- theories) yield (a, b.map(File.standard_path(_))),
wenzelm@66668
    93
        theories_local = for ((a, b) <- theories_local) yield (a, b.map(File.standard_path(_))),
wenzelm@66668
    94
        files = for ((a, b) <- files) yield (a, b.map(c => c.map(File.standard_path(_)))))
wenzelm@66668
    95
wenzelm@66195
    96
    def get_file(file: JFile, bootstrap: Boolean = false): Option[Document.Node.Name] =
wenzelm@66195
    97
    {
wenzelm@66234
    98
      val res = files.getOrElse(File.canonical(file), Nil).headOption
wenzelm@66195
    99
      if (bootstrap) res.map(_.map_theory(Thy_Header.bootstrap_name(_))) else res
wenzelm@66195
   100
    }
wenzelm@65495
   101
  }
wenzelm@65495
   102
wenzelm@65495
   103
  object Base
wenzelm@65495
   104
  {
wenzelm@65495
   105
    def bootstrap(global_theories: Map[String, String]): Base =
wenzelm@65495
   106
      Base(
wenzelm@65495
   107
        global_theories = global_theories,
wenzelm@66720
   108
        overall_syntax = Thy_Header.bootstrap_syntax)
wenzelm@65495
   109
  }
wenzelm@65495
   110
wenzelm@65495
   111
  sealed case class Base(
wenzelm@66571
   112
    pos: Position.T = Position.none,
wenzelm@65495
   113
    global_theories: Map[String, String] = Map.empty,
wenzelm@66717
   114
    loaded_theories: Graph[String, Outer_Syntax] = Graph.string,
wenzelm@65495
   115
    known: Known = Known.empty,
wenzelm@66720
   116
    overall_syntax: Outer_Syntax = Outer_Syntax.empty,
wenzelm@66744
   117
    imported_sources: List[(Path, SHA1.Digest)] = Nil,
wenzelm@65495
   118
    sources: List[(Path, SHA1.Digest)] = Nil,
wenzelm@66822
   119
    session_graph_display: Graph_Display.Graph = Graph_Display.empty_graph,
wenzelm@66694
   120
    errors: List[String] = Nil,
wenzelm@66694
   121
    imports: Option[Base] = None)
wenzelm@65495
   122
  {
wenzelm@65495
   123
    def platform_path: Base = copy(known = known.platform_path)
wenzelm@66668
   124
    def standard_path: Base = copy(known = known.standard_path)
wenzelm@65463
   125
wenzelm@66967
   126
    def theory_qualifier(name: String): String =
wenzelm@66967
   127
      global_theories.getOrElse(name, Long_Name.qualifier(name))
wenzelm@66967
   128
    def theory_qualifier(name: Document.Node.Name): String = theory_qualifier(name.theory)
wenzelm@66966
   129
wenzelm@66717
   130
    def loaded_theory(name: String): Boolean = loaded_theories.defined(name)
wenzelm@66712
   131
    def loaded_theory(name: Document.Node.Name): Boolean = loaded_theory(name.theory)
wenzelm@65432
   132
wenzelm@66717
   133
    def loaded_theory_syntax(name: String): Option[Outer_Syntax] =
wenzelm@66717
   134
      if (loaded_theory(name)) Some(loaded_theories.get_node(name)) else None
wenzelm@66717
   135
    def loaded_theory_syntax(name: Document.Node.Name): Option[Outer_Syntax] =
wenzelm@66717
   136
      loaded_theory_syntax(name.theory)
wenzelm@66717
   137
wenzelm@66770
   138
    def node_syntax(nodes: Document.Nodes, name: Document.Node.Name): Outer_Syntax =
wenzelm@66770
   139
      nodes(name).syntax orElse loaded_theory_syntax(name) getOrElse overall_syntax
wenzelm@66721
   140
wenzelm@65498
   141
    def known_theory(name: String): Option[Document.Node.Name] =
wenzelm@65499
   142
      known.theories.get(name)
wenzelm@65498
   143
wenzelm@65432
   144
    def dest_known_theories: List[(String, String)] =
wenzelm@65499
   145
      for ((theory, node_name) <- known.theories.toList)
wenzelm@65432
   146
        yield (theory, node_name.node)
wenzelm@66694
   147
wenzelm@66694
   148
    def get_imports: Base = imports getOrElse Base.bootstrap(global_theories)
wenzelm@65355
   149
  }
wenzelm@64856
   150
wenzelm@65495
   151
  sealed case class Deps(session_bases: Map[String, Base], all_known: Known)
wenzelm@65251
   152
  {
wenzelm@65463
   153
    def is_empty: Boolean = session_bases.isEmpty
wenzelm@65463
   154
    def apply(name: String): Base = session_bases(name)
wenzelm@66988
   155
    def get(name: String): Option[Base] = session_bases.get(name)
wenzelm@66744
   156
wenzelm@66744
   157
    def imported_sources(name: String): List[SHA1.Digest] =
wenzelm@66744
   158
      session_bases(name).imported_sources.map(_._2)
wenzelm@66744
   159
wenzelm@66744
   160
    def sources(name: String): List[SHA1.Digest] =
wenzelm@66744
   161
      session_bases(name).sources.map(_._2)
wenzelm@66571
   162
wenzelm@66571
   163
    def errors: List[String] =
wenzelm@66571
   164
      (for {
wenzelm@66571
   165
        (name, base) <- session_bases.iterator
wenzelm@66571
   166
        if base.errors.nonEmpty
wenzelm@66571
   167
      } yield cat_lines(base.errors) +
wenzelm@66571
   168
          "\nThe error(s) above occurred in session " + quote(name) + Position.here(base.pos)
wenzelm@66571
   169
      ).toList
wenzelm@66571
   170
wenzelm@66571
   171
    def check_errors: Deps =
wenzelm@66571
   172
      errors match {
wenzelm@66571
   173
        case Nil => this
wenzelm@66571
   174
        case errs => error(cat_lines(errs))
wenzelm@66571
   175
      }
wenzelm@65251
   176
  }
wenzelm@64856
   177
wenzelm@67024
   178
  def deps(sessions_structure: T,
wenzelm@66962
   179
      global_theories: Map[String, String],
wenzelm@65251
   180
      progress: Progress = No_Progress,
wenzelm@65251
   181
      inlined_files: Boolean = false,
wenzelm@65251
   182
      verbose: Boolean = false,
wenzelm@65251
   183
      list_files: Boolean = false,
wenzelm@66962
   184
      check_keywords: Set[String] = Set.empty): Deps =
wenzelm@65372
   185
  {
wenzelm@66743
   186
    var cache_sources = Map.empty[JFile, SHA1.Digest]
wenzelm@66743
   187
    def check_sources(paths: List[Path]): List[(Path, SHA1.Digest)] =
wenzelm@66743
   188
    {
wenzelm@66743
   189
      for {
wenzelm@66743
   190
        path <- paths
wenzelm@66743
   191
        file = path.file
wenzelm@66743
   192
        if cache_sources.isDefinedAt(file) || file.isFile
wenzelm@66743
   193
      }
wenzelm@66743
   194
      yield {
wenzelm@66743
   195
        cache_sources.get(file) match {
wenzelm@66743
   196
          case Some(digest) => (path, digest)
wenzelm@66743
   197
          case None =>
wenzelm@66743
   198
            val digest = SHA1.digest(file)
wenzelm@66743
   199
            cache_sources = cache_sources + (file -> digest)
wenzelm@66743
   200
            (path, digest)
wenzelm@66743
   201
        }
wenzelm@66743
   202
      }
wenzelm@66743
   203
    }
wenzelm@66743
   204
wenzelm@65463
   205
    val session_bases =
wenzelm@67024
   206
      (Map.empty[String, Base] /: sessions_structure.imports_topological_order)({
wenzelm@67023
   207
        case (session_bases, session_name) =>
wenzelm@65463
   208
          if (progress.stopped) throw Exn.Interrupt()
wenzelm@65251
   209
wenzelm@67024
   210
          val info = sessions_structure(session_name)
wenzelm@65463
   211
          try {
wenzelm@65496
   212
            val parent_base: Sessions.Base =
wenzelm@65463
   213
              info.parent match {
wenzelm@65475
   214
                case None => Base.bootstrap(global_theories)
wenzelm@65463
   215
                case Some(parent) => session_bases(parent)
wenzelm@65463
   216
              }
wenzelm@65496
   217
            val imports_base: Sessions.Base =
wenzelm@65496
   218
              parent_base.copy(known =
wenzelm@66701
   219
                Known.make(info.dir, parent_base :: info.imports.map(session_bases(_))))
wenzelm@65496
   220
wenzelm@65532
   221
            val resources = new Resources(imports_base)
wenzelm@65251
   222
wenzelm@65463
   223
            if (verbose || list_files) {
wenzelm@65463
   224
              val groups =
wenzelm@65463
   225
                if (info.groups.isEmpty) ""
wenzelm@65463
   226
                else info.groups.mkString(" (", " ", ")")
wenzelm@65519
   227
              progress.echo("Session " + info.chapter + "/" + info.name + groups)
wenzelm@65463
   228
            }
wenzelm@65251
   229
wenzelm@65463
   230
            val thy_deps =
wenzelm@66959
   231
              resources.dependencies(
wenzelm@66742
   232
                for { (_, thys) <- info.theories; (thy, pos) <- thys }
wenzelm@66780
   233
                yield (resources.import_name(info.name, info.dir.implode, thy), pos))
wenzelm@65251
   234
wenzelm@66720
   235
            val overall_syntax = thy_deps.overall_syntax
wenzelm@65251
   236
wenzelm@66716
   237
            val theory_files = thy_deps.names.map(_.path)
wenzelm@65463
   238
            val loaded_files =
wenzelm@65463
   239
              if (inlined_files) {
wenzelm@66701
   240
                if (Sessions.is_pure(info.name)) {
wenzelm@66720
   241
                  (Thy_Header.PURE -> resources.pure_files(overall_syntax, info.dir)) ::
wenzelm@66701
   242
                    thy_deps.loaded_files.filterNot(p => p._1 == Thy_Header.PURE)
wenzelm@66701
   243
                }
wenzelm@66701
   244
                else thy_deps.loaded_files
wenzelm@65463
   245
              }
wenzelm@65463
   246
              else Nil
wenzelm@65251
   247
wenzelm@66742
   248
            val session_files =
wenzelm@66701
   249
              (theory_files ::: loaded_files.flatMap(_._2) :::
wenzelm@65463
   250
                info.document_files.map(file => info.dir + file._1 + file._2)).map(_.expand)
wenzelm@65463
   251
wenzelm@66743
   252
            val imported_files = if (inlined_files) thy_deps.imported_files else Nil
wenzelm@66743
   253
wenzelm@65463
   254
            if (list_files)
wenzelm@66742
   255
              progress.echo(cat_lines(session_files.map(_.implode).sorted.map("  " + _)))
wenzelm@65463
   256
wenzelm@66719
   257
            if (check_keywords.nonEmpty) {
wenzelm@66719
   258
              Check_Keywords.check_keywords(
wenzelm@66720
   259
                progress, overall_syntax.keywords, check_keywords, theory_files)
wenzelm@66719
   260
            }
wenzelm@65251
   261
wenzelm@66822
   262
            val session_graph_display: Graph_Display.Graph =
wenzelm@65507
   263
            {
wenzelm@65507
   264
              def session_node(name: String): Graph_Display.Node =
wenzelm@65507
   265
                Graph_Display.Node("[" + name + "]", "session." + name)
wenzelm@65507
   266
wenzelm@65507
   267
              def node(name: Document.Node.Name): Graph_Display.Node =
wenzelm@65507
   268
              {
wenzelm@66966
   269
                val qualifier = imports_base.theory_qualifier(name)
wenzelm@66780
   270
                if (qualifier == info.name)
wenzelm@65507
   271
                  Graph_Display.Node(name.theory_base_name, "theory." + name.theory)
wenzelm@65528
   272
                else session_node(qualifier)
wenzelm@65507
   273
              }
wenzelm@65507
   274
wenzelm@65507
   275
              val imports_subgraph =
wenzelm@67024
   276
                sessions_structure.imports_graph.
wenzelm@67024
   277
                  restrict(sessions_structure.imports_graph.all_preds(info.deps).toSet)
wenzelm@65507
   278
wenzelm@65507
   279
              val graph0 =
wenzelm@65507
   280
                (Graph_Display.empty_graph /: imports_subgraph.topological_order)(
wenzelm@65507
   281
                  { case (g, session) =>
wenzelm@65507
   282
                      val a = session_node(session)
wenzelm@65507
   283
                      val bs = imports_subgraph.imm_preds(session).toList.map(session_node(_))
wenzelm@65507
   284
                      ((g /: (a :: bs))(_.default_node(_, Nil)) /: bs)(_.add_edge(_, a)) })
wenzelm@65507
   285
wenzelm@66714
   286
              (graph0 /: thy_deps.entries)(
wenzelm@66714
   287
                { case (g, entry) =>
wenzelm@66714
   288
                    val a = node(entry.name)
wenzelm@65507
   289
                    val bs =
wenzelm@66714
   290
                      entry.header.imports.map({ case (name, _) => node(name) }).
wenzelm@65507
   291
                        filterNot(_ == a)
wenzelm@65507
   292
                    ((g /: (a :: bs))(_.default_node(_, Nil)) /: bs)(_.add_edge(_, a)) })
wenzelm@65507
   293
            }
wenzelm@65507
   294
wenzelm@66701
   295
            val known =
wenzelm@66701
   296
              Known.make(info.dir, List(imports_base),
wenzelm@66715
   297
                theories = thy_deps.names,
wenzelm@66701
   298
                loaded_files = loaded_files)
wenzelm@66701
   299
wenzelm@66743
   300
            val sources_errors =
wenzelm@66743
   301
              for (p <- session_files if !p.is_file) yield "No such file: " + p
wenzelm@66604
   302
wenzelm@65463
   303
            val base =
wenzelm@66571
   304
              Base(
wenzelm@66571
   305
                pos = info.pos,
wenzelm@65540
   306
                global_theories = global_theories,
wenzelm@65463
   307
                loaded_theories = thy_deps.loaded_theories,
wenzelm@66701
   308
                known = known,
wenzelm@66720
   309
                overall_syntax = overall_syntax,
wenzelm@66744
   310
                imported_sources = check_sources(imported_files),
wenzelm@66743
   311
                sources = check_sources(session_files),
wenzelm@66822
   312
                session_graph_display = session_graph_display,
wenzelm@66694
   313
                errors = thy_deps.errors ::: sources_errors,
wenzelm@66694
   314
                imports = Some(imports_base))
wenzelm@65251
   315
wenzelm@65519
   316
            session_bases + (info.name -> base)
wenzelm@65463
   317
          }
wenzelm@65463
   318
          catch {
wenzelm@65463
   319
            case ERROR(msg) =>
wenzelm@65463
   320
              cat_error(msg, "The error(s) above occurred in session " +
wenzelm@65519
   321
                quote(info.name) + Position.here(info.pos))
wenzelm@65463
   322
          }
wenzelm@65463
   323
      })
wenzelm@65251
   324
wenzelm@66701
   325
    Deps(session_bases, Known.make(Path.current, session_bases.toList.map(_._2)))
wenzelm@65372
   326
  }
wenzelm@65251
   327
wenzelm@66963
   328
wenzelm@66963
   329
  /* base info */
wenzelm@66963
   330
wenzelm@66974
   331
  sealed case class Base_Info(
wenzelm@66974
   332
    session: String,
wenzelm@67024
   333
    sessions_structure: T,
wenzelm@66975
   334
    errors: List[String],
wenzelm@66974
   335
    base: Base,
wenzelm@66974
   336
    infos: List[Info])
wenzelm@66974
   337
  {
wenzelm@66974
   338
    def check_base: Base = if (errors.isEmpty) base else error(cat_lines(errors))
wenzelm@66974
   339
  }
wenzelm@66974
   340
wenzelm@66976
   341
  def base_info(options: Options, session: String,
wenzelm@65428
   342
    dirs: List[Path] = Nil,
wenzelm@66988
   343
    ancestor_session: Option[String] = None,
wenzelm@66968
   344
    all_known: Boolean = false,
wenzelm@66987
   345
    focus_session: Boolean = false,
wenzelm@66968
   346
    required_session: Boolean = false): Base_Info =
wenzelm@65251
   347
  {
wenzelm@67026
   348
    val full_sessions = load_structure(options, dirs = dirs)
wenzelm@65428
   349
    val global_theories = full_sessions.global_theories
wenzelm@65372
   350
wenzelm@66990
   351
    val selected_sessions =
wenzelm@67025
   352
      full_sessions.selection(Selection(sessions = session :: ancestor_session.toList))
wenzelm@66974
   353
    val info = selected_sessions(session)
wenzelm@66988
   354
    val ancestor = ancestor_session orElse info.parent
wenzelm@66963
   355
wenzelm@66974
   356
    val (session1, infos1) =
wenzelm@66988
   357
      if (required_session && ancestor.isDefined) {
wenzelm@66974
   358
        val deps = Sessions.deps(selected_sessions, global_theories)
wenzelm@66974
   359
        val base = deps(session)
wenzelm@66968
   360
wenzelm@66988
   361
        val ancestor_loaded =
wenzelm@66988
   362
          deps.get(ancestor.get) match {
wenzelm@66990
   363
            case Some(ancestor_base)
wenzelm@66990
   364
            if !selected_sessions.imports_requirements(List(ancestor.get)).contains(session) =>
wenzelm@66990
   365
              ancestor_base.loaded_theories.defined(_)
wenzelm@66990
   366
            case _ =>
wenzelm@66988
   367
              error("Bad ancestor " + quote(ancestor.get) + " for session " + quote(session))
wenzelm@66988
   368
          }
wenzelm@66974
   369
wenzelm@66974
   370
        val required_theories =
wenzelm@66968
   371
          for {
wenzelm@66968
   372
            thy <- base.loaded_theories.keys
wenzelm@66988
   373
            if !ancestor_loaded(thy) && base.theory_qualifier(thy) != session
wenzelm@66968
   374
          }
wenzelm@66974
   375
          yield thy
wenzelm@66968
   376
wenzelm@66988
   377
        if (required_theories.isEmpty) (ancestor.get, Nil)
wenzelm@66968
   378
        else {
wenzelm@66988
   379
          val other_name = info.name + "_base(" + ancestor.get + ")"
wenzelm@66974
   380
          (other_name,
wenzelm@66968
   381
            List(
wenzelm@66968
   382
              make_info(info.options,
wenzelm@66968
   383
                dir_selected = false,
wenzelm@66968
   384
                dir = info.dir,
wenzelm@66968
   385
                chapter = info.chapter,
wenzelm@66968
   386
                Session_Entry(
wenzelm@66968
   387
                  pos = info.pos,
wenzelm@66968
   388
                  name = other_name,
wenzelm@66968
   389
                  groups = info.groups,
wenzelm@66968
   390
                  path = ".",
wenzelm@66988
   391
                  parent = ancestor,
wenzelm@66974
   392
                  description = "Required theory imports from other sessions",
wenzelm@66968
   393
                  options = Nil,
wenzelm@66991
   394
                  imports = info.deps,
wenzelm@66974
   395
                  theories = List((Nil, required_theories.map(thy => ((thy, Position.none), false)))),
wenzelm@66974
   396
                  document_files = Nil))))
wenzelm@66968
   397
        }
wenzelm@66968
   398
      }
wenzelm@66974
   399
      else (session, Nil)
wenzelm@66968
   400
wenzelm@66974
   401
    val full_sessions1 =
wenzelm@66974
   402
      if (infos1.isEmpty) full_sessions
wenzelm@67026
   403
      else load_structure(options, dirs = dirs, infos = infos1)
wenzelm@66987
   404
wenzelm@66987
   405
    val select_sessions1 =
wenzelm@66987
   406
      if (focus_session) full_sessions1.imports_descendants(List(session1))
wenzelm@66987
   407
      else List(session1)
wenzelm@66987
   408
    val selected_sessions1 =
wenzelm@67025
   409
      full_sessions1.selection(Selection(sessions = select_sessions1))
wenzelm@66964
   410
wenzelm@66974
   411
    val sessions1 = if (all_known) full_sessions1 else selected_sessions1
wenzelm@66974
   412
    val deps1 = Sessions.deps(sessions1, global_theories)
wenzelm@66974
   413
    val base1 = if (all_known) deps1(session1).copy(known = deps1.all_known) else deps1(session1)
wenzelm@66964
   414
wenzelm@66975
   415
    Base_Info(session1, sessions1, deps1.errors, base1, infos1)
wenzelm@65251
   416
  }
wenzelm@65251
   417
wenzelm@65251
   418
wenzelm@65415
   419
  /* cumulative session info */
wenzelm@62631
   420
wenzelm@62631
   421
  sealed case class Info(
wenzelm@65519
   422
    name: String,
wenzelm@62631
   423
    chapter: String,
wenzelm@66829
   424
    dir_selected: Boolean,
wenzelm@62631
   425
    pos: Position.T,
wenzelm@62631
   426
    groups: List[String],
wenzelm@62631
   427
    dir: Path,
wenzelm@62631
   428
    parent: Option[String],
wenzelm@62631
   429
    description: String,
wenzelm@62631
   430
    options: Options,
wenzelm@65420
   431
    imports: List[String],
wenzelm@65517
   432
    theories: List[(Options, List[(String, Position.T)])],
wenzelm@65374
   433
    global_theories: List[String],
wenzelm@62631
   434
    document_files: List[(Path, Path)],
wenzelm@62631
   435
    meta_digest: SHA1.Digest)
wenzelm@62631
   436
  {
wenzelm@66828
   437
    def deps: List[String] = parent.toList ::: imports
wenzelm@66828
   438
wenzelm@62631
   439
    def timeout: Time = Time.seconds(options.real("timeout") * options.real("timeout_scale"))
wenzelm@62631
   440
  }
wenzelm@62631
   441
wenzelm@66967
   442
  def make_info(options: Options, dir_selected: Boolean, dir: Path, chapter: String,
wenzelm@66967
   443
    entry: Session_Entry): Info =
wenzelm@66967
   444
  {
wenzelm@66967
   445
    try {
wenzelm@66967
   446
      val name = entry.name
wenzelm@66967
   447
wenzelm@66967
   448
      if (name == "" || name == DRAFT) error("Bad session name")
wenzelm@66967
   449
      if (is_pure(name) && entry.parent.isDefined) error("Illegal parent session")
wenzelm@66967
   450
      if (!is_pure(name) && !entry.parent.isDefined) error("Missing parent session")
wenzelm@66967
   451
wenzelm@66967
   452
      val session_options = options ++ entry.options
wenzelm@66967
   453
wenzelm@66967
   454
      val theories =
wenzelm@66967
   455
        entry.theories.map({ case (opts, thys) => (session_options ++ opts, thys.map(_._1)) })
wenzelm@66967
   456
wenzelm@66967
   457
      val global_theories =
wenzelm@66967
   458
        for { (_, thys) <- entry.theories; ((thy, pos), global) <- thys if global }
wenzelm@66967
   459
        yield {
wenzelm@66967
   460
          val thy_name = Path.explode(thy).expand.base_name
wenzelm@66967
   461
          if (Long_Name.is_qualified(thy_name))
wenzelm@66967
   462
            error("Bad qualified name for global theory " +
wenzelm@66967
   463
              quote(thy_name) + Position.here(pos))
wenzelm@66967
   464
          else thy_name
wenzelm@66967
   465
        }
wenzelm@66967
   466
wenzelm@66967
   467
      val conditions =
wenzelm@66967
   468
        theories.flatMap(thys => space_explode(',', thys._1.string("condition"))).distinct.sorted.
wenzelm@66967
   469
          map(x => (x, Isabelle_System.getenv(x) != ""))
wenzelm@66967
   470
wenzelm@66967
   471
      val document_files =
wenzelm@66967
   472
        entry.document_files.map({ case (s1, s2) => (Path.explode(s1), Path.explode(s2)) })
wenzelm@66967
   473
wenzelm@66967
   474
      val meta_digest =
wenzelm@66967
   475
        SHA1.digest((name, chapter, entry.parent, entry.options, entry.imports,
wenzelm@66967
   476
          entry.theories_no_position, conditions, entry.document_files).toString)
wenzelm@66967
   477
wenzelm@66967
   478
      Info(name, chapter, dir_selected, entry.pos, entry.groups,
wenzelm@66967
   479
        dir + Path.explode(entry.path), entry.parent, entry.description, session_options,
wenzelm@66967
   480
        entry.imports, theories, global_theories, document_files, meta_digest)
wenzelm@66967
   481
    }
wenzelm@66967
   482
    catch {
wenzelm@66967
   483
      case ERROR(msg) =>
wenzelm@66967
   484
        error(msg + "\nThe error(s) above occurred in session entry " +
wenzelm@66967
   485
          quote(entry.name) + Position.here(entry.pos))
wenzelm@66967
   486
    }
wenzelm@66967
   487
  }
wenzelm@66967
   488
wenzelm@65419
   489
  object Selection
wenzelm@65419
   490
  {
wenzelm@65422
   491
    val empty: Selection = Selection()
wenzelm@65525
   492
    val all: Selection = Selection(all_sessions = true)
wenzelm@65419
   493
  }
wenzelm@65419
   494
wenzelm@65419
   495
  sealed case class Selection(
wenzelm@65419
   496
    requirements: Boolean = false,
wenzelm@65419
   497
    all_sessions: Boolean = false,
wenzelm@66737
   498
    base_sessions: List[String] = Nil,
wenzelm@65419
   499
    exclude_session_groups: List[String] = Nil,
wenzelm@65419
   500
    exclude_sessions: List[String] = Nil,
wenzelm@65419
   501
    session_groups: List[String] = Nil,
wenzelm@65419
   502
    sessions: List[String] = Nil)
wenzelm@65419
   503
  {
wenzelm@66736
   504
    def ++ (other: Selection): Selection =
wenzelm@65422
   505
      Selection(
wenzelm@65422
   506
        requirements = requirements || other.requirements,
wenzelm@65422
   507
        all_sessions = all_sessions || other.all_sessions,
wenzelm@66737
   508
        base_sessions = Library.merge(base_sessions, other.base_sessions),
wenzelm@66736
   509
        exclude_session_groups = Library.merge(exclude_session_groups, other.exclude_session_groups),
wenzelm@66736
   510
        exclude_sessions = Library.merge(exclude_sessions, other.exclude_sessions),
wenzelm@66736
   511
        session_groups = Library.merge(session_groups, other.session_groups),
wenzelm@66736
   512
        sessions = Library.merge(sessions, other.sessions))
wenzelm@65419
   513
  }
wenzelm@65419
   514
wenzelm@66960
   515
  def make(infos: List[Info]): T =
wenzelm@62631
   516
  {
wenzelm@65420
   517
    def add_edges(graph: Graph[String, Info], kind: String, edges: Info => Traversable[String])
wenzelm@65420
   518
      : Graph[String, Info] =
wenzelm@65420
   519
    {
wenzelm@65420
   520
      def add_edge(pos: Position.T, name: String, g: Graph[String, Info], parent: String) =
wenzelm@65420
   521
      {
wenzelm@65420
   522
        if (!g.defined(parent))
wenzelm@65420
   523
          error("Bad " + kind + " session " + quote(parent) + " for " +
wenzelm@65420
   524
            quote(name) + Position.here(pos))
wenzelm@65420
   525
wenzelm@65420
   526
        try { g.add_edge_acyclic(parent, name) }
wenzelm@65420
   527
        catch {
wenzelm@65420
   528
          case exn: Graph.Cycles[_] =>
wenzelm@65420
   529
            error(cat_lines(exn.cycles.map(cycle =>
wenzelm@65420
   530
              "Cyclic session dependency of " +
wenzelm@65420
   531
                cycle.map(c => quote(c.toString)).mkString(" via "))) + Position.here(pos))
wenzelm@65420
   532
        }
wenzelm@65420
   533
      }
wenzelm@65420
   534
      (graph /: graph.iterator) {
wenzelm@65420
   535
        case (g, (name, (info, _))) => (g /: edges(info))(add_edge(info.pos, name, _, _))
wenzelm@65420
   536
      }
wenzelm@65420
   537
    }
wenzelm@65420
   538
wenzelm@65420
   539
    val graph0 =
wenzelm@65415
   540
      (Graph.string[Info] /: infos) {
wenzelm@66960
   541
        case (graph, info) =>
wenzelm@66960
   542
          if (graph.defined(info.name))
wenzelm@66960
   543
            error("Duplicate session " + quote(info.name) + Position.here(info.pos) +
wenzelm@66960
   544
              Position.here(graph.get_node(info.name).pos))
wenzelm@66960
   545
          else graph.new_node(info.name, info)
wenzelm@65415
   546
      }
wenzelm@65420
   547
    val graph1 = add_edges(graph0, "parent", _.parent)
wenzelm@65420
   548
    val graph2 = add_edges(graph1, "imports", _.imports)
wenzelm@62631
   549
wenzelm@65420
   550
    new T(graph1, graph2)
wenzelm@62631
   551
  }
wenzelm@62631
   552
wenzelm@65420
   553
  final class T private[Sessions](
wenzelm@65420
   554
      val build_graph: Graph[String, Info],
wenzelm@65420
   555
      val imports_graph: Graph[String, Info])
wenzelm@62631
   556
  {
wenzelm@66823
   557
    def build_graph_display: Graph_Display.Graph = Graph_Display.make_graph(build_graph)
wenzelm@66823
   558
    def imports_graph_display: Graph_Display.Graph = Graph_Display.make_graph(imports_graph)
wenzelm@66823
   559
wenzelm@67025
   560
    def defined(name: String): Boolean = imports_graph.defined(name)
wenzelm@65420
   561
    def apply(name: String): Info = imports_graph.get_node(name)
wenzelm@67025
   562
    def get(name: String): Option[Info] = if (defined(name)) Some(apply(name)) else None
wenzelm@62631
   563
wenzelm@65457
   564
    def global_theories: Map[String, String] =
wenzelm@65490
   565
      (Thy_Header.bootstrap_global_theories.toMap /:
wenzelm@65424
   566
        (for {
wenzelm@65519
   567
          (_, (info, _)) <- imports_graph.iterator
wenzelm@65519
   568
          thy <- info.global_theories.iterator }
wenzelm@65519
   569
         yield (thy, info)))({
wenzelm@65519
   570
            case (global, (thy, info)) =>
wenzelm@66780
   571
              val qualifier = info.name
wenzelm@65457
   572
              global.get(thy) match {
wenzelm@65457
   573
                case Some(qualifier1) if qualifier != qualifier1 =>
wenzelm@65457
   574
                  error("Duplicate global theory " + quote(thy) + Position.here(info.pos))
wenzelm@65457
   575
                case _ => global + (thy -> qualifier)
wenzelm@65457
   576
              }
wenzelm@65457
   577
          })
wenzelm@65372
   578
wenzelm@67025
   579
    def selection(sel: Selection): T =
wenzelm@62631
   580
    {
wenzelm@67025
   581
      val bad_sessions =
wenzelm@67025
   582
        SortedSet((sel.base_sessions ::: sel.exclude_sessions ::: sel.sessions).
wenzelm@67025
   583
          filterNot(defined(_)): _*).toList
wenzelm@67025
   584
      if (bad_sessions.nonEmpty)
wenzelm@67025
   585
        error("Undefined session(s): " + commas_quote(bad_sessions))
wenzelm@67025
   586
wenzelm@67025
   587
      val excluded =
wenzelm@67025
   588
      {
wenzelm@67025
   589
        val exclude_group = sel.exclude_session_groups.toSet
wenzelm@67025
   590
        val exclude_group_sessions =
wenzelm@67025
   591
          (for {
wenzelm@67025
   592
            (name, (info, _)) <- build_graph.iterator
wenzelm@67025
   593
            if build_graph.get_node(name).groups.exists(exclude_group)
wenzelm@67025
   594
          } yield name).toList
wenzelm@67025
   595
        build_graph.all_succs(exclude_group_sessions ::: sel.exclude_sessions).toSet
wenzelm@67025
   596
      }
wenzelm@67025
   597
wenzelm@67027
   598
      val select_group = sel.session_groups.toSet
wenzelm@67027
   599
      val select_session = sel.sessions.toSet ++ build_graph.all_succs(sel.base_sessions)
wenzelm@67027
   600
wenzelm@67025
   601
      def restrict(graph: Graph[String, Info]): Graph[String, Info] =
wenzelm@67025
   602
      {
wenzelm@67025
   603
        val selected0 =
wenzelm@67025
   604
        {
wenzelm@67025
   605
          if (sel.all_sessions) graph.keys
wenzelm@67025
   606
          else {
wenzelm@67025
   607
            (for {
wenzelm@67025
   608
              (name, (info, _)) <- graph.iterator
wenzelm@67027
   609
              if info.dir_selected || select_session(name) || apply(name).groups.exists(select_group)
wenzelm@67025
   610
            } yield name).toList
wenzelm@67025
   611
          }
wenzelm@67028
   612
        }
wenzelm@67025
   613
wenzelm@67025
   614
        val selected1 =
wenzelm@67025
   615
          if (sel.requirements) (graph.all_preds(selected0).toSet -- selected0).toList
wenzelm@67025
   616
          else selected0
wenzelm@67025
   617
wenzelm@67028
   618
        val selected2 = graph.all_preds(selected1).filterNot(excluded)
wenzelm@67028
   619
wenzelm@67028
   620
        graph.restrict(graph.all_preds(selected2).toSet)
wenzelm@67025
   621
      }
wenzelm@67025
   622
wenzelm@67025
   623
      new T(restrict(build_graph), restrict(imports_graph))
wenzelm@62631
   624
    }
wenzelm@62631
   625
wenzelm@65420
   626
    def build_descendants(names: List[String]): List[String] =
wenzelm@65420
   627
      build_graph.all_succs(names)
wenzelm@66848
   628
    def build_requirements(names: List[String]): List[String] =
wenzelm@66848
   629
      build_graph.all_preds(names).reverse
wenzelm@67023
   630
    def build_topological_order: List[String] =
wenzelm@67023
   631
      build_graph.topological_order
wenzelm@62631
   632
wenzelm@66848
   633
    def imports_descendants(names: List[String]): List[String] =
wenzelm@66848
   634
      imports_graph.all_succs(names)
wenzelm@66848
   635
    def imports_requirements(names: List[String]): List[String] =
wenzelm@66848
   636
      imports_graph.all_preds(names).reverse
wenzelm@67023
   637
    def imports_topological_order: List[String] =
wenzelm@67023
   638
      imports_graph.topological_order
wenzelm@65420
   639
wenzelm@65420
   640
    override def toString: String =
wenzelm@65420
   641
      imports_graph.keys_iterator.mkString("Sessions.T(", ", ", ")")
wenzelm@62631
   642
  }
wenzelm@62631
   643
wenzelm@62631
   644
wenzelm@62631
   645
  /* parser */
wenzelm@62631
   646
wenzelm@62864
   647
  val ROOT = Path.explode("ROOT")
wenzelm@62864
   648
  val ROOTS = Path.explode("ROOTS")
wenzelm@62864
   649
wenzelm@62631
   650
  private val CHAPTER = "chapter"
wenzelm@62631
   651
  private val SESSION = "session"
wenzelm@62631
   652
  private val IN = "in"
wenzelm@62631
   653
  private val DESCRIPTION = "description"
wenzelm@62631
   654
  private val OPTIONS = "options"
wenzelm@65420
   655
  private val SESSIONS = "sessions"
wenzelm@62631
   656
  private val THEORIES = "theories"
wenzelm@65374
   657
  private val GLOBAL = "global"
wenzelm@62631
   658
  private val DOCUMENT_FILES = "document_files"
wenzelm@62631
   659
wenzelm@67004
   660
  val root_syntax =
wenzelm@67004
   661
    Outer_Syntax.empty + "(" + ")" + "+" + "," + "=" + "[" + "]" + GLOBAL + IN +
wenzelm@63443
   662
      (CHAPTER, Keyword.THY_DECL) +
wenzelm@63443
   663
      (SESSION, Keyword.THY_DECL) +
wenzelm@63443
   664
      (DESCRIPTION, Keyword.QUASI_COMMAND) +
wenzelm@63443
   665
      (OPTIONS, Keyword.QUASI_COMMAND) +
wenzelm@65420
   666
      (SESSIONS, Keyword.QUASI_COMMAND) +
wenzelm@63443
   667
      (THEORIES, Keyword.QUASI_COMMAND) +
wenzelm@63443
   668
      (DOCUMENT_FILES, Keyword.QUASI_COMMAND)
wenzelm@62631
   669
wenzelm@66818
   670
  abstract class Entry
wenzelm@66818
   671
  sealed case class Chapter(name: String) extends Entry
wenzelm@66818
   672
  sealed case class Session_Entry(
wenzelm@66818
   673
    pos: Position.T,
wenzelm@66818
   674
    name: String,
wenzelm@66818
   675
    groups: List[String],
wenzelm@66818
   676
    path: String,
wenzelm@66818
   677
    parent: Option[String],
wenzelm@66818
   678
    description: String,
wenzelm@66818
   679
    options: List[Options.Spec],
wenzelm@66818
   680
    imports: List[String],
wenzelm@66818
   681
    theories: List[(List[Options.Spec], List[((String, Position.T), Boolean)])],
wenzelm@66818
   682
    document_files: List[(String, String)]) extends Entry
wenzelm@66818
   683
  {
wenzelm@66818
   684
    def theories_no_position: List[(List[Options.Spec], List[(String, Boolean)])] =
wenzelm@66818
   685
      theories.map({ case (a, b) => (a, b.map({ case ((c, _), d) => (c, d) })) })
wenzelm@66818
   686
  }
wenzelm@66818
   687
wenzelm@62968
   688
  private object Parser extends Parse.Parser with Options.Parser
wenzelm@62631
   689
  {
wenzelm@62631
   690
    private val chapter: Parser[Chapter] =
wenzelm@62631
   691
    {
wenzelm@62631
   692
      val chapter_name = atom("chapter name", _.is_name)
wenzelm@62631
   693
wenzelm@62631
   694
      command(CHAPTER) ~! chapter_name ^^ { case _ ~ a => Chapter(a) }
wenzelm@62631
   695
    }
wenzelm@62631
   696
wenzelm@62631
   697
    private val session_entry: Parser[Session_Entry] =
wenzelm@62631
   698
    {
wenzelm@62631
   699
      val option =
wenzelm@62968
   700
        option_name ~ opt($$$("=") ~! option_value ^^
wenzelm@62968
   701
          { case _ ~ x => x }) ^^ { case x ~ y => (x, y) }
wenzelm@62631
   702
      val options = $$$("[") ~> rep1sep(option, $$$(",")) <~ $$$("]")
wenzelm@62631
   703
wenzelm@65374
   704
      val global =
wenzelm@65374
   705
        ($$$("(") ~! $$$(GLOBAL) ~ $$$(")")) ^^ { case _ => true } | success(false)
wenzelm@65374
   706
wenzelm@65374
   707
      val theory_entry =
wenzelm@65517
   708
        position(theory_name) ~ global ^^ { case x ~ y => (x, y) }
wenzelm@65374
   709
wenzelm@62631
   710
      val theories =
wenzelm@65374
   711
        $$$(THEORIES) ~!
wenzelm@66970
   712
          ((options | success(Nil)) ~ rep1(theory_entry)) ^^
wenzelm@65374
   713
          { case _ ~ (x ~ y) => (x, y) }
wenzelm@62631
   714
wenzelm@62631
   715
      val document_files =
wenzelm@62631
   716
        $$$(DOCUMENT_FILES) ~!
wenzelm@62631
   717
          (($$$("(") ~! ($$$(IN) ~! (path ~ $$$(")"))) ^^
wenzelm@62631
   718
              { case _ ~ (_ ~ (x ~ _)) => x } | success("document")) ~
wenzelm@62631
   719
            rep1(path)) ^^ { case _ ~ (x ~ y) => y.map((x, _)) }
wenzelm@62631
   720
wenzelm@62631
   721
      command(SESSION) ~!
wenzelm@62631
   722
        (position(session_name) ~
wenzelm@62631
   723
          (($$$("(") ~! (rep1(name) <~ $$$(")")) ^^ { case _ ~ x => x }) | success(Nil)) ~
wenzelm@62631
   724
          (($$$(IN) ~! path ^^ { case _ ~ x => x }) | success(".")) ~
wenzelm@62631
   725
          ($$$("=") ~!
wenzelm@62631
   726
            (opt(session_name ~! $$$("+") ^^ { case x ~ _ => x }) ~
wenzelm@62631
   727
              (($$$(DESCRIPTION) ~! text ^^ { case _ ~ x => x }) | success("")) ~
wenzelm@62631
   728
              (($$$(OPTIONS) ~! options ^^ { case _ ~ x => x }) | success(Nil)) ~
wenzelm@66970
   729
              (($$$(SESSIONS) ~! rep1(session_name)  ^^ { case _ ~ x => x }) | success(Nil)) ~
wenzelm@66970
   730
              rep(theories) ~
wenzelm@62631
   731
              (rep(document_files) ^^ (x => x.flatten))))) ^^
wenzelm@66759
   732
        { case _ ~ ((a, pos) ~ b ~ c ~ (_ ~ (d ~ e ~ f ~ g ~ h ~ i))) =>
wenzelm@66759
   733
            Session_Entry(pos, a, b, c, d, e, f, g, h, i) }
wenzelm@62631
   734
    }
wenzelm@62631
   735
wenzelm@66819
   736
    def parse_root(path: Path): List[Entry] =
wenzelm@62631
   737
    {
wenzelm@66764
   738
      val toks = Token.explode(root_syntax.keywords, File.read(path))
wenzelm@66764
   739
      val start = Token.Pos.file(path.implode)
wenzelm@62631
   740
wenzelm@66764
   741
      parse_all(rep(chapter | session_entry), Token.reader(toks, start)) match {
wenzelm@66818
   742
        case Success(result, _) => result
wenzelm@66764
   743
        case bad => error(bad.toString)
wenzelm@62631
   744
      }
wenzelm@62631
   745
    }
wenzelm@62631
   746
  }
wenzelm@62631
   747
wenzelm@66819
   748
  def parse_root(path: Path): List[Entry] = Parser.parse_root(path)
wenzelm@66819
   749
wenzelm@66819
   750
  def parse_root_entries(path: Path): List[Session_Entry] =
wenzelm@66819
   751
    for (entry <- Parser.parse_root(path) if entry.isInstanceOf[Session_Entry])
wenzelm@66819
   752
    yield entry.asInstanceOf[Session_Entry]
wenzelm@66818
   753
wenzelm@66960
   754
  def read_root(options: Options, select: Boolean, path: Path): List[Info] =
wenzelm@66818
   755
  {
wenzelm@66818
   756
    var entry_chapter = "Unsorted"
wenzelm@66960
   757
    val infos = new mutable.ListBuffer[Info]
wenzelm@66819
   758
    parse_root(path).foreach {
wenzelm@66818
   759
      case Chapter(name) => entry_chapter = name
wenzelm@66967
   760
      case entry: Session_Entry =>
wenzelm@66967
   761
        infos += make_info(options, select, path.dir, entry_chapter, entry)
wenzelm@66818
   762
    }
wenzelm@66818
   763
    infos.toList
wenzelm@66818
   764
  }
wenzelm@66818
   765
wenzelm@66818
   766
  def parse_roots(roots: Path): List[String] =
wenzelm@66818
   767
  {
wenzelm@66818
   768
    for {
wenzelm@66818
   769
      line <- split_lines(File.read(roots))
wenzelm@66818
   770
      if !(line == "" || line.startsWith("#"))
wenzelm@66818
   771
    } yield line
wenzelm@66818
   772
  }
wenzelm@66818
   773
wenzelm@62631
   774
wenzelm@62635
   775
  /* load sessions from certain directories */
wenzelm@62631
   776
wenzelm@62631
   777
  private def is_session_dir(dir: Path): Boolean =
wenzelm@62631
   778
    (dir + ROOT).is_file || (dir + ROOTS).is_file
wenzelm@62631
   779
wenzelm@62631
   780
  private def check_session_dir(dir: Path): Path =
wenzelm@65468
   781
    if (is_session_dir(dir)) File.pwd() + dir.expand
wenzelm@62631
   782
    else error("Bad session root directory: " + dir.toString)
wenzelm@62631
   783
wenzelm@65561
   784
  def directories(dirs: List[Path], select_dirs: List[Path]): List[(Boolean, Path)] =
wenzelm@65561
   785
  {
wenzelm@65561
   786
    val default_dirs = Isabelle_System.components().filter(is_session_dir(_))
wenzelm@65561
   787
    (default_dirs ::: dirs).map((false, _)) ::: select_dirs.map((true, _))
wenzelm@65561
   788
  }
wenzelm@65561
   789
wenzelm@67026
   790
  def load_structure(options: Options,
wenzelm@66968
   791
    dirs: List[Path] = Nil,
wenzelm@66968
   792
    select_dirs: List[Path] = Nil,
wenzelm@66968
   793
    infos: List[Info] = Nil): T =
wenzelm@62631
   794
  {
wenzelm@66764
   795
    def load_dir(select: Boolean, dir: Path): List[(Boolean, Path)] =
wenzelm@62635
   796
      load_root(select, dir) ::: load_roots(select, dir)
wenzelm@62631
   797
wenzelm@66764
   798
    def load_root(select: Boolean, dir: Path): List[(Boolean, Path)] =
wenzelm@66764
   799
    {
wenzelm@66764
   800
      val root = dir + ROOT
wenzelm@66764
   801
      if (root.is_file) List((select, root)) else Nil
wenzelm@66764
   802
    }
wenzelm@62631
   803
wenzelm@66764
   804
    def load_roots(select: Boolean, dir: Path): List[(Boolean, Path)] =
wenzelm@62631
   805
    {
wenzelm@62631
   806
      val roots = dir + ROOTS
wenzelm@62631
   807
      if (roots.is_file) {
wenzelm@62631
   808
        for {
wenzelm@66818
   809
          entry <- parse_roots(roots)
wenzelm@62631
   810
          dir1 =
wenzelm@66818
   811
            try { check_session_dir(dir + Path.explode(entry)) }
wenzelm@62631
   812
            catch {
wenzelm@62631
   813
              case ERROR(msg) =>
wenzelm@62631
   814
                error(msg + "\nThe error(s) above occurred in session catalog " + roots.toString)
wenzelm@62631
   815
            }
wenzelm@66764
   816
          res <- load_dir(select, dir1)
wenzelm@66764
   817
        } yield res
wenzelm@62631
   818
      }
wenzelm@62631
   819
      else Nil
wenzelm@62631
   820
    }
wenzelm@62631
   821
wenzelm@66764
   822
    val roots =
wenzelm@62631
   823
      for {
wenzelm@65561
   824
        (select, dir) <- directories(dirs, select_dirs)
wenzelm@66764
   825
        res <- load_dir(select, check_session_dir(dir))
wenzelm@66764
   826
      } yield res
wenzelm@66764
   827
wenzelm@66764
   828
    val unique_roots =
wenzelm@66764
   829
      ((Map.empty[JFile, (Boolean, Path)] /: roots) { case (m, (select, path)) =>
wenzelm@66764
   830
        val file = path.canonical_file
wenzelm@66764
   831
        m.get(file) match {
wenzelm@66764
   832
          case None => m + (file -> (select, path))
wenzelm@66764
   833
          case Some((select1, path1)) => m + (file -> (select1 || select, path1))
wenzelm@66764
   834
        }
wenzelm@66764
   835
      }).toList.map(_._2)
wenzelm@66764
   836
wenzelm@66968
   837
    make(unique_roots.flatMap(p => read_root(options, p._1, p._2)) ::: infos)
wenzelm@62631
   838
  }
wenzelm@62632
   839
wenzelm@62632
   840
wenzelm@62637
   841
wenzelm@62704
   842
  /** heap file with SHA1 digest **/
wenzelm@62704
   843
wenzelm@62704
   844
  private val sha1_prefix = "SHA1:"
wenzelm@62704
   845
wenzelm@62704
   846
  def read_heap_digest(heap: Path): Option[String] =
wenzelm@62704
   847
  {
wenzelm@62704
   848
    if (heap.is_file) {
wenzelm@62704
   849
      val file = FileChannel.open(heap.file.toPath, StandardOpenOption.READ)
wenzelm@62704
   850
      try {
wenzelm@62704
   851
        val len = file.size
wenzelm@62704
   852
        val n = sha1_prefix.length + SHA1.digest_length
wenzelm@62704
   853
        if (len >= n) {
wenzelm@62704
   854
          file.position(len - n)
wenzelm@62704
   855
wenzelm@62704
   856
          val buf = ByteBuffer.allocate(n)
wenzelm@62704
   857
          var i = 0
wenzelm@62704
   858
          var m = 0
wenzelm@62704
   859
          do {
wenzelm@62704
   860
            m = file.read(buf)
wenzelm@62704
   861
            if (m != -1) i += m
wenzelm@62704
   862
          }
wenzelm@62704
   863
          while (m != -1 && n > i)
wenzelm@62704
   864
wenzelm@62704
   865
          if (i == n) {
wenzelm@62704
   866
            val prefix = new String(buf.array(), 0, sha1_prefix.length, UTF8.charset)
wenzelm@62704
   867
            val s = new String(buf.array(), sha1_prefix.length, SHA1.digest_length, UTF8.charset)
wenzelm@62704
   868
            if (prefix == sha1_prefix) Some(s) else None
wenzelm@62704
   869
          }
wenzelm@62704
   870
          else None
wenzelm@62704
   871
        }
wenzelm@62704
   872
        else None
wenzelm@62704
   873
      }
wenzelm@62704
   874
      finally { file.close }
wenzelm@62704
   875
    }
wenzelm@62704
   876
    else None
wenzelm@62704
   877
  }
wenzelm@62704
   878
wenzelm@62704
   879
  def write_heap_digest(heap: Path): String =
wenzelm@62704
   880
    read_heap_digest(heap) match {
wenzelm@62704
   881
      case None =>
wenzelm@62704
   882
        val s = SHA1.digest(heap).rep
wenzelm@62704
   883
        File.append(heap, sha1_prefix + s)
wenzelm@62704
   884
        s
wenzelm@62704
   885
      case Some(s) => s
wenzelm@62704
   886
    }
wenzelm@62704
   887
wenzelm@62704
   888
wenzelm@62704
   889
wenzelm@62637
   890
  /** persistent store **/
wenzelm@62632
   891
wenzelm@65296
   892
  object Session_Info
wenzelm@65296
   893
  {
wenzelm@66857
   894
    val session_name = SQL.Column.string("session_name").make_primary_key
wenzelm@65326
   895
wenzelm@65296
   896
    // Build_Log.Session_Info
wenzelm@65296
   897
    val session_timing = SQL.Column.bytes("session_timing")
wenzelm@65296
   898
    val command_timings = SQL.Column.bytes("command_timings")
wenzelm@66873
   899
    val theory_timings = SQL.Column.bytes("theory_timings")
wenzelm@65296
   900
    val ml_statistics = SQL.Column.bytes("ml_statistics")
wenzelm@65296
   901
    val task_statistics = SQL.Column.bytes("task_statistics")
wenzelm@65934
   902
    val errors = SQL.Column.bytes("errors")
wenzelm@65296
   903
    val build_log_columns =
wenzelm@66873
   904
      List(session_name, session_timing, command_timings, theory_timings,
wenzelm@66873
   905
        ml_statistics, task_statistics, errors)
wenzelm@65296
   906
wenzelm@65296
   907
    // Build.Session_Info
wenzelm@65296
   908
    val sources = SQL.Column.string("sources")
wenzelm@65296
   909
    val input_heaps = SQL.Column.string("input_heaps")
wenzelm@65296
   910
    val output_heap = SQL.Column.string("output_heap")
wenzelm@65296
   911
    val return_code = SQL.Column.int("return_code")
wenzelm@66746
   912
    val build_columns = List(sources, input_heaps, output_heap, return_code)
wenzelm@65296
   913
wenzelm@65296
   914
    val table = SQL.Table("isabelle_session_info", build_log_columns ::: build_columns)
wenzelm@65296
   915
  }
wenzelm@65296
   916
wenzelm@62632
   917
  def store(system_mode: Boolean = false): Store = new Store(system_mode)
wenzelm@62632
   918
wenzelm@65857
   919
  class Store private[Sessions](system_mode: Boolean)
wenzelm@62632
   920
  {
wenzelm@65278
   921
    /* file names */
wenzelm@65278
   922
wenzelm@65281
   923
    def database(name: String): Path = Path.basic("log") + Path.basic(name).ext("db")
wenzelm@65278
   924
    def log(name: String): Path = Path.basic("log") + Path.basic(name)
wenzelm@65278
   925
    def log_gz(name: String): Path = log(name).ext("gz")
wenzelm@65278
   926
wenzelm@65278
   927
wenzelm@65286
   928
    /* SQL database content */
wenzelm@65283
   929
wenzelm@65857
   930
    val xml_cache = new XML.Cache()
wenzelm@65857
   931
wenzelm@65320
   932
    def read_bytes(db: SQL.Database, name: String, column: SQL.Column): Bytes =
wenzelm@65698
   933
      db.using_statement(Session_Info.table.select(List(column),
wenzelm@65699
   934
        Session_Info.session_name.where_equal(name)))(stmt =>
wenzelm@65291
   935
      {
wenzelm@65740
   936
        val res = stmt.execute_query()
wenzelm@65740
   937
        if (!res.next()) Bytes.empty else res.bytes(column)
wenzelm@65291
   938
      })
wenzelm@65285
   939
wenzelm@65320
   940
    def read_properties(db: SQL.Database, name: String, column: SQL.Column): List[Properties.T] =
wenzelm@65857
   941
      Properties.uncompress(read_bytes(db, name, column), Some(xml_cache))
wenzelm@65286
   942
wenzelm@65283
   943
wenzelm@62637
   944
    /* output */
wenzelm@62632
   945
wenzelm@62632
   946
    val browser_info: Path =
wenzelm@62632
   947
      if (system_mode) Path.explode("~~/browser_info")
wenzelm@62632
   948
      else Path.explode("$ISABELLE_BROWSER_INFO")
wenzelm@62632
   949
wenzelm@62637
   950
    val output_dir: Path =
wenzelm@62637
   951
      if (system_mode) Path.explode("~~/heaps/$ML_IDENTIFIER")
wenzelm@62637
   952
      else Path.explode("$ISABELLE_OUTPUT")
wenzelm@62637
   953
wenzelm@65298
   954
    override def toString: String = "Store(output_dir = " + output_dir.expand + ")"
wenzelm@65298
   955
wenzelm@62637
   956
    def prepare_output() { Isabelle_System.mkdirs(output_dir + Path.basic("log")) }
wenzelm@62637
   957
wenzelm@62637
   958
wenzelm@62637
   959
    /* input */
wenzelm@62637
   960
wenzelm@62637
   961
    private val input_dirs =
wenzelm@62632
   962
      if (system_mode) List(output_dir)
wenzelm@62633
   963
      else {
wenzelm@62633
   964
        val ml_ident = Path.explode("$ML_IDENTIFIER").expand
wenzelm@62633
   965
        output_dir :: Path.split(Isabelle_System.getenv_strict("ISABELLE_PATH")).map(_ + ml_ident)
wenzelm@62633
   966
      }
wenzelm@62632
   967
wenzelm@65291
   968
    def find_database_heap(name: String): Option[(Path, Option[String])] =
wenzelm@65291
   969
      input_dirs.find(dir => (dir + database(name)).is_file).map(dir =>
wenzelm@65291
   970
        (dir + database(name), read_heap_digest(dir + Path.basic(name))))
wenzelm@62632
   971
wenzelm@65281
   972
    def find_database(name: String): Option[Path] =
wenzelm@65281
   973
      input_dirs.map(_ + database(name)).find(_.is_file)
wenzelm@65281
   974
wenzelm@62637
   975
    def heap(name: String): Path =
wenzelm@65288
   976
      input_dirs.map(_ + Path.basic(name)).find(_.is_file) getOrElse
wenzelm@62637
   977
        error("Unknown logic " + quote(name) + " -- no heap file found in:\n" +
wenzelm@62769
   978
          cat_lines(input_dirs.map(dir => "  " + dir.expand.implode)))
wenzelm@65287
   979
wenzelm@65287
   980
wenzelm@65296
   981
    /* session info */
wenzelm@65281
   982
wenzelm@65296
   983
    def write_session_info(
wenzelm@65318
   984
      db: SQL.Database,
wenzelm@65320
   985
      name: String,
wenzelm@65318
   986
      build_log: Build_Log.Session_Info,
wenzelm@65318
   987
      build: Build.Session_Info)
wenzelm@65281
   988
    {
wenzelm@65281
   989
      db.transaction {
wenzelm@65296
   990
        db.create_table(Session_Info.table)
wenzelm@65698
   991
        db.using_statement(
wenzelm@65699
   992
          Session_Info.table.delete(Session_Info.session_name.where_equal(name)))(_.execute)
wenzelm@65698
   993
        db.using_statement(Session_Info.table.insert())(stmt =>
wenzelm@65281
   994
        {
wenzelm@65748
   995
          stmt.string(1) = name
wenzelm@65857
   996
          stmt.bytes(2) = Properties.encode(build_log.session_timing)
wenzelm@65857
   997
          stmt.bytes(3) = Properties.compress(build_log.command_timings)
wenzelm@66873
   998
          stmt.bytes(4) = Properties.compress(build_log.theory_timings)
wenzelm@66873
   999
          stmt.bytes(5) = Properties.compress(build_log.ml_statistics)
wenzelm@66873
  1000
          stmt.bytes(6) = Properties.compress(build_log.task_statistics)
wenzelm@66873
  1001
          stmt.bytes(7) = Build_Log.compress_errors(build_log.errors)
wenzelm@66873
  1002
          stmt.string(8) = build.sources
wenzelm@66873
  1003
          stmt.string(9) = cat_lines(build.input_heaps)
wenzelm@66873
  1004
          stmt.string(10) = build.output_heap getOrElse ""
wenzelm@66873
  1005
          stmt.int(11) = build.return_code
wenzelm@65281
  1006
          stmt.execute()
wenzelm@65281
  1007
        })
wenzelm@65281
  1008
      }
wenzelm@65281
  1009
    }
wenzelm@65281
  1010
wenzelm@65320
  1011
    def read_session_timing(db: SQL.Database, name: String): Properties.T =
wenzelm@65857
  1012
      Properties.decode(read_bytes(db, name, Session_Info.session_timing), Some(xml_cache))
wenzelm@65286
  1013
wenzelm@65320
  1014
    def read_command_timings(db: SQL.Database, name: String): List[Properties.T] =
wenzelm@65320
  1015
      read_properties(db, name, Session_Info.command_timings)
wenzelm@65286
  1016
wenzelm@66873
  1017
    def read_theory_timings(db: SQL.Database, name: String): List[Properties.T] =
wenzelm@66873
  1018
      read_properties(db, name, Session_Info.theory_timings)
wenzelm@66873
  1019
wenzelm@65320
  1020
    def read_ml_statistics(db: SQL.Database, name: String): List[Properties.T] =
wenzelm@65320
  1021
      read_properties(db, name, Session_Info.ml_statistics)
wenzelm@65286
  1022
wenzelm@65320
  1023
    def read_task_statistics(db: SQL.Database, name: String): List[Properties.T] =
wenzelm@65320
  1024
      read_properties(db, name, Session_Info.task_statistics)
wenzelm@65286
  1025
wenzelm@65937
  1026
    def read_errors(db: SQL.Database, name: String): List[String] =
wenzelm@65937
  1027
      Build_Log.uncompress_errors(read_bytes(db, name, Session_Info.errors))
wenzelm@65937
  1028
wenzelm@65320
  1029
    def read_build(db: SQL.Database, name: String): Option[Build.Session_Info] =
wenzelm@66744
  1030
    {
wenzelm@66957
  1031
      if (db.tables.contains(Session_Info.table.name)) {
wenzelm@66957
  1032
        db.using_statement(Session_Info.table.select(Session_Info.build_columns,
wenzelm@66957
  1033
          Session_Info.session_name.where_equal(name)))(stmt =>
wenzelm@66957
  1034
        {
wenzelm@66957
  1035
          val res = stmt.execute_query()
wenzelm@66957
  1036
          if (!res.next()) None
wenzelm@66957
  1037
          else {
wenzelm@66957
  1038
            Some(
wenzelm@66957
  1039
              Build.Session_Info(
wenzelm@66957
  1040
                res.string(Session_Info.sources),
wenzelm@66957
  1041
                split_lines(res.string(Session_Info.input_heaps)),
wenzelm@66957
  1042
                res.string(Session_Info.output_heap) match { case "" => None case s => Some(s) },
wenzelm@66957
  1043
                res.int(Session_Info.return_code)))
wenzelm@66957
  1044
          }
wenzelm@66957
  1045
        })
wenzelm@66957
  1046
      }
wenzelm@66957
  1047
      else None
wenzelm@66744
  1048
    }
wenzelm@65281
  1049
  }
wenzelm@62631
  1050
}