src/Tools/jEdit/src/plugin.scala
author wenzelm
Thu Feb 27 21:02:09 2014 +0100 (2014-02-27)
changeset 55791 5821b1937fa5
parent 55784 9b243afbbe83
child 56208 06cc31dff138
permissions -rw-r--r--
clarified init_models: simultaneous initialization of all document models, before flushing edits by regular means (via PIDE.editor.invoke) -- important for consolidated doc_blobs when determining initial edits;
clarified asynchronous event propagation: determine buffers where they are actually accessed;
tuned signature;
wenzelm@43282
     1
/*  Title:      Tools/jEdit/src/plugin.scala
wenzelm@36760
     2
    Author:     Makarius
wenzelm@36760
     3
wenzelm@50362
     4
Main plumbing for PIDE infrastructure as jEdit plugin.
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@44573
    12
import javax.swing.JOptionPane
wenzelm@34318
    13
wenzelm@49246
    14
import scala.swing.{ListView, ScrollPane}
immler@34406
    15
wenzelm@50709
    16
import org.gjt.sp.jedit.{jEdit, EBMessage, EBPlugin, Buffer, View, Debug}
wenzelm@53487
    17
import org.jedit.options.CombinedOptions
wenzelm@53487
    18
import org.gjt.sp.jedit.gui.AboutDialog
wenzelm@39043
    19
import org.gjt.sp.jedit.textarea.{JEditTextArea, TextArea}
wenzelm@50362
    20
import org.gjt.sp.jedit.syntax.ModeProvider
wenzelm@49100
    21
import org.gjt.sp.jedit.msg.{EditorStarted, BufferUpdate, EditPaneUpdate, PropertiesChanged}
wenzelm@34429
    22
wenzelm@43443
    23
import org.gjt.sp.util.SyntaxUtilities
wenzelm@39241
    24
wenzelm@44721
    25
import scala.actors.Actor._
wenzelm@39630
    26
wenzelm@34318
    27
wenzelm@50205
    28
object PIDE
wenzelm@34618
    29
{
wenzelm@34784
    30
  /* plugin instance */
wenzelm@34784
    31
wenzelm@49245
    32
  val options = new JEdit_Options
wenzelm@53337
    33
  val completion_history = new Completion.History_Variable
wenzelm@49245
    34
wenzelm@49099
    35
  @volatile var startup_failure: Option[Throwable] = None
wenzelm@49099
    36
  @volatile var startup_notified = false
wenzelm@34784
    37
wenzelm@49101
    38
  @volatile var plugin: Plugin = null
wenzelm@49101
    39
  @volatile var session: Session = new Session(new JEdit_Thy_Load(Set.empty, Outer_Syntax.empty))
wenzelm@49101
    40
wenzelm@55791
    41
  def options_changed() { plugin.options_changed() }
wenzelm@52815
    42
wenzelm@48870
    43
  def thy_load(): JEdit_Thy_Load =
wenzelm@48870
    44
    session.thy_load.asInstanceOf[JEdit_Thy_Load]
wenzelm@44955
    45
wenzelm@52971
    46
  lazy val editor = new JEdit_Editor
wenzelm@52971
    47
wenzelm@34784
    48
wenzelm@53244
    49
  /* popups */
wenzelm@53244
    50
wenzelm@53244
    51
  def dismissed_popups(view: View): Boolean =
wenzelm@53244
    52
  {
wenzelm@53272
    53
    var dismissed = false
wenzelm@53272
    54
wenzelm@53274
    55
    JEdit_Lib.jedit_text_areas(view).foreach(text_area =>
wenzelm@53274
    56
      if (Completion_Popup.Text_Area.dismissed(text_area)) dismissed = true)
wenzelm@53272
    57
wenzelm@53272
    58
    if (Pretty_Tooltip.dismissed_all()) dismissed = true
wenzelm@53272
    59
wenzelm@53272
    60
    dismissed
wenzelm@53244
    61
  }
