src/Tools/jEdit/src/jedit_resources.scala
author wenzelm
Mon, 02 Jan 2023 12:29:08 +0100
changeset 76860 f95ed5a0600c
parent 76858 39db5e268aaf
child 76864 56c926de7ea6
permissions -rw-r--r--
clarified signature: uniform master_dir instead of separate field;
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
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73340
diff changeset
    24
object JEdit_Resources {
66572
1e5ae735e026 tolerate errors in session structure, although this may lead to confusion about theory imports later on;
wenzelm
parents: 66195
diff changeset
    25
  def apply(options: Options): JEdit_Resources =
76656
a8f452f7c503 clarified names;
wenzelm
parents: 76601
diff changeset
    26
    new JEdit_Resources(JEdit_Sessions.session_background(options))
66572
1e5ae735e026 tolerate errors in session structure, although this may lead to confusion about theory imports later on;
wenzelm
parents: 66195
diff changeset
    27
}
1e5ae735e026 tolerate errors in session structure, although this may lead to confusion about theory imports later on;
wenzelm
parents: 66195
diff changeset
    28
76657
a8d85b4a588c clarified signature;
wenzelm
parents: 76656
diff changeset
    29
class JEdit_Resources private(session_background: Sessions.Background)
a8d85b4a588c clarified signature;
wenzelm
parents: 76656
diff changeset
    30
extends Resources(session_background) {
64834
wenzelm
parents: 64813
diff changeset
    31
  /* document node name */
50566
b43c4f660320 tuned signature: use thy_load to adapt to prover/editor specific view on sources;
wenzelm
parents: 49406
diff changeset
    32
64841
d53696aed874 added node_name(String): imitate jEdit buffer operations;
wenzelm
parents: 64837
diff changeset
    33
  def node_name(path: String): Document.Node.Name =
71601
97ccf48c2f0c misc tuning based on hints by IntelliJ IDEA;
wenzelm
parents: 70718
diff changeset
    34
    JEdit_Lib.check_file(path).flatMap(find_theory) getOrElse {
65501
b42743f5b595 prefer formal name from session context, for proper qualified theory name;
wenzelm
parents: 65476
diff changeset
    35
      val vfs = VFSManager.getVFSForPath(path)
b42743f5b595 prefer formal name from session context, for proper qualified theory name;
wenzelm
parents: 65476
diff changeset
    36
      val node = if (vfs.isInstanceOf[FileVFS]) MiscUtilities.resolveSymlinks(path) else path
67104
a2fa0c6a7aff clarified theory_name vs. loaded_theory: proper import_name for already loaded theories from other sessions (amending 4c98c929a12a);
wenzelm
parents: 66973
diff changeset
    37
      val theory = theory_name(Sessions.DRAFT, Thy_Header.theory_name(node))
76845
81848d12aba3 clarified modules;
wenzelm
parents: 76843
diff changeset
    38
      if (session_base.loaded_theory(theory)) Document.Node.Name.loaded_theory(theory)
76860
f95ed5a0600c clarified signature: uniform master_dir instead of separate field;
wenzelm
parents: 76858
diff changeset
    39
      else Document.Node.Name(node, theory = theory)
65472
wenzelm
parents: 65471
diff changeset
    40
    }
64841
d53696aed874 added node_name(String): imitate jEdit buffer operations;
wenzelm
parents: 64837
diff changeset
    41
65469
78ace4a14975 more explicit jEdit file operations;
wenzelm
parents: 65452
diff changeset
    42
  def node_name(buffer: Buffer): Document.Node.Name =
78ace4a14975 more explicit jEdit file operations;
wenzelm
parents: 65452
diff changeset
    43
    node_name(JEdit_Lib.buffer_name(buffer))
64858
e31cf6eaecb8 update File_Model based on file-system events;
wenzelm
parents: 64856
diff changeset
    44
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73340
diff changeset
    45
  def theory_node_name(buffer: Buffer): Option[Document.Node.Name] = {
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
    46
    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
    47
    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
    48
  }
b43c4f660320 tuned signature: use thy_load to adapt to prover/editor specific view on sources;
wenzelm
parents: 49406
diff changeset
    49
76739
cb72b5996520 proper migrate_name between different kinds of Resources, notably for Windows;
wenzelm
parents: 76662
diff changeset
    50
  override def migrate_name(standard_name: Document.Node.Name): Document.Node.Name =
cb72b5996520 proper migrate_name between different kinds of Resources, notably for Windows;
wenzelm
parents: 76662
diff changeset
    51
    node_name(File.platform_path(Path.explode(standard_name.node).canonical))
cb72b5996520 proper migrate_name between different kinds of Resources, notably for Windows;
wenzelm
parents: 76662
diff changeset
    52
76858
39db5e268aaf tuned signature, following Url.append_path;
wenzelm
parents: 76845
diff changeset
    53
  override def append_path(dir: String, source_path: Path): String = {
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    54
    val path = source_path.expand
76596
wenzelm
parents: 76590
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))
76596
wenzelm
parents: 76590
diff changeset
    57
    }
