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