wenzelm@53244
    62
wenzelm@53244
    63
wenzelm@43449
    64
  /* document model and view */
wenzelm@43449
    65
wenzelm@43449
    66
  def document_model(buffer: Buffer): Option[Document_Model] = Document_Model(buffer)
wenzelm@53274
    67
wenzelm@55712
    68
  def document_view(text_area: TextArea): Option[Document_View] = Document_View(text_area)
wenzelm@43449
    69
wenzelm@44379
    70
  def document_views(buffer: Buffer): List[Document_View] =
wenzelm@44379
    71
    for {
wenzelm@49406
    72
      text_area <- JEdit_Lib.jedit_text_areas(buffer).toList
wenzelm@54529
    73
      doc_view <- document_view(text_area)
wenzelm@54529
    74
    } yield doc_view
wenzelm@44379
    75
wenzelm@54522
    76
  def document_models(): List[Document_Model] =
wenzelm@54522
    77
    for {
wenzelm@54522
    78
      buffer <- JEdit_Lib.jedit_buffers().toList
wenzelm@54522
    79
      model <- document_model(buffer)
wenzelm@54522
    80
    } yield model
wenzelm@54522
    81
wenzelm@54522
    82
  def document_blobs(): Document.Blobs =
wenzelm@55783
    83
    Document.Blobs(
wenzelm@55783
    84
      (for {
wenzelm@55783
    85
        buffer <- JEdit_Lib.jedit_buffers()
wenzelm@55783
    86
        model <- document_model(buffer)
wenzelm@55783
    87
        blob <- model.get_blob()
wenzelm@55783
    88
      } yield (model.node_name -> blob)).toMap)
wenzelm@54522
    89
wenzelm@50344
    90
  def exit_models(buffers: List[Buffer])
wenzelm@47058
    91
  {
wenzelm@50344
    92
    Swing_Thread.now {
wenzelm@54461
    93
      PIDE.editor.flush()
wenzelm@50344
    94
      buffers.foreach(buffer =>
wenzelm@50344
    95
        JEdit_Lib.buffer_lock(buffer) {
wenzelm@50344
    96
          JEdit_Lib.jedit_text_areas(buffer).foreach(Document_View.exit)
wenzelm@50344
    97
          Document_Model.exit(buffer)
wenzelm@50344
    98
        })
wenzelm@50344
    99
      }
wenzelm@47058
   100
  }
wenzelm@47058
   101
wenzelm@55791
   102
  def init_models()
wenzelm@43510
   103
  {
wenzelm@50344
   104
    Swing_Thread.now {
wenzelm@54461
   105
      PIDE.editor.flush()
wenzelm@55791
   106
wenzelm@55791
   107
      for {
wenzelm@55791
   108
        buffer <- JEdit_Lib.jedit_buffers()
wenzelm@55791
   109
        if buffer != null && !buffer.isLoading && !buffer.getBooleanProperty(Buffer.GZIPPED)
wenzelm@55791
   110
      } {
wenzelm@55791
   111
        JEdit_Lib.buffer_lock(buffer) {
wenzelm@55791
   112
          val node_name = thy_load.node_name(buffer)
wenzelm@55791
   113
          val model =
wenzelm@55791
   114
            document_model(buffer) match {
wenzelm@55791
   115
              case Some(model) if model.node_name == node_name => model
wenzelm@55791
   116
              case _ => Document_Model.init(session, buffer, node_name)
wenzelm@43510
   117
            }
wenzelm@55791
   118
          for {
wenzelm@55791
   119
            text_area <- JEdit_Lib.jedit_text_areas(buffer)
wenzelm@55791
   120
            if document_view(text_area).map(_.model) != Some(model)
wenzelm@55791
   121
          } Document_View.init(model, text_area)
wenzelm@43510
   122
        }
wenzelm@55791
   123
      }
wenzelm@55791
   124
wenzelm@55791
   125
      PIDE.editor.invoke()
wenzelm@43510
   126
    }
wenzelm@43510
   127
  }
