src/Pure/Thy/sessions.scala
author wenzelm
Wed Apr 05 22:00:44 2017 +0200 (2017-04-05 ago)
changeset 65397 f365f61f2081
parent 65396 b5740579cad6
child 65405 2b819faf45e9
permissions -rw-r--r--
uniform import_name, with treatment of global and qualified theories;
wenzelm@62631
     1
/*  Title:      Pure/Thy/sessions.scala
wenzelm@62631
     2
    Author:     Makarius
wenzelm@62631
     3
wenzelm@62973
     4
Isabelle session information.
wenzelm@62631
     5
*/
wenzelm@62631
     6
wenzelm@62631
     7
package isabelle
wenzelm@62631
     8
wenzelm@62704
     9
import java.nio.ByteBuffer
wenzelm@62704
    10
import java.nio.channels.FileChannel
wenzelm@62704
    11
import java.nio.file.StandardOpenOption
wenzelm@65320
    12
import java.sql.PreparedStatement
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@65360
    22
  def is_pure(name: String): Boolean = name == Thy_Header.PURE
wenzelm@64856
    23
wenzelm@64856
    24
  object Base
wenzelm@64856
    25
  {
wenzelm@65360
    26
    def pure(options: Options): Base = session_base(options, Thy_Header.PURE)
wenzelm@65360
    27
wenzelm@64856
    28
    lazy val bootstrap: Base =
wenzelm@64856
    29
      Base(keywords = Thy_Header.bootstrap_header, syntax = Thy_Header.bootstrap_syntax)
wenzelm@64856
    30
  }
wenzelm@64856
    31
wenzelm@64856
    32
  sealed case class Base(
wenzelm@65375
    33
    global_theories: Set[String] = Set.empty,
wenzelm@64856
    34
    loaded_theories: Set[String] = Set.empty,
wenzelm@64856
    35
    known_theories: Map[String, Document.Node.Name] = Map.empty,
wenzelm@64856
    36
    keywords: Thy_Header.Keywords = Nil,
wenzelm@64856
    37
    syntax: Outer_Syntax = Outer_Syntax.empty,
wenzelm@64856
    38
    sources: List[(Path, SHA1.Digest)] = Nil,
wenzelm@64856
    39
    session_graph: Graph_Display.Graph = Graph_Display.empty_graph)
wenzelm@65355
    40
  {
wenzelm@65355
    41
    def loaded_theory(name: Document.Node.Name): Boolean =
wenzelm@65355
    42
      loaded_theories.contains(name.theory)
wenzelm@65355
    43
  }
wenzelm@64856
    44
wenzelm@65251
    45
  sealed case class Deps(deps: Map[String, Base])
wenzelm@65251
    46
  {
wenzelm@65251
    47
    def is_empty: Boolean = deps.isEmpty
wenzelm@65251
    48
    def apply(name: String): Base = deps(name)
wenzelm@65251
    49
    def sources(name: String): List[SHA1.Digest] = deps(name).sources.map(_._2)
wenzelm@65251
    50
  }
wenzelm@64856
    51
wenzelm@65251
    52
  def dependencies(
wenzelm@65251
    53
      progress: Progress = No_Progress,
wenzelm@65251
    54
      inlined_files: Boolean = false,
wenzelm@65251
    55
      verbose: Boolean = false,
wenzelm@65251
    56
      list_files: Boolean = false,
wenzelm@65251
    57
      check_keywords: Set[String] = Set.empty,
wenzelm@65375
    58
      global_theories: Set[String] = Set.empty,
wenzelm@65251
    59
      tree: Tree): Deps =
