src/Tools/jEdit/src/jedit/plugin.scala
author wenzelm
Wed Nov 10 20:21:55 2010 +0100 (2010-11-10)
changeset 40474 576b88b1dce9
parent 39741 62b91eb2d39a
child 40848 8662b9b1f123
permissions -rw-r--r--
added buffer_text convenience, with explicit locking;
wenzelm@36760
     1
/*  Title:      Tools/jEdit/src/jedit/plugin.scala
wenzelm@36760
     2
    Author:     Makarius
wenzelm@36760
     3
wenzelm@36760
     4
Main Isabelle/jEdit plugin setup.
wenzelm@36760
     5
*/
wenzelm@34407
     6
wenzelm@34318
     7
package isabelle.jedit
wenzelm@34318
     8
wenzelm@34429
     9
wenzelm@36015
    10
import isabelle._
wenzelm@36015
    11
wenzelm@34429
    12
import java.io.{FileInputStream, IOException}
wenzelm@34318
    13
import java.awt.Font
wenzelm@34318
    14
wenzelm@34497
    15
import scala.collection.mutable
wenzelm@39517
    16
import scala.swing.ComboBox
immler@34406
    17
wenzelm@39241
    18
import org.gjt.sp.jedit.{jEdit, GUIUtilities, EBMessage, EBPlugin,
wenzelm@39241
    19
  Buffer, EditPane, ServiceManager, View}
immler@34406
    20
import org.gjt.sp.jedit.buffer.JEditBuffer
wenzelm@39043
    21
import org.gjt.sp.jedit.textarea.{JEditTextArea, TextArea}
wenzelm@39633
    22
import org.gjt.sp.jedit.msg.{EditorStarted, BufferUpdate, EditPaneUpdate, PropertiesChanged}
wenzelm@37068
    23
import org.gjt.sp.jedit.gui.DockableWindowManager
wenzelm@34429
    24
wenzelm@39241
    25
import org.gjt.sp.util.Log
wenzelm@39241
    26
wenzelm@39630
    27
import scala.actors.Actor
wenzelm@39630
    28
import Actor._
wenzelm@39630
    29
wenzelm@34318
    30
wenzelm@34618
    31