56502
db2836f65d42 improved support for external URLs, based on standard Java network operations;
wenzelm
parents: 56460
diff changeset
    58
    else if (path.is_current) dir
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    59
    else {
44615
a4ff8a787202 more abstract Document.Node.Name;
wenzelm
parents: 44580
diff changeset
    60
      val vfs = VFSManager.getVFSForPath(dir)
76596
wenzelm
parents: 76590
diff changeset
    61
      if (vfs.isInstanceOf[FileVFS]) {
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    62
        MiscUtilities.resolveSymlinks(
60988
1d7a7e33fd67 tuned signature, according to ML version;
wenzelm
parents: 60917
diff changeset
    63
          vfs.constructPath(dir, File.platform_path(path)))
76596
wenzelm
parents: 76590
diff changeset
    64
      }
60988
1d7a7e33fd67 tuned signature, according to ML version;
wenzelm
parents: 60917
diff changeset
    65
      else vfs.constructPath(dir, File.standard_path(path))
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    66
    }
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    67
  }
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    68
64834
wenzelm
parents: 64813
diff changeset
    69
wenzelm
parents: 64813
diff changeset
    70
  /* file content */
wenzelm
parents: 64813
diff changeset
    71
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73340
diff changeset
    72
  def read_file_content(node_name: Document.Node.Name): Option[String] = {
69255
800b1ce96fce more general support for Isabelle/PIDE file formats -- less hardwired Bibtex operations;
wenzelm
parents: 67290
diff changeset
    73
    make_theory_content(node_name) orElse {
67290
98b6cd12f963 implicit thy_load context for bibtex files;
wenzelm
parents: 67104
diff changeset
    74
      val name = node_name.node
98b6cd12f963 implicit thy_load context for bibtex files;
wenzelm
parents: 67104
diff changeset
    75
      try {
98b6cd12f963 implicit thy_load context for bibtex files;
wenzelm
parents: 67104
diff changeset
    76
        val text =
76662
762406d791f4 tuned signature;
wenzelm
parents: 76657
diff changeset
    77
          if (Url.is_wellformed(name)) Url.read(name)
67290
98b6cd12f963 implicit thy_load context for bibtex files;
wenzelm
parents: 67104
diff changeset
    78
          else File.read(new JFile(name))
98b6cd12f963 implicit thy_load context for bibtex files;
wenzelm
parents: 67104
diff changeset
    79
        Some(Symbol.decode(Line.normalize(text)))
98b6cd12f963 implicit thy_load context for bibtex files;
wenzelm
parents: 67104
diff changeset
    80
      }
98b6cd12f963 implicit thy_load context for bibtex files;
wenzelm
parents: 67104
diff changeset
    81
      catch { case ERROR(_) => None }
64835
fd1efd6dd385 resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
wenzelm
parents: 64834
diff changeset
    82
    }
fd1efd6dd385 resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
wenzelm
parents: 64834
diff changeset
    83
  }
fd1efd6dd385 resolve dependencies implicitly via File_Model, without jEdit Buffer_Model;
wenzelm
parents: 64834
diff changeset
    84
64841
d53696aed874 added node_name(String): imitate jEdit buffer operations;
wenzelm
parents: 64837
diff changeset
    85
  def get_file_content(node_name: Document.Node.Name): Option[String] =
76768
40c8275f0131 tuned signature: follow terminology of VSCode_Resources;
wenzelm
parents: 76739
diff changeset
    86
    Document_Model.get_model(node_name) match {
64841
d53696aed874 added node_name(String): imitate jEdit buffer operations;
wenzelm
parents: 64837
diff changeset
    87
      case Some(model: Buffer_Model) => Some(JEdit_Lib.buffer_text(model.buffer))
d53696aed874 added node_name(String): imitate jEdit buffer operations;
wenzelm
parents: 64837
diff changeset
    88
      case Some(model: File_Model) => Some(model.content.text)
d53696aed874 added node_name(String): imitate jEdit buffer operations;
wenzelm
parents: 64837
diff changeset
    89
      case None => read_file_content(node_name)
d53696aed874 added node_name(String): imitate jEdit buffer operations;
wenzelm
parents: 64837
diff changeset
    90
    }
