src/Tools/jEdit/src/jedit_resources.scala
author wenzelm
Sun, 08 Jan 2017 16:47:53 +0100
changeset 64835 fd1efd6dd385
parent 64834 0a7179ad430d
child 64836 3611f759f896
permissions -rw-r--r--
resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
56208
06cc31dff138 clarifed module name;
wenzelm
parents: 55134
diff changeset
     1
/*  Title:      Tools/jEdit/src/jedit_resources.scala
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
     3
56208
06cc31dff138 clarifed module name;
wenzelm
parents: 55134
diff changeset
     4
Resources for theories and auxiliary files, based on jEdit buffer
06cc31dff138 clarifed module name;
wenzelm
parents: 55134
diff changeset
     5
content and virtual file-systems.
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
     6
*/
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
     7
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
     8
package isabelle.jedit
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
     9
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    10
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    11
import isabelle._
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    12
56502
db2836f65d42 improved support for external URLs, based on standard Java network operations;
wenzelm
parents: 56460
diff changeset
    13
import java.io.{File => JFile, ByteArrayOutputStream}
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    14
import javax.swing.text.Segment
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    15
56823
37be55461dbe more frugal access to theory text via Reader, reduced costs for I/O text decoding;
wenzelm
parents: 56801
diff changeset
    16
import scala.util.parsing.input.Reader
37be55461dbe more frugal access to theory text via Reader, reduced costs for I/O text decoding;
wenzelm
parents: 56801
diff changeset
    17
56502
db2836f65d42 improved support for external URLs, based on standard Java network operations;
wenzelm
parents: 56460
diff changeset
    18
import org.gjt.sp.jedit.io.{VFS, FileVFS, VFSManager}
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    19
import org.gjt.sp.jedit.MiscUtilities
55134
1b67b17cdad5 propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
wenzelm
parents: 54517
diff changeset
    20
import org.gjt.sp.jedit.{jEdit, View, Buffer}
54511
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
    21
import org.gjt.sp.jedit.bufferio.BufferIORequest
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    22
56208
06cc31dff138 clarifed module name;
wenzelm
parents: 55134
diff changeset
    23
60835
6512bb0b1ff4 clarified management of (single) session;
wenzelm
parents: 59691
diff changeset
    24
object JEdit_Resources
6512bb0b1ff4 clarified management of (single) session;
wenzelm
parents: 59691
diff changeset
    25
{
6512bb0b1ff4 clarified management of (single) session;
wenzelm
parents: 59691
diff changeset
    26
  val empty: JEdit_Resources =
6512bb0b1ff4 clarified management of (single) session;
wenzelm
parents: 59691
diff changeset
    27
    new JEdit_Resources(Set.empty, Map.empty, Outer_Syntax.empty)
6512bb0b1ff4 clarified management of (single) session;
wenzelm
parents: 59691
diff changeset
    28
}
6512bb0b1ff4 clarified management of (single) session;
wenzelm
parents: 59691
diff changeset
    29
56801
8dd9df88f647 some support for session-qualified theories: allow to refer to resources via qualified name instead of odd file-system path;
wenzelm
parents: 56666
diff changeset
    30
class JEdit_Resources(
8dd9df88f647 some support for session-qualified theories: allow to refer to resources via qualified name instead of odd file-system path;
wenzelm
parents: 56666
diff changeset
    31
    loaded_theories: Set[String],
8dd9df88f647 some support for session-qualified theories: allow to refer to resources via qualified name instead of odd file-system path;
wenzelm
parents: 56666
diff changeset
    32
    known_theories: Map[String, Document.Node.Name],
8dd9df88f647 some support for session-qualified theories: allow to refer to resources via qualified name instead of odd file-system path;
wenzelm
parents: 56666
diff changeset
    33
    base_syntax: Outer_Syntax)