wenzelm@65375
    60
  {
wenzelm@65251
    61
    Deps((Map.empty[String, Base] /: tree.topological_order)(
wenzelm@65251
    62
      { case (deps, (name, info)) =>
wenzelm@65251
    63
          if (progress.stopped) throw Exn.Interrupt()
wenzelm@65251
    64
wenzelm@65251
    65
          try {
wenzelm@65359
    66
            val parent_base =
wenzelm@65359
    67
              info.parent match {
wenzelm@65359
    68
                case None => Base.bootstrap
wenzelm@65359
    69
                case Some(parent) => deps(parent)
wenzelm@65359
    70
              }
wenzelm@65359
    71
            val resources = new Resources(name, parent_base)
wenzelm@65251
    72
wenzelm@65251
    73
            if (verbose || list_files) {
wenzelm@65251
    74
              val groups =
wenzelm@65251
    75
                if (info.groups.isEmpty) ""
wenzelm@65251
    76
                else info.groups.mkString(" (", " ", ")")
wenzelm@65251
    77
              progress.echo("Session " + info.chapter + "/" + name + groups)
wenzelm@65251
    78
            }
wenzelm@65251
    79
wenzelm@65251
    80
            val thy_deps =
wenzelm@65251
    81
            {
wenzelm@65251
    82
              val root_theories =
wenzelm@65377
    83
                info.theories.flatMap({ case (_, thys) =>
wenzelm@65397
    84
                  thys.map(thy => (resources.import_name(info.dir.implode, thy), info.pos))
wenzelm@65251
    85
                })
wenzelm@65359
    86
              val thy_deps = resources.thy_info.dependencies(root_theories)
wenzelm@65251
    87
wenzelm@65251
    88
              thy_deps.errors match {
wenzelm@65251
    89
                case Nil => thy_deps
wenzelm@65251
    90
                case errs => error(cat_lines(errs))
wenzelm@65251
    91
              }
wenzelm@65251
    92
            }
wenzelm@65251
    93
wenzelm@65251
    94
            val known_theories =
wenzelm@65359
    95
              (parent_base.known_theories /: thy_deps.deps)({ case (known, dep) =>
wenzelm@65251
    96
                val name = dep.name
wenzelm@65251
    97
                known.get(name.theory) match {
wenzelm@65251
    98
                  case Some(name1) if name != name1 =>
wenzelm@65251
    99
                    error("Duplicate theory " + quote(name.node) + " vs. " + quote(name1.node))
wenzelm@65251
   100
                  case _ =>
wenzelm@65251
   101
                    known + (name.theory -> name) + (Long_Name.base_name(name.theory) -> name)
wenzelm@65251
   102
                }
wenzelm@65251
   103
              })
wenzelm@65251
   104
wenzelm@65251
   105
            val loaded_theories = thy_deps.loaded_theories
wenzelm@65251
   106
            val keywords = thy_deps.keywords
wenzelm@65251
   107
            val syntax = thy_deps.syntax
wenzelm@65251
   108
wenzelm@65251
   109
            val theory_files = thy_deps.deps.map(dep => Path.explode(dep.name.node))
wenzelm@65251
   110
            val loaded_files =
wenzelm@65251
   111
              if (inlined_files) {
wenzelm@65251
   112
                val pure_files =
wenzelm@65360
   113
                  if (is_pure(name)) {
wenzelm@65360
   114
                    val roots = Thy_Header.ml_roots.map(p => info.dir + Path.explode(p._1))
wenzelm@65360
   115
                    val files =
wenzelm@65360
   116
                      roots.flatMap(root => resources.loaded_files(syntax, File.read(root))).
wenzelm@65360
   117
                        map(file => info.dir + Path.explode(file))
wenzelm@65360
   118
                    roots ::: files
wenzelm@65360
   119
                  }
wenzelm@65251
   120
                  else Nil
wenzelm@65251
   121
                pure_files ::: thy_deps.loaded_files
wenzelm@65251
   122
              }
wenzelm@65251
   123
              else Nil
wenzelm@65251
   124
wenzelm@65251
   125
            val all_files =
wenzelm@65251
   126
              (theory_files ::: loaded_files :::
wenzelm@65251
   127
                info.files.map(file => info.dir + file) :::
wenzelm@65251
   128
                info.document_files.map(file => info.dir + file._1 + file._2)).map(_.expand)
wenzelm@65251
   129
wenzelm@65251
   130
            if (list_files)
wenzelm@65251
   131
              progress.echo(cat_lines(all_files.map(_.implode).sorted.map("  " + _)))
wenzelm@65251
   132
wenzelm@65251
   133
            if (check_keywords.nonEmpty)
wenzelm@65251
   134
              Check_Keywords.check_keywords(progress, syntax.keywords, check_keywords, theory_files)
wenzelm@65251
   135
wenzelm@65375
   136
            val base =
wenzelm@65375
   137
              Base(global_theories = global_theories,
wenzelm@65375
   138
                loaded_theories = loaded_theories,
wenzelm@65375
   139
                known_theories = known_theories,
wenzelm@65375
   140
                keywords = keywords,
wenzelm@65375
   141
                syntax = syntax,
wenzelm@65375
   142
                sources = all_files.map(p => (p, SHA1.digest(p.file))),
wenzelm@65375
   143
                session_graph =
wenzelm@65396
   144
                  Present.session_graph(info.parent getOrElse "", parent_base, thy_deps.deps))
wenzelm@65251
   145
wenzelm@65251
   146
            deps + (name -> base)
wenzelm@65251
   147
          }
wenzelm@65251
   148
          catch {
wenzelm@65251
   149
            case ERROR(msg) =>
wenzelm@65251
   150
              cat_error(msg, "The error(s) above occurred in session " +
wenzelm@65251
   151
                quote(name) + Position.here(info.pos))
wenzelm@65251
   152
          }
wenzelm@65251
   153
      }))
wenzelm@65375
   154
  }
wenzelm@65251
   155
wenzelm@65251
   156
  def session_base(options: Options, session: String, dirs: List[Path] = Nil): Base =
wenzelm@65251
   157
  {
wenzelm@65375
   158
    val full_tree = load(options, dirs = dirs)
wenzelm@65375
   159
    val (_, tree) = full_tree.selection(sessions = List(session))
wenzelm@65375
   160
wenzelm@65375
   161
    dependencies(global_theories = full_tree.global_theories, tree = tree)(session)
wenzelm@65251
   162
  }
wenzelm@65251
   163
wenzelm@65251
   164
wenzelm@65251
   165
  /* session tree */
wenzelm@62631
   166
wenzelm@62631
   167
  sealed case class Info(
wenzelm@62631
   168
    chapter: String,
wenzelm@62631
   169
    select: Boolean,
wenzelm@62631
   170
    pos: Position.T,
wenzelm@62631
   171
    groups: List[String],
wenzelm@62631
   172
    dir: Path,
wenzelm@62631
   173
    parent: Option[String],
wenzelm@62631
   174
    description: String,
wenzelm@62631
   175
    options: Options,
wenzelm@65397
   176
    theories: List[(Options, List[String])],
wenzelm@65377
   177
    global_theories: List[String],
wenzelm@62631
   178
    files: List[Path],
wenzelm@62631
   179
    document_files: List[(Path, Path)],
wenzelm@62631
   180
    meta_digest: SHA1.Digest)
wenzelm@62631
   181
  {
wenzelm@62631
   182
    def timeout: Time = Time.seconds(options.real("timeout") * options.real("timeout_scale"))
wenzelm@62631
   183
  }
wenzelm@62631
   184
wenzelm@62631
   185
  object Tree
