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