wenzelm@43510
   128
wenzelm@43510
   129
  def init_view(buffer: Buffer, text_area: JEditTextArea)
wenzelm@43510
   130
  {
wenzelm@49406
   131
    JEdit_Lib.swing_buffer_lock(buffer) {
wenzelm@43510
   132
      document_model(buffer) match {
wenzelm@55432
   133
        case Some(model) => Document_View.init(model, text_area)
wenzelm@55432
   134
        case None =>
wenzelm@43510
   135
      }
wenzelm@43510
   136
    }
wenzelm@43510
   137
  }
wenzelm@43510
   138
wenzelm@43510
   139
  def exit_view(buffer: Buffer, text_area: JEditTextArea)
wenzelm@43510
   140
  {
wenzelm@49406
   141
    JEdit_Lib.swing_buffer_lock(buffer) {
wenzelm@43510
   142
      Document_View.exit(text_area)
wenzelm@43510
   143
    }
wenzelm@43510
   144
  }
wenzelm@55621
   145
wenzelm@55621
   146
wenzelm@55621
   147
  /* current document content */
wenzelm@55621
   148
wenzelm@55621
   149
  def snapshot(view: View): Document.Snapshot =
wenzelm@55621
   150
  {
wenzelm@55621
   151
    val buffer = view.getBuffer
wenzelm@55621
   152
    document_model(buffer) match {
wenzelm@55621
   153
      case Some(model) => model.snapshot
wenzelm@55621
   154
      case None => error("No document model for current buffer")
wenzelm@55621
   155
    }
wenzelm@55621
   156
  }
wenzelm@55621
   157
wenzelm@55621
   158
  def rendering(view: View): Rendering =
wenzelm@55621
   159
  {
wenzelm@55621
   160
    val text_area = view.getTextArea
wenzelm@55621
   161
    document_view(text_area) match {
wenzelm@55621
   162
      case Some(doc_view) => doc_view.get_rendering()
wenzelm@55621
   163
      case None => error("No document view for current text area")
wenzelm@55621
   164
    }
wenzelm@55621
   165
  }
wenzelm@34318
   166
}
wenzelm@34318
   167
wenzelm@34429
   168
wenzelm@34618
   169
