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