wenzelm@62631
   186
  {
wenzelm@65374
   187
    def apply(infos: Traversable[(String, Info)]): Tree =
wenzelm@62631
   188
    {
wenzelm@62631
   189
      val graph1 =
wenzelm@62631
   190
        (Graph.string[Info] /: infos) {
wenzelm@62631
   191
          case (graph, (name, info)) =>
wenzelm@62631
   192
            if (graph.defined(name))
wenzelm@62631
   193
              error("Duplicate session " + quote(name) + Position.here(info.pos) +
wenzelm@62631
   194
                Position.here(graph.get_node(name).pos))
wenzelm@62631
   195
            else graph.new_node(name, info)
wenzelm@62631
   196
        }
wenzelm@62631
   197
      val graph2 =
wenzelm@62631
   198
        (graph1 /: graph1.iterator) {
wenzelm@62631
   199
          case (graph, (name, (info, _))) =>
wenzelm@62631
   200
            info.parent match {
wenzelm@62631
   201
              case None => graph
wenzelm@62631
   202
              case Some(parent) =>
wenzelm@62631
   203
                if (!graph.defined(parent))
wenzelm@62631
   204
                  error("Bad parent session " + quote(parent) + " for " +
wenzelm@62631
   205
                    quote(name) + Position.here(info.pos))
wenzelm@62631
   206
wenzelm@62631
   207
                try { graph.add_edge_acyclic(parent, name) }
wenzelm@62631
   208
                catch {
wenzelm@62631
   209
                  case exn: Graph.Cycles[_] =>
wenzelm@62631
   210
                    error(cat_lines(exn.cycles.map(cycle =>
wenzelm@62631
   211
                      "Cyclic session dependency of " +
wenzelm@62631
   212
                        cycle.map(c => quote(c.toString)).mkString(" via "))) +
wenzelm@62631
   213
                          Position.here(info.pos))
wenzelm@62631
   214
                }
wenzelm@62631
   215
            }
wenzelm@62631
   216
        }
wenzelm@65375
   217
wenzelm@62631
   218
      new Tree(graph2)
wenzelm@62631
   219
    }
wenzelm@62631
   220
  }
wenzelm@62631
   221
wenzelm@62631
   222
  final class Tree private(val graph: Graph[String, Info])
wenzelm@62631
   223
    extends PartialFunction[String, Info]
wenzelm@62631
   224
  {
wenzelm@62631
   225
    def apply(name: String): Info = graph.get_node(name)
wenzelm@62631
   226
    def isDefinedAt(name: String): Boolean = graph.defined(name)
wenzelm@62631
   227
wenzelm@65375
   228
    def global_theories: Set[String] =
wenzelm@65375
   229
      (for {
wenzelm@65375
   230
        (_, (info, _)) <- graph.iterator
wenzelm@65375
   231
        name <- info.global_theories.iterator }
wenzelm@65375
   232
       yield name).toSet
wenzelm@65375
   233
wenzelm@62631
   234
    def selection(
wenzelm@62631
   235
      requirements: Boolean = false,
wenzelm@62631
   236
      all_sessions: Boolean = false,
wenzelm@62631
   237
      exclude_session_groups: List[String] = Nil,
wenzelm@62631
   238
      exclude_sessions: List[String] = Nil,
wenzelm@62631
   239
      session_groups: List[String] = Nil,
wenzelm@62631
   240
      sessions: List[String] = Nil): (List[String], Tree) =
wenzelm@62631
   241
    {
wenzelm@62631
   242
      val bad_sessions =
wenzelm@62631
   243
        SortedSet((exclude_sessions ::: sessions).filterNot(isDefinedAt(_)): _*).toList
wenzelm@62631
   244
      if (bad_sessions.nonEmpty) error("Undefined session(s): " + commas_quote(bad_sessions))
wenzelm@62631
   245
wenzelm@62631
   246
      val excluded =
wenzelm@62631
   247
      {
wenzelm@62631
   248
        val exclude_group = exclude_session_groups.toSet
wenzelm@62631
   249
        val exclude_group_sessions =
wenzelm@62631
   250
          (for {
wenzelm@62631
   251
            (name, (info, _)) <- graph.iterator
wenzelm@62631
   252
            if apply(name).groups.exists(exclude_group)
wenzelm@62631
   253
          } yield name).toList
wenzelm@62631
   254
        graph.all_succs(exclude_group_sessions ::: exclude_sessions).toSet
wenzelm@62631
   255
      }
wenzelm@62631
   256
wenzelm@62631
   257
      val pre_selected =
wenzelm@62631
   258
      {
wenzelm@62631
   259
        if (all_sessions) graph.keys
wenzelm@62631
   260
        else {
wenzelm@62631
   261
          val select_group = session_groups.toSet
wenzelm@62631
   262
          val select = sessions.toSet
wenzelm@62631
   263
          (for {
wenzelm@62631
   264
            (name, (info, _)) <- graph.iterator
wenzelm@62631
   265
            if info.select || select(name) || apply(name).groups.exists(select_group)
wenzelm@62631
   266
          } yield name).toList
wenzelm@62631
   267
        }
wenzelm@62631
   268
      }.filterNot(excluded)
wenzelm@62631
   269
wenzelm@62631
   270
      val selected =
wenzelm@62631
   271
        if (requirements) (graph.all_preds(pre_selected).toSet -- pre_selected).toList
wenzelm@62631
   272
        else pre_selected
wenzelm@62631
   273
wenzelm@62631
   274
      val graph1 = graph.restrict(graph.all_preds(selected).toSet)
wenzelm@62631
   275
      (selected, new Tree(graph1))
wenzelm@62631
   276
    }
wenzelm@62631
   277
wenzelm@62631
   278
    def ancestors(name: String): List[String] =
wenzelm@62631
   279
      graph.all_preds(List(name)).tail.reverse
wenzelm@62631
   280
wenzelm@62631
   281
    def topological_order: List[(String, Info)] =
wenzelm@62631
   282
      graph.topological_order.map(name => (name, apply(name)))
wenzelm@62631
   283
wenzelm@62631
   284
    override def toString: String = graph.keys_iterator.mkString("Sessions.Tree(", ", ", ")")
wenzelm@62631
   285
  }
wenzelm@62631
   286
wenzelm@62631
   287
wenzelm@62631
   288
  /* parser */
wenzelm@62631
   289
