src/Pure/PIDE/resources.scala
author wenzelm
Mon Dec 26 15:31:13 2016 +0100 (2016-12-26)
changeset 64673 b5965890e54d
parent 64657 6209e0f7a4e8
child 64718 3197b68f4314
permissions -rw-r--r--
more uniform treatment of file name vs. theory name and special header;
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@56208
    16
object Resources
wenzelm@48422
    17
{
wenzelm@48422
    18
  def thy_path(path: Path): Path = path.ext("thy")
wenzelm@60835
    19
wenzelm@60835
    20
  val empty: Resources = new Resources(Set.empty, Map.empty, Outer_Syntax.empty)
wenzelm@48422
    21
}
wenzelm@44953
    22
wenzelm@56801
    23
class Resources(
wenzelm@56801
    24
  val loaded_theories: Set[String],
wenzelm@56801
    25
  val known_theories: Map[String, Document.Node.Name],
wenzelm@63584
    26
  val base_syntax: Outer_Syntax)
wenzelm@43651
    27
{
wenzelm@54514
    28
  /* document node names */
wenzelm@54514
    29
wenzelm@56801
    30
  def node_name(qualifier: String, raw_path: Path): Document.Node.Name =
wenzelm@54514
    31
  {
wenzelm@56913
    32
    val no_qualifier = "" // FIXME
wenzelm@54514
    33
    val path = raw_path.expand
wenzelm@54514
    34
    val node = path.implode
wenzelm@56913
    35
    val theory = Long_Name.qualify(no_qualifier, Thy_Header.thy_name(node).getOrElse(""))
wenzelm@54515
    36
    val master_dir = if (theory == "") "" else path.dir.implode
wenzelm@54515
    37
    Document.Node.Name(node, master_dir, theory)
wenzelm@54514
    38
  }
wenzelm@54514
    39
wenzelm@54514
    40
wenzelm@44953
    41
  /* file-system operations */
wenzelm@44953
    42
wenzelm@44953
    43
  def append(dir: String, source_path: Path): String =
wenzelm@48711
    44
    (Path.explode(dir) + source_path).expand.implode
wenzelm@44953
    45
wenzelm@64654
    46
  def append_file(dir: String, raw_name: String): String =
wenzelm@64654
    47
    if (Path.is_valid(raw_name)) append(dir, Path.explode(raw_name))
wenzelm@64654
    48
    else raw_name
wenzelm@64654
    49
wenzelm@64654
    50
  def append_file_url(dir: String, raw_name: String): String =
wenzelm@64654
    51
    if (Path.is_valid(raw_name)) "file://" + append(dir, Path.explode(raw_name))
wenzelm@64654
    52
    else raw_name
wenzelm@64654
    53
wenzelm@64654
    54
wenzelm@46737
    55
wenzelm@64657
    56
  /* source files of Isabelle/ML bootstrap */
wenzelm@64657
    57
wenzelm@64657
    58
  def source_file(raw_name: String): Option[String] =
wenzelm@64657
    59
  {
wenzelm@64657
    60
    if (Path.is_wellformed(raw_name)) {
wenzelm@64657
    61
      if (Path.is_valid(raw_name)) {
wenzelm@64657
    62
        def check(p: Path): Option[Path] = if (p.is_file) Some(p) else None
wenzelm@64657
    63
wenzelm@64657
    64
        val path = Path.explode(raw_name)
wenzelm@64657
    65
        val path1 =
wenzelm@64657
    66
          if (path.is_absolute || path.is_current) check(path)
wenzelm@64657
    67
          else {
wenzelm@64657
    68
            check(Path.explode("~~/src/Pure") + path) orElse
wenzelm@64657
    69
              (if (Isabelle_System.getenv("ML_SOURCES") == "") None
wenzelm@64657
    70
               else check(Path.explode("$ML_SOURCES") + path))
wenzelm@64657
    71
          }
wenzelm@64657
    72
        Some(File.platform_path(path1 getOrElse path))
wenzelm@64657
    73
      }
wenzelm@64657
    74
      else None
wenzelm@64657
    75
    }
wenzelm@64657
    76
    else Some(raw_name)
wenzelm@64657
    77
  }
wenzelm@64657
    78
wenzelm@64657
    79
wenzelm@46737
    80
  /* theory files */
wenzelm@46737
    81
wenzelm@63584
    82
  def loaded_files(syntax: Outer_Syntax, text: String): List[String] =
wenzelm@56393
    83
    if (syntax.load_commands_in(text)) {
wenzelm@57906
    84
      val spans = syntax.parse_spans(text)
wenzelm@59689
    85
      spans.iterator.map(Command.span_files(syntax, _)._1).flatten.toList
wenzelm@56392
    86
    }
wenzelm@56392
    87
    else Nil
wenzelm@48885
    88
wenzelm@56801
    89
  private def dummy_name(theory: String): Document.Node.Name =
wenzelm@56801
    90
    Document.Node.Name(theory + ".thy", "", theory)
wenzelm@56801
    91
wenzelm@56801
    92
  def import_name(qualifier: String, master: Document.Node.Name, s: String): Document.Node.Name =
wenzelm@51634
    93
  {
wenzelm@56913
    94
    val no_qualifier = "" // FIXME
wenzelm@56801
    95
    val thy1 = Thy_Header.base_name(s)
wenzelm@56913
    96
    val thy2 = if (Long_Name.is_qualified(thy1)) thy1 else Long_Name.qualify(no_qualifier, thy1)
wenzelm@56801
    97
    (known_theories.get(thy1) orElse
wenzelm@56801
    98
     known_theories.get(thy2) orElse
wenzelm@56801
    99
     known_theories.get(Long_Name.base_name(thy1))) match {
wenzelm@56801
   100
      case Some(name) if loaded_theories(name.theory) => dummy_name(name.theory)
wenzelm@56801
   101
      case Some(name) => name
wenzelm@56801
   102
      case None =>
wenzelm@56801
   103
        val path = Path.explode(s)
wenzelm@56801
   104
        val theory = path.base.implode
wenzelm@56801
   105
        if (Long_Name.is_qualified(theory)) dummy_name(theory)
wenzelm@56801
   106
        else {
wenzelm@56801
   107
          val node = append(master.master_dir, Resources.thy_path(path))
wenzelm@56801
   108
          val master_dir = append(master.master_dir, path.dir)
wenzelm@56913
   109
          Document.Node.Name(node, master_dir, Long_Name.qualify(no_qualifier, theory))
wenzelm@56801
   110
        }
wenzelm@51634
   111
    }
wenzelm@51634
   112
  }
wenzelm@51634
   113
wenzelm@64656
   114
  def with_thy_reader[A](name: Document.Node.Name, f: Reader[Char] => A): A =
wenzelm@64656
   115
  {
wenzelm@64656
   116
    val path = Path.explode(name.node)
wenzelm@64656
   117
    if (!path.is_file) error("No such file: " + path.toString)
wenzelm@64656
   118
wenzelm@64656
   119
    val reader = Scan.byte_reader(path.file)
wenzelm@64656
   120
    try { f(reader) } finally { reader.close }
wenzelm@64656
   121
  }
wenzelm@64656
   122
wenzelm@59705
   123
  def check_thy_reader(qualifier: String, node_name: Document.Node.Name,
wenzelm@59705
   124
    reader: Reader[Char], start: Token.Pos): Document.Node.Header =
wenzelm@46737
   125
  {
wenzelm@57615
   126
    if (reader.source.length > 0) {
wenzelm@57615
   127
      try {
wenzelm@59705
   128
        val header = Thy_Header.read(reader, start).decode_symbols
wenzelm@48885
   129
wenzelm@59694
   130
        val base_name = Long_Name.base_name(node_name.theory)
wenzelm@59694
   131
        val (name, pos) = header.name
wenzelm@59694
   132
        if (base_name != name)
wenzelm@59718
   133
          error("Bad theory name " + quote(name) +
wenzelm@59718
   134
            " for file " + Resources.thy_path(Path.basic(base_name)) + Position.here(pos) +
wenzelm@59718
   135
            Completion.report_names(pos, 1, List((base_name, ("theory", base_name)))))
wenzelm@48885
   136
wenzelm@59694
   137
        val imports =
wenzelm@59695
   138
          header.imports.map({ case (s, pos) => (import_name(qualifier, 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@59705
   146
  def check_thy(qualifier: String, name: Document.Node.Name, start: Token.Pos)
wenzelm@59705
   147
    : Document.Node.Header =
wenzelm@59705
   148
    with_thy_reader(name, check_thy_reader(qualifier, name, _, start))
wenzelm@50566
   149
wenzelm@59691
   150
  def check_file(file: String): Boolean =
wenzelm@59691
   151
    try {
wenzelm@59691
   152
      if (Url.is_wellformed(file)) Url.is_readable(file)
wenzelm@59691
   153
      else (new JFile(file)).isFile
wenzelm@59691
   154
    }
wenzelm@59691
   155
    catch { case ERROR(_) => false }
wenzelm@59691
   156
wenzelm@50566
   157
wenzelm@64673
   158
  /* special header */
wenzelm@64673
   159
wenzelm@64673
   160
  def special_header(name: Document.Node.Name): Option[Document.Node.Header] =
wenzelm@64673
   161
    if (Thy_Header.is_ml_root(name.theory))
wenzelm@64673
   162
      Some(Document.Node.Header(List((import_name("", name, Thy_Header.ML_BOOTSTRAP), Position.none))))
wenzelm@64673
   163
    else if (Thy_Header.is_bootstrap(name.theory))
wenzelm@64673
   164
      Some(Document.Node.Header(List((import_name("", name, Thy_Header.PURE), Position.none))))
wenzelm@64673
   165
    else None
wenzelm@64673
   166
wenzelm@64673
   167
wenzelm@56316
   168
  /* document changes */
wenzelm@50566
   169
wenzelm@56316
   170
  def parse_change(
wenzelm@56315
   171
      reparse_limit: Int,
wenzelm@56315
   172
      previous: Document.Version,
wenzelm@56315
   173
      doc_blobs: Document.Blobs,
wenzelm@56315
   174
      edits: List[Document.Edit_Text]): Session.Change =
wenzelm@56316
   175
    Thy_Syntax.parse_change(this, reparse_limit, previous, doc_blobs, edits)
wenzelm@55134
   176
wenzelm@56316
   177
  def commit(change: Session.Change) { }
wenzelm@43651
   178
}