src/Tools/jEdit/src/jedit_editor.scala
author wenzelm
Wed Jul 23 11:19:24 2014 +0200 (2014-07-23)
changeset 57612 990ffb84489b
parent 57611 b6256ea3b7c5
child 57615 df1b3452d71c
permissions -rw-r--r--
clarified module name: facilitate alternative GUI frameworks;
wenzelm@52971
     1
/*  Title:      Tools/jEdit/src/jedit_editor.scala
wenzelm@52971
     2
    Author:     Makarius
wenzelm@52971
     3
wenzelm@52971
     4
PIDE editor operations for jEdit.
wenzelm@52971
     5
*/
wenzelm@52971
     6
wenzelm@52971
     7
package isabelle.jedit
wenzelm@52971
     8
wenzelm@52971
     9
wenzelm@52971
    10
import isabelle._
wenzelm@52971
    11
wenzelm@52971
    12
wenzelm@54706
    13
import java.io.{File => JFile}
wenzelm@54706
    14
wenzelm@52971
    15
import org.gjt.sp.jedit.{jEdit, View}
wenzelm@54706
    16
import org.gjt.sp.jedit.browser.VFSBrowser
wenzelm@52971
    17
wenzelm@52971
    18
wenzelm@52971
    19
class JEdit_Editor extends Editor[View]
wenzelm@52971
    20
{
wenzelm@52977
    21
  /* session */
wenzelm@52977
    22
wenzelm@52980
    23
  override def session: Session = PIDE.session
wenzelm@52971
    24
wenzelm@57612
    25
  // owned by GUI thread
wenzelm@57611
    26
  private var removed_nodes = Set.empty[Document.Node.Name]
wenzelm@57611
    27
wenzelm@57611
    28
  def remove_node(name: Document.Node.Name): Unit =
wenzelm@57612
    29
    GUI_Thread.require { removed_nodes += name }
wenzelm@57611
    30
wenzelm@52980
    31
  override def flush()
wenzelm@52974
    32
  {
wenzelm@57612
    33
    GUI_Thread.require {}
wenzelm@52974
    34
wenzelm@55783
    35
    val doc_blobs = PIDE.document_blobs()
wenzelm@57611
    36
    val models = PIDE.document_models()
wenzelm@57611
    37
wenzelm@57611
    38
    val removed = removed_nodes; removed_nodes = Set.empty
wenzelm@57611
    39
    val removed_perspective =
wenzelm@57611
    40
      (removed -- models.iterator.map(_.node_name)).toList.map(
wenzelm@57611
    41
        name => (name, Document.Node.empty_perspective_text))
wenzelm@57611
    42
wenzelm@57611
    43
    val edits = models.flatMap(_.flushed_edits(doc_blobs)) ::: removed_perspective
wenzelm@55783
    44
    if (!edits.isEmpty) session.update(doc_blobs, edits)
wenzelm@52974
    45
  }
wenzelm@52974
    46
wenzelm@54461
    47
  private val delay_flush =
wenzelm@57612
    48
    GUI_Thread.delay_last(PIDE.options.seconds("editor_input_delay")) { flush() }
wenzelm@54461
    49
wenzelm@56770
    50
  def invoke(): Unit = delay_flush.invoke()
wenzelm@54461
    51
wenzelm@52977
    52
wenzelm@52977
    53
  /* current situation */
wenzelm@52977
    54
wenzelm@52980
    55
  override def current_context: View =
wenzelm@57612
    56
    GUI_Thread.require { jEdit.getActiveView() }
wenzelm@52971
    57
wenzelm@52980
    58
  override def current_node(view: View): Option[Document.Node.Name] =
wenzelm@57612
    59
    GUI_Thread.require { PIDE.document_model(view.getBuffer).map(_.node_name) }
wenzelm@52971
    60
wenzelm@52980
    61
  override def current_node_snapshot(view: View): Option[Document.Snapshot] =
wenzelm@57612
    62
    GUI_Thread.require { PIDE.document_model(view.getBuffer).map(_.snapshot()) }
wenzelm@52971
    63
wenzelm@52980
    64
  override def node_snapshot(name: Document.Node.Name): Document.Snapshot =
wenzelm@52974
    65
  {
wenzelm@57612
    66
    GUI_Thread.require {}
wenzelm@52974
    67
wenzelm@56457
    68
    JEdit_Lib.jedit_buffer(name) match {
wenzelm@52974
    69
      case Some(buffer) =>
wenzelm@52974
    70
        PIDE.document_model(buffer) match {
wenzelm@52974
    71
          case Some(model) => model.snapshot
wenzelm@52974
    72
          case None => session.snapshot(name)
wenzelm@52974
    73
        }
wenzelm@52974
    74
      case None => session.snapshot(name)
wenzelm@52974
    75
    }
wenzelm@52974
    76
  }
wenzelm@52974
    77
wenzelm@53844
    78
  override def current_command(view: View, snapshot: Document.Snapshot): Option[Command] =
wenzelm@52971
    79
  {
wenzelm@57612
    80
    GUI_Thread.require {}
wenzelm@52971
    81
wenzelm@54325
    82
    val text_area = view.getTextArea
wenzelm@54528
    83
    val buffer = view.getBuffer
wenzelm@54528
    84
wenzelm@54325
    85
    PIDE.document_view(text_area) match {
wenzelm@55432
    86
      case Some(doc_view) if doc_view.model.is_theory =>
wenzelm@54325
    87
        val node = snapshot.version.nodes(doc_view.model.node_name)
wenzelm@54325
    88
        val caret = snapshot.revert(text_area.getCaretPosition)
wenzelm@54528
    89
        if (caret < buffer.getLength) {
wenzelm@56373
    90
          val caret_command_iterator = node.command_iterator(caret)
wenzelm@56373
    91
          if (caret_command_iterator.hasNext) {
wenzelm@56373
    92
            val (cmd0, _) = caret_command_iterator.next
wenzelm@54325
    93
            node.commands.reverse.iterator(cmd0).find(cmd => !cmd.is_ignored)
wenzelm@53844
    94
          }
wenzelm@54325
    95
          else None
wenzelm@54325
    96
        }
wenzelm@54325
    97
        else node.commands.reverse.iterator.find(cmd => !cmd.is_ignored)
wenzelm@55432
    98
      case _ =>
wenzelm@54528
    99
        PIDE.document_model(buffer) match {
wenzelm@54531
   100
          case Some(model) if !model.is_theory =>
wenzelm@56314
   101
            snapshot.version.nodes.load_commands(model.node_name) match {
wenzelm@54528
   102
              case cmd :: _ => Some(cmd)
wenzelm@54528
   103
              case Nil => None
wenzelm@54528
   104
            }
wenzelm@54528
   105
          case _ => None
wenzelm@54528
   106
        }
wenzelm@52971
   107
    }
wenzelm@52971
   108
  }
wenzelm@52977
   109
wenzelm@52977
   110
wenzelm@52977
   111
  /* overlays */
wenzelm@52977
   112
wenzelm@52977
   113
  private var overlays = Document.Overlays.empty
wenzelm@52977
   114
wenzelm@52980
   115
  override def node_overlays(name: Document.Node.Name): Document.Node.Overlays =
wenzelm@52977
   116
    synchronized { overlays(name) }
wenzelm@52977
   117
wenzelm@52980
   118
  override def insert_overlay(command: Command, fn: String, args: List[String]): Unit =
wenzelm@52977
   119
    synchronized { overlays = overlays.insert(command, fn, args) }
wenzelm@52977
   120
wenzelm@52980
   121
  override def remove_overlay(command: Command, fn: String, args: List[String]): Unit =
wenzelm@52977
   122
    synchronized { overlays = overlays.remove(command, fn, args) }
wenzelm@52980
   123
wenzelm@52980
   124
wenzelm@55877
   125
  /* navigation */
wenzelm@52980
   126
wenzelm@56413
   127
  def push_position(view: View)
wenzelm@56413
   128
  {
wenzelm@56413
   129
    val navigator = jEdit.getPlugin("ise.plugin.nav.NavigatorPlugin")
wenzelm@56413
   130
    if (navigator != null) {
wenzelm@56413
   131
      try {
wenzelm@56413
   132
        val m = navigator.getClass.getDeclaredMethod("pushPosition", view.getClass)
wenzelm@56413
   133
        m.invoke(null, view)
wenzelm@56413
   134
      }
wenzelm@56413
   135
      catch { case _: NoSuchMethodException => }
wenzelm@56413
   136
    }
wenzelm@56413
   137
  }
wenzelm@56413
   138
wenzelm@55877
   139
  def goto_file(view: View, name: String, line: Int = 0, column: Int = 0)
wenzelm@52980
   140
  {
wenzelm@57612
   141
    GUI_Thread.require {}
wenzelm@52980
   142
wenzelm@56413
   143
    push_position(view)
wenzelm@56413
   144
wenzelm@54706
   145
    JEdit_Lib.jedit_buffer(name) match {
wenzelm@52980
   146
      case Some(buffer) =>
wenzelm@52980
   147
        view.goToBuffer(buffer)
wenzelm@52980
   148
        val text_area = view.getTextArea
wenzelm@52980
   149
wenzelm@52980
   150
        try {
wenzelm@52980
   151
          val line_start = text_area.getBuffer.getLineStartOffset(line - 1)
wenzelm@52980
   152
          text_area.moveCaretPosition(line_start)
wenzelm@52980
   153
          if (column > 0) text_area.moveCaretPosition(line_start + column - 1)
wenzelm@52980
   154
        }
wenzelm@52980
   155
        catch {
wenzelm@52980
   156
          case _: ArrayIndexOutOfBoundsException =>
wenzelm@52980
   157
          case _: IllegalArgumentException =>
wenzelm@52980
   158
        }
wenzelm@52980
   159
wenzelm@54706
   160
      case None if (new JFile(name)).isDirectory =>
wenzelm@54706
   161
        VFSBrowser.browseDirectory(view, name)
wenzelm@54706
   162
wenzelm@52980
   163
      case None =>
wenzelm@52980
   164
        val args =
wenzelm@54706
   165
          if (line <= 0) Array(name)
wenzelm@54706
   166
          else if (column <= 0) Array(name, "+line:" + line.toInt)
wenzelm@54706
   167
          else Array(name, "+line:" + line.toInt + "," + column.toInt)
wenzelm@52980
   168
        jEdit.openFiles(view, null, args)
wenzelm@52980
   169
    }
wenzelm@52980
   170
  }
wenzelm@52980
   171
wenzelm@55877
   172
wenzelm@55877
   173
  /* hyperlinks */
wenzelm@55877
   174
wenzelm@56461
   175
  def hyperlink_url(name: String): Hyperlink =
wenzelm@56461
   176
    new Hyperlink {
wenzelm@56494
   177
      val external = true
wenzelm@56729
   178
      def follow(view: View): Unit =
wenzelm@56729
   179
        Future.fork {
wenzelm@56461
   180
          try { Isabelle_System.open(name) }
wenzelm@56461
   181
          catch {
wenzelm@56461
   182
            case exn: Throwable =>
wenzelm@56461
   183
              GUI.error_dialog(view, "System error", GUI.scrollable_text(Exn.message(exn)))
wenzelm@56729
   184
          }
wenzelm@56729
   185
        }
wenzelm@56461
   186
      override def toString: String = "URL " + quote(name)
wenzelm@52980
   187
    }
wenzelm@55876
   188
wenzelm@55876
   189
  def hyperlink_file(name: String, line: Int = 0, column: Int = 0): Hyperlink =
wenzelm@56461
   190
    new Hyperlink {
wenzelm@56494
   191
      val external = false
wenzelm@56729
   192
      def follow(view: View): Unit = goto_file(view, name, line, column)
wenzelm@56461
   193
      override def toString: String = "file " + quote(name)
wenzelm@56461
   194
    }
wenzelm@55876
   195
wenzelm@55884
   196
  def hyperlink_source_file(source_name: String, line: Int, offset: Symbol.Offset)
wenzelm@55878
   197
    : Option[Hyperlink] =
wenzelm@55878
   198
  {
wenzelm@56458
   199
    val opt_name =
wenzelm@56458
   200
      if (Path.is_wellformed(source_name)) {
wenzelm@56458
   201
        if (Path.is_valid(source_name)) {
wenzelm@56458
   202
          val path = Path.explode(source_name)
wenzelm@56458
   203
          Some(Isabelle_System.platform_path(Isabelle_System.source_file(path) getOrElse path))
wenzelm@56458
   204
        }
wenzelm@56458
   205
        else None
wenzelm@55878
   206
      }
wenzelm@56458
   207
      else Some(source_name)
wenzelm@56458
   208
wenzelm@56458
   209
    opt_name match {
wenzelm@56458
   210
      case Some(name) =>
wenzelm@56458
   211
        JEdit_Lib.jedit_buffer(name) match {
wenzelm@56458
   212
          case Some(buffer) if offset > 0 =>
wenzelm@56458
   213
            val (line, column) =
wenzelm@56458
   214
              JEdit_Lib.buffer_lock(buffer) {
wenzelm@56458
   215
                ((1, 1) /:
wenzelm@56458
   216
                  (Symbol.iterator(JEdit_Lib.buffer_text(buffer)).
wenzelm@56458
   217
                    zipWithIndex.takeWhile(p => p._2 < offset - 1).map(_._1)))(
wenzelm@56458
   218
                      Symbol.advance_line_column)
wenzelm@56458
   219
              }
wenzelm@56458
   220
            Some(hyperlink_file(name, line, column))
wenzelm@56458
   221
          case _ => Some(hyperlink_file(name, line))
wenzelm@56458
   222
        }
wenzelm@56458
   223
      case None => None
wenzelm@55878
   224
    }
wenzelm@55878
   225
  }
wenzelm@55876
   226
wenzelm@56461
   227
  override def hyperlink_command(
wenzelm@56461
   228
    snapshot: Document.Snapshot, command: Command, offset: Symbol.Offset = 0): Option[Hyperlink] =
wenzelm@56461
   229
  {
wenzelm@56461
   230
    if (snapshot.is_outdated) None
wenzelm@56461
   231
    else {
wenzelm@56461
   232
      snapshot.state.find_command(snapshot.version, command.id) match {
wenzelm@56461
   233
        case None => None
wenzelm@56461
   234
        case Some((node, _)) =>
wenzelm@56461
   235
          val file_name = command.node_name.node
wenzelm@56461
   236
          val sources_iterator =
wenzelm@56461
   237
            node.commands.iterator.takeWhile(_ != command).map(_.source) ++
wenzelm@56461
   238
              (if (offset == 0) Iterator.empty
wenzelm@56462
   239
               else Iterator.single(command.source(Text.Range(0, command.chunk.decode(offset)))))
wenzelm@56461
   240
          val (line, column) = ((1, 1) /: sources_iterator)(Symbol.advance_line_column)
wenzelm@56461
   241
          Some(hyperlink_file(file_name, line, column))
wenzelm@56461
   242
      }
wenzelm@55876
   243
    }
wenzelm@56461
   244
  }
wenzelm@56461
   245
wenzelm@56461
   246
  def hyperlink_command_id(
wenzelm@56461
   247
    snapshot: Document.Snapshot,
wenzelm@56461
   248
    id: Document_ID.Generic,
wenzelm@56461
   249
    offset: Symbol.Offset): Option[Hyperlink] =
wenzelm@56461
   250
  {
wenzelm@56461
   251
    snapshot.state.find_command(snapshot.version, id) match {
wenzelm@56461
   252
      case Some((node, command)) => hyperlink_command(snapshot, command, offset)
wenzelm@56461
   253
      case None => None
wenzelm@56461
   254
    }
wenzelm@56461
   255
  }
wenzelm@52971
   256
}