wenzelm@62864
   290
  val ROOT = Path.explode("ROOT")
wenzelm@62864
   291
  val ROOTS = Path.explode("ROOTS")
wenzelm@62864
   292
wenzelm@62631
   293
  private val CHAPTER = "chapter"
wenzelm@62631
   294
  private val SESSION = "session"
wenzelm@62631
   295
  private val IN = "in"
wenzelm@62631
   296
  private val DESCRIPTION = "description"
wenzelm@62631
   297
  private val OPTIONS = "options"
wenzelm@62631
   298
  private val THEORIES = "theories"
wenzelm@65377
   299
  private val GLOBAL = "global"
wenzelm@62631
   300
  private val FILES = "files"
wenzelm@62631
   301
  private val DOCUMENT_FILES = "document_files"
wenzelm@62631
   302
wenzelm@62631
   303
  lazy val root_syntax =
wenzelm@65377
   304
    Outer_Syntax.init() + "(" + ")" + "+" + "," + "=" + "[" + "]" + GLOBAL + IN +
wenzelm@63443
   305
      (CHAPTER, Keyword.THY_DECL) +
wenzelm@63443
   306
      (SESSION, Keyword.THY_DECL) +
wenzelm@63443
   307
      (DESCRIPTION, Keyword.QUASI_COMMAND) +
wenzelm@63443
   308
      (OPTIONS, Keyword.QUASI_COMMAND) +
wenzelm@63443
   309
      (THEORIES, Keyword.QUASI_COMMAND) +
wenzelm@63443
   310
      (FILES, Keyword.QUASI_COMMAND) +
wenzelm@63443
   311
      (DOCUMENT_FILES, Keyword.QUASI_COMMAND)
wenzelm@62631
   312
wenzelm@62968
   313
  private object Parser extends Parse.Parser with Options.Parser
