src/Pure/PIDE/resources.scala
author wenzelm
Wed Dec 21 23:54:21 2016 +0100 (2016-12-21)
changeset 64654 31b681e38c70
parent 63584 68751fe1c036
child 64656 65c8a7780538
permissions -rw-r--r--
clarified 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@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@56823
    55
  def with_thy_reader[A](name: Document.Node.Name, f: Reader[Char] => A): A =
wenzelm@48885
    56
  {
wenzelm@48885
    57
    val path = Path.explode(name.node)
wenzelm@48885
    58
    if (!path.is_file) error("No such file: " + path.toString)
wenzelm@50291
    59
wenzelm@56823
    60
    val reader = Scan.byte_reader(path.file)
wenzelm@56823
    61
    try { f(reader) } finally { reader.close }
wenzelm@48885
    62
  }
wenzelm@48885
    63
wenzelm@46737
    64
wenzelm@46737
    65
  /* theory files */
wenzelm@46737
    66
wenzelm@63584
    67
  def loaded_files(syntax: Outer_Syntax, text: String): List[String] =
wenzelm@56393
    68
    if (syntax.load_commands_in(text)) {
wenzelm@57906
    69
      val spans = syntax.parse_spans(text)
wenzelm@59689
    70
      spans.iterator.map(Command.span_files(syntax, _)._1).flatten.toList
wenzelm@56392
    71
    }
wenzelm@56392
    72
    else Nil
wenzelm@48885
    73
wenzelm@56801
    74
  private def dummy_name(theory: String): Document.Node.Name =
wenzelm@56801
    75
    Document.Node.Name(theory + ".thy", "", theory)
wenzelm@56801
    76
wenzelm@56801
    77
  def import_name(qualifier: String, master: Document.Node.Name, s: String): Document.Node.Name =
wenzelm@51634
    78
  {
wenzelm@56913
    79
    val no_qualifier = "" // FIXME
wenzelm@56801
    80
    val thy1 = Thy_Header.base_name(s)
wenzelm@56913
    81
    val thy2 = if (Long_Name.is_qualified(thy1)) thy1 else Long_Name.qualify(no_qualifier, thy1)
wenzelm@56801
    82
    (known_theories.get(thy1) orElse
wenzelm@56801
    83
     known_theories.get(thy2) orElse
wenzelm@56801
    84
     known_theories.get(Long_Name.base_name(thy1))) match {
wenzelm@56801
    85
      case Some(name) if loaded_theories(name.theory) => dummy_name(name.theory)
wenzelm@56801
    86
      case Some(name) => name
wenzelm@56801
    87
      case None =>
wenzelm@56801
    88
        val path = Path.explode(s)
wenzelm@56801
    89
        val theory = path.base.implode
wenzelm@56801
    90
        if (Long_Name.is_qualified(theory)) dummy_name(theory)
wenzelm@56801
    91
        else {
wenzelm@56801
    92
          val node = append(master.master_dir, Resources.thy_path(path))
wenzelm@56801
    93
          val master_dir = append(master.master_dir, path.dir)
wenzelm@56913
    94
          Document.Node.Name(node, master_dir, Long_Name.qualify(no_qualifier, theory))
wenzelm@56801
    95
        }
wenzelm@51634
    96
    }
wenzelm@51634
    97
  }
wenzelm@51634
    98
wenzelm@59705
    99
  def check_thy_reader(qualifier: String, node_name: Document.Node.Name,
wenzelm@59705
   100
    reader: Reader[Char], start: Token.Pos): Document.Node.Header =
wenzelm@46737
   101
  {
wenzelm@57615
   102
    if (reader.source.length > 0) {
wenzelm@57615
   103
      try {
wenzelm@59705
   104
        val header = Thy_Header.read(reader, start).decode_symbols
wenzelm@48885
   105
wenzelm@59694
   106
        val base_name = Long_Name.base_name(node_name.theory)
wenzelm@59694
   107
        val (name, pos) = header.name
wenzelm@59694
   108
        if (base_name != name)
wenzelm@59718
   109
          error("Bad theory name " + quote(name) +
wenzelm@59718
   110
            " for file " + Resources.thy_path(Path.basic(base_name)) + Position.here(pos) +
wenzelm@59718
   111
            Completion.report_names(pos, 1, List((base_name, ("theory", base_name)))))
wenzelm@48885
   112
wenzelm@59694
   113
        val imports =
wenzelm@59695
   114
          header.imports.map({ case (s, pos) => (import_name(qualifier, node_name, s), pos) })
wenzelm@63579
   115
        Document.Node.Header(imports, header.keywords, header.abbrevs)
wenzelm@57615
   116
      }
wenzelm@57615
   117
      catch { case exn: Throwable => Document.Node.bad_header(Exn.message(exn)) }
wenzelm@50414
   118
    }
wenzelm@57615
   119
    else Document.Node.no_header
wenzelm@46737
   120
  }
wenzelm@46748
   121
wenzelm@59705
   122
  def check_thy(qualifier: String, name: Document.Node.Name, start: Token.Pos)
wenzelm@59705
   123
    : Document.Node.Header =
wenzelm@59705
   124
    with_thy_reader(name, check_thy_reader(qualifier, name, _, start))
wenzelm@50566
   125
wenzelm@59691
   126
  def check_file(file: String): Boolean =
wenzelm@59691
   127
    try {
wenzelm@59691
   128
      if (Url.is_wellformed(file)) Url.is_readable(file)
wenzelm@59691
   129
      else (new JFile(file)).isFile
wenzelm@59691
   130
    }
wenzelm@59691
   131
    catch { case ERROR(_) => false }
wenzelm@59691
   132
wenzelm@50566
   133
wenzelm@56316
   134
  /* document changes */
wenzelm@50566
   135
wenzelm@56316
   136
  def parse_change(
wenzelm@56315
   137
      reparse_limit: Int,
wenzelm@56315
   138
      previous: Document.Version,
wenzelm@56315
   139
      doc_blobs: Document.Blobs,
wenzelm@56315
   140
      edits: List[Document.Edit_Text]): Session.Change =
wenzelm@56316
   141
    Thy_Syntax.parse_change(this, reparse_limit, previous, doc_blobs, edits)
wenzelm@55134
   142
wenzelm@56316
   143
  def commit(change: Session.Change) { }
wenzelm@43651
   144
}