src/Pure/Thy/sessions.scala
author wenzelm
Mon Oct 09 21:12:22 2017 +0200 (20 months ago)
changeset 66822 4642cf4a7ebb
parent 66819 064c80e9d1cf
child 66823 f529719cc47d
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 
    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_display: 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): Outer_Syntax =
   135       nodes(name).syntax orElse loaded_theory_syntax(name) getOrElse overall_syntax
   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.name, 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.document_files.map(file => info.dir + file._1 + file._2)).map(_.expand)
   245 
   246             val imported_files = if (inlined_files) thy_deps.imported_files else Nil
   247 
   248             if (list_files)
   249               progress.echo(cat_lines(session_files.map(_.implode).sorted.map("  " + _)))
   250 
   251             if (check_keywords.nonEmpty) {
   252               Check_Keywords.check_keywords(
   253                 progress, overall_syntax.keywords, check_keywords, theory_files)
   254             }
   255 
   256             val session_graph_display: Graph_Display.Graph =
   257             {
   258               def session_node(name: String): Graph_Display.Node =
   259                 Graph_Display.Node("[" + name + "]", "session." + name)
   260 
   261               def node(name: Document.Node.Name): Graph_Display.Node =
   262               {
   263                 val qualifier = resources.theory_qualifier(name)
   264                 if (qualifier == info.name)
   265                   Graph_Display.Node(name.theory_base_name, "theory." + name.theory)
   266                 else session_node(qualifier)
   267               }
   268 
   269               val imports_subgraph =
   270                 sessions.imports_graph.restrict(
   271                   sessions.imports_graph.all_preds(info.parent.toList ::: info.imports).toSet)
   272 
   273               val graph0 =
   274                 (Graph_Display.empty_graph /: imports_subgraph.topological_order)(
   275                   { case (g, session) =>
   276                       val a = session_node(session)
   277                       val bs = imports_subgraph.imm_preds(session).toList.map(session_node(_))
   278                       ((g /: (a :: bs))(_.default_node(_, Nil)) /: bs)(_.add_edge(_, a)) })
   279 
   280               (graph0 /: thy_deps.entries)(
   281                 { case (g, entry) =>
   282                     val a = node(entry.name)
   283                     val bs =
   284                       entry.header.imports.map({ case (name, _) => node(name) }).
   285                         filterNot(_ == a)
   286                     ((g /: (a :: bs))(_.default_node(_, Nil)) /: bs)(_.add_edge(_, a)) })
   287             }
   288 
   289             val known =
   290               Known.make(info.dir, List(imports_base),
   291                 theories = thy_deps.names,
   292                 loaded_files = loaded_files)
   293 
   294             val sources_errors =
   295               for (p <- session_files if !p.is_file) yield "No such file: " + p
   296 
   297             val base =
   298               Base(
   299                 pos = info.pos,
   300                 global_theories = global_theories,
   301                 loaded_theories = thy_deps.loaded_theories,
   302                 known = known,
   303                 overall_syntax = overall_syntax,
   304                 imported_sources = check_sources(imported_files),
   305                 sources = check_sources(session_files),
   306                 session_graph_display = session_graph_display,
   307                 errors = thy_deps.errors ::: sources_errors,
   308                 imports = Some(imports_base))
   309 
   310             session_bases + (info.name -> base)
   311           }
   312           catch {
   313             case ERROR(msg) =>
   314               cat_error(msg, "The error(s) above occurred in session " +
   315                 quote(info.name) + Position.here(info.pos))
   316           }
   317       })
   318 
   319     Deps(session_bases, Known.make(Path.current, session_bases.toList.map(_._2)))
   320   }
   321 
   322   def session_base_errors(
   323     options: Options,
   324     session: String,
   325     dirs: List[Path] = Nil,
   326     inlined_files: Boolean = false,
   327     all_known: Boolean = false): (List[String], Base) =
   328   {
   329     val full_sessions = load(options, dirs = dirs)
   330     val global_theories = full_sessions.global_theories
   331     val (_, selected_sessions) = full_sessions.selection(Selection(sessions = List(session)))
   332 
   333     val sessions: T = if (all_known) full_sessions else selected_sessions
   334     val deps =
   335       Sessions.deps(sessions, inlined_files = inlined_files, global_theories = global_theories)
   336     val base = if (all_known) deps(session).copy(known = deps.all_known) else deps(session)
   337     (deps.errors, base)
   338   }
   339 
   340   def session_base(
   341     options: Options,
   342     session: String,
   343     dirs: List[Path] = Nil,
   344     inlined_files: Boolean = false,
   345     all_known: Boolean = false): Base =
   346   {
   347     val (errs, base) =
   348       session_base_errors(options, session, dirs = dirs,
   349         inlined_files = inlined_files, all_known = all_known)
   350     if (errs.isEmpty) base else error(cat_lines(errs))
   351   }
   352 
   353 
   354   /* cumulative session info */
   355 
   356   sealed case class Info(
   357     name: String,
   358     chapter: String,
   359     select: Boolean,
   360     pos: Position.T,
   361     groups: List[String],
   362     dir: Path,
   363     parent: Option[String],
   364     description: String,
   365     options: Options,
   366     imports: List[String],
   367     theories: List[(Options, List[(String, Position.T)])],
   368     global_theories: List[String],
   369     document_files: List[(Path, Path)],
   370     meta_digest: SHA1.Digest)
   371   {
   372     def timeout: Time = Time.seconds(options.real("timeout") * options.real("timeout_scale"))
   373   }
   374 
   375   object Selection
   376   {
   377     val empty: Selection = Selection()
   378     val all: Selection = Selection(all_sessions = true)
   379   }
   380 
   381   sealed case class Selection(
   382     requirements: Boolean = false,
   383     all_sessions: Boolean = false,
   384     base_sessions: List[String] = Nil,
   385     exclude_session_groups: List[String] = Nil,
   386     exclude_sessions: List[String] = Nil,
   387     session_groups: List[String] = Nil,
   388     sessions: List[String] = Nil)
   389   {
   390     def ++ (other: Selection): Selection =
   391       Selection(
   392         requirements = requirements || other.requirements,
   393         all_sessions = all_sessions || other.all_sessions,
   394         base_sessions = Library.merge(base_sessions, other.base_sessions),
   395         exclude_session_groups = Library.merge(exclude_session_groups, other.exclude_session_groups),
   396         exclude_sessions = Library.merge(exclude_sessions, other.exclude_sessions),
   397         session_groups = Library.merge(session_groups, other.session_groups),
   398         sessions = Library.merge(sessions, other.sessions))
   399 
   400     def apply(graph: Graph[String, Info]): (List[String], Graph[String, Info]) =
   401     {
   402       val bad_sessions =
   403         SortedSet((base_sessions ::: exclude_sessions ::: sessions).
   404           filterNot(graph.defined(_)): _*).toList
   405       if (bad_sessions.nonEmpty)
   406         error("Undefined session(s): " + commas_quote(bad_sessions))
   407 
   408       val excluded =
   409       {
   410         val exclude_group = exclude_session_groups.toSet
   411         val exclude_group_sessions =
   412           (for {
   413             (name, (info, _)) <- graph.iterator
   414             if graph.get_node(name).groups.exists(exclude_group)
   415           } yield name).toList
   416         graph.all_succs(exclude_group_sessions ::: exclude_sessions).toSet
   417       }
   418 
   419       val pre_selected =
   420       {
   421         if (all_sessions) graph.keys
   422         else {
   423           val select_group = session_groups.toSet
   424           val select = sessions.toSet ++ graph.all_succs(base_sessions)
   425           (for {
   426             (name, (info, _)) <- graph.iterator
   427             if info.select || select(name) || graph.get_node(name).groups.exists(select_group)
   428           } yield name).toList
   429         }
   430       }.filterNot(excluded)
   431 
   432       val selected =
   433         if (requirements) (graph.all_preds(pre_selected).toSet -- pre_selected).toList
   434         else pre_selected
   435 
   436       (selected, graph.restrict(graph.all_preds(selected).toSet))
   437     }
   438   }
   439 
   440   def make(infos: Traversable[(String, Info)]): T =
   441   {
   442     def add_edges(graph: Graph[String, Info], kind: String, edges: Info => Traversable[String])
   443       : Graph[String, Info] =
   444     {
   445       def add_edge(pos: Position.T, name: String, g: Graph[String, Info], parent: String) =
   446       {
   447         if (!g.defined(parent))
   448           error("Bad " + kind + " session " + quote(parent) + " for " +
   449             quote(name) + Position.here(pos))
   450 
   451         try { g.add_edge_acyclic(parent, name) }
   452         catch {
   453           case exn: Graph.Cycles[_] =>
   454             error(cat_lines(exn.cycles.map(cycle =>
   455               "Cyclic session dependency of " +
   456                 cycle.map(c => quote(c.toString)).mkString(" via "))) + Position.here(pos))
   457         }
   458       }
   459       (graph /: graph.iterator) {
   460         case (g, (name, (info, _))) => (g /: edges(info))(add_edge(info.pos, name, _, _))
   461       }
   462     }
   463 
   464     val graph0 =
   465       (Graph.string[Info] /: infos) {
   466         case (graph, (name, info)) =>
   467           if (graph.defined(name))
   468             error("Duplicate session " + quote(name) + Position.here(info.pos) +
   469               Position.here(graph.get_node(name).pos))
   470           else graph.new_node(name, info)
   471       }
   472     val graph1 = add_edges(graph0, "parent", _.parent)
   473     val graph2 = add_edges(graph1, "imports", _.imports)
   474 
   475     new T(graph1, graph2)
   476   }
   477 
   478   final class T private[Sessions](
   479       val build_graph: Graph[String, Info],
   480       val imports_graph: Graph[String, Info])
   481   {
   482     def apply(name: String): Info = imports_graph.get_node(name)
   483     def get(name: String): Option[Info] =
   484       if (imports_graph.defined(name)) Some(imports_graph.get_node(name)) else None
   485 
   486     def global_theories: Map[String, String] =
   487       (Thy_Header.bootstrap_global_theories.toMap /:
   488         (for {
   489           (_, (info, _)) <- imports_graph.iterator
   490           thy <- info.global_theories.iterator }
   491          yield (thy, info)))({
   492             case (global, (thy, info)) =>
   493               val qualifier = info.name
   494               global.get(thy) match {
   495                 case Some(qualifier1) if qualifier != qualifier1 =>
   496                   error("Duplicate global theory " + quote(thy) + Position.here(info.pos))
   497                 case _ => global + (thy -> qualifier)
   498               }
   499           })
   500 
   501     def selection(select: Selection): (List[String], T) =
   502     {
   503       val (_, build_graph1) = select(build_graph)
   504       val (selected, imports_graph1) = select(imports_graph)
   505       (selected, new T(build_graph1, imports_graph1))
   506     }
   507 
   508     def build_ancestors(name: String): List[String] =
   509       build_graph.all_preds(List(name)).tail.reverse
   510 
   511     def build_descendants(names: List[String]): List[String] =
   512       build_graph.all_succs(names)
   513 
   514     def build_topological_order: List[Info] =
   515       build_graph.topological_order.map(apply(_))
   516 
   517     def imports_ancestors(name: String): List[String] =
   518       imports_graph.all_preds(List(name)).tail.reverse
   519 
   520     def imports_topological_order: List[Info] =
   521       imports_graph.topological_order.map(apply(_))
   522 
   523     override def toString: String =
   524       imports_graph.keys_iterator.mkString("Sessions.T(", ", ", ")")
   525   }
   526 
   527 
   528   /* parser */
   529 
   530   val ROOT = Path.explode("ROOT")
   531   val ROOTS = Path.explode("ROOTS")
   532 
   533   private val CHAPTER = "chapter"
   534   private val SESSION = "session"
   535   private val IN = "in"
   536   private val DESCRIPTION = "description"
   537   private val OPTIONS = "options"
   538   private val SESSIONS = "sessions"
   539   private val THEORIES = "theories"
   540   private val GLOBAL = "global"
   541   private val DOCUMENT_FILES = "document_files"
   542 
   543   lazy val root_syntax =
   544     Outer_Syntax.init() + "(" + ")" + "+" + "," + "=" + "[" + "]" + GLOBAL + IN +
   545       (CHAPTER, Keyword.THY_DECL) +
   546       (SESSION, Keyword.THY_DECL) +
   547       (DESCRIPTION, Keyword.QUASI_COMMAND) +
   548       (OPTIONS, Keyword.QUASI_COMMAND) +
   549       (SESSIONS, Keyword.QUASI_COMMAND) +
   550       (THEORIES, Keyword.QUASI_COMMAND) +
   551       (DOCUMENT_FILES, Keyword.QUASI_COMMAND)
   552 
   553   abstract class Entry
   554   sealed case class Chapter(name: String) extends Entry
   555   sealed case class Session_Entry(
   556     pos: Position.T,
   557     name: String,
   558     groups: List[String],
   559     path: String,
   560     parent: Option[String],
   561     description: String,
   562     options: List[Options.Spec],
   563     imports: List[String],
   564     theories: List[(List[Options.Spec], List[((String, Position.T), Boolean)])],
   565     document_files: List[(String, String)]) extends Entry
   566   {
   567     def theories_no_position: List[(List[Options.Spec], List[(String, Boolean)])] =
   568       theories.map({ case (a, b) => (a, b.map({ case ((c, _), d) => (c, d) })) })
   569   }
   570 
   571   private object Parser extends Parse.Parser with Options.Parser
   572   {
   573     private val chapter: Parser[Chapter] =
   574     {
   575       val chapter_name = atom("chapter name", _.is_name)
   576 
   577       command(CHAPTER) ~! chapter_name ^^ { case _ ~ a => Chapter(a) }
   578     }
   579 
   580     private val session_entry: Parser[Session_Entry] =
   581     {
   582       val session_name = atom("session name", _.is_name)
   583 
   584       val option =
   585         option_name ~ opt($$$("=") ~! option_value ^^
   586           { case _ ~ x => x }) ^^ { case x ~ y => (x, y) }
   587       val options = $$$("[") ~> rep1sep(option, $$$(",")) <~ $$$("]")
   588 
   589       val global =
   590         ($$$("(") ~! $$$(GLOBAL) ~ $$$(")")) ^^ { case _ => true } | success(false)
   591 
   592       val theory_entry =
   593         position(theory_name) ~ global ^^ { case x ~ y => (x, y) }
   594 
   595       val theories =
   596         $$$(THEORIES) ~!
   597           ((options | success(Nil)) ~ rep(theory_entry)) ^^
   598           { case _ ~ (x ~ y) => (x, y) }
   599 
   600       val document_files =
   601         $$$(DOCUMENT_FILES) ~!
   602           (($$$("(") ~! ($$$(IN) ~! (path ~ $$$(")"))) ^^
   603               { case _ ~ (_ ~ (x ~ _)) => x } | success("document")) ~
   604             rep1(path)) ^^ { case _ ~ (x ~ y) => y.map((x, _)) }
   605 
   606       command(SESSION) ~!
   607         (position(session_name) ~
   608           (($$$("(") ~! (rep1(name) <~ $$$(")")) ^^ { case _ ~ x => x }) | success(Nil)) ~
   609           (($$$(IN) ~! path ^^ { case _ ~ x => x }) | success(".")) ~
   610           ($$$("=") ~!
   611             (opt(session_name ~! $$$("+") ^^ { case x ~ _ => x }) ~
   612               (($$$(DESCRIPTION) ~! text ^^ { case _ ~ x => x }) | success("")) ~
   613               (($$$(OPTIONS) ~! options ^^ { case _ ~ x => x }) | success(Nil)) ~
   614               (($$$(SESSIONS) ~! rep(session_name)  ^^ { case _ ~ x => x }) | success(Nil)) ~
   615               rep1(theories) ~
   616               (rep(document_files) ^^ (x => x.flatten))))) ^^
   617         { case _ ~ ((a, pos) ~ b ~ c ~ (_ ~ (d ~ e ~ f ~ g ~ h ~ i))) =>
   618             Session_Entry(pos, a, b, c, d, e, f, g, h, i) }
   619     }
   620 
   621     def parse_root(path: Path): List[Entry] =
   622     {
   623       val toks = Token.explode(root_syntax.keywords, File.read(path))
   624       val start = Token.Pos.file(path.implode)
   625 
   626       parse_all(rep(chapter | session_entry), Token.reader(toks, start)) match {
   627         case Success(result, _) => result
   628         case bad => error(bad.toString)
   629       }
   630     }
   631   }
   632 
   633   def parse_root(path: Path): List[Entry] = Parser.parse_root(path)
   634 
   635   def parse_root_entries(path: Path): List[Session_Entry] =
   636     for (entry <- Parser.parse_root(path) if entry.isInstanceOf[Session_Entry])
   637     yield entry.asInstanceOf[Session_Entry]
   638 
   639   def read_root(options: Options, select: Boolean, path: Path): List[(String, Info)] =
   640   {
   641     def make_info(entry_chapter: String, entry: Session_Entry): (String, Info) =
   642     {
   643       try {
   644         val name = entry.name
   645 
   646         if (name == "" || name == DRAFT) error("Bad session name")
   647         if (is_pure(name) && entry.parent.isDefined) error("Illegal parent session")
   648         if (!is_pure(name) && !entry.parent.isDefined) error("Missing parent session")
   649 
   650         val session_options = options ++ entry.options
   651 
   652         val theories =
   653           entry.theories.map({ case (opts, thys) => (session_options ++ opts, thys.map(_._1)) })
   654 
   655         val global_theories =
   656           for { (_, thys) <- entry.theories; ((thy, pos), global) <- thys if global }
   657           yield {
   658             val thy_name = Path.explode(thy).expand.base_name
   659             if (Long_Name.is_qualified(thy_name))
   660               error("Bad qualified name for global theory " +
   661                 quote(thy_name) + Position.here(pos))
   662             else thy_name
   663           }
   664 
   665         val document_files =
   666           entry.document_files.map({ case (s1, s2) => (Path.explode(s1), Path.explode(s2)) })
   667 
   668         val meta_digest =
   669           SHA1.digest((entry_chapter, name, entry.parent, entry.options, entry.imports,
   670             entry.theories_no_position, entry.document_files).toString)
   671 
   672         val info =
   673           Info(name, entry_chapter, select, entry.pos, entry.groups,
   674             path.dir + Path.explode(entry.path), entry.parent, entry.description, session_options,
   675             entry.imports, theories, global_theories, document_files, meta_digest)
   676 
   677         (name, info)
   678       }
   679       catch {
   680         case ERROR(msg) =>
   681           error(msg + "\nThe error(s) above occurred in session entry " +
   682             quote(entry.name) + Position.here(entry.pos))
   683       }
   684     }
   685 
   686     var entry_chapter = "Unsorted"
   687     val infos = new mutable.ListBuffer[(String, Info)]
   688     parse_root(path).foreach {
   689       case Chapter(name) => entry_chapter = name
   690       case entry: Session_Entry => infos += make_info(entry_chapter, entry)
   691     }
   692     infos.toList
   693   }
   694 
   695   def parse_roots(roots: Path): List[String] =
   696   {
   697     for {
   698       line <- split_lines(File.read(roots))
   699       if !(line == "" || line.startsWith("#"))
   700     } yield line
   701   }
   702 
   703 
   704   /* load sessions from certain directories */
   705 
   706   private def is_session_dir(dir: Path): Boolean =
   707     (dir + ROOT).is_file || (dir + ROOTS).is_file
   708 
   709   private def check_session_dir(dir: Path): Path =
   710     if (is_session_dir(dir)) File.pwd() + dir.expand
   711     else error("Bad session root directory: " + dir.toString)
   712 
   713   def directories(dirs: List[Path], select_dirs: List[Path]): List[(Boolean, Path)] =
   714   {
   715     val default_dirs = Isabelle_System.components().filter(is_session_dir(_))
   716     (default_dirs ::: dirs).map((false, _)) ::: select_dirs.map((true, _))
   717   }
   718 
   719   def load(options: Options, dirs: List[Path] = Nil, select_dirs: List[Path] = Nil): T =
   720   {
   721     def load_dir(select: Boolean, dir: Path): List[(Boolean, Path)] =
   722       load_root(select, dir) ::: load_roots(select, dir)
   723 
   724     def load_root(select: Boolean, dir: Path): List[(Boolean, Path)] =
   725     {
   726       val root = dir + ROOT
   727       if (root.is_file) List((select, root)) else Nil
   728     }
   729 
   730     def load_roots(select: Boolean, dir: Path): List[(Boolean, Path)] =
   731     {
   732       val roots = dir + ROOTS
   733       if (roots.is_file) {
   734         for {
   735           entry <- parse_roots(roots)
   736           dir1 =
   737             try { check_session_dir(dir + Path.explode(entry)) }
   738             catch {
   739               case ERROR(msg) =>
   740                 error(msg + "\nThe error(s) above occurred in session catalog " + roots.toString)
   741             }
   742           res <- load_dir(select, dir1)
   743         } yield res
   744       }
   745       else Nil
   746     }
   747 
   748     val roots =
   749       for {
   750         (select, dir) <- directories(dirs, select_dirs)
   751         res <- load_dir(select, check_session_dir(dir))
   752       } yield res
   753 
   754     val unique_roots =
   755       ((Map.empty[JFile, (Boolean, Path)] /: roots) { case (m, (select, path)) =>
   756         val file = path.canonical_file
   757         m.get(file) match {
   758           case None => m + (file -> (select, path))
   759           case Some((select1, path1)) => m + (file -> (select1 || select, path1))
   760         }
   761       }).toList.map(_._2)
   762 
   763     make(unique_roots.flatMap(p => read_root(options, p._1, p._2)))
   764   }
   765 
   766 
   767 
   768   /** heap file with SHA1 digest **/
   769 
   770   private val sha1_prefix = "SHA1:"
   771 
   772   def read_heap_digest(heap: Path): Option[String] =
   773   {
   774     if (heap.is_file) {
   775       val file = FileChannel.open(heap.file.toPath, StandardOpenOption.READ)
   776       try {
   777         val len = file.size
   778         val n = sha1_prefix.length + SHA1.digest_length
   779         if (len >= n) {
   780           file.position(len - n)
   781 
   782           val buf = ByteBuffer.allocate(n)
   783           var i = 0
   784           var m = 0
   785           do {
   786             m = file.read(buf)
   787             if (m != -1) i += m
   788           }
   789           while (m != -1 && n > i)
   790 
   791           if (i == n) {
   792             val prefix = new String(buf.array(), 0, sha1_prefix.length, UTF8.charset)
   793             val s = new String(buf.array(), sha1_prefix.length, SHA1.digest_length, UTF8.charset)
   794             if (prefix == sha1_prefix) Some(s) else None
   795           }
   796           else None
   797         }
   798         else None
   799       }
   800       finally { file.close }
   801     }
   802     else None
   803   }
   804 
   805   def write_heap_digest(heap: Path): String =
   806     read_heap_digest(heap) match {
   807       case None =>
   808         val s = SHA1.digest(heap).rep
   809         File.append(heap, sha1_prefix + s)
   810         s
   811       case Some(s) => s
   812     }
   813 
   814 
   815 
   816   /** persistent store **/
   817 
   818   object Session_Info
   819   {
   820     val session_name = SQL.Column.string("session_name", primary_key = true)
   821 
   822     // Build_Log.Session_Info
   823     val session_timing = SQL.Column.bytes("session_timing")
   824     val command_timings = SQL.Column.bytes("command_timings")
   825     val ml_statistics = SQL.Column.bytes("ml_statistics")
   826     val task_statistics = SQL.Column.bytes("task_statistics")
   827     val errors = SQL.Column.bytes("errors")
   828     val build_log_columns =
   829       List(session_name, session_timing, command_timings, ml_statistics, task_statistics, errors)
   830 
   831     // Build.Session_Info
   832     val sources = SQL.Column.string("sources")
   833     val input_heaps = SQL.Column.string("input_heaps")
   834     val output_heap = SQL.Column.string("output_heap")
   835     val return_code = SQL.Column.int("return_code")
   836     val build_columns = List(sources, input_heaps, output_heap, return_code)
   837 
   838     val table = SQL.Table("isabelle_session_info", build_log_columns ::: build_columns)
   839   }
   840 
   841   def store(system_mode: Boolean = false): Store = new Store(system_mode)
   842 
   843   class Store private[Sessions](system_mode: Boolean)
   844   {
   845     /* file names */
   846 
   847     def database(name: String): Path = Path.basic("log") + Path.basic(name).ext("db")
   848     def log(name: String): Path = Path.basic("log") + Path.basic(name)
   849     def log_gz(name: String): Path = log(name).ext("gz")
   850 
   851 
   852     /* SQL database content */
   853 
   854     val xml_cache = new XML.Cache()
   855 
   856     def read_bytes(db: SQL.Database, name: String, column: SQL.Column): Bytes =
   857       db.using_statement(Session_Info.table.select(List(column),
   858         Session_Info.session_name.where_equal(name)))(stmt =>
   859       {
   860         val res = stmt.execute_query()
   861         if (!res.next()) Bytes.empty else res.bytes(column)
   862       })
   863 
   864     def read_properties(db: SQL.Database, name: String, column: SQL.Column): List[Properties.T] =
   865       Properties.uncompress(read_bytes(db, name, column), Some(xml_cache))
   866 
   867 
   868     /* output */
   869 
   870     val browser_info: Path =
   871       if (system_mode) Path.explode("~~/browser_info")
   872       else Path.explode("$ISABELLE_BROWSER_INFO")
   873 
   874     val output_dir: Path =
   875       if (system_mode) Path.explode("~~/heaps/$ML_IDENTIFIER")
   876       else Path.explode("$ISABELLE_OUTPUT")
   877 
   878     override def toString: String = "Store(output_dir = " + output_dir.expand + ")"
   879 
   880     def prepare_output() { Isabelle_System.mkdirs(output_dir + Path.basic("log")) }
   881 
   882 
   883     /* input */
   884 
   885     private val input_dirs =
   886       if (system_mode) List(output_dir)
   887       else {
   888         val ml_ident = Path.explode("$ML_IDENTIFIER").expand
   889         output_dir :: Path.split(Isabelle_System.getenv_strict("ISABELLE_PATH")).map(_ + ml_ident)
   890       }
   891 
   892     def find_database_heap(name: String): Option[(Path, Option[String])] =
   893       input_dirs.find(dir => (dir + database(name)).is_file).map(dir =>
   894         (dir + database(name), read_heap_digest(dir + Path.basic(name))))
   895 
   896     def find_database(name: String): Option[Path] =
   897       input_dirs.map(_ + database(name)).find(_.is_file)
   898 
   899     def heap(name: String): Path =
   900       input_dirs.map(_ + Path.basic(name)).find(_.is_file) getOrElse
   901         error("Unknown logic " + quote(name) + " -- no heap file found in:\n" +
   902           cat_lines(input_dirs.map(dir => "  " + dir.expand.implode)))
   903 
   904 
   905     /* session info */
   906 
   907     def write_session_info(
   908       db: SQL.Database,
   909       name: String,
   910       build_log: Build_Log.Session_Info,
   911       build: Build.Session_Info)
   912     {
   913       db.transaction {
   914         db.create_table(Session_Info.table)
   915         db.using_statement(
   916           Session_Info.table.delete(Session_Info.session_name.where_equal(name)))(_.execute)
   917         db.using_statement(Session_Info.table.insert())(stmt =>
   918         {
   919           stmt.string(1) = name
   920           stmt.bytes(2) = Properties.encode(build_log.session_timing)
   921           stmt.bytes(3) = Properties.compress(build_log.command_timings)
   922           stmt.bytes(4) = Properties.compress(build_log.ml_statistics)
   923           stmt.bytes(5) = Properties.compress(build_log.task_statistics)
   924           stmt.bytes(6) = Build_Log.compress_errors(build_log.errors)
   925           stmt.string(7) = build.sources
   926           stmt.string(8) = cat_lines(build.input_heaps)
   927           stmt.string(9) = build.output_heap getOrElse ""
   928           stmt.int(10) = build.return_code
   929           stmt.execute()
   930         })
   931       }
   932     }
   933 
   934     def read_session_timing(db: SQL.Database, name: String): Properties.T =
   935       Properties.decode(read_bytes(db, name, Session_Info.session_timing), Some(xml_cache))
   936 
   937     def read_command_timings(db: SQL.Database, name: String): List[Properties.T] =
   938       read_properties(db, name, Session_Info.command_timings)
   939 
   940     def read_ml_statistics(db: SQL.Database, name: String): List[Properties.T] =
   941       read_properties(db, name, Session_Info.ml_statistics)
   942 
   943     def read_task_statistics(db: SQL.Database, name: String): List[Properties.T] =
   944       read_properties(db, name, Session_Info.task_statistics)
   945 
   946     def read_errors(db: SQL.Database, name: String): List[String] =
   947       Build_Log.uncompress_errors(read_bytes(db, name, Session_Info.errors))
   948 
   949     def read_build(db: SQL.Database, name: String): Option[Build.Session_Info] =
   950     {
   951       db.using_statement(Session_Info.table.select(Session_Info.build_columns,
   952         Session_Info.session_name.where_equal(name)))(stmt =>
   953       {
   954         val res = stmt.execute_query()
   955         if (!res.next()) None
   956         else {
   957           Some(
   958             Build.Session_Info(
   959               res.string(Session_Info.sources),
   960               split_lines(res.string(Session_Info.input_heaps)),
   961               res.string(Session_Info.output_heap) match { case "" => None case s => Some(s) },
   962               res.int(Session_Info.return_code)))
   963         }
   964       })
   965     }
   966   }
   967 }