wenzelm@62631
   314
  {
wenzelm@62631
   315
    private abstract class Entry
wenzelm@62631
   316
    private sealed case class Chapter(name: String) extends Entry
wenzelm@62631
   317
    private sealed case class Session_Entry(
wenzelm@62631
   318
      pos: Position.T,
wenzelm@62631
   319
      name: String,
wenzelm@62631
   320
      groups: List[String],
wenzelm@62631
   321
      path: String,
wenzelm@62631
   322
      parent: Option[String],
wenzelm@62631
   323
      description: String,
wenzelm@62631
   324
      options: List[Options.Spec],
wenzelm@65377
   325
      theories: List[(List[Options.Spec], List[(String, Boolean)])],
wenzelm@62631
   326
      files: List[String],
wenzelm@62631
   327
      document_files: List[(String, String)]) extends Entry
wenzelm@62631
   328
wenzelm@62631
   329
    private val chapter: Parser[Chapter] =
wenzelm@62631
   330
    {
wenzelm@62631
   331
      val chapter_name = atom("chapter name", _.is_name)
wenzelm@62631
   332
wenzelm@62631
   333
      command(CHAPTER) ~! chapter_name ^^ { case _ ~ a => Chapter(a) }
wenzelm@62631
   334
    }
wenzelm@62631
   335
wenzelm@62631
   336
    private val session_entry: Parser[Session_Entry] =
wenzelm@62631
   337
    {
wenzelm@62631
   338
      val session_name = atom("session name", _.is_name)
wenzelm@62631
   339
wenzelm@62631
   340
      val option =
wenzelm@62968
   341
        option_name ~ opt($$$("=") ~! option_value ^^
wenzelm@62968
   342
          { case _ ~ x => x }) ^^ { case x ~ y => (x, y) }
wenzelm@62631
   343
      val options = $$$("[") ~> rep1sep(option, $$$(",")) <~ $$$("]")
wenzelm@62631
   344
wenzelm@65377
   345
      val global =
wenzelm@65377
   346
        ($$$("(") ~! $$$(GLOBAL) ~ $$$(")")) ^^ { case _ => true } | success(false)
wenzelm@65377
   347
wenzelm@65377
   348
      val theory_entry =
wenzelm@65377
   349
        theory_name ~ global ^^ { case x ~ y => (x, y) }
wenzelm@65377
   350
wenzelm@62631
   351
      val theories =
wenzelm@65377
   352
        $$$(THEORIES) ~!
wenzelm@65377
   353
          ((options | success(Nil)) ~ rep(theory_entry)) ^^
wenzelm@65377
   354
          { case _ ~ (x ~ y) => (x, y) }
wenzelm@62631
   355
wenzelm@62631
   356
      val document_files =
wenzelm@62631
   357
        $$$(DOCUMENT_FILES) ~!
wenzelm@62631
   358
          (($$$("(") ~! ($$$(IN) ~! (path ~ $$$(")"))) ^^
wenzelm@62631
   359
              { case _ ~ (_ ~ (x ~ _)) => x } | success("document")) ~
wenzelm@62631
   360
            rep1(path)) ^^ { case _ ~ (x ~ y) => y.map((x, _)) }
wenzelm@62631
   361
wenzelm@62631
   362
      command(SESSION) ~!
wenzelm@62631
   363
        (position(session_name) ~
wenzelm@62631
   364
          (($$$("(") ~! (rep1(name) <~ $$$(")")) ^^ { case _ ~ x => x }) | success(Nil)) ~
wenzelm@62631
   365
          (($$$(IN) ~! path ^^ { case _ ~ x => x }) | success(".")) ~
wenzelm@62631
   366
          ($$$("=") ~!
wenzelm@62631
   367
            (opt(session_name ~! $$$("+") ^^ { case x ~ _ => x }) ~
wenzelm@62631
   368
              (($$$(DESCRIPTION) ~! text ^^ { case _ ~ x => x }) | success("")) ~
wenzelm@62631
   369
              (($$$(OPTIONS) ~! options ^^ { case _ ~ x => x }) | success(Nil)) ~
wenzelm@62631
   370
              rep1(theories) ~
wenzelm@62631
   371
              (($$$(FILES) ~! rep1(path) ^^ { case _ ~ x => x }) | success(Nil)) ~
wenzelm@62631
   372
              (rep(document_files) ^^ (x => x.flatten))))) ^^
wenzelm@62631
   373
        { case _ ~ ((a, pos) ~ b ~ c ~ (_ ~ (d ~ e ~ f ~ g ~ h ~ i))) =>
wenzelm@62631
   374
            Session_Entry(pos, a, b, c, d, e, f, g, h, i) }
wenzelm@62631
   375
    }
wenzelm@62631
   376
wenzelm@62631
   377
    def parse(options: Options, select: Boolean, dir: Path): List[(String, Info)] =
wenzelm@62631
   378
    {
wenzelm@62631
   379
      def make_info(entry_chapter: String, entry: Session_Entry): (String, Info) =
wenzelm@62631
   380
      {
wenzelm@62631
   381
        try {
wenzelm@62631
   382
          val name = entry.name
wenzelm@62631
   383
wenzelm@62631
   384
          if (name == "") error("Bad session name")
wenzelm@65360
   385
          if (is_pure(name) && entry.parent.isDefined) error("Illegal parent session")
wenzelm@65360
   386
          if (!is_pure(name) && !entry.parent.isDefined) error("Missing parent session")
wenzelm@62631
   387
wenzelm@62631
   388
          val session_options = options ++ entry.options
wenzelm@62631
   389
wenzelm@62631
   390
          val theories =
wenzelm@65397
   391
            entry.theories.map({ case (opts, thys) => (session_options ++ opts, thys.map(_._1)) })
wenzelm@65377
   392
wenzelm@65377
   393
          val global_theories =
wenzelm@65377
   394
            for { (_, thys) <- entry.theories; (thy, global) <- thys if global }
wenzelm@65377
   395
            yield {
wenzelm@65377
   396
              val thy_name = Path.explode(thy).expand.base.implode
wenzelm@65377
   397
              if (Long_Name.is_qualified(thy_name))
wenzelm@65377
   398
                error("Bad qualified name for global theory " + quote(thy_name))
wenzelm@65377
   399
              else thy_name
wenzelm@65377
   400
            }
wenzelm@65377
   401
wenzelm@62631
   402
          val files = entry.files.map(Path.explode(_))
wenzelm@62631
   403
          val document_files =
wenzelm@62631
   404
            entry.document_files.map({ case (s1, s2) => (Path.explode(s1), Path.explode(s2)) })
wenzelm@62631
   405
wenzelm@62631
   406
          val meta_digest =
wenzelm@62631
   407
            SHA1.digest((entry_chapter, name, entry.parent, entry.options,
wenzelm@62631
   408
              entry.theories, entry.files, entry.document_files).toString)
wenzelm@62631
   409
wenzelm@62631
   410
          val info =
wenzelm@62631
   411
            Info(entry_chapter, select, entry.pos, entry.groups, dir + Path.explode(entry.path),
wenzelm@65377
   412
              entry.parent, entry.description, session_options, theories, global_theories,
wenzelm@65377
   413
              files, document_files, meta_digest)
wenzelm@62631
   414
wenzelm@62631
   415
          (name, info)
wenzelm@62631
   416
        }
wenzelm@62631
   417
        catch {
wenzelm@62631
   418
          case ERROR(msg) =>
wenzelm@62631
   419
            error(msg + "\nThe error(s) above occurred in session entry " +
wenzelm@62631
   420
              quote(entry.name) + Position.here(entry.pos))
wenzelm@62631
   421
        }
wenzelm@62631
   422
      }
wenzelm@62631
   423
wenzelm@62631
   424
      val root = dir + ROOT
wenzelm@62631
   425
      if (root.is_file) {
wenzelm@62631
   426
        val toks = Token.explode(root_syntax.keywords, File.read(root))
wenzelm@62631
   427
        val start = Token.Pos.file(root.implode)
wenzelm@62631
   428
wenzelm@62631
   429
        parse_all(rep(chapter | session_entry), Token.reader(toks, start)) match {
wenzelm@62631
   430
          case Success(result, _) =>
wenzelm@62631
   431
            var entry_chapter = "Unsorted"
wenzelm@62631
   432
            val infos = new mutable.ListBuffer[(String, Info)]
wenzelm@62631
   433
            result.foreach {
wenzelm@62631
   434
              case Chapter(name) => entry_chapter = name
wenzelm@62631
   435
              case entry: Session_Entry => infos += make_info(entry_chapter, entry)
wenzelm@62631
   436
            }
wenzelm@62631
   437
            infos.toList
wenzelm@62631
   438
          case bad => error(bad.toString)
wenzelm@62631
   439
        }
wenzelm@62631
   440
      }
wenzelm@62631
   441
      else Nil
wenzelm@62631
   442
    }
wenzelm@62631
   443
  }
wenzelm@62631
   444
wenzelm@62631
   445
wenzelm@62635
   446
  /* load sessions from certain directories */
wenzelm@62631
   447
wenzelm@62631
   448
  private def is_session_dir(dir: Path): Boolean =
wenzelm@62631
   449
    (dir + ROOT).is_file || (dir + ROOTS).is_file
wenzelm@62631
   450
wenzelm@62631
   451
  private def check_session_dir(dir: Path): Path =
wenzelm@62631
   452
    if (is_session_dir(dir)) dir
wenzelm@62631
   453
    else error("Bad session root directory: " + dir.toString)
wenzelm@62631
   454
wenzelm@62635
   455
  def load(options: Options, dirs: List[Path] = Nil, select_dirs: List[Path] = Nil): Tree =
