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