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