wenzelm@62631
   456
  {
wenzelm@62635
   457
    def load_dir(select: Boolean, dir: Path): List[(String, Info)] =
wenzelm@62635
   458
      load_root(select, dir) ::: load_roots(select, dir)
wenzelm@62631
   459
wenzelm@62635
   460
    def load_root(select: Boolean, dir: Path): List[(String, Info)] =
wenzelm@62631
   461
      Parser.parse(options, select, dir)
wenzelm@62631
   462
wenzelm@62635
   463
    def load_roots(select: Boolean, dir: Path): List[(String, Info)] =
wenzelm@62631
   464
    {
wenzelm@62631
   465
      val roots = dir + ROOTS
wenzelm@62631
   466
      if (roots.is_file) {
wenzelm@62631
   467
        for {
wenzelm@62631
   468
          line <- split_lines(File.read(roots))
wenzelm@62631
   469
          if !(line == "" || line.startsWith("#"))
wenzelm@62631
   470
          dir1 =
wenzelm@62631
   471
            try { check_session_dir(dir + Path.explode(line)) }
wenzelm@62631
   472
            catch {
wenzelm@62631
   473
              case ERROR(msg) =>
wenzelm@62631
   474
                error(msg + "\nThe error(s) above occurred in session catalog " + roots.toString)
wenzelm@62631
   475
            }
wenzelm@62635
   476
          info <- load_dir(select, dir1)
wenzelm@62631
   477
        } yield info
wenzelm@62631
   478
      }
wenzelm@62631
   479
      else Nil
wenzelm@62631
   480
    }
wenzelm@62631
   481
wenzelm@62631
   482
    val default_dirs = Isabelle_System.components().filter(is_session_dir(_))
wenzelm@62631
   483
    dirs.foreach(check_session_dir(_))
wenzelm@62631
   484
    select_dirs.foreach(check_session_dir(_))
wenzelm@62631
   485
wenzelm@62631
   486
    Tree(
wenzelm@62631
   487
      for {
wenzelm@62631
   488
        (select, dir) <- (default_dirs ::: dirs).map((false, _)) ::: select_dirs.map((true, _))
wenzelm@62635
   489
        info <- load_dir(select, dir)
wenzelm@62631
   490
      } yield info)
wenzelm@62631
   491
  }
wenzelm@62632
   492
wenzelm@62632
   493
wenzelm@62637
   494
wenzelm@62704
   495
  /** heap file with SHA1 digest **/
wenzelm@62704
   496
wenzelm@62704
   497
  private val sha1_prefix = "SHA1:"
wenzelm@62704
   498
wenzelm@62704
   499
  def read_heap_digest(heap: Path): Option[String] =
wenzelm@62704
   500
  {
wenzelm@62704
   501
    if (heap.is_file) {
wenzelm@62704
   502
      val file = FileChannel.open(heap.file.toPath, StandardOpenOption.READ)
wenzelm@62704
   503
      try {
wenzelm@62704
   504
        val len = file.size
wenzelm@62704
   505
        val n = sha1_prefix.length + SHA1.digest_length
wenzelm@62704
   506
        if (len >= n) {
wenzelm@62704
   507
          file.position(len - n)
wenzelm@62704
   508
wenzelm@62704
   509
          val buf = ByteBuffer.allocate(n)
wenzelm@62704
   510
          var i = 0
wenzelm@62704
   511
          var m = 0
wenzelm@62704
   512
          do {
wenzelm@62704
   513
            m = file.read(buf)
wenzelm@62704
   514
            if (m != -1) i += m
wenzelm@62704
   515
          }
wenzelm@62704
   516
          while (m != -1 && n > i)
wenzelm@62704
   517
wenzelm@62704
   518
          if (i == n) {
wenzelm@62704
   519
            val prefix = new String(buf.array(), 0, sha1_prefix.length, UTF8.charset)
wenzelm@62704
   520
            val s = new String(buf.array(), sha1_prefix.length, SHA1.digest_length, UTF8.charset)
wenzelm@62704
   521
            if (prefix == sha1_prefix) Some(s) else None
wenzelm@62704
   522
          }
wenzelm@62704
   523
          else None
wenzelm@62704
   524
        }
wenzelm@62704
   525
        else None
wenzelm@62704
   526
      }
wenzelm@62704
   527
      finally { file.close }
wenzelm@62704
   528
    }
wenzelm@62704
   529
    else None
wenzelm@62704
   530
  }
wenzelm@62704
   531
wenzelm@62704
   532
  def write_heap_digest(heap: Path): String =
wenzelm@62704
   533
    read_heap_digest(heap) match {
wenzelm@62704
   534
      case None =>
wenzelm@62704
   535
        val s = SHA1.digest(heap).rep
wenzelm@62704
   536
        File.append(heap, sha1_prefix + s)
wenzelm@62704
   537
        s
wenzelm@62704
   538
      case Some(s) => s
wenzelm@62704
   539
    }
wenzelm@62704
   540
wenzelm@62704
   541
wenzelm@62704
   542
wenzelm@62637
   543
  /** persistent store **/
wenzelm@62632
   544
wenzelm@65296
   545
  object Session_Info
