src/Pure/Thy/thy_load.scala
author wenzelm
Sat, 25 Jan 2014 15:29:40 +0100
changeset 55134 1b67b17cdad5
parent 54521 744ea0025e11
child 55879 ac979f750c1a
permissions -rw-r--r--
propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
43651
511df47bcadc some support for theory files within Isabelle/Scala session;
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/Thy/thy_load.scala
511df47bcadc some support for theory files within Isabelle/Scala session;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
511df47bcadc some support for theory files within Isabelle/Scala session;
wenzelm
parents:
diff changeset
     3
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents: 44574
diff changeset
     4
Primitives for loading theory files.
43651
511df47bcadc some support for theory files within Isabelle/Scala session;
wenzelm
parents:
diff changeset
     5
*/
511df47bcadc some support for theory files within Isabelle/Scala session;
wenzelm
parents:
diff changeset
     6
511df47bcadc some support for theory files within Isabelle/Scala session;
wenzelm
parents:
diff changeset
     7
package isabelle
511df47bcadc some support for theory files within Isabelle/Scala session;
wenzelm
parents:
diff changeset
     8
44953
cdfe42f1267c sane default for class Thy_Load;
wenzelm
parents: 44616
diff changeset
     9
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    10
import scala.annotation.tailrec
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    11
48409
0d2114eb412a more explicit java.io.{File => JFile};
wenzelm
parents: 46938
diff changeset
    12
import java.io.{File => JFile}
44953
cdfe42f1267c sane default for class Thy_Load;
wenzelm
parents: 44616
diff changeset
    13
cdfe42f1267c sane default for class Thy_Load;
wenzelm
parents: 44616
diff changeset
    14
48422
9613780a805b determine source dependencies, relatively to preloaded theories;
wenzelm
parents: 48409
diff changeset
    15
object Thy_Load
9613780a805b determine source dependencies, relatively to preloaded theories;
wenzelm
parents: 48409
diff changeset
    16
{
50204
daeb1674fb91 tuned signature -- avoid intrusion of module Path in generic PIDE concepts;
wenzelm
parents: 48889
diff changeset
    17
  /* paths */
daeb1674fb91 tuned signature -- avoid intrusion of module Path in generic PIDE concepts;
wenzelm
parents: 48889
diff changeset
    18
48422
9613780a805b determine source dependencies, relatively to preloaded theories;
wenzelm
parents: 48409
diff changeset
    19
  def thy_path(path: Path): Path = path.ext("thy")
48484
70898d016538 more explicit checks during parsing;
wenzelm
parents: 48422
diff changeset
    20
70898d016538 more explicit checks during parsing;
wenzelm
parents: 48422
diff changeset
    21
  def is_ok(str: String): Boolean =
70898d016538 more explicit checks during parsing;
wenzelm
parents: 48422
diff changeset
    22
    try { thy_path(Path.explode(str)); true }
70898d016538 more explicit checks during parsing;
wenzelm
parents: 48422
diff changeset
    23
    catch { case ERROR(_) => false }
48422
9613780a805b determine source dependencies, relatively to preloaded theories;
wenzelm
parents: 48409
diff changeset
    24
}
44953
cdfe42f1267c sane default for class Thy_Load;
wenzelm
parents: 44616
diff changeset
    25
48422
9613780a805b determine source dependencies, relatively to preloaded theories;
wenzelm
parents: 48409
diff changeset
    26
48870
4accee106f0f clarified initialization of Thy_Load, Thy_Info, Session;
wenzelm
parents: 48827
diff changeset
    27
