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