8dd9df88f647 some support for session-qualified theories: allow to refer to resources via qualified name instead of odd file-system path;
wenzelm
parents: 56666
diff changeset
    34
  extends Resources(loaded_theories, known_theories, base_syntax)
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    35
{
64834
wenzelm
parents: 64813
diff changeset
    36
  /* document node name */
50566
b43c4f660320 tuned signature: use thy_load to adapt to prover/editor specific view on sources;
wenzelm
parents: 49406
diff changeset
    37
54509
1f77110c94ef maintain document model for all files, with document view for theory only, and special blob for non-theory files;
wenzelm
parents: 50566
diff changeset
    38
  def node_name(buffer: Buffer): Document.Node.Name =
50566
b43c4f660320 tuned signature: use thy_load to adapt to prover/editor specific view on sources;
wenzelm
parents: 49406
diff changeset
    39
  {
54515
570ba266f5b5 clarified boundary cases of Document.Node.Name;
wenzelm
parents: 54511
diff changeset
    40
    val node = JEdit_Lib.buffer_name(buffer)
63022
785a59235a15 more IDE support for Isabelle/Pure bootstrap;
wenzelm
parents: 61023
diff changeset
    41
    val theory = Thy_Header.thy_name_bootstrap(node).getOrElse("")
54515
570ba266f5b5 clarified boundary cases of Document.Node.Name;
wenzelm
parents: 54511
diff changeset
    42
    val master_dir = if (theory == "") "" else buffer.getDirectory
570ba266f5b5 clarified boundary cases of Document.Node.Name;
wenzelm
parents: 54511
diff changeset
    43
    Document.Node.Name(node, master_dir, theory)
54509
1f77110c94ef maintain document model for all files, with document view for theory only, and special blob for non-theory files;
wenzelm
parents: 50566
diff changeset
    44
  }
1f77110c94ef maintain document model for all files, with document view for theory only, and special blob for non-theory files;
wenzelm
parents: 50566
diff changeset
    45
1f77110c94ef maintain document model for all files, with document view for theory only, and special blob for non-theory files;
wenzelm
parents: 50566
diff changeset
    46
  def theory_node_name(buffer: Buffer): Option[Document.Node.Name] =
1f77110c94ef maintain document model for all files, with document view for theory only, and special blob for non-theory files;
wenzelm
parents: 50566
diff changeset
    47
  {
1f77110c94ef maintain document model for all files, with document view for theory only, and special blob for non-theory files;
wenzelm
parents: 50566
diff changeset
    48
    val name = node_name(buffer)
1f77110c94ef maintain document model for all files, with document view for theory only, and special blob for non-theory files;
wenzelm
parents: 50566
diff changeset
    49
    if (name.is_theory) Some(name) else None
50566
b43c4f660320 tuned signature: use thy_load to adapt to prover/editor specific view on sources;
wenzelm
parents: 49406
diff changeset
    50
  }
b43c4f660320 tuned signature: use thy_load to adapt to prover/editor specific view on sources;
wenzelm
parents: 49406
diff changeset
    51
44615
a4ff8a787202 more abstract Document.Node.Name;
wenzelm
parents: 44580
diff changeset
    52
  override def append(dir: String, source_path: Path): String =
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    53
  {
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    54
    val path = source_path.expand
57841
e212e2001b2a always resolve symlinks for local files, e.g. relevant for ML_file to load proper source via editor instead of stored file via prover;
wenzelm
parents: 57622
diff changeset
    55
    if (dir == "" || path.is_absolute)
60988
1d7a7e33fd67 tuned signature, according to ML version;
wenzelm
parents: 60917
diff changeset
    56
      MiscUtilities.resolveSymlinks(File.platform_path(path))
56502
db2836f65d42 improved support for external URLs, based on standard Java network operations;
wenzelm
parents: 56460
diff changeset
    57
    else if (path.is_current) dir
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    58
    else {
44615
a4ff8a787202 more abstract Document.Node.Name;
wenzelm
parents: 44580
diff changeset
    59
      val vfs = VFSManager.getVFSForPath(dir)
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    60
      if (vfs.isInstanceOf[FileVFS])
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    61
        MiscUtilities.resolveSymlinks(
60988
1d7a7e33fd67 tuned signature, according to ML version;
wenzelm
parents: 60917
diff changeset
    62
          vfs.constructPath(dir, File.platform_path(path)))
1d7a7e33fd67 tuned signature, according to ML version;
wenzelm
parents: 60917
diff changeset
    63
      else vfs.constructPath(dir, File.standard_path(path))
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    64
    }
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    65
  }
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    66
64834
wenzelm
parents: 64813
diff changeset
    67
wenzelm
parents: 64813
diff changeset
    68
  /* file content */
wenzelm
parents: 64813
diff changeset
    69
64835
fd1efd6dd385 resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
wenzelm
parents: 64834
diff changeset
    70
  def read_file_content(node_name: Document.Node.Name): Option[String] =
fd1efd6dd385 resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
wenzelm
parents: 64834
diff changeset
    71
  {
fd1efd6dd385 resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
wenzelm
parents: 64834
diff changeset
    72
    val name = node_name.node
fd1efd6dd385 resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
wenzelm
parents: 64834
diff changeset
    73
    try {
fd1efd6dd385 resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
wenzelm
parents: 64834
diff changeset
    74
      val text =
fd1efd6dd385 resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
wenzelm
parents: 64834
diff changeset
    75
        if (Url.is_wellformed(name)) Url.read(Url(name))
fd1efd6dd385 resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
wenzelm
parents: 64834
diff changeset
    76
        else File.read(new JFile(name))
fd1efd6dd385 resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
wenzelm
parents: 64834
diff changeset
    77
      Some(Symbol.decode(Line.normalize(text)))
fd1efd6dd385 resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
wenzelm
parents: 64834
diff changeset
    78
    }
fd1efd6dd385 resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
wenzelm
parents: 64834
diff changeset
    79
    catch { case ERROR(_) => None }
fd1efd6dd385 resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
wenzelm
parents: 64834
diff changeset
    80
  }
fd1efd6dd385 resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
wenzelm
parents: 64834
diff changeset
    81
56823
37be55461dbe more frugal access to theory text via Reader, reduced costs for I/O text decoding;
wenzelm
parents: 56801
diff changeset
    82
  override def with_thy_reader[A](name: Document.Node.Name, f: Reader[Char] => A): A =
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    83
  {
57612
990ffb84489b clarified module name: facilitate alternative GUI frameworks;
wenzelm
parents: 56823
diff changeset
    84
    GUI_Thread.now {
56457
eea4bbe15745 tuned signature -- prefer static type Document.Node.Name;
wenzelm
parents: 56316
diff changeset
    85
      JEdit_Lib.jedit_buffer(name) match {
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    86
        case Some(buffer) =>
56823
37be55461dbe more frugal access to theory text via Reader, reduced costs for I/O text decoding;
wenzelm
parents: 56801
diff changeset
    87
          JEdit_Lib.buffer_lock(buffer) { Some(f(JEdit_Lib.buffer_reader(buffer))) }
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    88
        case None => None
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    89
      }
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    90
    } getOrElse {
56823
37be55461dbe more frugal access to theory text via Reader, reduced costs for I/O text decoding;
wenzelm
parents: 56801
diff changeset
    91
      if (Url.is_wellformed(name.node)) f(Scan.byte_reader(Url(name.node)))
56502
db2836f65d42 improved support for external URLs, based on standard Java network operations;
wenzelm
parents: 56460
diff changeset
    92
      else {
db2836f65d42 improved support for external URLs, based on standard Java network operations;
wenzelm
parents: 56460
diff changeset
    93
        val file = new JFile(name.node)
56823
37be55461dbe more frugal access to theory text via Reader, reduced costs for I/O text decoding;
wenzelm
parents: 56801
diff changeset
    94
        if (file.isFile) f(Scan.byte_reader(file))
56502
db2836f65d42 improved support for external URLs, based on standard Java network operations;
wenzelm
parents: 56460
diff changeset
    95
        else error("No such file: " + quote(file.toString))
db2836f65d42 improved support for external URLs, based on standard Java network operations;
wenzelm
parents: 56460
diff changeset
    96
      }
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    97
    }
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    98
  }
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    99
54511
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   100
56666
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   101
  private class File_Content_Output(buffer: Buffer) extends
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   102
    ByteArrayOutputStream(buffer.getLength + 1)
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   103
  {
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   104
    def content(): Bytes = Bytes(this.buf, 0, this.count)
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   105
  }
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   106
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   107
  private class File_Content(buffer: Buffer) extends
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   108
    BufferIORequest(null, buffer, null, VFSManager.getVFSForPath(buffer.getPath), buffer.getPath)
54511
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   109
  {
56666
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   110
    def _run() { }
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   111
    def content(): Bytes =
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   112
    {
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   113
      val out = new File_Content_Output(buffer)
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   114
      write(buffer, out)
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   115
      out.content()
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   116
    }
54511
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   117
  }
55134
1b67b17cdad5 propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
wenzelm
parents: 54517
diff changeset
   118
64835
fd1efd6dd385 resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
wenzelm
parents: 64834
diff changeset
   119
  def make_file_content(buffer: Buffer): Bytes = (new File_Content(buffer)).content()
56666
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   120
55134
1b67b17cdad5 propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
wenzelm
parents: 54517
diff changeset
   121
1b67b17cdad5 propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
wenzelm
parents: 54517
diff changeset
   122
  /* theory text edits */
1b67b17cdad5 propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
wenzelm
parents: 54517
diff changeset
   123
56316
b1cf8ddc2e04 propagate deps_changed, to resolve missing files without requiring jEdit events (e.g. buffer load/save);
wenzelm
parents: 56208
diff changeset
   124
  override def commit(change: Session.Change)
b1cf8ddc2e04 propagate deps_changed, to resolve missing files without requiring jEdit events (e.g. buffer load/save);
wenzelm
parents: 56208
diff changeset
   125
  {
59319
wenzelm
parents: 59078
diff changeset
   126
    if (change.syntax_changed.nonEmpty)
59078
cf255dc2b48f more careful syntax_changed propagation -- avoid global jEdit.propertiesChanged;
wenzelm
parents: 59077
diff changeset
   127
      GUI_Thread.later {
cf255dc2b48f more careful syntax_changed propagation -- avoid global jEdit.propertiesChanged;
wenzelm
parents: 59077
diff changeset
   128
        val changed = change.syntax_changed.toSet
cf255dc2b48f more careful syntax_changed propagation -- avoid global jEdit.propertiesChanged;
wenzelm
parents: 59077
diff changeset
   129
        for {
cf255dc2b48f more careful syntax_changed propagation -- avoid global jEdit.propertiesChanged;
wenzelm
parents: 59077
diff changeset
   130
          buffer <- JEdit_Lib.jedit_buffers()
64813
7283f41d05ab manage buffer models as explicit global state;
wenzelm
parents: 64797
diff changeset
   131
          model <- Document_Model.get(buffer)
59078
cf255dc2b48f more careful syntax_changed propagation -- avoid global jEdit.propertiesChanged;
wenzelm
parents: 59077
diff changeset
   132
          if changed(model.node_name)
cf255dc2b48f more careful syntax_changed propagation -- avoid global jEdit.propertiesChanged;
wenzelm
parents: 59077
diff changeset
   133
        } model.syntax_changed()
cf255dc2b48f more careful syntax_changed propagation -- avoid global jEdit.propertiesChanged;
wenzelm
parents: 59077
diff changeset
   134
      }
60917
0607869c2ff3 more thorough reload;
wenzelm
parents: 60916
diff changeset
   135
    if (change.deps_changed ||
61023
46df28442a80 clarified undefined_blobs: already loaded theories are suppressed;
wenzelm
parents: 60988
diff changeset
   136
        PIDE.options.bool("jedit_auto_resolve") && undefined_blobs(change.version.nodes).nonEmpty)
60916
a6e2a667b0a8 resolve undefined blobs by default, e.g. relevant for ML debugger to avoid reset of breakpoints after reload;
wenzelm
parents: 60835
diff changeset
   137
      PIDE.deps_changed()
56316
b1cf8ddc2e04 propagate deps_changed, to resolve missing files without requiring jEdit events (e.g. buffer load/save);
wenzelm
parents: 56208
diff changeset
   138
  }
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
   139
}