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