src/Pure/PIDE/resources.scala
author wenzelm
Wed Sep 27 11:11:07 2017 +0200 (21 months ago)
changeset 66697 190834aa43a7
parent 66696 8f863dae78a0
child 66698 5b9dc3f7bcde
permissions -rw-r--r--
tuned;
wenzelm@56208
     1
/*  Title:      Pure/PIDE/resources.scala
wenzelm@43651
     2
    Author:     Makarius
wenzelm@43651
     3
wenzelm@56208
     4
Resources for theories and auxiliary files.
wenzelm@43651
     5
*/
wenzelm@43651
     6
wenzelm@43651
     7
package isabelle
wenzelm@43651
     8
wenzelm@44953
     9
wenzelm@48885
    10
import scala.annotation.tailrec
wenzelm@56823
    11
import scala.util.parsing.input.Reader
wenzelm@48885
    12
wenzelm@48409
    13
import java.io.{File => JFile}
wenzelm@44953
    14
wenzelm@44953
    15
wenzelm@65359
    16
class Resources(
wenzelm@65361
    17
  val session_base: Sessions.Base,
wenzelm@65359
    18
  val log: Logger = No_Logger)
wenzelm@43651
    19
{
wenzelm@64839
    20
  val thy_info = new Thy_Info(this)
wenzelm@64839
    21
wenzelm@65250
    22
  def thy_path(path: Path): Path = path.ext("thy")
wenzelm@65250
    23
wenzelm@64839
    24
wenzelm@44953
    25
  /* file-system operations */
wenzelm@44953
    26
wenzelm@44953
    27
  def append(dir: String, source_path: Path): String =
wenzelm@48711
    28
    (Path.explode(dir) + source_path).expand.implode
wenzelm@44953
    29
wenzelm@65488
    30
  def append(node_name: Document.Node.Name, source_path: Path): String =
wenzelm@65488
    31
    append(node_name.master_dir, source_path)
wenzelm@65488
    32
wenzelm@46737
    33
wenzelm@64657
    34
  /* source files of Isabelle/ML bootstrap */
wenzelm@64657
    35
wenzelm@64657
    36
  def source_file(raw_name: String): Option[String] =
wenzelm@64657
    37
  {
wenzelm@64657
    38
    if (Path.is_wellformed(raw_name)) {
wenzelm@64657
    39
      if (Path.is_valid(raw_name)) {
wenzelm@64657
    40
        def check(p: Path): Option[Path] = if (p.is_file) Some(p) else None
wenzelm@64657
    41
wenzelm@64657
    42
        val path = Path.explode(raw_name)
wenzelm@64657
    43
        val path1 =
wenzelm@64657
    44
          if (path.is_absolute || path.is_current) check(path)
wenzelm@64657
    45
          else {
wenzelm@64657
    46
            check(Path.explode("~~/src/Pure") + path) orElse
wenzelm@64657
    47
              (if (Isabelle_System.getenv("ML_SOURCES") == "") None
wenzelm@64657
    48
               else check(Path.explode("$ML_SOURCES") + path))
wenzelm@64657
    49
          }
wenzelm@64657
    50
        Some(File.platform_path(path1 getOrElse path))
wenzelm@64657
    51
      }
wenzelm@64657
    52
      else None
wenzelm@64657
    53
    }
wenzelm@64657
    54
    else Some(raw_name)
wenzelm@64657
    55
  }
wenzelm@64657
    56
wenzelm@64657
    57
wenzelm@46737
    58
  /* theory files */
wenzelm@46737
    59
wenzelm@66695
    60
  def loaded_files(syntax: Outer_Syntax, name: Document.Node.Name): List[Path] =
wenzelm@66695
    61
  {
wenzelm@66695
    62
    val text = with_thy_reader(name, reader => Symbol.decode(reader.source.toString))
wenzelm@66696
    63
    if (syntax.load_commands_in(text)) {
wenzelm@66696
    64
      val spans = syntax.parse_spans(text)
wenzelm@66696
    65
      val dir = Path.explode(name.master_dir)
wenzelm@66696
    66
      spans.iterator.map(Command.span_files(syntax, _)._1).flatten.
wenzelm@66696
    67
        map(a => dir + Path.explode(a)).toList
wenzelm@66696
    68
    }
wenzelm@66696
    69
    else Nil
wenzelm@66695
    70
  }
wenzelm@66695
    71
wenzelm@66696
    72
  def pure_files(syntax: Outer_Syntax, session: String, dir: Path): List[Path] =
wenzelm@66696
    73
    if (Sessions.is_pure(session)) {
wenzelm@66696
    74
      val roots =
wenzelm@66697
    75
        for { (name, _) <- Thy_Header.ml_roots }
wenzelm@66697
    76
        yield (dir + Path.explode(name)).expand
wenzelm@66696
    77
      val files =
wenzelm@66696
    78
        for {
wenzelm@66697
    79
          (path, (_, theory)) <- roots zip Thy_Header.ml_roots
wenzelm@66696
    80
          file <- loaded_files(syntax, Document.Node.Name(path.implode, path.dir.implode, theory))
wenzelm@66696
    81
        } yield file
wenzelm@66697
    82
      roots ::: files
wenzelm@66696
    83
    }
wenzelm@66696
    84
    else Nil
wenzelm@66696
    85
wenzelm@65445
    86
  def theory_qualifier(name: Document.Node.Name): String =
wenzelm@65457
    87
    session_base.global_theories.getOrElse(name.theory, Long_Name.qualifier(name.theory))
wenzelm@65445
    88
wenzelm@65476
    89
  def theory_name(qualifier: String, theory0: String): (Boolean, String) =
wenzelm@65471
    90
    session_base.loaded_theories.get(theory0) match {
wenzelm@65471
    91
      case Some(theory) => (true, theory)
wenzelm@65471
    92
      case None =>
wenzelm@65471
    93
        val theory =
wenzelm@65503
    94
          if (Long_Name.is_qualified(theory0) || session_base.global_theories.isDefinedAt(theory0))
wenzelm@65503
    95
            theory0
wenzelm@65471
    96
          else Long_Name.qualify(qualifier, theory0)
wenzelm@65471
    97
        (false, theory)
wenzelm@65471
    98
    }
wenzelm@65471
    99
wenzelm@65445
   100
  def import_name(qualifier: String, dir: String, s: String): Document.Node.Name =
wenzelm@65476
   101
    theory_name(qualifier, Thy_Header.import_name(s)) match {
wenzelm@65472
   102
      case (true, theory) => Document.Node.Name.loaded_theory(theory)
wenzelm@65472
   103
      case (false, theory) =>
wenzelm@65498
   104
        session_base.known_theory(theory) match {
wenzelm@65472
   105
          case Some(node_name) => node_name
wenzelm@65472
   106
          case None =>
wenzelm@65472
   107
            val path = Path.explode(s)
wenzelm@65472
   108
            val node = append(dir, thy_path(path))
wenzelm@65472
   109
            val master_dir = append(dir, path.dir)
wenzelm@65472
   110
            Document.Node.Name(node, master_dir, theory)
wenzelm@65472
   111
        }
wenzelm@65472
   112
    }
wenzelm@51634
   113
wenzelm@65529
   114
  def import_name(name: Document.Node.Name, s: String): Document.Node.Name =
wenzelm@65529
   115
    import_name(theory_qualifier(name), name.master_dir, s)
wenzelm@65489
   116
wenzelm@64656
   117
  def with_thy_reader[A](name: Document.Node.Name, f: Reader[Char] => A): A =
wenzelm@64656
   118
  {
wenzelm@65494
   119
    val path = File.check_file(Path.explode(name.node))
wenzelm@64656
   120
    val reader = Scan.byte_reader(path.file)
wenzelm@64656
   121
    try { f(reader) } finally { reader.close }
wenzelm@64656
   122
  }
wenzelm@64656
   123
wenzelm@65359
   124
  def check_thy_reader(node_name: Document.Node.Name, reader: Reader[Char],
wenzelm@65359
   125
    start: Token.Pos = Token.Pos.command, strict: Boolean = true): Document.Node.Header =
wenzelm@46737
   126
  {
wenzelm@64826
   127
    if (node_name.is_theory && reader.source.length > 0) {
wenzelm@57615
   128
      try {
wenzelm@64825
   129
        val header = Thy_Header.read(reader, start, strict).decode_symbols
wenzelm@48885
   130
wenzelm@65439
   131
        val base_name = node_name.theory_base_name
wenzelm@59694
   132
        val (name, pos) = header.name
wenzelm@59694
   133
        if (base_name != name)
wenzelm@59718
   134
          error("Bad theory name " + quote(name) +
wenzelm@65250
   135
            " for file " + thy_path(Path.basic(base_name)) + Position.here(pos) +
wenzelm@59718
   136
            Completion.report_names(pos, 1, List((base_name, ("theory", base_name)))))
wenzelm@48885
   137
wenzelm@65489
   138
        val imports = header.imports.map({ case (s, pos) => (import_name(node_name, s), pos) })
wenzelm@63579
   139
        Document.Node.Header(imports, header.keywords, header.abbrevs)
wenzelm@57615
   140
      }
wenzelm@57615
   141
      catch { case exn: Throwable => Document.Node.bad_header(Exn.message(exn)) }
wenzelm@50414
   142
    }
wenzelm@57615
   143
    else Document.Node.no_header
wenzelm@46737
   144
  }
wenzelm@46748
   145
wenzelm@65359
   146
  def check_thy(name: Document.Node.Name, start: Token.Pos = Token.Pos.command,
wenzelm@65359
   147
      strict: Boolean = true): Document.Node.Header =
wenzelm@65359
   148
    with_thy_reader(name, check_thy_reader(name, _, start, strict))
wenzelm@50566
   149
wenzelm@50566
   150
wenzelm@64673
   151
  /* special header */
wenzelm@64673
   152
wenzelm@64673
   153
  def special_header(name: Document.Node.Name): Option[Document.Node.Header] =
wenzelm@65445
   154
  {
wenzelm@65445
   155
    val imports =
wenzelm@65489
   156
      if (Thy_Header.is_ml_root(name.theory)) List(import_name(name, Thy_Header.ML_BOOTSTRAP))
wenzelm@65489
   157
      else if (Thy_Header.is_bootstrap(name.theory)) List(import_name(name, Thy_Header.PURE))
wenzelm@65445
   158
      else Nil
wenzelm@65445
   159
    if (imports.isEmpty) None
wenzelm@65445
   160
    else Some(Document.Node.Header(imports.map((_, Position.none))))
wenzelm@65445
   161
  }
wenzelm@64673
   162
wenzelm@64673
   163
wenzelm@64797
   164
  /* blobs */
wenzelm@64797
   165
wenzelm@64797
   166
  def undefined_blobs(nodes: Document.Nodes): List[Document.Node.Name] =
wenzelm@64797
   167
    (for {
wenzelm@64797
   168
      (node_name, node) <- nodes.iterator
wenzelm@65361
   169
      if !session_base.loaded_theory(node_name)
wenzelm@64797
   170
      cmd <- node.load_commands.iterator
wenzelm@64797
   171
      name <- cmd.blobs_undefined.iterator
wenzelm@64797
   172
    } yield name).toList
wenzelm@64797
   173
wenzelm@64797
   174
wenzelm@56316
   175
  /* document changes */
wenzelm@50566
   176
wenzelm@56316
   177
  def parse_change(
wenzelm@56315
   178
      reparse_limit: Int,
wenzelm@56315
   179
      previous: Document.Version,
wenzelm@56315
   180
      doc_blobs: Document.Blobs,
wenzelm@56315
   181
      edits: List[Document.Edit_Text]): Session.Change =
wenzelm@56316
   182
    Thy_Syntax.parse_change(this, reparse_limit, previous, doc_blobs, edits)
wenzelm@55134
   183
wenzelm@56316
   184
  def commit(change: Session.Change) { }
wenzelm@43651
   185
}