src/Tools/jEdit/src/jedit_editor.scala
author wenzelm
Mon Mar 03 10:59:33 2014 +0100 (2014-03-03)
changeset 55877 65c9968286d5
parent 55876 142139457653
child 55878 6d092a5166f1
permissions -rw-r--r--
tuned signature;
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@52980
    25
  override def flush()
wenzelm@52974
    26
  {
wenzelm@52974
    27
    Swing_Thread.require()
wenzelm@52974
    28
wenzelm@55783
    29
    val doc_blobs = PIDE.document_blobs()
wenzelm@55783
    30
    val edits = PIDE.document_models().flatMap(_.flushed_edits(doc_blobs))
wenzelm@55783
    31
    if (!edits.isEmpty) session.update(doc_blobs, edits)
wenzelm@52974
    32
  }
wenzelm@52974
    33
wenzelm@54461
    34
  private val delay_flush =
wenzelm@54461
    35
    Swing_Thread.delay_last(PIDE.options.seconds("editor_input_delay")) { flush() }
wenzelm@54461
    36
wenzelm@54461
    37
  def invoke(): Unit = Swing_Thread.require { delay_flush.invoke() }
wenzelm@54461
    38
wenzelm@52977
    39
wenzelm@52977
    40
  /* current situation */
wenzelm@52977
    41
wenzelm@52980
    42
  override def current_context: View =
wenzelm@52971
    43
    Swing_Thread.require { jEdit.getActiveView() }
wenzelm@52971
    44
wenzelm@52980
    45
  override def current_node(view: View): Option[Document.Node.Name] =
wenzelm@52973
    46
    Swing_Thread.require { PIDE.document_model(view.getBuffer).map(_.node_name) }
wenzelm@52971
    47
wenzelm@52980
    48
  override def current_node_snapshot(view: View): Option[Document.Snapshot] =
wenzelm@52971
    49
    Swing_Thread.require { PIDE.document_model(view.getBuffer).map(_.snapshot()) }
wenzelm@52971
    50
wenzelm@52980
    51
  override def node_snapshot(name: Document.Node.Name): Document.Snapshot =
wenzelm@52974
    52
  {
wenzelm@52974
    53
    Swing_Thread.require()
wenzelm@52974
    54
wenzelm@52974
    55
    JEdit_Lib.jedit_buffer(name.node) match {
wenzelm@52974
    56
      case Some(buffer) =>
wenzelm@52974
    57
        PIDE.document_model(buffer) match {
wenzelm@52974
    58
          case Some(model) => model.snapshot
wenzelm@52974
    59
          case None => session.snapshot(name)
wenzelm@52974
    60
        }
wenzelm@52974
    61
      case None => session.snapshot(name)
wenzelm@52974
    62
    }
wenzelm@52974
    63
  }
wenzelm@52974
    64
wenzelm@53844
    65
  override def current_command(view: View, snapshot: Document.Snapshot): Option[Command] =
wenzelm@52971
    66
  {
wenzelm@52971
    67
    Swing_Thread.require()
wenzelm@52971
    68
wenzelm@54325
    69
    val text_area = view.getTextArea
wenzelm@54528
    70
    val buffer = view.getBuffer
wenzelm@54528
    71
wenzelm@54325
    72
    PIDE.document_view(text_area) match {
wenzelm@55432
    73
      case Some(doc_view) if doc_view.model.is_theory =>
wenzelm@54325
    74
        val node = snapshot.version.nodes(doc_view.model.node_name)
wenzelm@54325
    75
        val caret = snapshot.revert(text_area.getCaretPosition)
wenzelm@54528
    76
        if (caret < buffer.getLength) {
wenzelm@54325
    77
          val caret_commands = node.command_range(caret)
wenzelm@54325
    78
          if (caret_commands.hasNext) {
wenzelm@54325
    79
            val (cmd0, _) = caret_commands.next
wenzelm@54325
    80
            node.commands.reverse.iterator(cmd0).find(cmd => !cmd.is_ignored)
wenzelm@53844
    81
          }
wenzelm@54325
    82
          else None
wenzelm@54325
    83
        }
wenzelm@54325
    84
        else node.commands.reverse.iterator.find(cmd => !cmd.is_ignored)
wenzelm@55432
    85
      case _ =>
wenzelm@54528
    86
        PIDE.document_model(buffer) match {
wenzelm@54531
    87
          case Some(model) if !model.is_theory =>
wenzelm@54528
    88
            snapshot.version.nodes.thy_load_commands(model.node_name) match {
wenzelm@54528
    89
              case cmd :: _ => Some(cmd)
wenzelm@54528
    90
              case Nil => None
wenzelm@54528
    91
            }
wenzelm@54528
    92
          case _ => None
wenzelm@54528
    93
        }
wenzelm@52971
    94
    }
wenzelm@52971
    95
  }
wenzelm@52977
    96
wenzelm@52977
    97
wenzelm@52977
    98
  /* overlays */
wenzelm@52977
    99
wenzelm@52977
   100
  private var overlays = Document.Overlays.empty
wenzelm@52977
   101
wenzelm@52980
   102
  override def node_overlays(name: Document.Node.Name): Document.Node.Overlays =
wenzelm@52977
   103
    synchronized { overlays(name) }
wenzelm@52977
   104
wenzelm@52980
   105
  override def insert_overlay(command: Command, fn: String, args: List[String]): Unit =
wenzelm@52977
   106
    synchronized { overlays = overlays.insert(command, fn, args) }
wenzelm@52977
   107
wenzelm@52980
   108
  override def remove_overlay(command: Command, fn: String, args: List[String]): Unit =
