src/Pure/Thy/sessions.scala
author wenzelm
Thu Apr 20 15:00:32 2017 +0200 (2017-04-20)
changeset 65524 0910f1733909
parent 65520 f47bc12b6e8a
child 65525 360063716c71
permissions -rw-r--r--
tuned signature;
     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     def get_file(file: JFile): Option[Document.Node.Name] =
    86       files.getOrElse(file.getCanonicalFile, Nil).headOption
    87   }
    88 
    89   object Base
    90   {
    91     def pure(options: Options): Base = session_base(options, Thy_Header.PURE)
    92 
    93     def bootstrap(global_theories: Map[String, String]): Base =
    94       Base(
    95         global_theories = global_theories,
    96         keywords = Thy_Header.bootstrap_header,
    97         syntax = Thy_Header.bootstrap_syntax)
    98   }
    99 
   100   sealed case class Base(
   101     global_theories: Map[String, String] = Map.empty,
   102     loaded_theories: Map[String, String] = Map.empty,
   103     known: Known = Known.empty,
   104     keywords: Thy_Header.Keywords = Nil,
   105     syntax: Outer_Syntax = Outer_Syntax.empty,
   106     sources: List[(Path, SHA1.Digest)] = Nil,
   107     session_graph: Graph_Display.Graph = Graph_Display.empty_graph)
   108   {
   109     def platform_path: Base = copy(known = known.platform_path)
   110 
   111     def loaded_theory(name: Document.Node.Name): Boolean =
   112       loaded_theories.isDefinedAt(name.theory)
   113 
   114     def known_theory(name: String): Option[Document.Node.Name] =
   115       known.theories.get(name)
   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, 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, default_qualifier = info.theory_qualifier)
   154 
   155             if (verbose || list_files) {
   156               val groups =
   157                 if (info.groups.isEmpty) ""
   158                 else info.groups.mkString(" (", " ", ")")
   159               progress.echo("Session " + info.chapter + "/" + info.name + groups)
   160             }
   161 
   162             val thy_deps =
   163             {
   164               val root_theories =
   165                 info.theories.flatMap({ case (_, thys) =>
   166                   thys.map({ case (thy, pos) =>
   167                     (resources.import_name(info.name, info.dir.implode, thy), pos) })
   168                 })
   169               val thy_deps = resources.thy_info.dependencies(root_theories)
   170 
   171               thy_deps.errors match {
   172                 case Nil => thy_deps
   173                 case errs => error(cat_lines(errs))
   174               }
   175             }
   176 
   177             val syntax = thy_deps.syntax
   178 
   179             val theory_files = thy_deps.deps.map(dep => Path.explode(dep.name.node))
   180             val loaded_files =
   181               if (inlined_files) {
   182                 val pure_files =
   183                   if (is_pure(info.name)) {
   184                     val roots = Thy_Header.ml_roots.map(p => info.dir + Path.explode(p._1))
   185                     val files =
   186                       roots.flatMap(root => resources.loaded_files(syntax, File.read(root))).
   187                         map(file => info.dir + Path.explode(file))
   188                     roots ::: files
   189                   }
   190                   else Nil
   191                 pure_files ::: thy_deps.loaded_files
   192               }
   193               else Nil
   194 
   195             val all_files =
   196               (theory_files ::: loaded_files :::
   197                 info.files.map(file => info.dir + file) :::
   198                 info.document_files.map(file => info.dir + file._1 + file._2)).map(_.expand)
   199 
   200             if (list_files)
   201               progress.echo(cat_lines(all_files.map(_.implode).sorted.map("  " + _)))
   202 
   203             if (check_keywords.nonEmpty)
   204               Check_Keywords.check_keywords(progress, syntax.keywords, check_keywords, theory_files)
   205 
   206             val session_graph: Graph_Display.Graph =
   207             {
   208               def session_node(name: String): Graph_Display.Node =
   209                 Graph_Display.Node("[" + name + "]", "session." + name)
   210 
   211               def node(name: Document.Node.Name): Graph_Display.Node =
   212               {
   213                 val session = resources.theory_qualifier(name)
   214                 if (session == info.name)
   215                   Graph_Display.Node(name.theory_base_name, "theory." + name.theory)
   216                 else session_node(session)
   217               }
   218 
   219               val imports_subgraph =
   220                 sessions.imports_graph.restrict(
   221                   sessions.imports_graph.all_preds(info.parent.toList ::: info.imports).toSet)
   222 
   223               val graph0 =
   224                 (Graph_Display.empty_graph /: imports_subgraph.topological_order)(
   225                   { case (g, session) =>
   226                       val a = session_node(session)
   227                       val bs = imports_subgraph.imm_preds(session).toList.map(session_node(_))
   228                       ((g /: (a :: bs))(_.default_node(_, Nil)) /: bs)(_.add_edge(_, a)) })
   229 
   230               (graph0 /: thy_deps.deps)(
   231                 { case (g, dep) =>
   232                     val a = node(dep.name)
   233                     val bs =
   234                       dep.header.imports.map({ case (name, _) => node(name) }).
   235                         filterNot(_ == a)
   236                     ((g /: (a :: bs))(_.default_node(_, Nil)) /: bs)(_.add_edge(_, a)) })
   237             }
   238 
   239             val base =
   240               Base(global_theories = global_theories,
   241                 loaded_theories = thy_deps.loaded_theories,
   242                 known = Known.make(info.dir, List(imports_base), thy_deps.deps.map(_.name)),
   243                 keywords = thy_deps.keywords,
   244                 syntax = syntax,
   245                 sources = all_files.map(p => (p, SHA1.digest(p.file))),
   246                 session_graph = session_graph)
   247 
   248             session_bases + (info.name -> base)
   249           }
   250           catch {
   251             case ERROR(msg) =>
   252               cat_error(msg, "The error(s) above occurred in session " +
   253                 quote(info.name) + Position.here(info.pos))
   254           }
   255       })
   256 
   257     Deps(session_bases,
   258       if (all_known) Known.make(Path.current, session_bases.toList.map(_._2), Nil)
   259       else Known.empty)
   260   }
   261 
   262   def session_base(
   263     options: Options,
   264     session: String,
   265     dirs: List[Path] = Nil,
   266     all_known: Boolean = false): Base =
   267   {
   268     val full_sessions = load(options, dirs = dirs)
   269     val global_theories = full_sessions.global_theories
   270     val selected_sessions = full_sessions.selection(Selection(sessions = List(session)))._2
   271 
   272     if (all_known) {
   273       val deps = Sessions.deps(
   274         full_sessions, global_theories = global_theories, all_known = all_known)
   275       deps(session).copy(known = deps.all_known)
   276     }
   277     else
   278       deps(selected_sessions, global_theories = global_theories)(session)
   279   }
   280 
   281 
   282   /* cumulative session info */
   283 
   284   sealed case class Info(
   285     name: String,
   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: String =
   304       options.string("theory_qualifier") match {
   305         case "" => name
   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           (_, (info, _)) <- imports_graph.iterator
   420           thy <- info.global_theories.iterator }
   421          yield (thy, info)))({
   422             case (global, (thy, info)) =>
   423               val qualifier = info.theory_qualifier
   424               global.get(thy) match {
   425                 case Some(qualifier1) if qualifier != qualifier1 =>
   426                   error("Duplicate global theory " + quote(thy) + Position.here(info.pos))
   427                 case _ => global + (thy -> qualifier)
   428               }
   429           })
   430 
   431     def selection(select: Selection): (List[String], T) =
   432     {
   433       val (_, build_graph1) = select(build_graph)
   434       val (selected, imports_graph1) = select(imports_graph)
   435       (selected, new T(build_graph1, imports_graph1))
   436     }
   437 
   438     def build_ancestors(name: String): List[String] =
   439       build_graph.all_preds(List(name)).tail.reverse
   440 
   441     def build_descendants(names: List[String]): List[String] =
   442       build_graph.all_succs(names)
   443 
   444     def build_topological_order: List[Info] =
   445       build_graph.topological_order.map(apply(_))
   446 
   447     def imports_topological_order: List[Info] =
   448       imports_graph.topological_order.map(apply(_))
   449 
   450     override def toString: String =
   451       imports_graph.keys_iterator.mkString("Sessions.T(", ", ", ")")
   452   }
   453 
   454 
   455   /* parser */
   456 
   457   val ROOT = Path.explode("ROOT")
   458   val ROOTS = Path.explode("ROOTS")
   459 
   460   private val CHAPTER = "chapter"
   461   private val SESSION = "session"
   462   private val IN = "in"
   463   private val DESCRIPTION = "description"
   464   private val OPTIONS = "options"
   465   private val SESSIONS = "sessions"
   466   private val THEORIES = "theories"
   467   private val GLOBAL = "global"
   468   private val FILES = "files"
   469   private val DOCUMENT_FILES = "document_files"
   470 
   471   lazy val root_syntax =
   472     Outer_Syntax.init() + "(" + ")" + "+" + "," + "=" + "[" + "]" + GLOBAL + IN +
   473       (CHAPTER, Keyword.THY_DECL) +
   474       (SESSION, Keyword.THY_DECL) +
   475       (DESCRIPTION, Keyword.QUASI_COMMAND) +
   476       (OPTIONS, Keyword.QUASI_COMMAND) +
   477       (SESSIONS, Keyword.QUASI_COMMAND) +
   478       (THEORIES, Keyword.QUASI_COMMAND) +
   479       (FILES, Keyword.QUASI_COMMAND) +
   480       (DOCUMENT_FILES, Keyword.QUASI_COMMAND)
   481 
   482   private object Parser extends Parse.Parser with Options.Parser
   483   {
   484     private abstract class Entry
   485     private sealed case class Chapter(name: String) extends Entry
   486     private sealed case class Session_Entry(
   487       pos: Position.T,
   488       name: String,
   489       groups: List[String],
   490       path: String,
   491       parent: Option[String],
   492       description: String,
   493       options: List[Options.Spec],
   494       imports: List[String],
   495       theories: List[(List[Options.Spec], List[((String, Position.T), Boolean)])],
   496       files: List[String],
   497       document_files: List[(String, String)]) extends Entry
   498 
   499     private val chapter: Parser[Chapter] =
   500     {
   501       val chapter_name = atom("chapter name", _.is_name)
   502 
   503       command(CHAPTER) ~! chapter_name ^^ { case _ ~ a => Chapter(a) }
   504     }
   505 
   506     private val session_entry: Parser[Session_Entry] =
   507     {
   508       val session_name = atom("session name", _.is_name)
   509 
   510       val option =
   511         option_name ~ opt($$$("=") ~! option_value ^^
   512           { case _ ~ x => x }) ^^ { case x ~ y => (x, y) }
   513       val options = $$$("[") ~> rep1sep(option, $$$(",")) <~ $$$("]")
   514 
   515       val global =
   516         ($$$("(") ~! $$$(GLOBAL) ~ $$$(")")) ^^ { case _ => true } | success(false)
   517 
   518       val theory_entry =
   519         position(theory_name) ~ global ^^ { case x ~ y => (x, y) }
   520 
   521       val theories =
   522         $$$(THEORIES) ~!
   523           ((options | success(Nil)) ~ rep(theory_entry)) ^^
   524           { case _ ~ (x ~ y) => (x, y) }
   525 
   526       val document_files =
   527         $$$(DOCUMENT_FILES) ~!
   528           (($$$("(") ~! ($$$(IN) ~! (path ~ $$$(")"))) ^^
   529               { case _ ~ (_ ~ (x ~ _)) => x } | success("document")) ~
   530             rep1(path)) ^^ { case _ ~ (x ~ y) => y.map((x, _)) }
   531 
   532       command(SESSION) ~!
   533         (position(session_name) ~
   534           (($$$("(") ~! (rep1(name) <~ $$$(")")) ^^ { case _ ~ x => x }) | success(Nil)) ~
   535           (($$$(IN) ~! path ^^ { case _ ~ x => x }) | success(".")) ~
   536           ($$$("=") ~!
   537             (opt(session_name ~! $$$("+") ^^ { case x ~ _ => x }) ~
   538               (($$$(DESCRIPTION) ~! text ^^ { case _ ~ x => x }) | success("")) ~
   539               (($$$(OPTIONS) ~! options ^^ { case _ ~ x => x }) | success(Nil)) ~
   540               (($$$(SESSIONS) ~! rep(session_name)  ^^ { case _ ~ x => x }) | success(Nil)) ~
   541               rep1(theories) ~
   542               (($$$(FILES) ~! rep1(path) ^^ { case _ ~ x => x }) | success(Nil)) ~
   543               (rep(document_files) ^^ (x => x.flatten))))) ^^
   544         { case _ ~ ((a, pos) ~ b ~ c ~ (_ ~ (d ~ e ~ f ~ g ~ h ~ i ~ j))) =>
   545             Session_Entry(pos, a, b, c, d, e, f, g, h, i, j) }
   546     }
   547 
   548     def parse(options: Options, select: Boolean, dir: Path): List[(String, Info)] =
   549     {
   550       def make_info(entry_chapter: String, entry: Session_Entry): (String, Info) =
   551       {
   552         try {
   553           val name = entry.name
   554 
   555           if (name == "" || name == DRAFT) error("Bad session name")
   556           if (is_pure(name) && entry.parent.isDefined) error("Illegal parent session")
   557           if (!is_pure(name) && !entry.parent.isDefined) error("Missing parent session")
   558 
   559           val session_options = options ++ entry.options
   560 
   561           val theories =
   562             entry.theories.map({ case (opts, thys) => (session_options ++ opts, thys.map(_._1)) })
   563 
   564           val global_theories =
   565             for { (_, thys) <- entry.theories; ((thy, pos), global) <- thys if global }
   566             yield {
   567               val thy_name = Path.explode(thy).expand.base.implode
   568               if (Long_Name.is_qualified(thy_name))
   569                 error("Bad qualified name for global theory " +
   570                   quote(thy_name) + Position.here(pos))
   571               else thy_name
   572             }
   573 
   574           val files = entry.files.map(Path.explode(_))
   575           val document_files =
   576             entry.document_files.map({ case (s1, s2) => (Path.explode(s1), Path.explode(s2)) })
   577 
   578           val meta_digest =
   579             SHA1.digest((entry_chapter, name, entry.parent, entry.options,
   580               entry.imports, entry.theories, entry.files, entry.document_files).toString)
   581 
   582           val info =
   583             Info(name, entry_chapter, select, entry.pos, entry.groups,
   584               dir + Path.explode(entry.path), entry.parent, entry.description, session_options,
   585               entry.imports, theories, global_theories, files, document_files, meta_digest)
   586 
   587           (name, info)
   588         }
   589         catch {
   590           case ERROR(msg) =>
   591             error(msg + "\nThe error(s) above occurred in session entry " +
   592               quote(entry.name) + Position.here(entry.pos))
   593         }
   594       }
   595 
   596       val root = dir + ROOT
   597       if (root.is_file) {
   598         val toks = Token.explode(root_syntax.keywords, File.read(root))
   599         val start = Token.Pos.file(root.implode)
   600 
   601         parse_all(rep(chapter | session_entry), Token.reader(toks, start)) match {
   602           case Success(result, _) =>
   603             var entry_chapter = "Unsorted"
   604             val infos = new mutable.ListBuffer[(String, Info)]
   605             result.foreach {
   606               case Chapter(name) => entry_chapter = name
   607               case entry: Session_Entry => infos += make_info(entry_chapter, entry)
   608             }
   609             infos.toList
   610           case bad => error(bad.toString)
   611         }
   612       }
   613       else Nil
   614     }
   615   }
   616 
   617 
   618   /* load sessions from certain directories */
   619 
   620   private def is_session_dir(dir: Path): Boolean =
   621     (dir + ROOT).is_file || (dir + ROOTS).is_file
   622 
   623   private def check_session_dir(dir: Path): Path =
   624     if (is_session_dir(dir)) File.pwd() + dir.expand
   625     else error("Bad session root directory: " + dir.toString)
   626 
   627   def load(options: Options, dirs: List[Path] = Nil, select_dirs: List[Path] = Nil): T =
   628   {
   629     def load_dir(select: Boolean, dir: Path): List[(String, Info)] =
   630       load_root(select, dir) ::: load_roots(select, dir)
   631 
   632     def load_root(select: Boolean, dir: Path): List[(String, Info)] =
   633       Parser.parse(options, select, dir)
   634 
   635     def load_roots(select: Boolean, dir: Path): List[(String, Info)] =
   636     {
   637       val roots = dir + ROOTS
   638       if (roots.is_file) {
   639         for {
   640           line <- split_lines(File.read(roots))
   641           if !(line == "" || line.startsWith("#"))
   642           dir1 =
   643             try { check_session_dir(dir + Path.explode(line)) }
   644             catch {
   645               case ERROR(msg) =>
   646                 error(msg + "\nThe error(s) above occurred in session catalog " + roots.toString)
   647             }
   648           info <- load_dir(select, dir1)
   649         } yield info
   650       }
   651       else Nil
   652     }
   653 
   654     val default_dirs = Isabelle_System.components().filter(is_session_dir(_))
   655 
   656     make(
   657       for {
   658         (select, dir) <- (default_dirs ::: dirs).map((false, _)) ::: select_dirs.map((true, _))
   659         info <- load_dir(select, check_session_dir(dir))
   660       } yield info)
   661   }
   662 
   663 
   664 
   665   /** heap file with SHA1 digest **/
   666 
   667   private val sha1_prefix = "SHA1:"
   668 
   669   def read_heap_digest(heap: Path): Option[String] =
   670   {
   671     if (heap.is_file) {
   672       val file = FileChannel.open(heap.file.toPath, StandardOpenOption.READ)
   673       try {
   674         val len = file.size
   675         val n = sha1_prefix.length + SHA1.digest_length
   676         if (len >= n) {
   677           file.position(len - n)
   678 
   679           val buf = ByteBuffer.allocate(n)
   680           var i = 0
   681           var m = 0
   682           do {
   683             m = file.read(buf)
   684             if (m != -1) i += m
   685           }
   686           while (m != -1 && n > i)
   687 
   688           if (i == n) {
   689             val prefix = new String(buf.array(), 0, sha1_prefix.length, UTF8.charset)
   690             val s = new String(buf.array(), sha1_prefix.length, SHA1.digest_length, UTF8.charset)
   691             if (prefix == sha1_prefix) Some(s) else None
   692           }
   693           else None
   694         }
   695         else None
   696       }
   697       finally { file.close }
   698     }
   699     else None
   700   }
   701 
   702   def write_heap_digest(heap: Path): String =
   703     read_heap_digest(heap) match {
   704       case None =>
   705         val s = SHA1.digest(heap).rep
   706         File.append(heap, sha1_prefix + s)
   707         s
   708       case Some(s) => s
   709     }
   710 
   711 
   712 
   713   /** persistent store **/
   714 
   715   object Session_Info
   716   {
   717     val session_name = SQL.Column.string("session_name", primary_key = true)
   718 
   719     // Build_Log.Session_Info
   720     val session_timing = SQL.Column.bytes("session_timing")
   721     val command_timings = SQL.Column.bytes("command_timings")
   722     val ml_statistics = SQL.Column.bytes("ml_statistics")
   723     val task_statistics = SQL.Column.bytes("task_statistics")
   724     val build_log_columns =
   725       List(session_name, session_timing, command_timings, ml_statistics, task_statistics)
   726 
   727     // Build.Session_Info
   728     val sources = SQL.Column.string("sources")
   729     val input_heaps = SQL.Column.string("input_heaps")
   730     val output_heap = SQL.Column.string("output_heap")
   731     val return_code = SQL.Column.int("return_code")
   732     val build_columns = List(sources, input_heaps, output_heap, return_code)
   733 
   734     val table = SQL.Table("isabelle_session_info", build_log_columns ::: build_columns)
   735 
   736     def where_session_name(name: String): String =
   737       "WHERE " + session_name.sql_name + " = " + SQL.quote_string(name)
   738 
   739     def select_statement(db: SQL.Database, name: String, columns: List[SQL.Column])
   740         : PreparedStatement =
   741       db.select_statement(table, columns, where_session_name(name))
   742 
   743     def delete_statement(db: SQL.Database, name: String): PreparedStatement =
   744       db.delete_statement(table, where_session_name(name))
   745   }
   746 
   747   def store(system_mode: Boolean = false): Store = new Store(system_mode)
   748 
   749   class Store private[Sessions](system_mode: Boolean)
   750   {
   751     /* file names */
   752 
   753     def database(name: String): Path = Path.basic("log") + Path.basic(name).ext("db")
   754     def log(name: String): Path = Path.basic("log") + Path.basic(name)
   755     def log_gz(name: String): Path = log(name).ext("gz")
   756 
   757 
   758     /* SQL database content */
   759 
   760     val xml_cache: XML.Cache = new XML.Cache()
   761 
   762     def encode_properties(ps: Properties.T): Bytes =
   763       Bytes(YXML.string_of_body(XML.Encode.properties(ps)))
   764 
   765     def decode_properties(bs: Bytes): Properties.T =
   766       xml_cache.props(XML.Decode.properties(YXML.parse_body(bs.text)))
   767 
   768     def compress_properties(ps: List[Properties.T], options: XZ.Options = XZ.options()): Bytes =
   769     {
   770       if (ps.isEmpty) Bytes.empty
   771       else Bytes(YXML.string_of_body(XML.Encode.list(XML.Encode.properties)(ps))).compress(options)
   772     }
   773 
   774     def uncompress_properties(bs: Bytes): List[Properties.T] =
   775     {
   776       if (bs.isEmpty) Nil
   777       else
   778         XML.Decode.list(XML.Decode.properties)(YXML.parse_body(bs.uncompress().text)).
   779           map(xml_cache.props(_))
   780     }
   781 
   782     def read_bytes(db: SQL.Database, name: String, column: SQL.Column): Bytes =
   783       using(Session_Info.select_statement(db, name, List(column)))(stmt =>
   784       {
   785         val rs = stmt.executeQuery
   786         if (!rs.next) Bytes.empty else db.bytes(rs, column)
   787       })
   788 
   789     def read_properties(db: SQL.Database, name: String, column: SQL.Column): List[Properties.T] =
   790       uncompress_properties(read_bytes(db, name, column))
   791 
   792 
   793     /* output */
   794 
   795     val browser_info: Path =
   796       if (system_mode) Path.explode("~~/browser_info")
   797       else Path.explode("$ISABELLE_BROWSER_INFO")
   798 
   799     val output_dir: Path =
   800       if (system_mode) Path.explode("~~/heaps/$ML_IDENTIFIER")
   801       else Path.explode("$ISABELLE_OUTPUT")
   802 
   803     override def toString: String = "Store(output_dir = " + output_dir.expand + ")"
   804 
   805     def prepare_output() { Isabelle_System.mkdirs(output_dir + Path.basic("log")) }
   806 
   807 
   808     /* input */
   809 
   810     private val input_dirs =
   811       if (system_mode) List(output_dir)
   812       else {
   813         val ml_ident = Path.explode("$ML_IDENTIFIER").expand
   814         output_dir :: Path.split(Isabelle_System.getenv_strict("ISABELLE_PATH")).map(_ + ml_ident)
   815       }
   816 
   817     def find_database_heap(name: String): Option[(Path, Option[String])] =
   818       input_dirs.find(dir => (dir + database(name)).is_file).map(dir =>
   819         (dir + database(name), read_heap_digest(dir + Path.basic(name))))
   820 
   821     def find_database(name: String): Option[Path] =
   822       input_dirs.map(_ + database(name)).find(_.is_file)
   823 
   824     def heap(name: String): Path =
   825       input_dirs.map(_ + Path.basic(name)).find(_.is_file) getOrElse
   826         error("Unknown logic " + quote(name) + " -- no heap file found in:\n" +
   827           cat_lines(input_dirs.map(dir => "  " + dir.expand.implode)))
   828 
   829 
   830     /* session info */
   831 
   832     def write_session_info(
   833       db: SQL.Database,
   834       name: String,
   835       build_log: Build_Log.Session_Info,
   836       build: Build.Session_Info)
   837     {
   838       db.transaction {
   839         db.create_table(Session_Info.table)
   840         using(Session_Info.delete_statement(db, name))(_.execute)
   841         using(db.insert_statement(Session_Info.table))(stmt =>
   842         {
   843           db.set_string(stmt, 1, name)
   844           db.set_bytes(stmt, 2, encode_properties(build_log.session_timing))
   845           db.set_bytes(stmt, 3, compress_properties(build_log.command_timings))
   846           db.set_bytes(stmt, 4, compress_properties(build_log.ml_statistics))
   847           db.set_bytes(stmt, 5, compress_properties(build_log.task_statistics))
   848           db.set_string(stmt, 6, cat_lines(build.sources))
   849           db.set_string(stmt, 7, cat_lines(build.input_heaps))
   850           db.set_string(stmt, 8, build.output_heap getOrElse "")
   851           db.set_int(stmt, 9, build.return_code)
   852           stmt.execute()
   853         })
   854       }
   855     }
   856 
   857     def read_session_timing(db: SQL.Database, name: String): Properties.T =
   858       decode_properties(read_bytes(db, name, Session_Info.session_timing))
   859 
   860     def read_command_timings(db: SQL.Database, name: String): List[Properties.T] =
   861       read_properties(db, name, Session_Info.command_timings)
   862 
   863     def read_ml_statistics(db: SQL.Database, name: String): List[Properties.T] =
   864       read_properties(db, name, Session_Info.ml_statistics)
   865 
   866     def read_task_statistics(db: SQL.Database, name: String): List[Properties.T] =
   867       read_properties(db, name, Session_Info.task_statistics)
   868 
   869     def read_build_log(db: SQL.Database, name: String,
   870       command_timings: Boolean = false,
   871       ml_statistics: Boolean = false,
   872       task_statistics: Boolean = false): Build_Log.Session_Info =
   873     {
   874       Build_Log.Session_Info(
   875         session_timing = read_session_timing(db, name),
   876         command_timings = if (command_timings) read_command_timings(db, name) else Nil,
   877         ml_statistics = if (ml_statistics) read_ml_statistics(db, name) else Nil,
   878         task_statistics = if (task_statistics) read_task_statistics(db, name) else Nil)
   879     }
   880 
   881     def read_build(db: SQL.Database, name: String): Option[Build.Session_Info] =
   882       using(Session_Info.select_statement(db, name, Session_Info.build_columns))(stmt =>
   883       {
   884         val rs = stmt.executeQuery
   885         if (!rs.next) None
   886         else {
   887           Some(
   888             Build.Session_Info(
   889               split_lines(db.string(rs, Session_Info.sources)),
   890               split_lines(db.string(rs, Session_Info.input_heaps)),
   891               db.string(rs, Session_Info.output_heap) match { case "" => None case s => Some(s) },
   892               db.int(rs, Session_Info.return_code)))
   893         }
   894       })
   895   }
   896 }