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