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