class Thy_Load(val loaded_theories: Set[String] = Set.empty, val base_syntax: Outer_Syntax)
43651
511df47bcadc some support for theory files within Isabelle/Scala session;
wenzelm
parents:
diff changeset
    28
{
54514
6428dfab6520 clarified Thy_Load.node_name;
wenzelm
parents: 54513
diff changeset
    29
  /* document node names */
6428dfab6520 clarified Thy_Load.node_name;
wenzelm
parents: 54513
diff changeset
    30
6428dfab6520 clarified Thy_Load.node_name;
wenzelm
parents: 54513
diff changeset
    31
  def node_name(raw_path: Path): Document.Node.Name =
6428dfab6520 clarified Thy_Load.node_name;
wenzelm
parents: 54513
diff changeset
    32
  {
6428dfab6520 clarified Thy_Load.node_name;
wenzelm
parents: 54513
diff changeset
    33
    val path = raw_path.expand
6428dfab6520 clarified Thy_Load.node_name;
wenzelm
parents: 54513
diff changeset
    34
    val node = path.implode
6428dfab6520 clarified Thy_Load.node_name;
wenzelm
parents: 54513
diff changeset
    35
    val theory = Thy_Header.thy_name(node).getOrElse("")
54515
570ba266f5b5 clarified boundary cases of Document.Node.Name;
wenzelm
parents: 54514
diff changeset
    36
    val master_dir = if (theory == "") "" else path.dir.implode
570ba266f5b5 clarified boundary cases of Document.Node.Name;
wenzelm
parents: 54514
diff changeset
    37
    Document.Node.Name(node, master_dir, theory)
54514
6428dfab6520 clarified Thy_Load.node_name;
wenzelm
parents: 54513
diff changeset
    38
  }
6428dfab6520 clarified Thy_Load.node_name;
wenzelm
parents: 54513
diff changeset
    39
6428dfab6520 clarified Thy_Load.node_name;
wenzelm
parents: 54513
diff changeset
    40
44953
cdfe42f1267c sane default for class Thy_Load;
wenzelm
parents: 44616
diff changeset
    41
  /* file-system operations */
cdfe42f1267c sane default for class Thy_Load;
wenzelm
parents: 44616
diff changeset
    42
cdfe42f1267c sane default for class Thy_Load;
wenzelm
parents: 44616
diff changeset
    43
  def append(dir: String, source_path: Path): String =
48711
8d381fdef898 need to expand path in order to resolve imports like "~~/src/Tools/Code_Generator";
wenzelm
parents: 48710
diff changeset
    44
    (Path.explode(dir) + source_path).expand.implode
44953
cdfe42f1267c sane default for class Thy_Load;
wenzelm
parents: 44616
diff changeset
    45
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    46
  def with_thy_text[A](name: Document.Node.Name, f: CharSequence => A): A =
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    47
  {
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    48
    val path = Path.explode(name.node)
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    49
    if (!path.is_file) error("No such file: " + path.toString)
50291
674893679352 prefer Symbol.decode_strict in batch mode, to avoid files with spurious Unicode symbols that clash with Isabelle symbol interpretation;
wenzelm
parents: 50204
diff changeset
    50
674893679352 prefer Symbol.decode_strict in batch mode, to avoid files with spurious Unicode symbols that clash with Isabelle symbol interpretation;
wenzelm
parents: 50204
diff changeset
    51
    val text = File.read(path)
674893679352 prefer Symbol.decode_strict in batch mode, to avoid files with spurious Unicode symbols that clash with Isabelle symbol interpretation;
wenzelm
parents: 50204
diff changeset
    52
    Symbol.decode_strict(text)
674893679352 prefer Symbol.decode_strict in batch mode, to avoid files with spurious Unicode symbols that clash with Isabelle symbol interpretation;
wenzelm
parents: 50204
diff changeset
    53
    f(text)
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    54
  }
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    55
46737
09ab89658a5d clarified module Thy_Load;
wenzelm
parents: 44953
diff changeset
    56
09ab89658a5d clarified module Thy_Load;
wenzelm
parents: 44953
diff changeset
    57
  /* theory files */
09ab89658a5d clarified module Thy_Load;
wenzelm
parents: 44953
diff changeset
    58
50415
0d60de55c58a fork slow part of Thy_Load.body_files only;
wenzelm
parents: 50414
diff changeset
    59
  def body_files_test(syntax: Outer_Syntax, text: String): Boolean =
0d60de55c58a fork slow part of Thy_Load.body_files only;
wenzelm
parents: 50414
diff changeset
    60
    syntax.thy_load_commands.exists({ case (cmd, _) => text.containsSlice(cmd) })
0d60de55c58a fork slow part of Thy_Load.body_files only;
wenzelm
parents: 50414
diff changeset
    61
0d60de55c58a fork slow part of Thy_Load.body_files only;
wenzelm
parents: 50414
diff changeset
    62
  def body_files(syntax: Outer_Syntax, text: String): List[String] =
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    63
  {
50415
0d60de55c58a fork slow part of Thy_Load.body_files only;
wenzelm
parents: 50414
diff changeset
    64
    val spans = Thy_Syntax.parse_spans(syntax.scan(text))
54513
5545aff878b1 inline blobs into command, via SHA1 digest;
wenzelm
parents: 51634
diff changeset
    65
    spans.iterator.map(Thy_Syntax.span_files(syntax, _)).flatten.toList
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    66
  }
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    67
51634
553953ad8165 more general Thy_Load.import_name, e.g. relevant for Isabelle/eclipse -- NB: Thy_Load serves as main hub for funny overriding to adapt to provers and editors;
wenzelm
parents: 51293
diff changeset
    68
  def import_name(master: Document.Node.Name, s: String): Document.Node.Name =
553953ad8165 more general Thy_Load.import_name, e.g. relevant for Isabelle/eclipse -- NB: Thy_Load serves as main hub for funny overriding to adapt to provers and editors;
wenzelm
parents: 51293
diff changeset
    69
  {
553953ad8165 more general Thy_Load.import_name, e.g. relevant for Isabelle/eclipse -- NB: Thy_Load serves as main hub for funny overriding to adapt to provers and editors;
wenzelm
parents: 51293
diff changeset
    70
    val theory = Thy_Header.base_name(s)
54515
570ba266f5b5 clarified boundary cases of Document.Node.Name;
wenzelm
parents: 54514
diff changeset
    71
    if (loaded_theories(theory)) Document.Node.Name(theory + ".thy", "", theory)
51634
553953ad8165 more general Thy_Load.import_name, e.g. relevant for Isabelle/eclipse -- NB: Thy_Load serves as main hub for funny overriding to adapt to provers and editors;
wenzelm
parents: 51293
diff changeset
    72
    else {
553953ad8165 more general Thy_Load.import_name, e.g. relevant for Isabelle/eclipse -- NB: Thy_Load serves as main hub for funny overriding to adapt to provers and editors;
wenzelm
parents: 51293
diff changeset
    73
      val path = Path.explode(s)
54515
570ba266f5b5 clarified boundary cases of Document.Node.Name;
wenzelm
parents: 54514
diff changeset
    74
      val node = append(master.master_dir, Thy_Load.thy_path(path))
570ba266f5b5 clarified boundary cases of Document.Node.Name;
wenzelm
parents: 54514
diff changeset
    75
      val master_dir = append(master.master_dir, path.dir)
570ba266f5b5 clarified boundary cases of Document.Node.Name;
wenzelm
parents: 54514
diff changeset
    76
      Document.Node.Name(node, master_dir, theory)
51634
553953ad8165 more general Thy_Load.import_name, e.g. relevant for Isabelle/eclipse -- NB: Thy_Load serves as main hub for funny overriding to adapt to provers and editors;
wenzelm
parents: 51293
diff changeset
    77
    }
553953ad8165 more general Thy_Load.import_name, e.g. relevant for Isabelle/eclipse -- NB: Thy_Load serves as main hub for funny overriding to adapt to provers and editors;
wenzelm
parents: 51293
diff changeset
    78
  }
553953ad8165 more general Thy_Load.import_name, e.g. relevant for Isabelle/eclipse -- NB: Thy_Load serves as main hub for funny overriding to adapt to provers and editors;
wenzelm
parents: 51293
diff changeset
    79
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    80
  def check_thy_text(name: Document.Node.Name, text: CharSequence): Document.Node.Header =
46737
09ab89658a5d clarified module Thy_Load;
wenzelm
parents: 44953
diff changeset
    81
  {
50414
e17a1f179bb0 explore theory_body_files via future, for improved performance;
wenzelm
parents: 50291
diff changeset
    82
    try {
e17a1f179bb0 explore theory_body_files via future, for improved performance;
wenzelm
parents: 50291
diff changeset
    83
      val header = Thy_Header.read(text)
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    84
50414
e17a1f179bb0 explore theory_body_files via future, for improved performance;
wenzelm
parents: 50291
diff changeset
    85
      val name1 = header.name
e17a1f179bb0 explore theory_body_files via future, for improved performance;
wenzelm
parents: 50291
diff changeset
    86
      if (name.theory != name1)
e17a1f179bb0 explore theory_body_files via future, for improved performance;
wenzelm
parents: 50291
diff changeset
    87
        error("Bad file name " + Thy_Load.thy_path(Path.basic(name.theory)) +
e17a1f179bb0 explore theory_body_files via future, for improved performance;
wenzelm
parents: 50291
diff changeset
    88
          " for theory " + quote(name1))
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    89
51634
553953ad8165 more general Thy_Load.import_name, e.g. relevant for Isabelle/eclipse -- NB: Thy_Load serves as main hub for funny overriding to adapt to provers and editors;
wenzelm
parents: 51293
diff changeset
    90
      val imports = header.imports.map(import_name(name, _))
51293
05b1bbae748d discontinued obsolete 'uses' within theory header;
wenzelm
parents: 50641
diff changeset
    91
      Document.Node.Header(imports, header.keywords, Nil)
50414
e17a1f179bb0 explore theory_body_files via future, for improved performance;
wenzelm
parents: 50291
diff changeset
    92
    }
50641
wenzelm
parents: 50566
diff changeset
    93
    catch { case exn: Throwable => Document.Node.bad_header(Exn.message(exn)) }
46737
09ab89658a5d clarified module Thy_Load;
wenzelm
parents: 44953
diff changeset
    94
  }
46748
8f3ae4d04a2d refined node_header -- more direct buffer access (again);
wenzelm
parents: 46737
diff changeset
    95
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    96
  def check_thy(name: Document.Node.Name): Document.Node.Header =
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    97
    with_thy_text(name, check_thy_text(name, _))
50566
b43c4f660320 tuned signature: use thy_load to adapt to prover/editor specific view on sources;
wenzelm
parents: 50415
diff changeset
    98
b43c4f660320 tuned signature: use thy_load to adapt to prover/editor specific view on sources;
wenzelm
parents: 50415
diff changeset
    99
b43c4f660320 tuned signature: use thy_load to adapt to prover/editor specific view on sources;
wenzelm
parents: 50415
diff changeset
   100
  /* theory text edits */
b43c4f660320 tuned signature: use thy_load to adapt to prover/editor specific view on sources;
wenzelm
parents: 50415
diff changeset
   101
54521
744ea0025e11 clarified Document.Blobs environment vs. actual edits of auxiliary files;
wenzelm
parents: 54519
diff changeset
   102
  def text_edits(
744ea0025e11 clarified Document.Blobs environment vs. actual edits of auxiliary files;
wenzelm
parents: 54519
diff changeset
   103
    reparse_limit: Int,
744ea0025e11 clarified Document.Blobs environment vs. actual edits of auxiliary files;
wenzelm
parents: 54519
diff changeset
   104
    previous: Document.Version,
744ea0025e11 clarified Document.Blobs environment vs. actual edits of auxiliary files;
wenzelm
parents: 54519
diff changeset
   105
    doc_blobs: Document.Blobs,
55134
1b67b17cdad5 propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
wenzelm
parents: 54521
diff changeset
   106
    edits: List[Document.Edit_Text]): (Boolean, List[Document.Edit_Command], Document.Version) =
54521
744ea0025e11 clarified Document.Blobs environment vs. actual edits of auxiliary files;
wenzelm
parents: 54519
diff changeset
   107
    Thy_Syntax.text_edits(this, reparse_limit, previous, doc_blobs, edits)
55134
1b67b17cdad5 propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
wenzelm
parents: 54521
diff changeset
   108
1b67b17cdad5 propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
wenzelm
parents: 54521
diff changeset
   109
  def syntax_changed() { }
43651
511df47bcadc some support for theory files within Isabelle/Scala session;
wenzelm
parents:
diff changeset
   110
}
511df47bcadc some support for theory files within Isabelle/Scala session;
wenzelm
parents:
diff changeset
   111