object Isabelle
wenzelm@34618
    32
{
wenzelm@34784
    33
  /* plugin instance */
wenzelm@34784
    34
wenzelm@34784
    35
  var system: Isabelle_System = null
wenzelm@34784
    36
  var session: Session = null
wenzelm@34784
    37
wenzelm@34784
    38
wenzelm@34618
    39
  /* properties */
wenzelm@34618
    40
wenzelm@34618
    41
  val OPTION_PREFIX = "options.isabelle."
wenzelm@34618
    42
wenzelm@34618
    43
  object Property
wenzelm@34618
    44
  {
wenzelm@36814
    45
    def apply(name: String): String =
wenzelm@36814
    46
      jEdit.getProperty(OPTION_PREFIX + name)
wenzelm@36814
    47
    def apply(name: String, default: String): String =
wenzelm@36814
    48
      jEdit.getProperty(OPTION_PREFIX + name, default)
wenzelm@36814
    49
    def update(name: String, value: String) =
wenzelm@36814
    50
      jEdit.setProperty(OPTION_PREFIX + name, value)
wenzelm@34468
    51
  }
wenzelm@34433
    52
wenzelm@34618
    53
  object Boolean_Property
wenzelm@34618
    54
  {
wenzelm@36814
    55
    def apply(name: String): Boolean =
wenzelm@36814
    56
      jEdit.getBooleanProperty(OPTION_PREFIX + name)
wenzelm@36814
    57
    def apply(name: String, default: Boolean): Boolean =
wenzelm@36814
    58
      jEdit.getBooleanProperty(OPTION_PREFIX + name, default)
wenzelm@36814
    59
    def update(name: String, value: Boolean) =
wenzelm@36814
    60
      jEdit.setBooleanProperty(OPTION_PREFIX + name, value)
wenzelm@34618
    61
  }
wenzelm@34618
    62
wenzelm@34618
    63
  object Int_Property
wenzelm@34618
    64
  {
wenzelm@36814
    65
    def apply(name: String): Int =
wenzelm@36814
    66
      jEdit.getIntegerProperty(OPTION_PREFIX + name)
wenzelm@36814
    67
    def apply(name: String, default: Int): Int =
wenzelm@36814
    68
      jEdit.getIntegerProperty(OPTION_PREFIX + name, default)
wenzelm@36814
    69
    def update(name: String, value: Int) =
wenzelm@36814
    70
      jEdit.setIntegerProperty(OPTION_PREFIX + name, value)
wenzelm@34618
    71
  }
wenzelm@34618
    72
wenzelm@37164
    73
wenzelm@37164
    74
  /* font */
wenzelm@37164
    75
wenzelm@37164
    76
  def font_family(): String = jEdit.getProperty("view.font")
wenzelm@37164
    77
wenzelm@37019
    78
  def font_size(): Float =
wenzelm@37019
    79
    (jEdit.getIntegerProperty("view.fontsize", 16) *
wenzelm@37019
    80
      Int_Property("relative-font-size", 100)).toFloat / 100
wenzelm@36814
    81
wenzelm@34618
    82
wenzelm@39043
    83
  /* text area ranges */
wenzelm@39043
    84
wenzelm@39043
    85
  case class Gfx_Range(val x: Int, val y: Int, val length: Int)
wenzelm@39043
    86
wenzelm@39043
    87
  def gfx_range(text_area: TextArea, range: Text.Range): Option[Gfx_Range] =
wenzelm@39043
    88
  {
wenzelm@39043
    89
    val p = text_area.offsetToXY(range.start)
wenzelm@39043
    90
    val q = text_area.offsetToXY(range.stop)
wenzelm@39043
    91
    if (p != null && q != null && p.y == q.y) Some(new Gfx_Range(p.x, p.y, q.x - p.x))
wenzelm@39043
    92
    else None
wenzelm@39043
    93
  }
wenzelm@39043
    94
wenzelm@39043
    95
wenzelm@37201
    96
  /* tooltip markup */
wenzelm@37201
    97
wenzelm@37201
    98
  def tooltip(text: String): String =
wenzelm@37203
    99
    "<html><pre style=\"font-family: " + font_family() + "; font-size: " +
wenzelm@37203
   100
        Int_Property("tooltip-font-size", 10).toString + "px; \">" +  // FIXME proper scaling (!?)
wenzelm@37203
   101
      HTML.encode(text) + "</pre></html>"
wenzelm@37201
   102
wenzelm@38854
   103
  def tooltip_dismiss_delay(): Int =
wenzelm@38854
   104
    Int_Property("tooltip-dismiss-delay", 8000) max 500
wenzelm@38854
   105
wenzelm@38854
   106
  def setup_tooltips()
wenzelm@38854
   107
  {
wenzelm@38854
   108
    Swing_Thread.now {
wenzelm@38854
   109
      val manager = javax.swing.ToolTipManager.sharedInstance
wenzelm@38854
   110
      manager.setDismissDelay(tooltip_dismiss_delay())
wenzelm@38854
   111
    }
wenzelm@38854
   112
  }
wenzelm@38854
   113
wenzelm@37201
   114
wenzelm@39241
   115
  /* icons */
wenzelm@39241
   116
wenzelm@39241
   117
  def load_icon(name: String): javax.swing.Icon =
wenzelm@39241
   118
  {
wenzelm@39241
   119
    val icon = GUIUtilities.loadIcon(name)
wenzelm@39241
   120
    if (icon.getIconWidth < 0 || icon.getIconHeight < 0)
wenzelm@39630
   121
      Log.log(Log.ERROR, icon, "Bad icon: " + name)
wenzelm@39241
   122
    icon
wenzelm@39241
   123
  }
wenzelm@39241
   124
wenzelm@39241
   125
wenzelm@38221
   126
  /* main jEdit components */
wenzelm@34784
   127
wenzelm@37177
   128
  def jedit_buffers(): Iterator[Buffer] = jEdit.getBuffers().iterator
wenzelm@34784
   129
wenzelm@37177
   130
  def jedit_views(): Iterator[View] = jEdit.getViews().iterator
wenzelm@34784
   131
wenzelm@34784
   132
  def jedit_text_areas(view: View): Iterator[JEditTextArea] =
wenzelm@37177
   133
    view.getEditPanes().iterator.map(_.getTextArea)
wenzelm@34784
   134
wenzelm@34784
   135
  def jedit_text_areas(): Iterator[JEditTextArea] =
wenzelm@34784
   136
    jedit_views().flatMap(jedit_text_areas(_))
wenzelm@34784
   137
wenzelm@34784
   138
  def jedit_text_areas(buffer: JEditBuffer): Iterator[JEditTextArea] =
wenzelm@34784
   139
    jedit_text_areas().filter(_.getBuffer == buffer)
wenzelm@34784
   140
wenzelm@38843
   141
  def buffer_lock[A](buffer: JEditBuffer)(body: => A): A =
wenzelm@38640
   142
  {
wenzelm@38640
   143
    try { buffer.readLock(); body }
wenzelm@38640
   144
    finally { buffer.readUnlock() }
wenzelm@38640
   145
  }
wenzelm@38640
   146
wenzelm@38843
   147
  def swing_buffer_lock[A](buffer: JEditBuffer)(body: => A): A =
wenzelm@38843
   148
    Swing_Thread.now { buffer_lock(buffer) { body } }
wenzelm@38843
   149
wenzelm@40474
   150
  def buffer_text(buffer: JEditBuffer): String =
wenzelm@40474
   151
    buffer_lock(buffer) { buffer.getText(0, buffer.getLength) }
wenzelm@40474
   152
wenzelm@34784
   153
wenzelm@37068
   154
  /* dockable windows */
wenzelm@37068
   155
wenzelm@37068
   156
  private def wm(view: View): DockableWindowManager = view.getDockableWindowManager
wenzelm@37068
   157
wenzelm@39515
   158
  def docked_session(view: View): Option[Session_Dockable] =
wenzelm@39515
   159
    wm(view).getDockableWindow("isabelle-session") match {
wenzelm@39515
   160
      case dockable: Session_Dockable => Some(dockable)
wenzelm@39515
   161
      case _ => None
wenzelm@39515
   162
    }
wenzelm@39515
   163
wenzelm@37068
   164
  def docked_output(view: View): Option[Output_Dockable] =
wenzelm@37068
   165
    wm(view).getDockableWindow("isabelle-output") match {
wenzelm@37068
   166
      case dockable: Output_Dockable => Some(dockable)
wenzelm@37068
   167
      case _ => None
wenzelm@37068
   168
    }
wenzelm@37068
   169
wenzelm@37068
   170
  def docked_raw_output(view: View): Option[Raw_Output_Dockable] =
wenzelm@37068
   171
    wm(view).getDockableWindow("isabelle-raw-output") match {
wenzelm@37068
   172
      case dockable: Raw_Output_Dockable => Some(dockable)
wenzelm@37068
   173
      case _ => None
wenzelm@37068
   174
    }
wenzelm@37068
   175
wenzelm@37068
   176
  def docked_protocol(view: View): Option[Protocol_Dockable] =
wenzelm@37068
   177
    wm(view).getDockableWindow("isabelle-protocol") match {
wenzelm@37068
   178
      case dockable: Protocol_Dockable => Some(dockable)
wenzelm@37068
   179
      case _ => None
wenzelm@37068
   180
    }
wenzelm@37068
   181
wenzelm@37068
   182
wenzelm@39517
   183
  /* logic image */
wenzelm@39517
   184
wenzelm@39517
   185
  def default_logic(): String =
wenzelm@39517
   186
  {
wenzelm@39517
   187
    val logic = system.getenv("JEDIT_LOGIC")
wenzelm@39517
   188
    if (logic != "") logic
wenzelm@39517
   189
    else system.getenv_strict("ISABELLE_LOGIC")
wenzelm@39517
   190
  }
wenzelm@39517
   191
wenzelm@39517
   192
  class Logic_Entry(val name: String, val description: String)
wenzelm@39517
   193
  {
wenzelm@39517
   194
    override def toString = description
wenzelm@39517
   195
  }
wenzelm@39517
   196
wenzelm@39517
   197
  def logic_selector(logic: String): ComboBox[Logic_Entry] =
wenzelm@39517
   198
  {
wenzelm@39517
   199
    val entries =
wenzelm@39517
   200
      new Logic_Entry("", "default (" + default_logic() + ")") ::
wenzelm@39517
   201
        system.find_logics().map(name => new Logic_Entry(name, name))
wenzelm@39517
   202
    val component = new ComboBox(entries)
wenzelm@39517
   203
    entries.find(_.name == logic) match {
wenzelm@39517
   204
      case None =>
wenzelm@39517
   205
      case Some(entry) => component.selection.item = entry
wenzelm@39517
   206
    }
wenzelm@39702
   207
    component.tooltip = "Isabelle logic image"
wenzelm@39517
   208
    component
wenzelm@39517
   209
  }
wenzelm@39702
   210
wenzelm@39702
   211
  def start_session()
wenzelm@39702
   212
  {
wenzelm@39702
   213
    val timeout = Int_Property("startup-timeout") max 1000
wenzelm@39702
   214
    val modes = system.getenv("JEDIT_PRINT_MODE").split(",").toList.map("-m" + _)
wenzelm@39702
   215
    val logic = {
wenzelm@39702
   216
      val logic = Property("logic")
wenzelm@39702
   217
      if (logic != null && logic != "") logic
wenzelm@39702
   218
      else Isabelle.default_logic()
wenzelm@39702
   219
    }
wenzelm@39702
   220
    session.start(timeout, modes ::: List(logic))
wenzelm@39702
   221
  }
wenzelm@34318
   222
}
wenzelm@34318
   223
