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