src/Tools/jEdit/src/jedit_resources.scala
author wenzelm
Sat, 29 Mar 2014 10:49:32 +0100
changeset 56316 b1cf8ddc2e04
parent 56208 06cc31dff138
child 56457 eea4bbe15745
permissions -rw-r--r--
propagate deps_changed, to resolve missing files without requiring jEdit events (e.g. buffer load/save); tuned signature;
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
54511
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
    13
import java.io.{File => JFile, IOException, 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
44963
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    16
import org.gjt.sp.jedit.io.{VFS, FileVFS, VFSFile, VFSManager}
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    17
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
    18
import org.gjt.sp.jedit.{jEdit, View, Buffer}
54511
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
    19
import org.gjt.sp.jedit.bufferio.BufferIORequest
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    20
56208
06cc31dff138 clarifed module name;
wenzelm
parents: 55134
diff changeset
    21
06cc31dff138 clarifed module name;
wenzelm
parents: 55134
diff changeset
    22
class JEdit_Resources(loaded_theories: Set[String] = Set.empty, base_syntax: Outer_Syntax)
06cc31dff138 clarifed module name;
wenzelm
parents: 55134
diff changeset
    23
  extends Resources(loaded_theories, base_syntax)
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    24
{
50566
b43c4f660320 tuned signature: use thy_load to adapt to prover/editor specific view on sources;
wenzelm
parents: 49406
diff changeset
    25
  /* document node names */
b43c4f660320 tuned signature: use thy_load to adapt to prover/editor specific view on sources;
wenzelm
parents: 49406
diff changeset
    26
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
    27
  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
    28
  {
54515
570ba266f5b5 clarified boundary cases of Document.Node.Name;
wenzelm
parents: 54511
diff changeset
    29
    val node = JEdit_Lib.buffer_name(buffer)
570ba266f5b5 clarified boundary cases of Document.Node.Name;
wenzelm
parents: 54511
diff changeset
    30
    val theory = Thy_Header.thy_name(node).getOrElse("")
570ba266f5b5 clarified boundary cases of Document.Node.Name;
wenzelm
parents: 54511
diff changeset
    31
    val master_dir = if (theory == "") "" else buffer.getDirectory
570ba266f5b5 clarified boundary cases of Document.Node.Name;
wenzelm
parents: 54511
diff changeset
    32
    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
    33
  }
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
    34
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
    35
  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
    36
  {
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
    37
    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
    38
    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
    39
  }
b43c4f660320 tuned signature: use thy_load to adapt to prover/editor specific view on sources;
wenzelm
parents: 49406
diff changeset
    40
b43c4f660320 tuned signature: use thy_load to adapt to prover/editor specific view on sources;
wenzelm
parents: 49406
diff changeset
    41
b43c4f660320 tuned signature: use thy_load to adapt to prover/editor specific view on sources;
wenzelm
parents: 49406
diff changeset
    42
  /* file-system operations */
b43c4f660320 tuned signature: use thy_load to adapt to prover/editor specific view on sources;
wenzelm
parents: 49406
diff changeset
    43
44615
a4ff8a787202 more abstract Document.Node.Name;
wenzelm
parents: 44580
diff changeset
    44
  override def append(dir: String, source_path: Path): String =
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    45
  {
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    46
    val path = source_path.expand
54517
044bee8c5e69 proper Thy_Load.append of auxiliary file names;
wenzelm
parents: 54515
diff changeset
    47
    if (dir == "" || path.is_absolute) Isabelle_System.platform_path(path)
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    48
    else {
44615
a4ff8a787202 more abstract Document.Node.Name;
wenzelm
parents: 44580
diff changeset
    49
      val vfs = VFSManager.getVFSForPath(dir)
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    50
      if (vfs.isInstanceOf[FileVFS])
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    51
        MiscUtilities.resolveSymlinks(
44615
a4ff8a787202 more abstract Document.Node.Name;
wenzelm
parents: 44580
diff changeset
    52
          vfs.constructPath(dir, Isabelle_System.platform_path(path)))
a4ff8a787202 more abstract Document.Node.Name;
wenzelm
parents: 44580
diff changeset
    53
      else vfs.constructPath(dir, Isabelle_System.standard_path(path))
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    54
    }
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    55
  }
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
    56
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    57
  override def with_thy_text[A](name: Document.Node.Name, f: CharSequence => A): A =
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    58
  {
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    59
    Swing_Thread.now {
49406
38db4832b210 somewhat more general JEdit_Lib;
wenzelm
parents: 48885
diff changeset
    60
      JEdit_Lib.jedit_buffer(name.node) match {
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    61
        case Some(buffer) =>
49406
38db4832b210 somewhat more general JEdit_Lib;
wenzelm
parents: 48885
diff changeset
    62
          JEdit_Lib.buffer_lock(buffer) {
48885
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    63
            Some(f(buffer.getSegment(0, buffer.getLength)))
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    64
          }
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    65
        case None => None
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    66
      }
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    67
    } getOrElse {
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    68
      val file = new JFile(name.node)  // FIXME load URL via jEdit VFS (!?)
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    69
      if (!file.exists || !file.isFile) error("No such file: " + quote(file.toString))
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    70
      f(File.read(file))
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    71
    }
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    72
  }
d5fdaf7dd1f8 find files via load commands within theory text;
wenzelm
parents: 48883
diff changeset
    73
44963
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    74
  def check_file(view: View, path: String): Boolean =
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    75
  {
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    76
    val vfs = VFSManager.getVFSForPath(path)
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    77
    val session = vfs.createVFSSession(path, view)
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    78
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    79
    try {
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    80
      session != null && {
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    81
        try {
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    82
          val file = vfs._getFile(session, path, view)
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    83
          file != null && file.isReadable && file.getType == VFSFile.FILE
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    84
        }
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    85
        catch { case _: IOException => false }
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    86
      }
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    87
    }
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    88
    finally {
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    89
      try { vfs._endVFSSession(session, view) }
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    90
      catch { case _: IOException => }
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    91
    }
4662dddc2fd8 explicit check_file wrt. jEdit VFS, to avoid slightly confusing empty buffer after IO error;
wenzelm
parents: 44953
diff changeset
    92
  }
54511
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
    93
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
    94
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
    95
  /* file content */
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
    96
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
    97
  def file_content(buffer: Buffer): Bytes =
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
    98
  {
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
    99
    val path = buffer.getPath
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   100
    val vfs = VFSManager.getVFSForPath(path)
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   101
    val content =
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   102
      new BufferIORequest(null, buffer, null, vfs, path) {
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   103
        def _run() { }
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   104
        def apply(): Bytes =
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   105
        {
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   106
          val out =
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   107
            new ByteArrayOutputStream(buffer.getLength + 1) {
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   108
              def content(): Bytes = Bytes(this.buf, 0, this.count)
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   109
            }
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   110
          write(buffer, out)
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   111
          out.content()
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   112
        }
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   113
      }
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   114
    content()
1fd24c96ce9b caching of blob;
wenzelm
parents: 54509
diff changeset
   115
  }
55134
1b67b17cdad5 propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
wenzelm
parents: 54517
diff changeset
   116
1b67b17cdad5 propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
wenzelm
parents: 54517
diff changeset
   117
1b67b17cdad5 propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
wenzelm
parents: 54517
diff changeset
   118
  /* theory text edits */
1b67b17cdad5 propagate update of outer syntax keywords: global propertiesChanged, buffer TokenMarker.markTokens, text area repainting;
wenzelm
parents: 54517
diff changeset
   119
56316
b1cf8ddc2e04 propagate deps_changed, to resolve missing files without requiring jEdit events (e.g. buffer load/save);
wenzelm
parents: 56208
diff changeset
   120
  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
   121
  {
b1cf8ddc2e04 propagate deps_changed, to resolve missing files without requiring jEdit events (e.g. buffer load/save);
wenzelm
parents: 56208
diff changeset
   122
    if (change.syntax_changed) Swing_Thread.later { jEdit.propertiesChanged() }
b1cf8ddc2e04 propagate deps_changed, to resolve missing files without requiring jEdit events (e.g. buffer load/save);
wenzelm
parents: 56208
diff changeset
   123
    if (change.deps_changed) PIDE.deps_changed()
b1cf8ddc2e04 propagate deps_changed, to resolve missing files without requiring jEdit events (e.g. buffer load/save);
wenzelm
parents: 56208
diff changeset
   124
  }
44577
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
   125
}
96b6388d06c4 separate module for jEdit primitives for loading theory files;
wenzelm
parents:
diff changeset
   126