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