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