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