d53696aed874 added node_name(String): imitate jEdit buffer operations;
wenzelm
parents: 64837
diff changeset
    91
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73340
diff changeset
    92
  override def with_thy_reader[A](name: Document.Node.Name, f: Reader[Char] => A): A = {
57612
990ffb84489b clarified module name: facilitate alternative GUI frameworks;
wenzelm
parents: 56823
diff changeset
    93
    GUI_Thread.now {
76768
40c8275f0131 tuned signature: follow terminology of VSCode_Resources;
wenzelm
parents: 76739
diff changeset
    94
      Document_Model.get_model(name) match {
64841
d53696aed874 added node_name(String): imitate jEdit buffer operations;
wenzelm
parents: 64837
diff changeset
    95
        case Some(model: Buffer_Model) =>
d53696aed874 added node_name(String): imitate jEdit buffer operations;
wenzelm
parents: 64837
diff changeset
    96
          JEdit_Lib.buffer_lock(model.buffer) { Some(f(JEdit_Lib.buffer_reader(model.buffer))) }
d53696aed874 added node_name(String): imitate jEdit buffer operations;
wenzelm
parents: 64837
diff changeset
    97
        case Some(model: File_Model) => Some(f(Scan.char_reader(model.content.text)))
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    98
        case None => None
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    99
      }
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
   100
    } getOrElse {
56823
37be55461dbe more frugal access to theory text via Reader, reduced costs for I/O text decoding;
wenzelm
parents: 56801
diff changeset
   101
      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
   102
      else {
db2836f65d42 improved support for external URLs, based on standard Java network operations;
wenzelm
parents: 56460
diff changeset
   103
        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
   104
        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
   105
        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
   106
      }
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
   107
    }
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
   108
  }
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
   109
54511
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   110
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73340
diff changeset
   111
  private class File_Content_Output(buffer: Buffer)
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73340
diff changeset
   112
  extends ByteArrayOutputStream(buffer.getLength + 1) {
56666
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   113
    def content(): Bytes = Bytes(this.buf, 0, this.count)
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   114
  }
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   115
76780
563939d75770 tuned signature: avoid name confusion;
wenzelm
parents: 76768
diff changeset
   116
  private class File_Content_Request(buffer: Buffer)
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73340
diff changeset
   117
  extends BufferIORequest(null, buffer, null, VFSManager.getVFSForPath(buffer.getPath), buffer.getPath) {
73340
0ffcad1f6130 tuned --- fewer warnings;
wenzelm
parents: 71601
diff changeset
   118
    def _run(): Unit = {}
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73340
diff changeset
   119
    def content(): Bytes = {
56666
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   120
      val out = new File_Content_Output(buffer)
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   121
      write(buffer, out)
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   122
      out.content()
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   123
    }
54511
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   124
  }
55134
1b67b17cdad5 propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
wenzelm
parents: 54517
diff changeset
   125
76780
563939d75770 tuned signature: avoid name confusion;
wenzelm
parents: 76768
diff changeset
   126
  def make_file_content(buffer: Buffer): Bytes = (new File_Content_Request(buffer)).content()
56666
229309cbc508 avoid accidental use of scala.language.reflectiveCalls;
wenzelm
parents: 56502
diff changeset
   127
55134
1b67b17cdad5 propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
wenzelm
parents: 54517
diff changeset
   128
1b67b17cdad5 propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
wenzelm
parents: 54517
diff changeset
   129
  /* theory text edits */
1b67b17cdad5 propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
wenzelm
parents: 54517
diff changeset
   130
76601
wenzelm
parents: 76596
diff changeset
   131
  def auto_resolve: Boolean = PIDE.options.bool("jedit_auto_resolve")
wenzelm
parents: 76596
diff changeset
   132
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73340
diff changeset
   133
  override def commit(change: Session.Change): Unit = {
76596
wenzelm
parents: 76590
diff changeset
   134
    if (change.syntax_changed.nonEmpty) {
64836
wenzelm
parents: 64835
diff changeset
   135
      GUI_Thread.later { Document_Model.syntax_changed(change.syntax_changed) }
76596
wenzelm
parents: 76590
diff changeset
   136
    }
76601
wenzelm
parents: 76596
diff changeset
   137
    if (change.deps_changed || auto_resolve && undefined_blobs(change.version).nonEmpty) {
65243
ba5ce07e06a7 proper plugin access;
wenzelm
parents: 64858
diff changeset
   138
      PIDE.plugin.deps_changed()
76596
wenzelm
parents: 76590
diff changeset
   139
    }
56316
b1cf8ddc2e04 propagate deps_changed, to resolve missing files without requiring jEdit events (e.g. buffer load/save);
wenzelm
parents: 56208
diff changeset
   140
  }
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
   141
}