wenzelm@65296
   546
  {
wenzelm@65326
   547
    val session_name = SQL.Column.string("session_name", primary_key = true)
wenzelm@65326
   548
wenzelm@65296
   549
    // Build_Log.Session_Info
wenzelm@65296
   550
    val session_timing = SQL.Column.bytes("session_timing")
wenzelm@65296
   551
    val command_timings = SQL.Column.bytes("command_timings")
wenzelm@65296
   552
    val ml_statistics = SQL.Column.bytes("ml_statistics")
wenzelm@65296
   553
    val task_statistics = SQL.Column.bytes("task_statistics")
wenzelm@65296
   554
    val build_log_columns =
wenzelm@65296
   555
      List(session_name, session_timing, command_timings, ml_statistics, task_statistics)
wenzelm@65296
   556
wenzelm@65296
   557
    // Build.Session_Info
wenzelm@65296
   558
    val sources = SQL.Column.string("sources")
wenzelm@65296
   559
    val input_heaps = SQL.Column.string("input_heaps")
wenzelm@65296
   560
    val output_heap = SQL.Column.string("output_heap")
wenzelm@65296
   561
    val return_code = SQL.Column.int("return_code")
wenzelm@65296
   562
    val build_columns = List(sources, input_heaps, output_heap, return_code)
wenzelm@65296
   563
wenzelm@65296
   564
    val table = SQL.Table("isabelle_session_info", build_log_columns ::: build_columns)
wenzelm@65320
   565
wenzelm@65320
   566
    def where_session_name(name: String): String =
wenzelm@65322
   567
      "WHERE " + session_name.sql_name + " = " + SQL.quote_string(name)
wenzelm@65320
   568
wenzelm@65320
   569
    def select_statement(db: SQL.Database, name: String, columns: List[SQL.Column])
wenzelm@65320
   570
        : PreparedStatement =
wenzelm@65320
   571
      db.select_statement(table, columns, where_session_name(name))
wenzelm@65320
   572
wenzelm@65320
   573
    def delete_statement(db: SQL.Database, name: String): PreparedStatement =
wenzelm@65320
   574
      db.delete_statement(table, where_session_name(name))
wenzelm@65296
   575
  }
wenzelm@65296
   576
wenzelm@62632
   577
  def store(system_mode: Boolean = false): Store = new Store(system_mode)
wenzelm@62632
   578
wenzelm@63996
   579
  class Store private[Sessions](system_mode: Boolean)