wenzelm@34429
   224
wenzelm@34618
   225
class Plugin extends EBPlugin
wenzelm@34618
   226
{
wenzelm@39630
   227
  /* session management */
wenzelm@39630
   228
wenzelm@39735
   229
  private def init_model(buffer: Buffer)
wenzelm@39630
   230
  {
wenzelm@39630
   231
    Isabelle.swing_buffer_lock(buffer) {
wenzelm@39735
   232
      val opt_model =
wenzelm@39735
   233
        Document_Model(buffer) match {
wenzelm@39735
   234
          case Some(model) => model.refresh; Some(model)
wenzelm@39735
   235
          case None =>
wenzelm@39735
   236
            Thy_Header.split_thy_path(Isabelle.system.posix_path(buffer.getPath)) match {
wenzelm@39735
   237
              case Some((_, thy_name)) =>
wenzelm@39735
   238
                Some(Document_Model.init(Isabelle.session, buffer, thy_name))
wenzelm@39735
   239
              case None => None
wenzelm@39735
   240
            }
wenzelm@39735
   241
        }
wenzelm@39735
   242
      if (opt_model.isDefined) {
wenzelm@39735
   243
        for (text_area <- Isabelle.jedit_text_areas(buffer)) {
wenzelm@39735
   244
          if (Document_View(text_area).map(_.model) != opt_model)
wenzelm@39735
   245
            Document_View.init(opt_model.get, text_area)
wenzelm@39735
   246
        }
wenzelm@39630
   247
      }
wenzelm@39630
   248
    }
wenzelm@39630
   249
  }
wenzelm@39630
   250
wenzelm@39735
   251
  private def exit_model(buffer: Buffer)
wenzelm@39630
   252
  {
wenzelm@39630
   253
    Isabelle.swing_buffer_lock(buffer) {
wenzelm@39637
   254
      Isabelle.jedit_text_areas(buffer).foreach(Document_View.exit)
wenzelm@39637
   255
      Document_Model.exit(buffer)
wenzelm@39630
   256
    }
wenzelm@39630
   257
  }
wenzelm@39630
   258
wenzelm@39735
   259
  private case class Init_Model(buffer: Buffer)
wenzelm@39735
   260
  private case class Exit_Model(buffer: Buffer)
wenzelm@39741
   261
  private case class Init_View(buffer: Buffer, text_area: JEditTextArea)
wenzelm@39741
   262
  private case class Exit_View(buffer: Buffer, text_area: JEditTextArea)
wenzelm@39735
   263
wenzelm@39633
   264
  private val session_manager = actor {
wenzelm@39735
   265
    var ready = false
wenzelm@39633
   266
    loop {
wenzelm@39633
   267
      react {
wenzelm@39735
   268
        case phase: Session.Phase =>
wenzelm@39735
   269
          ready = phase == Session.Ready
wenzelm@39735
   270
          phase match {
wenzelm@39735
   271
            case Session.Failed =>
wenzelm@39735
   272
              Swing_Thread.now {
wenzelm@39735
   273
                val text = new scala.swing.TextArea(Isabelle.session.syslog())
wenzelm@39735
   274
                text.editable = false
wenzelm@39735
   275
                Library.error_dialog(jEdit.getActiveView, "Failed to start Isabelle process", text)
wenzelm@39735
   276
              }
wenzelm@39735
   277
wenzelm@39735
   278
            case Session.Ready => Isabelle.jedit_buffers.foreach(init_model)
wenzelm@39735
   279
            case Session.Shutdown => Isabelle.jedit_buffers.foreach(exit_model)
wenzelm@39735
   280
            case _ =>
wenzelm@39735
   281
          }
wenzelm@39735
   282
wenzelm@39735
   283
        case Init_Model(buffer) =>
wenzelm@39735
   284
          if (ready) init_model(buffer)
wenzelm@39630
   285
wenzelm@39735
   286
        case Exit_Model(buffer) =>
wenzelm@39735
   287
          exit_model(buffer)
wenzelm@39735
   288
wenzelm@39735
   289
        case Init_View(buffer, text_area) =>
wenzelm@39735
   290
          if (ready) {
wenzelm@39735
   291
            Isabelle.swing_buffer_lock(buffer) {
wenzelm@39735
   292
              Document_Model(buffer) match {
wenzelm@39735
   293
                case Some(model) => Document_View.init(model, text_area)
wenzelm@39735
   294
                case None =>
wenzelm@39735
   295
              }
wenzelm@39735
   296
            }
wenzelm@39735
   297
          }
wenzelm@39735
   298
wenzelm@39735
   299
        case Exit_View(buffer, text_area) =>
wenzelm@39735
   300
          Isabelle.swing_buffer_lock(buffer) {
wenzelm@39735
   301
            Document_View.exit(text_area)
wenzelm@39735
   302
          }
wenzelm@39735
   303
wenzelm@39735
   304
        case bad => System.err.println("session_manager: ignoring bad message " + bad)
wenzelm@39630
   305
      }
wenzelm@39630
   306
    }
wenzelm@39630
   307
  }
wenzelm@39630
   308
wenzelm@39630
   309
wenzelm@34618
   310
  /* main plugin plumbing */
wenzelm@34433
   311
wenzelm@34767
   312
  override def handleMessage(message: EBMessage)
wenzelm@34618
   313
  {
wenzelm@34767
   314
    message match {
wenzelm@39702
   315
      case msg: EditorStarted
wenzelm@39702
   316
      if Isabelle.Boolean_Property("auto-start") => Isabelle.start_session()
wenzelm@39630
   317
wenzelm@37557
   318
      case msg: BufferUpdate
wenzelm@39735
   319
      if msg.getWhat == BufferUpdate.PROPERTIES_CHANGED =>
wenzelm@39634
   320
wenzelm@39633
   321
        val buffer = msg.getBuffer
wenzelm@39735
   322
        if (buffer != null) session_manager ! Init_Model(buffer)
wenzelm@37557
   323
wenzelm@39634
   324
      case msg: EditPaneUpdate
wenzelm@39735
   325
      if (msg.getWhat == EditPaneUpdate.BUFFER_CHANGING ||
wenzelm@39637
   326
          msg.getWhat == EditPaneUpdate.BUFFER_CHANGED ||
wenzelm@39634
   327
          msg.getWhat == EditPaneUpdate.CREATED ||
wenzelm@39634
   328
          msg.getWhat == EditPaneUpdate.DESTROYED) =>
wenzelm@39634
   329
wenzelm@34784
   330
        val edit_pane = msg.getEditPane
wenzelm@34784
   331
        val buffer = edit_pane.getBuffer
wenzelm@34784
   332
        val text_area = edit_pane.getTextArea
wenzelm@34784
   333
wenzelm@39637
   334
        if (buffer != null && text_area != null) {
wenzelm@39735
   335
          if (msg.getWhat == EditPaneUpdate.BUFFER_CHANGED ||
wenzelm@39735
   336
              msg.getWhat == EditPaneUpdate.CREATED)
wenzelm@39735
   337
            session_manager ! Init_View(buffer, text_area)
wenzelm@39735
   338
          else
wenzelm@39735
   339
            session_manager ! Exit_View(buffer, text_area)
immler@34671
   340
        }
wenzelm@34784
   341
wenzelm@34777
   342
      case msg: PropertiesChanged =>
wenzelm@37241
   343
        Swing_Thread.now {
wenzelm@39630
   344
          Isabelle.setup_tooltips()
wenzelm@37241
   345
          for (text_area <- Isabelle.jedit_text_areas if Document_View(text_area).isDefined)
wenzelm@37241
   346
            Document_View(text_area).get.extend_styles()
wenzelm@37241
   347
        }
wenzelm@34791
   348
        Isabelle.session.global_settings.event(Session.Global_Settings)
wenzelm@34784
   349
wenzelm@34318
   350
      case _ =>
wenzelm@34318
   351
    }
wenzelm@34318
   352
  }
wenzelm@34318
   353
wenzelm@34618
   354
  override def start()
wenzelm@34618
   355
  {
wenzelm@39630
   356
    Isabelle.setup_tooltips()
wenzelm@34615
   357
    Isabelle.system = new Isabelle_System
wenzelm@34774
   358
    Isabelle.system.install_fonts()
wenzelm@39628
   359
    Isabelle.session = new Session(Isabelle.system)
wenzelm@39633
   360
    Isabelle.session.phase_changed += session_manager
wenzelm@34318
   361
  }
wenzelm@34618
   362
wenzelm@39628
   363
  override def stop()
wenzelm@34618
   364
  {
wenzelm@39628
   365
    Isabelle.session.stop()
wenzelm@39633
   366
    Isabelle.session.phase_changed -= session_manager
wenzelm@34318
   367
  }
wenzelm@34318
   368
}