src/Pure/Thy/sessions.scala
author wenzelm
Wed Apr 19 20:10:34 2017 +0200 (2017-04-19)
changeset 65517 1544e61e5314
parent 65507 decdb95bd007
child 65519 d244d8f8e13f
permissions -rw-r--r--
more position information;
     1 /*  Title:      Pure/Thy/sessions.scala
     2     Author:     Makarius
     3 
     4 Cumulative session information.
     5 */
     6 
     7 package isabelle
     8 
     9 import java.io.{File => JFile}
    10 import java.nio.ByteBuffer
    11 import java.nio.channels.FileChannel
    12 import java.nio.file.StandardOpenOption
    13 import java.sql.PreparedStatement
    14 
    15 import scala.collection.SortedSet
    16 import scala.collection.mutable
    17 
    18 
    19 object Sessions
    20 {
    21   /* base info and source dependencies */
    22 
    23   val DRAFT = "Draft"
    24 
    25   def is_pure(name: String): Boolean = name == Thy_Header.PURE
    26 
    27   object Known
    28   {
    29     val empty: Known = Known()
    30 
    31     def make(local_dir: Path, bases: List[Base], theories: List[Document.Node.Name]): Known =
    32     {
    33       def bases_iterator(local: Boolean) =
    34         for {
    35           base <- bases.iterator
    36           (_, name) <- (if (local) base.known.theories_local else base.known.theories).iterator
    37         } yield name
    38 
    39       def local_theories_iterator =
    40       {
    41         val local_path = local_dir.file.getCanonicalFile.toPath
    42         theories.iterator.filter(name =>
    43           Path.explode(name.node).file.getCanonicalFile.toPath.startsWith(local_path))
    44       }
    45 
    46       val known_theories =
    47         (Map.empty[String, Document.Node.Name] /: (bases_iterator(false) ++ theories.iterator))({
    48           case (known, name) =>
    49             known.get(name.theory) match {
    50               case Some(name1) if name != name1 =>
    51                 error("Duplicate theory " + quote(name.node) + " vs. " + quote(name1.node))
    52               case _ => known + (name.theory -> name)
    53             }
    54           })
    55       val known_theories_local =
    56         (Map.empty[String, Document.Node.Name] /:
    57             (bases_iterator(true) ++ local_theories_iterator))({
    58           case (known, name) => known + (name.theory -> name)
    59         })
    60       val known_files =
    61         (Map.empty[JFile, List[Document.Node.Name]] /:
    62             (bases_iterator(true) ++ bases_iterator(false) ++ theories.iterator))({
    63           case (known, name) =>
    64             val file = Path.explode(name.node).file.getCanonicalFile
    65             val theories1 = known.getOrElse(file, Nil)
    66             if (theories1.exists(name1 => name.node == name1.node && name.theory == name1.theory))
    67               known
    68             else known + (file -> (name :: theories1))
    69         })
    70       Known(known_theories, known_theories_local,
    71         known_files.iterator.map(p => (p._1, p._2.reverse)).toMap)
    72     }
    73   }
    74 
    75   sealed case class Known(
    76     theories: Map[String, Document.Node.Name] = Map.empty,
    77     theories_local: Map[String, Document.Node.Name] = Map.empty,
    78     files: Map[JFile, List[Document.Node.Name]] = Map.empty)
    79   {
    80     def platform_path: Known =
    81       copy(theories = for ((a, b) <- theories) yield (a, b.map(File.platform_path(_))),
    82         theories_local = for ((a, b) <- theories_local) yield (a, b.map(File.platform_path(_))),
    83         files = for ((a, b) <- files) yield (a, b.map(c => c.map(File.platform_path(_)))))
    84   }
    85 
    86   object Base
    87   {
    88     def pure(options: Options): Base = session_base(options, Thy_Header.PURE)
    89 
    90     def bootstrap(global_theories: Map[String, String]): Base =
    91       Base(
    92         global_theories = global_theories,
    93         keywords = Thy_Header.bootstrap_header,
    94         syntax = Thy_Header.bootstrap_syntax)
    95   }
    96 
    97   sealed case class Base(
    98     global_theories: Map[String, String] = Map.empty,
    99     loaded_theories: Map[String, String] = Map.empty,
   100     known: Known = Known.empty,
   101     keywords: Thy_Header.Keywords = Nil,
   102     syntax: Outer_Syntax = Outer_Syntax.empty,
   103     sources: List[(Path, SHA1.Digest)] = Nil,
   104     session_graph: Graph_Display.Graph = Graph_Display.empty_graph)
   105   {
   106     def platform_path: Base = copy(known = known.platform_path)
   107 
   108     def loaded_theory(name: Document.Node.Name): Boolean =
   109       loaded_theories.isDefinedAt(name.theory)
   110 
   111     def known_theory(name: String): Option[Document.Node.Name] =
   112       known.theories.get(name)
   113 
   114     def known_file(file: JFile): Option[Document.Node.Name] =
   115       known.files.getOrElse(file.getCanonicalFile, Nil).headOption
   116 
   117     def dest_known_theories: List[(String, String)] =
   118       for ((theory, node_name) <- known.theories.toList)
   119         yield (theory, node_name.node)
   120   }
   121 
   122   sealed case class Deps(session_bases: Map[String, Base], all_known: Known)
   123   {
   124     def is_empty: Boolean = session_bases.isEmpty
   125     def apply(name: String): Base = session_bases(name)
   126     def sources(name: String): List[SHA1.Digest] = session_bases(name).sources.map(_._2)
   127   }
   128 
   129   def deps(sessions: T,
   130       progress: Progress = No_Progress,
   131       inlined_files: Boolean = false,
   132       verbose: Boolean = false,
   133       list_files: Boolean = false,
   134       check_keywords: Set[String] = Set.empty,
   135       global_theories: Map[String, String] = Map.empty,
   136       all_known: Boolean = false): Deps =
   137   {
   138     val session_bases =
   139       (Map.empty[String, Base] /: sessions.imports_topological_order)({
   140         case (session_bases, (session_name, info)) =>
   141           if (progress.stopped) throw Exn.Interrupt()
   142 
   143           try {
   144             val parent_base: Sessions.Base =
   145               info.parent match {
   146                 case None => Base.bootstrap(global_theories)
   147                 case Some(parent) => session_bases(parent)
   148               }
   149             val imports_base: Sessions.Base =
   150               parent_base.copy(known =
   151                 Known.make(info.dir, parent_base :: info.imports.map(session_bases(_)), Nil))
   152 
   153             val resources = new Resources(imports_base,
   154               default_qualifier = info.theory_qualifier(session_name))
   155 
   156             if (verbose || list_files) {
   157               val groups =
   158                 if (info.groups.isEmpty) ""
   159                 else info.groups.mkString(" (", " ", ")")
   160               progress.echo("Session " + info.chapter + "/" + session_name + groups)
   161             }
   162 
   163             val thy_deps =
   164             {
   165               val root_theories =
   166                 info.theories.flatMap({ case (_, thys) =>
   167                   thys.map({ case (thy, pos) =>
   168                     (resources.import_name(session_name, info.dir.implode, thy), pos) })
   169                 })
   170               val thy_deps = resources.thy_info.dependencies(root_theories)
   171 
   172               thy_deps.errors match {
   173                 case Nil => thy_deps
   174                 case errs => error(cat_lines(errs))
   175               }
   176             }
   177 
   178             val syntax = thy_deps.syntax
   179 
   180             val theory_files = thy_deps.deps.map(dep => Path.explode(dep.name.node))
   181             val loaded_files =
   182               if (inlined_files) {
   183                 val pure_files =
   184                   if (is_pure(session_name)) {
   185                     val roots = Thy_Header.ml_roots.map(p => info.dir + Path.explode(p._1))
   186                     val files =
   187                       roots.flatMap(root => resources.loaded_files(syntax, File.read(root))).
   188                         map(file => info.dir + Path.explode(file))
   189                     roots ::: files
   190                   }
   191                   else Nil
   192                 pure_files ::: thy_deps.loaded_files
   193               }
   194               else Nil
   195 
   196             val all_files =
   197               (theory_files ::: loaded_files :::
   198                 info.files.map(file => info.dir + file) :::
   199                 info.document_files.map(file => info.dir + file._1 + file._2)).map(_.expand)
   200 
   201             if (list_files)
   202               progress.echo(cat_lines(all_files.map(_.implode).sorted.map("  " + _)))
   203 
   204             if (check_keywords.nonEmpty)
   205               Check_Keywords.check_keywords(progress, syntax.keywords, check_keywords, theory_files)
   206 
   207             val session_graph: Graph_Display.Graph =
   208             {
   209               def session_node(name: String): Graph_Display.Node =
   210                 Graph_Display.Node("[" + name + "]", "session." + name)
   211 
   212               def node(name: Document.Node.Name): Graph_Display.Node =
   213               {
   214                 val session = resources.theory_qualifier(name)
   215                 if (session == session_name)
   216                   Graph_Display.Node(name.theory_base_name, "theory." + name.theory)
   217                 else session_node(session)
   218               }
   219 
   220               val imports_subgraph =
   221                 sessions.imports_graph.restrict(
   222                   sessions.imports_graph.all_preds(info.parent.toList ::: info.imports).toSet)
   223 
   224               val graph0 =
   225                 (Graph_Display.empty_graph /: imports_subgraph.topological_order)(
   226                   { case (g, session) =>
   227                       val a = session_node(session)
   228                       val bs = imports_subgraph.imm_preds(session).toList.map(session_node(_))
   229                       ((g /: (a :: bs))(_.default_node(_, Nil)) /: bs)(_.add_edge(_, a)) })
   230 
   231               (graph0 /: thy_deps.deps)(
   232                 { case (g, dep) =>
   233                     val a = node(dep.name)
   234                     val bs =
   235                       dep.header.imports.map({ case (name, _) => node(name) }).
   236                         filterNot(_ == a)
   237                     ((g /: (a :: bs))(_.default_node(_, Nil)) /: bs)(_.add_edge(_, a)) })
   238             }
   239 
   240             val base =
   241               Base(global_theories = global_theories,
   242                 loaded_theories = thy_deps.loaded_theories,
   243                 known = Known.make(info.dir, List(imports_base), thy_deps.deps.map(_.name)),
   244                 keywords = thy_deps.keywords,
   245                 syntax = syntax,
   246                 sources = all_files.map(p => (p, SHA1.digest(p.file))),
   247                 session_graph = session_graph)
   248 
   249             session_bases + (session_name -> base)
   250           }
   251           catch {
   252             case ERROR(msg) =>
   253               cat_error(msg, "The error(s) above occurred in session " +
   254                 quote(session_name) + Position.here(info.pos))
   255           }
   256       })
   257 
   258     Deps(session_bases,
   259       if (all_known) Known.make(Path.current, session_bases.toList.map(_._2), Nil)
   260       else Known.empty)
   261   }
   262 
   263   def session_base(
   264     options: Options,
   265     session: String,
   266     dirs: List[Path] = Nil,
   267     all_known: Boolean = false): Base =
   268   {
   269     val full_sessions = load(options, dirs = dirs)
   270     val global_theories = full_sessions.global_theories
   271     val selected_sessions = full_sessions.selection(Selection(sessions = List(session)))._2
   272 
   273     if (all_known) {
   274       val deps = Sessions.deps(
   275         full_sessions, global_theories = global_theories, all_known = all_known)
   276       deps(session).copy(known = deps.all_known)
   277     }
   278     else
   279       deps(selected_sessions, global_theories = global_theories)(session)
   280   }
   281 
   282 
   283   /* cumulative session info */
   284 
   285   sealed case class Info(
   286     chapter: String,
   287     select: Boolean,
   288     pos: Position.T,
   289     groups: List[String],
   290     dir: Path,
   291     parent: Option[String],
   292     description: String,
   293     options: Options,
   294     imports: List[String],
   295     theories: List[(Options, List[(String, Position.T)])],
   296     global_theories: List[String],
   297     files: List[Path],
   298     document_files: List[(Path, Path)],
   299     meta_digest: SHA1.Digest)
   300   {
   301     def timeout: Time = Time.seconds(options.real("timeout") * options.real("timeout_scale"))
   302 
   303     def theory_qualifier(default_qualifier: String): String =
   304       options.string("theory_qualifier") match {
   305         case "" => default_qualifier
   306         case qualifier => qualifier
   307       }
   308   }
   309 
   310   object Selection
   311   {
   312     val empty: Selection = Selection()
   313   }
   314 
   315   sealed case class Selection(
   316     requirements: Boolean = false,
   317     all_sessions: Boolean = false,
   318     exclude_session_groups: List[String] = Nil,
   319     exclude_sessions: List[String] = Nil,
   320     session_groups: List[String] = Nil,
   321     sessions: List[String] = Nil)
   322   {
   323     def + (other: Selection): Selection =
   324       Selection(
   325         requirements = requirements || other.requirements,
   326         all_sessions = all_sessions || other.all_sessions,
   327         exclude_session_groups = exclude_session_groups ::: other.exclude_session_groups,
   328         exclude_sessions = exclude_sessions ::: other.exclude_sessions,
   329         session_groups = session_groups ::: other.session_groups,
   330         sessions = sessions ::: other.sessions)
   331 
   332     def apply(graph: Graph[String, Info]): (List[String], Graph[String, Info]) =
   333     {
   334       val bad_sessions =
   335         SortedSet((exclude_sessions ::: sessions).filterNot(graph.defined(_)): _*).toList
   336       if (bad_sessions.nonEmpty) error("Undefined session(s): " + commas_quote(bad_sessions))
   337 
   338       val excluded =
   339       {
   340         val exclude_group = exclude_session_groups.toSet
   341         val exclude_group_sessions =
   342           (for {
   343             (name, (info, _)) <- graph.iterator
   344             if graph.get_node(name).groups.exists(exclude_group)
   345           } yield name).toList
   346         graph.all_succs(exclude_group_sessions ::: exclude_sessions).toSet
   347       }
   348 
   349       val pre_selected =
   350       {
   351         if (all_sessions) graph.keys
   352         else {
   353           val select_group = session_groups.toSet
   354           val select = sessions.toSet
   355           (for {
   356             (name, (info, _)) <- graph.iterator
   357             if info.select || select(name) || graph.get_node(name).groups.exists(select_group)
   358           } yield name).toList
   359         }
   360       }.filterNot(excluded)
   361 
   362       val selected =
   363         if (requirements) (graph.all_preds(pre_selected).toSet -- pre_selected).toList
   364         else pre_selected
   365 
   366       (selected, graph.restrict(graph.all_preds(selected).toSet))
   367     }
   368   }
   369 
   370   def make(infos: Traversable[(String, Info)]): T =
   371   {
   372     def add_edges(graph: Graph[String, Info], kind: String, edges: Info => Traversable[String])
   373       : Graph[String, Info] =
   374     {
   375       def add_edge(pos: Position.T, name: String, g: Graph[String, Info], parent: String) =
   376       {
   377         if (!g.defined(parent))
   378           error("Bad " + kind + " session " + quote(parent) + " for " +
   379             quote(name) + Position.here(pos))
   380 
   381         try { g.add_edge_acyclic(parent, name) }
   382         catch {
   383           case exn: Graph.Cycles[_] =>
   384             error(cat_lines(exn.cycles.map(cycle =>
   385               "Cyclic session dependency of " +
   386                 cycle.map(c => quote(c.toString)).mkString(" via "))) + Position.here(pos))
   387         }
   388       }
   389       (graph /: graph.iterator) {
   390         case (g, (name, (info, _))) => (g /: edges(info))(add_edge(info.pos, name, _, _))
   391       }
   392     }
   393 
   394     val graph0 =
   395       (Graph.string[Info] /: infos) {
   396         case (graph, (name, info)) =>
   397           if (graph.defined(name))
   398             error("Duplicate session " + quote(name) + Position.here(info.pos) +
   399               Position.here(graph.get_node(name).pos))
   400           else graph.new_node(name, info)
   401       }
   402     val graph1 = add_edges(graph0, "parent", _.parent)
   403     val graph2 = add_edges(graph1, "imports", _.imports)
   404 
   405     new T(graph1, graph2)
   406   }
   407 
   408   final class T private[Sessions](
   409       val build_graph: Graph[String, Info],
   410       val imports_graph: Graph[String, Info])
   411   {
   412     def apply(name: String): Info = imports_graph.get_node(name)
   413     def get(name: String): Option[Info] =
   414       if (imports_graph.defined(name)) Some(imports_graph.get_node(name)) else None
   415 
   416     def global_theories: Map[String, String] =
   417       (Thy_Header.bootstrap_global_theories.toMap /:
   418         (for {
   419           (session_name, (info, _)) <- imports_graph.iterator
   420           thy <- info.global_theories.iterator } yield (thy, session_name, info)))({
   421             case (global, (thy, session_name, info)) =>
   422               val qualifier = info.theory_qualifier(session_name)
   423               global.get(thy) match {
   424                 case Some(qualifier1) if qualifier != qualifier1 =>
   425                   error("Duplicate global theory " + quote(thy) + Position.here(info.pos))
   426                 case _ => global + (thy -> qualifier)
   427               }
   428           })
   429 
   430     def selection(select: Selection): (List[String], T) =
   431     {
   432       val (_, build_graph1) = select(build_graph)
   433       val (selected, imports_graph1) = select(imports_graph)
   434       (selected, new T(build_graph1, imports_graph1))
   435     }
   436 
   437     def build_ancestors(name: String): List[String] =
   438       build_graph.all_preds(List(name)).tail.reverse
   439 
   440     def build_descendants(names: List[String]): List[String] =
   441       build_graph.all_succs(names)
   442 
   443     def build_topological_order: List[(String, Info)] =
   444       build_graph.topological_order.map(name => (name, apply(name)))
   445 
   446     def imports_topological_order: List[(String, Info)] =
   447       imports_graph.topological_order.map(name => (name, apply(name)))
   448 
   449     override def toString: String =
   450       imports_graph.keys_iterator.mkString("Sessions.T(", ", ", ")")
   451   }
   452 
   453 
   454   /* parser */
   455 
   456   val ROOT = Path.explode("ROOT")
   457   val ROOTS = Path.explode("ROOTS")
   458 
   459   private val CHAPTER = "chapter"
   460   private val SESSION = "session"
   461   private val IN = "in"
   462   private val DESCRIPTION = "description"
   463   private val OPTIONS = "options"
   464   private val SESSIONS = "sessions"
   465   private val THEORIES = "theories"
   466   private val GLOBAL = "global"
   467   private val FILES = "files"
   468   private val DOCUMENT_FILES = "document_files"
   469 
   470   lazy val root_syntax =
   471     Outer_Syntax.init() + "(" + ")" + "+" + "," + "=" + "[" + "]" + GLOBAL + IN +
   472       (CHAPTER, Keyword.THY_DECL) +
   473       (SESSION, Keyword.THY_DECL) +
   474       (DESCRIPTION, Keyword.QUASI_COMMAND) +
   475       (OPTIONS, Keyword.QUASI_COMMAND) +
   476       (SESSIONS, Keyword.QUASI_COMMAND) +
   477       (THEORIES, Keyword.QUASI_COMMAND) +
   478       (FILES, Keyword.QUASI_COMMAND) +
   479       (DOCUMENT_FILES, Keyword.QUASI_COMMAND)
   480 
   481   private object Parser extends Parse.Parser with Options.Parser
   482   {
   483     private abstract class Entry
   484     private sealed case class Chapter(name: String) extends Entry
   485     private sealed case class Session_Entry(
   486       pos: Position.T,
   487       name: String,
   488       groups: List[String],
   489       path: String,
   490       parent: Option[String],
   491       description: String,
   492       options: List[Options.Spec],
   493       imports: List[String],
   494       theories: List[(List[Options.Spec], List[((String, Position.T), Boolean)])],
   495       files: List[String],
   496       document_files: List[(String, String)]) extends Entry
   497 
   498     private val chapter: Parser[Chapter] =
   499     {
   500       val chapter_name = atom("chapter name", _.is_name)
   501 
   502       command(CHAPTER) ~! chapter_name ^^ { case _ ~ a => Chapter(a) }
   503     }
   504 
   505     private val session_entry: Parser[Session_Entry] =
   506     {
   507       val session_name = atom("session name", _.is_name)
   508 
   509       val option =
   510         option_name ~ opt($$$("=") ~! option_value ^^
   511           { case _ ~ x => x }) ^^ { case x ~ y => (x, y) }
   512       val options = $$$("[") ~> rep1sep(option, $$$(",")) <~ $$$("]")
   513 
   514       val global =
   515         ($$$("(") ~! $$$(GLOBAL) ~ $$$(")")) ^^ { case _ => true } | success(false)
   516 
   517       val theory_entry =
   518         position(theory_name) ~ global ^^ { case x ~ y => (x, y) }
   519 
   520       val theories =
   521         $$$(THEORIES) ~!
   522           ((options | success(Nil)) ~ rep(theory_entry)) ^^
   523           { case _ ~ (x ~ y) => (x, y) }
   524 
   525       val document_files =
   526         $$$(DOCUMENT_FILES) ~!
   527           (($$$("(") ~! ($$$(IN) ~! (path ~ $$$(")"))) ^^
   528               { case _ ~ (_ ~ (x ~ _)) => x } | success("document")) ~
   529             rep1(path)) ^^ { case _ ~ (x ~ y) => y.map((x, _)) }
   530 
   531       command(SESSION) ~!
   532         (position(session_name) ~
   533           (($$$("(") ~! (rep1(name) <~ $$$(")")) ^^ { case _ ~ x => x }) | success(Nil)) ~
   534           (($$$(IN) ~! path ^^ { case _ ~ x => x }) | success(".")) ~
   535           ($$$("=") ~!
   536             (opt(session_name ~! $$$("+") ^^ { case x ~ _ => x }) ~
   537               (($$$(DESCRIPTION) ~! text ^^ { case _ ~ x => x }) | success("")) ~
   538               (($$$(OPTIONS) ~! options ^^ { case _ ~ x => x }) | success(Nil)) ~
   539               (($$$(SESSIONS) ~! rep(session_name)  ^^ { case _ ~ x => x }) | success(Nil)) ~
   540               rep1(theories) ~
   541               (($$$(FILES) ~! rep1(path) ^^ { case _ ~ x => x }) | success(Nil)) ~
   542               (rep(document_files) ^^ (x => x.flatten))))) ^^
   543         { case _ ~ ((a, pos) ~ b ~ c ~ (_ ~ (d ~ e ~ f ~ g ~ h ~ i ~ j))) =>
   544             Session_Entry(pos, a, b, c, d, e, f, g, h, i, j) }
   545     }
   546 
   547     def parse(options: Options, select: Boolean, dir: Path): List[(String, Info)] =
   548     {
   549       def make_info(entry_chapter: String, entry: Session_Entry): (String, Info) =
   550       {
   551         try {
   552           val name = entry.name
   553 
   554           if (name == "" || name == DRAFT) error("Bad session name")
   555           if (is_pure(name) && entry.parent.isDefined) error("Illegal parent session")
   556           if (!is_pure(name) && !entry.parent.isDefined) error("Missing parent session")
   557 
   558           val session_options = options ++ entry.options
   559 
   560           val theories =
   561             entry.theories.map({ case (opts, thys) => (session_options ++ opts, thys.map(_._1)) })
   562 
   563           val global_theories =
   564             for { (_, thys) <- entry.theories; ((thy, pos), global) <- thys if global }
   565             yield {
   566               val thy_name = Path.explode(thy).expand.base.implode
   567               if (Long_Name.is_qualified(thy_name))
   568                 error("Bad qualified name for global theory " +
   569                   quote(thy_name) + Position.here(pos))
   570               else thy_name
   571             }
   572 
   573           val files = entry.files.map(Path.explode(_))
   574           val document_files =
   575             entry.document_files.map({ case (s1, s2) => (Path.explode(s1), Path.explode(s2)) })
   576 
   577           val meta_digest =
   578             SHA1.digest((entry_chapter, name, entry.parent, entry.options,
   579               entry.imports, entry.theories, entry.files, entry.document_files).toString)
   580 
   581           val info =
   582             Info(entry_chapter, select, entry.pos, entry.groups, dir + Path.explode(entry.path),
   583               entry.parent, entry.description, session_options, entry.imports, theories,
   584               global_theories, files, document_files, meta_digest)
   585 
   586           (name, info)
   587         }
   588         catch {
   589           case ERROR(msg) =>
   590             error(msg + "\nThe error(s) above occurred in session entry " +
   591               quote(entry.name) + Position.here(entry.pos))
   592         }
   593       }
   594 
   595       val root = dir + ROOT
   596       if (root.is_file) {
   597         val toks = Token.explode(root_syntax.keywords, File.read(root))
   598         val start = Token.Pos.file(root.implode)
   599 
   600         parse_all(rep(chapter | session_entry), Token.reader(toks, start)) match {
   601           case Success(result, _) =>
   602             var entry_chapter = "Unsorted"
   603             val infos = new mutable.ListBuffer[(String, Info)]
   604             result.foreach {
   605               case Chapter(name) => entry_chapter = name
   606               case entry: Session_Entry => infos += make_info(entry_chapter, entry)
   607             }
   608             infos.toList
   609           case bad => error(bad.toString)
   610         }
   611       }
   612       else Nil
   613     }
   614   }
   615 
   616 
   617   /* load sessions from certain directories */
   618 
   619   private def is_session_dir(dir: Path): Boolean =
   620     (dir + ROOT).is_file || (dir + ROOTS).is_file
   621 
   622   private def check_session_dir(dir: Path): Path =
   623     if (is_session_dir(dir)) File.pwd() + dir.expand
   624     else error("Bad session root directory: " + dir.toString)
   625 
   626   def load(options: Options, dirs: List[Path] = Nil, select_dirs: List[Path] = Nil): T =
   627   {
   628     def load_dir(select: Boolean, dir: Path): List[(String, Info)] =
   629       load_root(select, dir) ::: load_roots(select, dir)
   630 
   631     def load_root(select: Boolean, dir: Path): List[(String, Info)] =
   632       Parser.parse(options, select, dir)
   633 
   634     def load_roots(select: Boolean, dir: Path): List[(String, Info)] =
   635     {
   636       val roots = dir + ROOTS
   637       if (roots.is_file) {
   638         for {
   639           line <- split_lines(File.read(roots))
   640           if !(line == "" || line.startsWith("#"))
   641           dir1 =
   642             try { check_session_dir(dir + Path.explode(line)) }
   643             catch {
   644               case ERROR(msg) =>
   645                 error(msg + "\nThe error(s) above occurred in session catalog " + roots.toString)
   646             }
   647           info <- load_dir(select, dir1)
   648         } yield info
   649       }
   650       else Nil
   651     }
   652 
   653     val default_dirs = Isabelle_System.components().filter(is_session_dir(_))
   654 
   655     make(
   656       for {
   657         (select, dir) <- (default_dirs ::: dirs).map((false, _)) ::: select_dirs.map((true, _))
   658         info <- load_dir(select, check_session_dir(dir))
   659       } yield info)
   660   }
   661 
   662 
   663 
   664   /** heap file with SHA1 digest **/
   665 
   666   private val sha1_prefix = "SHA1:"
   667 
   668   def read_heap_digest(heap: Path): Option[String] =
   669   {
   670     if (heap.is_file) {
   671       val file = FileChannel.open(heap.file.toPath, StandardOpenOption.READ)
   672       try {
   673         val len = file.size
   674         val n = sha1_prefix.length + SHA1.digest_length
   675         if (len >= n) {
   676           file.position(len - n)
   677 
   678           val buf = ByteBuffer.allocate(n)
   679           var i = 0
   680           var m = 0
   681           do {
   682             m = file.read(buf)
   683             if (m != -1) i += m
   684           }
   685           while (m != -1 && n > i)
   686 
   687           if (i == n) {
   688             val prefix = new String(buf.array(), 0, sha1_prefix.length, UTF8.charset)
   689             val s = new String(buf.array(), sha1_prefix.length, SHA1.digest_length, UTF8.charset)
   690             if (prefix == sha1_prefix) Some(s) else None
   691           }
   692           else None
   693         }
   694         else None
   695       }
   696       finally { file.close }
   697     }
   698     else None
   699   }
   700 
   701   def write_heap_digest(heap: Path): String =
   702     read_heap_digest(heap) match {
   703       case None =>
   704         val s = SHA1.digest(heap).rep
   705         File.append(heap, sha1_prefix + s)
   706         s
   707       case Some(s) => s
   708     }
   709 
   710 
   711 
   712   /** persistent store **/
   713 
   714   object Session_Info
   715   {
   716     val session_name = SQL.Column.string("session_name", primary_key = true)
   717 
   718     // Build_Log.Session_Info
   719     val session_timing = SQL.Column.bytes("session_timing")
   720     val command_timings = SQL.Column.bytes("command_timings")
   721     val ml_statistics = SQL.Column.bytes("ml_statistics")
   722     val task_statistics = SQL.Column.bytes("task_statistics")
   723     val build_log_columns =
   724       List(session_name, session_timing, command_timings, ml_statistics, task_statistics)
   725 
   726     // Build.Session_Info
   727     val sources = SQL.Column.string("sources")
   728     val input_heaps = SQL.Column.string("input_heaps")
   729     val output_heap = SQL.Column.string("output_heap")
   730     val return_code = SQL.Column.int("return_code")
   731     val build_columns = List(sources, input_heaps, output_heap, return_code)
   732 
   733     val table = SQL.Table("isabelle_session_info", build_log_columns ::: build_columns)
   734 
   735     def where_session_name(name: String): String =
   736       "WHERE " + session_name.sql_name + " = " + SQL.quote_string(name)
   737 
   738     def select_statement(db: SQL.Database, name: String, columns: List[SQL.Column])
   739         : PreparedStatement =
   740       db.select_statement(table, columns, where_session_name(name))
   741 
   742     def delete_statement(db: SQL.Database, name: String): PreparedStatement =
   743       db.delete_statement(table, where_session_name(name))
   744   }
   745 
   746   def store(system_mode: Boolean = false): Store = new Store(system_mode)
   747 
   748   class Store private[Sessions](system_mode: Boolean)
   749   {
   750     /* file names */
   751 
   752     def database(name: String): Path = Path.basic("log") + Path.basic(name).ext("db")
   753     def log(name: String): Path = Path.basic("log") + Path.basic(name)
   754     def log_gz(name: String): Path = log(name).ext("gz")
   755 
   756 
   757     /* SQL database content */
   758 
   759     val xml_cache: XML.Cache = new XML.Cache()
   760 
   761     def encode_properties(ps: Properties.T): Bytes =
   762       Bytes(YXML.string_of_body(XML.Encode.properties(ps)))
   763 
   764     def decode_properties(bs: Bytes): Properties.T =
   765       xml_cache.props(XML.Decode.properties(YXML.parse_body(bs.text)))
   766 
   767     def compress_properties(ps: List[Properties.T], options: XZ.Options = XZ.options()): Bytes =
   768     {
   769       if (ps.isEmpty) Bytes.empty
   770       else Bytes(YXML.string_of_body(XML.Encode.list(XML.Encode.properties)(ps))).compress(options)
   771     }
   772 
   773     def uncompress_properties(bs: Bytes): List[Properties.T] =
   774     {
   775       if (bs.isEmpty) Nil
   776       else
   777         XML.Decode.list(XML.Decode.properties)(YXML.parse_body(bs.uncompress().text)).
   778           map(xml_cache.props(_))
   779     }
   780 
   781     def read_bytes(db: SQL.Database, name: String, column: SQL.Column): Bytes =
   782       using(Session_Info.select_statement(db, name, List(column)))(stmt =>
   783       {
   784         val rs = stmt.executeQuery
   785         if (!rs.next) Bytes.empty else db.bytes(rs, column)
   786       })
   787 
   788     def read_properties(db: SQL.Database, name: String, column: SQL.Column): List[Properties.T] =
   789       uncompress_properties(read_bytes(db, name, column))
   790 
   791 
   792     /* output */
   793 
   794     val browser_info: Path =
   795       if (system_mode) Path.explode("~~/browser_info")
   796       else Path.explode("$ISABELLE_BROWSER_INFO")
   797 
   798     val output_dir: Path =
   799       if (system_mode) Path.explode("~~/heaps/$ML_IDENTIFIER")
   800       else Path.explode("$ISABELLE_OUTPUT")
   801 
   802     override def toString: String = "Store(output_dir = " + output_dir.expand + ")"
   803 
   804     def prepare_output() { Isabelle_System.mkdirs(output_dir + Path.basic("log")) }
   805 
   806 
   807     /* input */
   808 
   809     private val input_dirs =
   810       if (system_mode) List(output_dir)
   811       else {
   812         val ml_ident = Path.explode("$ML_IDENTIFIER").expand
   813         output_dir :: Path.split(Isabelle_System.getenv_strict("ISABELLE_PATH")).map(_ + ml_ident)
   814       }
   815 
   816     def find_database_heap(name: String): Option[(Path, Option[String])] =
   817       input_dirs.find(dir => (dir + database(name)).is_file).map(dir =>
   818         (dir + database(name), read_heap_digest(dir + Path.basic(name))))
   819 
   820     def find_database(name: String): Option[Path] =
   821       input_dirs.map(_ + database(name)).find(_.is_file)
   822 
   823     def heap(name: String): Path =
   824       input_dirs.map(_ + Path.basic(name)).find(_.is_file) getOrElse
   825         error("Unknown logic " + quote(name) + " -- no heap file found in:\n" +
   826           cat_lines(input_dirs.map(dir => "  " + dir.expand.implode)))
   827 
   828 
   829     /* session info */
   830 
   831     def write_session_info(
   832       db: SQL.Database,
   833       name: String,
   834       build_log: Build_Log.Session_Info,
   835       build: Build.Session_Info)
   836     {
   837       db.transaction {
   838         db.create_table(Session_Info.table)
   839         using(Session_Info.delete_statement(db, name))(_.execute)
   840         using(db.insert_statement(Session_Info.table))(stmt =>
   841         {
   842           db.set_string(stmt, 1, name)
   843           db.set_bytes(stmt, 2, encode_properties(build_log.session_timing))
   844           db.set_bytes(stmt, 3, compress_properties(build_log.command_timings))
   845           db.set_bytes(stmt, 4, compress_properties(build_log.ml_statistics))
   846           db.set_bytes(stmt, 5, compress_properties(build_log.task_statistics))
   847           db.set_string(stmt, 6, cat_lines(build.sources))
   848           db.set_string(stmt, 7, cat_lines(build.input_heaps))
   849           db.set_string(stmt, 8, build.output_heap getOrElse "")
   850           db.set_int(stmt, 9, build.return_code)
   851           stmt.execute()
   852         })
   853       }
   854     }
   855 
   856     def read_session_timing(db: SQL.Database, name: String): Properties.T =
   857       decode_properties(read_bytes(db, name, Session_Info.session_timing))
   858 
   859     def read_command_timings(db: SQL.Database, name: String): List[Properties.T] =
   860       read_properties(db, name, Session_Info.command_timings)
   861 
   862     def read_ml_statistics(db: SQL.Database, name: String): List[Properties.T] =
   863       read_properties(db, name, Session_Info.ml_statistics)
   864 
   865     def read_task_statistics(db: SQL.Database, name: String): List[Properties.T] =
   866       read_properties(db, name, Session_Info.task_statistics)
   867 
   868     def read_build_log(db: SQL.Database, name: String,
   869       command_timings: Boolean = false,
   870       ml_statistics: Boolean = false,
   871       task_statistics: Boolean = false): Build_Log.Session_Info =
   872     {
   873       Build_Log.Session_Info(
   874         session_timing = read_session_timing(db, name),
   875         command_timings = if (command_timings) read_command_timings(db, name) else Nil,
   876         ml_statistics = if (ml_statistics) read_ml_statistics(db, name) else Nil,
   877         task_statistics = if (task_statistics) read_task_statistics(db, name) else Nil)
   878     }
   879 
   880     def read_build(db: SQL.Database, name: String): Option[Build.Session_Info] =
   881       using(Session_Info.select_statement(db, name, Session_Info.build_columns))(stmt =>
   882       {
   883         val rs = stmt.executeQuery
   884         if (!rs.next) None
   885         else {
   886           Some(
   887             Build.Session_Info(
   888               split_lines(db.string(rs, Session_Info.sources)),
   889               split_lines(db.string(rs, Session_Info.input_heaps)),
   890               db.string(rs, Session_Info.output_heap) match { case "" => None case s => Some(s) },
   891               db.int(rs, Session_Info.return_code)))
   892         }
   893       })
   894   }
   895 }