wenzelm@62632
   580
  {
wenzelm@65278
   581
    /* file names */
wenzelm@65278
   582
wenzelm@65281
   583
    def database(name: String): Path = Path.basic("log") + Path.basic(name).ext("db")
wenzelm@65278
   584
    def log(name: String): Path = Path.basic("log") + Path.basic(name)
wenzelm@65278
   585
    def log_gz(name: String): Path = log(name).ext("gz")
wenzelm@65278
   586
wenzelm@65278
   587
wenzelm@65286
   588
    /* SQL database content */
wenzelm@65283
   589
wenzelm@65283
   590
    val xml_cache: XML.Cache = new XML.Cache()
wenzelm@65283
   591
wenzelm@65283
   592
    def encode_properties(ps: Properties.T): Bytes =
wenzelm@65283
   593
      Bytes(YXML.string_of_body(XML.Encode.properties(ps)))
wenzelm@65283
   594
wenzelm@65283
   595
    def decode_properties(bs: Bytes): Properties.T =
wenzelm@65283
   596
      xml_cache.props(XML.Decode.properties(YXML.parse_body(bs.text)))
wenzelm@65283
   597
wenzelm@65283
   598
    def compress_properties(ps: List[Properties.T], options: XZ.Options = XZ.options()): Bytes =
wenzelm@65283
   599
    {
wenzelm@65283
   600
      if (ps.isEmpty) Bytes.empty
wenzelm@65283
   601
      else Bytes(YXML.string_of_body(XML.Encode.list(XML.Encode.properties)(ps))).compress(options)
wenzelm@65283
   602
    }
wenzelm@65283
   603
wenzelm@65283
   604
    def uncompress_properties(bs: Bytes): List[Properties.T] =
wenzelm@65283
   605
    {
wenzelm@65283
   606
      if (bs.isEmpty) Nil
wenzelm@65283
   607
      else
wenzelm@65283
   608
        XML.Decode.list(XML.Decode.properties)(YXML.parse_body(bs.uncompress().text)).
wenzelm@65283
   609
          map(xml_cache.props(_))
wenzelm@65283
   610
    }
wenzelm@65283
   611
wenzelm@65320
   612
    def read_bytes(db: SQL.Database, name: String, column: SQL.Column): Bytes =
wenzelm@65320
   613
      using(Session_Info.select_statement(db, name, List(column)))(stmt =>
wenzelm@65291
   614
      {
wenzelm@65291
   615
        val rs = stmt.executeQuery
wenzelm@65324
   616
        if (!rs.next) Bytes.empty else db.bytes(rs, column)
wenzelm@65291
   617
      })
wenzelm@65285
   618
wenzelm@65320
   619
    def read_properties(db: SQL.Database, name: String, column: SQL.Column): List[Properties.T] =
wenzelm@65320
   620
      uncompress_properties(read_bytes(db, name, column))
wenzelm@65286
   621
wenzelm@65283
   622
wenzelm@62637
   623
    /* output */
wenzelm@62632
   624
wenzelm@62632
   625
    val browser_info: Path =
wenzelm@62632
   626
      if (system_mode) Path.explode("~~/browser_info")
wenzelm@62632
   627
      else Path.explode("$ISABELLE_BROWSER_INFO")
wenzelm@62632
   628
wenzelm@62637
   629
    val output_dir: Path =
wenzelm@62637
   630
      if (system_mode) Path.explode("~~/heaps/$ML_IDENTIFIER")
wenzelm@62637
   631
      else Path.explode("$ISABELLE_OUTPUT")
wenzelm@62637
   632
wenzelm@65298
   633
    override def toString: String = "Store(output_dir = " + output_dir.expand + ")"
wenzelm@65298
   634
wenzelm@62637
   635
    def prepare_output() { Isabelle_System.mkdirs(output_dir + Path.basic("log")) }
wenzelm@62637
   636
wenzelm@62637
   637
wenzelm@62637
   638
    /* input */
wenzelm@62637
   639
wenzelm@62637
   640
    private val input_dirs =
wenzelm@62632
   641
      if (system_mode) List(output_dir)
wenzelm@62633
   642
      else {
wenzelm@62633
   643
        val ml_ident = Path.explode("$ML_IDENTIFIER").expand
wenzelm@62633
   644
        output_dir :: Path.split(Isabelle_System.getenv_strict("ISABELLE_PATH")).map(_ + ml_ident)
wenzelm@62633
   645
      }
wenzelm@62632
   646
wenzelm@65291
   647
    def find_database_heap(name: String): Option[(Path, Option[String])] =
wenzelm@65291
   648
      input_dirs.find(dir => (dir + database(name)).is_file).map(dir =>
wenzelm@65291
   649
        (dir + database(name), read_heap_digest(dir + Path.basic(name))))
wenzelm@62632
   650
wenzelm@65281
   651
    def find_database(name: String): Option[Path] =
wenzelm@65281
   652
      input_dirs.map(_ + database(name)).find(_.is_file)
wenzelm@65281
   653
wenzelm@62637
   654
    def heap(name: String): Path =
wenzelm@65288
   655
      input_dirs.map(_ + Path.basic(name)).find(_.is_file) getOrElse
wenzelm@62637
   656
        error("Unknown logic " + quote(name) + " -- no heap file found in:\n" +
wenzelm@62769
   657
          cat_lines(input_dirs.map(dir => "  " + dir.expand.implode)))
wenzelm@65287
   658
wenzelm@65287
   659
wenzelm@65296
   660
    /* session info */
wenzelm@65281
   661
wenzelm@65296
   662
    def write_session_info(
wenzelm@65318
   663
      db: SQL.Database,
wenzelm@65320
   664
      name: String,
wenzelm@65318
   665
      build_log: Build_Log.Session_Info,
wenzelm@65318
   666
      build: Build.Session_Info)
wenzelm@65281
   667
    {
wenzelm@65281
   668
      db.transaction {
wenzelm@65296
   669
        db.create_table(Session_Info.table)
wenzelm@65320
   670
        using(Session_Info.delete_statement(db, name))(_.execute)
wenzelm@65296
   671
        using(db.insert_statement(Session_Info.table))(stmt =>
wenzelm@65281
   672
        {
wenzelm@65320
   673
          db.set_string(stmt, 1, name)
wenzelm@65296
   674
          db.set_bytes(stmt, 2, encode_properties(build_log.session_timing))
wenzelm@65296
   675
          db.set_bytes(stmt, 3, compress_properties(build_log.command_timings))
wenzelm@65296
   676
          db.set_bytes(stmt, 4, compress_properties(build_log.ml_statistics))
wenzelm@65296
   677
          db.set_bytes(stmt, 5, compress_properties(build_log.task_statistics))
wenzelm@65284
   678
          db.set_string(stmt, 6, cat_lines(build.sources))
wenzelm@65284
   679
          db.set_string(stmt, 7, cat_lines(build.input_heaps))
wenzelm@65291
   680
          db.set_string(stmt, 8, build.output_heap getOrElse "")
wenzelm@65283
   681
          db.set_int(stmt, 9, build.return_code)
wenzelm@65281
   682
          stmt.execute()
wenzelm@65281
   683
        })
wenzelm@65281
   684
      }
wenzelm@65281
   685
    }
wenzelm@65281
   686
wenzelm@65320
   687
    def read_session_timing(db: SQL.Database, name: String): Properties.T =
wenzelm@65320
   688
      decode_properties(read_bytes(db, name, Session_Info.session_timing))
wenzelm@65286
   689
wenzelm@65320
   690
    def read_command_timings(db: SQL.Database, name: String): List[Properties.T] =
wenzelm@65320
   691
      read_properties(db, name, Session_Info.command_timings)
wenzelm@65286
   692
wenzelm@65320
   693
    def read_ml_statistics(db: SQL.Database, name: String): List[Properties.T] =
wenzelm@65320
   694
      read_properties(db, name, Session_Info.ml_statistics)
wenzelm@65286
   695
wenzelm@65320
   696
    def read_task_statistics(db: SQL.Database, name: String): List[Properties.T] =
wenzelm@65320
   697
      read_properties(db, name, Session_Info.task_statistics)
wenzelm@65286
   698
wenzelm@65320
   699
    def read_build_log(db: SQL.Database, name: String,
wenzelm@65291
   700
      command_timings: Boolean = false,
wenzelm@65291
   701
      ml_statistics: Boolean = false,
wenzelm@65291
   702
      task_statistics: Boolean = false): Build_Log.Session_Info =
wenzelm@65291
   703
    {
wenzelm@65291
   704
      Build_Log.Session_Info(
wenzelm@65320
   705
        session_timing = read_session_timing(db, name),
wenzelm@65320
   706
        command_timings = if (command_timings) read_command_timings(db, name) else Nil,
wenzelm@65320
   707
        ml_statistics = if (ml_statistics) read_ml_statistics(db, name) else Nil,
wenzelm@65320
   708
        task_statistics = if (task_statistics) read_task_statistics(db, name) else Nil)
wenzelm@65291
   709
    }
wenzelm@65285
   710
wenzelm@65320
   711
    def read_build(db: SQL.Database, name: String): Option[Build.Session_Info] =
wenzelm@65320
   712
      using(Session_Info.select_statement(db, name, Session_Info.build_columns))(stmt =>
wenzelm@65285
   713
      {
wenzelm@65285
   714
        val rs = stmt.executeQuery
wenzelm@65285
   715
        if (!rs.next) None
wenzelm@65285
   716
        else {
wenzelm@65285
   717
          Some(
wenzelm@65281
   718
            Build.Session_Info(
wenzelm@65324
   719
              split_lines(db.string(rs, Session_Info.sources)),
wenzelm@65324
   720
              split_lines(db.string(rs, Session_Info.input_heaps)),
wenzelm@65324
   721
              db.string(rs, Session_Info.output_heap) match { case "" => None case s => Some(s) },
wenzelm@65324
   722
              db.int(rs, Session_Info.return_code)))
wenzelm@65281
   723
        }
wenzelm@65281
   724
      })
wenzelm@65281
   725
  }
wenzelm@62631
   726
}