class Plugin extends EBPlugin
wenzelm@34618
   170
{
wenzelm@55791
   171
  /* options */
wenzelm@55791
   172
wenzelm@55791
   173
  def options_changed() {
wenzelm@55791
   174
    PIDE.session.global_options.event(Session.Global_Options(PIDE.options.value))
wenzelm@55791
   175
    Swing_Thread.later { delay_load.invoke() }
wenzelm@55791
   176
  }
wenzelm@55791
   177
wenzelm@55791
   178
wenzelm@44577
   179
  /* theory files */
wenzelm@44574
   180
wenzelm@50344
   181
  private lazy val delay_init =
wenzelm@50344
   182
    Swing_Thread.delay_last(PIDE.options.seconds("editor_load_delay"))
wenzelm@50344
   183
    {
wenzelm@55791
   184
      PIDE.init_models()
wenzelm@50344
   185
    }
wenzelm@50344
   186
wenzelm@44573
   187
  private lazy val delay_load =
wenzelm@50207
   188
    Swing_Thread.delay_last(PIDE.options.seconds("editor_load_delay"))
wenzelm@44574
   189
    {
wenzelm@53074
   190
      if (Isabelle.continuous_checking) {
wenzelm@53074
   191
        val view = jEdit.getActiveView()
wenzelm@44963
   192
wenzelm@53074
   193
        val buffers = JEdit_Lib.jedit_buffers().toList
wenzelm@53074
   194
        if (buffers.forall(_.isLoaded)) {
wenzelm@53074
   195
          def loaded_buffer(name: String): Boolean =
wenzelm@53074
   196
            buffers.exists(buffer => JEdit_Lib.buffer_name(buffer) == name)
wenzelm@44574
   197
wenzelm@53074
   198
          val thys =
wenzelm@54509
   199
            for {
wenzelm@54509
   200
              buffer <- buffers
wenzelm@54509
   201
              model <- PIDE.document_model(buffer)
wenzelm@54509
   202
              if model.is_theory
wenzelm@55490
   203
            } yield (model.node_name, Position.none)
wenzelm@46761
   204
wenzelm@53074
   205
          val thy_info = new Thy_Info(PIDE.thy_load)
wenzelm@53074
   206
          // FIXME avoid I/O in Swing thread!?!
wenzelm@53074
   207
          val files = thy_info.dependencies(thys).deps.map(_.name.node).
wenzelm@53074
   208
            filter(file => !loaded_buffer(file) && PIDE.thy_load.check_file(view, file))
wenzelm@44574
   209
wenzelm@53074
   210
          if (!files.isEmpty) {
wenzelm@53715
   211
            if (PIDE.options.bool("jedit_auto_load")) {
wenzelm@53715
   212
              files.foreach(file => jEdit.openFile(null: View, file))
wenzelm@53715
   213
            }
wenzelm@53715
   214
            else {
wenzelm@53715
   215
              val files_list = new ListView(files.sorted)
wenzelm@53715
   216
              for (i <- 0 until files.length)
wenzelm@53715
   217
                files_list.selection.indices += i
wenzelm@44606
   218
wenzelm@53715
   219
              val answer =
wenzelm@53715
   220
                GUI.confirm_dialog(view,
wenzelm@53715
   221
                  "Auto loading of required files",
wenzelm@53715
   222
                  JOptionPane.YES_NO_OPTION,
wenzelm@53715
   223
                  "The following files are required to resolve theory imports.",
wenzelm@53715
   224
                  "Reload selected files now?",
wenzelm@53715
   225
                  new ScrollPane(files_list),
wenzelm@53715
   226
                  new Isabelle.Continuous_Checking)
wenzelm@53715
   227
              if (answer == 0) {
wenzelm@53715
   228
                files.foreach(file =>
wenzelm@53715
   229
                  if (files_list.selection.items.contains(file))
wenzelm@53715
   230
                    jEdit.openFile(null: View, file))
wenzelm@53715
   231
              }
wenzelm@53074
   232
            }
wenzelm@46761
   233
          }
wenzelm@46761
   234
        }
wenzelm@44606
   235
      }
wenzelm@44574
   236
    }
wenzelm@44573
   237
wenzelm@44574
   238
wenzelm@44574
   239
  /* session manager */
wenzelm@44573
   240
wenzelm@39633
   241
  private val session_manager = actor {
wenzelm@39633
   242
    loop {
wenzelm@39633
   243
      react {
wenzelm@39735
   244
        case phase: Session.Phase =>
wenzelm@39735
   245
          phase match {
wenzelm@50808
   246
            case Session.Inactive | Session.Failed =>
wenzelm@46918
   247
              Swing_Thread.later {
wenzelm@51616
   248
                GUI.error_dialog(jEdit.getActiveView, "Prover process terminated",
wenzelm@51616
   249
                    "Isabelle Syslog", GUI.scrollable_text(PIDE.session.current_syslog()))
wenzelm@39735
   250
              }
wenzelm@39735
   251
wenzelm@44573
   252
            case Session.Ready =>
wenzelm@52084
   253
              PIDE.session.update_options(PIDE.options.value)
wenzelm@55791
   254
              PIDE.init_models()
wenzelm@49195
   255
              Swing_Thread.later { delay_load.invoke() }
wenzelm@44573
   256
wenzelm@46740
   257
            case Session.Shutdown =>
wenzelm@50344
   258
              PIDE.exit_models(JEdit_Lib.jedit_buffers().toList)
wenzelm@49195
   259
              Swing_Thread.later { delay_load.revoke() }
wenzelm@46740
   260
wenzelm@39735
   261
            case _ =>
wenzelm@39735
   262
          }
wenzelm@55618
   263
        case bad => System.err.println("session_manager: ignoring bad message " + bad)
wenzelm@39630
   264
      }
wenzelm@39630
   265
    }
wenzelm@39630
   266
  }
wenzelm@39630
   267
wenzelm@39630
   268
wenzelm@34618
   269
  /* main plugin plumbing */
wenzelm@34433
   270
wenzelm@34767
   271
  override def handleMessage(message: EBMessage)
wenzelm@34618
   272
  {
wenzelm@43510
   273
    Swing_Thread.assert()
wenzelm@39630
   274
wenzelm@50205
   275
    if (PIDE.startup_failure.isDefined && !PIDE.startup_notified) {
wenzelm@49099
   276
      message match {
wenzelm@49100
   277
        case msg: EditorStarted =>
wenzelm@51616
   278
          GUI.error_dialog(null, "Isabelle plugin startup failure",
wenzelm@51616
   279
            GUI.scrollable_text(Exn.message(PIDE.startup_failure.get)),
wenzelm@49099
   280
            "Prover IDE inactive!")
wenzelm@50205
   281
          PIDE.startup_notified = true
wenzelm@49099
   282
        case _ =>
wenzelm@49099
   283
      }
wenzelm@49099
   284
    }
wenzelm@49099
   285
wenzelm@50205
   286
    if (PIDE.startup_failure.isEmpty) {
wenzelm@49099
   287
      message match {
wenzelm@49099
   288
        case msg: EditorStarted =>
wenzelm@50408
   289
          PIDE.session.start(Isabelle_Logic.session_args())
wenzelm@37557
   290
wenzelm@49099
   291
        case msg: BufferUpdate
wenzelm@49099
   292
        if msg.getWhat == BufferUpdate.LOADED || msg.getWhat == BufferUpdate.PROPERTIES_CHANGED =>
wenzelm@50205
   293
          if (PIDE.session.is_ready) {
wenzelm@55791
   294
            delay_init.invoke()
wenzelm@55791
   295
            delay_load.invoke()
wenzelm@49099
   296
          }
wenzelm@34784
   297
wenzelm@49099
   298
        case msg: EditPaneUpdate
wenzelm@49099
   299
        if (msg.getWhat == EditPaneUpdate.BUFFER_CHANGING ||
wenzelm@49099
   300
            msg.getWhat == EditPaneUpdate.BUFFER_CHANGED ||
wenzelm@49099
   301
            msg.getWhat == EditPaneUpdate.CREATED ||
wenzelm@49099
   302
            msg.getWhat == EditPaneUpdate.DESTROYED) =>
wenzelm@49099
   303
          val edit_pane = msg.getEditPane
wenzelm@49099
   304
          val buffer = edit_pane.getBuffer
wenzelm@49099
   305
          val text_area = edit_pane.getTextArea
wenzelm@49099
   306
wenzelm@49099
   307
          if (buffer != null && text_area != null) {
wenzelm@49099
   308
            if (msg.getWhat == EditPaneUpdate.BUFFER_CHANGED ||
wenzelm@49099
   309
                msg.getWhat == EditPaneUpdate.CREATED) {
wenzelm@50205
   310
              if (PIDE.session.is_ready)
wenzelm@50205
   311
                PIDE.init_view(buffer, text_area)
wenzelm@49099
   312
            }
wenzelm@52867
   313
            else {
wenzelm@53244
   314
              PIDE.dismissed_popups(text_area.getView)
wenzelm@52867
   315
              PIDE.exit_view(buffer, text_area)
wenzelm@52867
   316
            }
wenzelm@53274
   317
wenzelm@53274
   318
            if (msg.getWhat == EditPaneUpdate.CREATED)
wenzelm@53274
   319
              Completion_Popup.Text_Area.init(text_area)
wenzelm@53274
   320
wenzelm@53274
   321
            if (msg.getWhat == EditPaneUpdate.DESTROYED)
wenzelm@53274
   322
              Completion_Popup.Text_Area.exit(text_area)
wenzelm@43510
   323
          }
wenzelm@34784
   324
wenzelm@49099
   325
        case msg: PropertiesChanged =>
wenzelm@52084
   326
          PIDE.session.update_options(PIDE.options.value)
wenzelm@34784
   327
wenzelm@49099
   328
        case _ =>
wenzelm@49099
   329
      }
wenzelm@34318
   330
    }
wenzelm@34318
   331
  }
wenzelm@34318
   332
wenzelm@34618
   333
  override def start()
wenzelm@49099
   334
  {
wenzelm@49099
   335
    try {
wenzelm@50709
   336
      Debug.DISABLE_SEARCH_DIALOG_POOL = true
wenzelm@50709
   337
wenzelm@50205
   338
      PIDE.plugin = this
wenzelm@49099
   339
      Isabelle_System.init()
wenzelm@51614
   340
      Isabelle_Font.install_fonts()
wenzelm@49099
   341
wenzelm@53338
   342
      PIDE.options.update(Options.init())
wenzelm@53337
   343
      PIDE.completion_history.load()
wenzelm@49245
   344
wenzelm@49099
   345
      SyntaxUtilities.setStyleExtender(new Token_Markup.Style_Extender)
wenzelm@49099
   346
      if (ModeProvider.instance.isInstanceOf[ModeProvider])
wenzelm@49099
   347
        ModeProvider.instance = new Token_Markup.Mode_Provider(ModeProvider.instance)
wenzelm@48870
   348
wenzelm@53274
   349
      JEdit_Lib.jedit_text_areas.foreach(Completion_Popup.Text_Area.init _)
wenzelm@53274
   350
wenzelm@49246
   351
      val content = Isabelle_Logic.session_content(false)
wenzelm@49099
   352
      val thy_load = new JEdit_Thy_Load(content.loaded_theories, content.syntax)
wenzelm@49524
   353
wenzelm@50205
   354
      PIDE.session = new Session(thy_load) {
wenzelm@50207
   355
        override def output_delay = PIDE.options.seconds("editor_output_delay")
wenzelm@50205
   356
        override def reparse_limit = PIDE.options.int("editor_reparse_limit")
wenzelm@49288
   357
      }
wenzelm@48870
   358
wenzelm@50205
   359
      PIDE.session.phase_changed += session_manager
wenzelm@50205
   360
      PIDE.startup_failure = None
wenzelm@49099
   361
    }
wenzelm@49099
   362
    catch {
wenzelm@49099
   363
      case exn: Throwable =>
wenzelm@50205
   364
        PIDE.startup_failure = Some(exn)
wenzelm@50205
   365
        PIDE.startup_notified = false
wenzelm@49099
   366
    }
wenzelm@34318
   367
  }
wenzelm@34618
   368
wenzelm@39628
   369
  override def stop()
wenzelm@34618
   370
  {
wenzelm@53274
   371
    JEdit_Lib.jedit_text_areas.foreach(Completion_Popup.Text_Area.exit _)
wenzelm@53274
   372
wenzelm@53337
   373
    if (PIDE.startup_failure.isEmpty) {
wenzelm@50205
   374
      PIDE.options.value.save_prefs()
wenzelm@53337
   375
      PIDE.completion_history.value.save()
wenzelm@53337
   376
    }
wenzelm@49245
   377
wenzelm@50205
   378
    PIDE.session.phase_changed -= session_manager
wenzelm@50344
   379
    PIDE.exit_models(JEdit_Lib.jedit_buffers().toList)
wenzelm@50205
   380
    PIDE.session.stop()
wenzelm@34318
   381
  }
wenzelm@34318
   382
}