src/Pure/PIDE/resources.scala
author wenzelm
Mon Apr 03 17:00:36 2017 +0200 (2017-04-03)
changeset 65361 ecefb68dc21d
parent 65359 9ca34f0407a9
child 65362 908a27a4b9c9
permissions -rw-r--r--
tuned signature;
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@65359
    17
  val session_name: String,
wenzelm@65361
    18
  val session_base: Sessions.Base,
wenzelm@65359
    19
  val log: Logger = No_Logger)
wenzelm@43651
    20
{
wenzelm@64839
    21
  val thy_info = new Thy_Info(this)
wenzelm@64839
    22
wenzelm@65250
    23
  def thy_path(path: Path): Path = path.ext("thy")
wenzelm@65250
    24
wenzelm@64839
    25
wenzelm@44953
    26
  /* file-system operations */
wenzelm@44953
    27
wenzelm@44953
    28
  def append(dir: String, source_path: Path): String =
wenzelm@48711
    29
    (Path.explode(dir) + source_path).expand.implode
wenzelm@44953
    30
wenzelm@64654
    31
  def append_file(dir: String, raw_name: String): String =
wenzelm@64654
    32
    if (Path.is_valid(raw_name)) append(dir, Path.explode(raw_name))
wenzelm@64654
    33
    else raw_name
wenzelm@64654
    34
wenzelm@64654
    35
wenzelm@46737
    36
wenzelm@64657
    37
  /* source files of Isabelle/ML bootstrap */
wenzelm@64657
    38
wenzelm@64657
    39
  def source_file(raw_name: String): Option[String] =
wenzelm@64657
    40
  {
wenzelm@64657
    41
    if (Path.is_wellformed(raw_name)) {
wenzelm@64657
    42
      if (Path.is_valid(raw_name)) {
wenzelm@64657
    43
        def check(p: Path): Option[Path] = if (p.is_file) Some(p) else None
wenzelm@64657
    44
wenzelm@64657
    45
        val path = Path.explode(raw_name)
wenzelm@64657
    46
        val path1 =
wenzelm@64657
    47
          if (path.is_absolute || path.is_current) check(path)
wenzelm@64657
    48
          else {
wenzelm@64657
    49
            check(Path.explode("~~/src/Pure") + path) orElse
wenzelm@64657
    50
              (if (Isabelle_System.getenv("ML_SOURCES") == "") None
wenzelm@64657
    51
               else check(Path.explode("$ML_SOURCES") + path))
wenzelm@64657
    52
          }
wenzelm@64657
    53
        Some(File.platform_path(path1 getOrElse path))
wenzelm@64657
    54
      }
wenzelm@64657
    55
      else None
wenzelm@64657
    56
    }
wenzelm@64657
    57
    else Some(raw_name)
wenzelm@64657
    58
  }
wenzelm@64657
    59
wenzelm@64657
    60
wenzelm@46737
    61
  /* theory files */
wenzelm@46737
    62
wenzelm@63584
    63
  def loaded_files(syntax: Outer_Syntax, text: String): List[String] =
wenzelm@56393
    64
    if (syntax.load_commands_in(text)) {
wenzelm@57906
    65
      val spans = syntax.parse_spans(text)
wenzelm@59689
    66
      spans.iterator.map(Command.span_files(syntax, _)._1).flatten.toList
wenzelm@56392
    67
    }
wenzelm@56392
    68
    else Nil
wenzelm@48885
    69
wenzelm@65359
    70
  def init_name(global: Boolean, raw_path: Path): Document.Node.Name =
wenzelm@65359
    71
  {
wenzelm@65359
    72
    val path = raw_path.expand
wenzelm@65359
    73
    val node = path.implode
wenzelm@65359
    74
    val qualifier = if (global) "" else session_name
wenzelm@65359
    75
    val theory = Long_Name.qualify(qualifier, Thy_Header.thy_name(node).getOrElse(""))
wenzelm@65359
    76
    val master_dir = if (theory == "") "" else path.dir.implode
wenzelm@65359
    77
    Document.Node.Name(node, master_dir, theory)
wenzelm@65359
    78
  }
wenzelm@65359
    79
wenzelm@65359
    80
  def import_name(master: Document.Node.Name, s: String): Document.Node.Name =
wenzelm@51634
    81
  {
wenzelm@56801
    82
    val thy1 = Thy_Header.base_name(s)
wenzelm@65359
    83
    val thy2 = if (Long_Name.is_qualified(thy1)) thy1 else Long_Name.qualify(session_name, thy1)
wenzelm@65361
    84
    (session_base.known_theories.get(thy1) orElse
wenzelm@65361
    85
     session_base.known_theories.get(thy2) orElse
wenzelm@65361
    86
     session_base.known_theories.get(Long_Name.base_name(thy1))) match {
wenzelm@65361
    87
      case Some(name) if session_base.loaded_theory(name) => Document.Node.Name.theory(name.theory)
wenzelm@56801
    88
      case Some(name) => name
wenzelm@56801
    89
      case None =>
wenzelm@56801
    90
        val path = Path.explode(s)
wenzelm@56801
    91
        val theory = path.base.implode
wenzelm@65357
    92
        if (Long_Name.is_qualified(theory)) Document.Node.Name.theory(theory)
wenzelm@56801
    93
        else {
wenzelm@65250
    94
          val node = append(master.master_dir, thy_path(path))
wenzelm@56801
    95
          val master_dir = append(master.master_dir, path.dir)
wenzelm@65359
    96
          Document.Node.Name(node, master_dir, Long_Name.qualify(session_name, theory))
wenzelm@56801
    97
        }
wenzelm@51634
    98
    }
wenzelm@51634
    99
  }
wenzelm@51634
   100
wenzelm@64656
   101
  def with_thy_reader[A](name: Document.Node.Name, f: Reader[Char] => A): A =
wenzelm@64656
   102
  {
wenzelm@64656
   103
    val path = Path.explode(name.node)
wenzelm@64656
   104
    if (!path.is_file) error("No such file: " + path.toString)
wenzelm@64656
   105
wenzelm@64656
   106
    val reader = Scan.byte_reader(path.file)
wenzelm@64656
   107
    try { f(reader) } finally { reader.close }
wenzelm@64656
   108
  }
wenzelm@64656
   109
wenzelm@65359
   110
  def check_thy_reader(node_name: Document.Node.Name, reader: Reader[Char],
wenzelm@65359
   111
    start: Token.Pos = Token.Pos.command, strict: Boolean = true): Document.Node.Header =
wenzelm@46737
   112
  {
wenzelm@64826
   113
    if (node_name.is_theory && reader.source.length > 0) {
wenzelm@57615
   114
      try {
wenzelm@64825
   115
        val header = Thy_Header.read(reader, start, strict).decode_symbols
wenzelm@48885
   116
wenzelm@59694
   117
        val base_name = Long_Name.base_name(node_name.theory)
wenzelm@59694
   118
        val (name, pos) = header.name
wenzelm@59694
   119
        if (base_name != name)
wenzelm@59718
   120
          error("Bad theory name " + quote(name) +
wenzelm@65250
   121
            " for file " + thy_path(Path.basic(base_name)) + Position.here(pos) +
wenzelm@59718
   122
            Completion.report_names(pos, 1, List((base_name, ("theory", base_name)))))
wenzelm@48885
   123
wenzelm@59694
   124
        val imports =
wenzelm@65359
   125
          header.imports.map({ case (s, pos) => (import_name(node_name, s), pos) })
wenzelm@63579
   126
        Document.Node.Header(imports, header.keywords, header.abbrevs)
wenzelm@57615
   127
      }
wenzelm@57615
   128
      catch { case exn: Throwable => Document.Node.bad_header(Exn.message(exn)) }
wenzelm@50414
   129
    }
wenzelm@57615
   130
    else Document.Node.no_header
wenzelm@46737
   131
  }
wenzelm@46748
   132
wenzelm@65359
   133
  def check_thy(name: Document.Node.Name, start: Token.Pos = Token.Pos.command,
wenzelm@65359
   134
      strict: Boolean = true): Document.Node.Header =
wenzelm@65359
   135
    with_thy_reader(name, check_thy_reader(name, _, start, strict))
wenzelm@50566
   136
wenzelm@50566
   137
wenzelm@64673
   138
  /* special header */
wenzelm@64673
   139
wenzelm@64673
   140
  def special_header(name: Document.Node.Name): Option[Document.Node.Header] =
wenzelm@64673
   141
    if (Thy_Header.is_ml_root(name.theory))
wenzelm@65359
   142
      Some(Document.Node.Header(List((import_name(name, Thy_Header.ML_BOOTSTRAP), Position.none))))
wenzelm@64673
   143
    else if (Thy_Header.is_bootstrap(name.theory))
wenzelm@65359
   144
      Some(Document.Node.Header(List((import_name(name, Thy_Header.PURE), Position.none))))
wenzelm@64673
   145
    else None
wenzelm@64673
   146
wenzelm@64673
   147
wenzelm@64797
   148
  /* blobs */
wenzelm@64797
   149
wenzelm@64797
   150
  def undefined_blobs(nodes: Document.Nodes): List[Document.Node.Name] =
wenzelm@64797
   151
    (for {
wenzelm@64797
   152
      (node_name, node) <- nodes.iterator
wenzelm@65361
   153
      if !session_base.loaded_theory(node_name)
wenzelm@64797
   154
      cmd <- node.load_commands.iterator
wenzelm@64797
   155
      name <- cmd.blobs_undefined.iterator
wenzelm@64797
   156
    } yield name).toList
wenzelm@64797
   157
wenzelm@64797
   158
wenzelm@56316
   159
  /* document changes */
wenzelm@50566
   160
wenzelm@56316
   161
  def parse_change(
wenzelm@56315
   162
      reparse_limit: Int,
wenzelm@56315
   163
      previous: Document.Version,
wenzelm@56315
   164
      doc_blobs: Document.Blobs,
wenzelm@56315
   165
      edits: List[Document.Edit_Text]): Session.Change =
wenzelm@56316
   166
    Thy_Syntax.parse_change(this, reparse_limit, previous, doc_blobs, edits)
wenzelm@55134
   167
wenzelm@56316
   168
  def commit(change: Session.Change) { }
wenzelm@43651
   169
}