wenzelm@52977
   109
    synchronized { overlays = overlays.remove(command, fn, args) }
wenzelm@52980
   110
wenzelm@52980
   111
wenzelm@55877
   112
  /* navigation */
wenzelm@52980
   113
wenzelm@55877
   114
  def goto_file(view: View, name: String, line: Int = 0, column: Int = 0)
wenzelm@52980
   115
  {
wenzelm@52980
   116
    Swing_Thread.require()
wenzelm@52980
   117
wenzelm@54706
   118
    JEdit_Lib.jedit_buffer(name) match {
wenzelm@52980
   119
      case Some(buffer) =>
wenzelm@52980
   120
        view.goToBuffer(buffer)
wenzelm@52980
   121
        val text_area = view.getTextArea
wenzelm@52980
   122
wenzelm@52980
   123
        try {
wenzelm@52980
   124
          val line_start = text_area.getBuffer.getLineStartOffset(line - 1)
wenzelm@52980
   125
          text_area.moveCaretPosition(line_start)
wenzelm@52980
   126
          if (column > 0) text_area.moveCaretPosition(line_start + column - 1)
wenzelm@52980
   127
        }
wenzelm@52980
   128
        catch {
wenzelm@52980
   129
          case _: ArrayIndexOutOfBoundsException =>
wenzelm@52980
   130
          case _: IllegalArgumentException =>
wenzelm@52980
   131
        }
wenzelm@52980
   132
wenzelm@54706
   133
      case None if (new JFile(name)).isDirectory =>
wenzelm@54706
   134
        VFSBrowser.browseDirectory(view, name)
wenzelm@54706
   135
wenzelm@52980
   136
      case None =>
wenzelm@52980
   137
        val args =
wenzelm@54706
   138
          if (line <= 0) Array(name)
wenzelm@54706
   139
          else if (column <= 0) Array(name, "+line:" + line.toInt)
wenzelm@54706
   140
          else Array(name, "+line:" + line.toInt + "," + column.toInt)
wenzelm@52980
   141
        jEdit.openFiles(view, null, args)
wenzelm@52980
   142
    }
wenzelm@52980
   143
  }
wenzelm@52980
   144
wenzelm@55877
   145
wenzelm@55877
   146
  /* hyperlinks */
wenzelm@55877
   147
wenzelm@55822
   148
  override def hyperlink_command(snapshot: Document.Snapshot, command: Command, raw_offset: Int = 0)
wenzelm@52980
   149
    : Option[Hyperlink] =
wenzelm@52980
   150
  {
wenzelm@52980
   151
    if (snapshot.is_outdated) None
wenzelm@52980
   152
    else {
wenzelm@52980
   153
      snapshot.state.find_command(snapshot.version, command.id) match {
wenzelm@52980
   154
        case None => None
wenzelm@52980
   155
        case Some((node, _)) =>
wenzelm@52980
   156
          val file_name = command.node_name.node
wenzelm@52980
   157
          val sources =
wenzelm@52980
   158
            node.commands.iterator.takeWhile(_ != command).map(_.source) ++
wenzelm@55822
   159
              (if (raw_offset == 0) Iterator.empty
wenzelm@55822
   160
               else Iterator.single(command.source(Text.Range(0, command.decode(raw_offset)))))
wenzelm@52980
   161
          val (line, column) = ((1, 1) /: sources)(Symbol.advance_line_column)
wenzelm@55877
   162
          Some(new Hyperlink { def follow(view: View) { goto_file(view, file_name, line, column) } })
wenzelm@52980
   163
      }
wenzelm@52980
   164
    }
wenzelm@52980
   165
  }
wenzelm@55876
   166
wenzelm@55876
   167
  def hyperlink_command_id(
wenzelm@55876
   168
    snapshot: Document.Snapshot,
wenzelm@55876
   169
    id: Document_ID.Generic,
wenzelm@55876
   170
    raw_offset: Text.Offset): Option[Hyperlink] =
wenzelm@55876
   171
  {
wenzelm@55876
   172
    snapshot.state.find_command(snapshot.version, id) match {
wenzelm@55876
   173
      case Some((node, command)) => hyperlink_command(snapshot, command, raw_offset)
wenzelm@55876
   174
      case None => None
wenzelm@55876
   175
    }
wenzelm@55876
   176
  }
wenzelm@55876
   177
wenzelm@55876
   178
  def hyperlink_file(name: String, line: Int = 0, column: Int = 0): Hyperlink =
wenzelm@55877
   179
    new Hyperlink { def follow(view: View) = goto_file(view, name, line, column) }
wenzelm@55876
   180
wenzelm@55876
   181
  def hyperlink_source_file(name: String, line: Int): Option[Hyperlink] =
wenzelm@55876
   182
    if (Path.is_ok(name))
wenzelm@55876
   183
      Isabelle_System.source_file(Path.explode(name)).map(path =>
wenzelm@55876
   184
        hyperlink_file(Isabelle_System.platform_path(path), line))
wenzelm@55876
   185
    else None
wenzelm@55876
   186
wenzelm@55876
   187
  def hyperlink_url(name: String): Hyperlink =
wenzelm@55876
   188
    new Hyperlink {
wenzelm@55876
   189
      def follow(view: View) =
wenzelm@55876
   190
        default_thread_pool.submit(() =>
wenzelm@55876
   191
          try { Isabelle_System.open(name) }
wenzelm@55876
   192
          catch {
wenzelm@55876
   193
            case exn: Throwable =>
wenzelm@55876
   194
              GUI.error_dialog(view, "System error", GUI.scrollable_text(Exn.message(exn)))
wenzelm@55876
   195
          })
wenzelm@55876
   196
    }
wenzelm@52971
   197
}