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