src/Tools/jEdit/src/plugin.scala
author wenzelm
Fri Feb 14 14:51:38 2014 +0100 (2014-02-14)
changeset 55490 9b0fb0e2c9f5
parent 55432 9c53198dbb1c
child 55618 995162143ef4
permissions -rw-r--r--
updated thy_info.dependencies;
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@54561
   107
            if (buffer.getBooleanProperty(Buffer.GZIPPED)) edits
wenzelm@54561
   108
            else {
wenzelm@54561
   109
              val node_name = thy_load.node_name(buffer)
wenzelm@54561
   110
              val (model_edits, model) =
wenzelm@54561
   111
                document_model(buffer) match {
wenzelm@54561
   112
                  case Some(model) if model.node_name == node_name => (Nil, model)
wenzelm@54561
   113
                  case _ =>
wenzelm@54561
   114
                    val model = Document_Model.init(session, buffer, node_name)
wenzelm@54561
   115
                    (model.init_edits(), model)
wenzelm@54561
   116
                }
wenzelm@55432
   117
              for {
wenzelm@55432
   118
                text_area <- JEdit_Lib.jedit_text_areas(buffer)
wenzelm@55432
   119
                if document_view(text_area).map(_.model) != Some(model)
wenzelm@55432
   120
              } Document_View.init(model, text_area)
wenzelm@54561
   121
              model_edits ::: edits
wenzelm@43510
   122
            }
wenzelm@50344
   123
          }
wenzelm@43510
   124
        }
wenzelm@54522
   125
      session.update(document_blobs(), init_edits)
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@34318
   145
}
wenzelm@34318
   146
wenzelm@34429
   147
wenzelm@34618
   148
class Plugin extends EBPlugin
wenzelm@34618
   149
{
wenzelm@44577
   150
  /* theory files */
wenzelm@44574
   151
wenzelm@50344
   152
  private lazy val delay_init =
wenzelm@50344
   153
    Swing_Thread.delay_last(PIDE.options.seconds("editor_load_delay"))
wenzelm@50344
   154
    {
wenzelm@50344
   155
      PIDE.init_models(JEdit_Lib.jedit_buffers().toList)
wenzelm@50344
   156
    }
wenzelm@50344
   157
wenzelm@53074
   158
  def load_theories() { Swing_Thread.later { delay_load.invoke() }}
wenzelm@53074
   159
wenzelm@44573
   160
  private lazy val delay_load =
wenzelm@50207
   161
    Swing_Thread.delay_last(PIDE.options.seconds("editor_load_delay"))
wenzelm@44574
   162
    {
wenzelm@53074
   163
      if (Isabelle.continuous_checking) {
wenzelm@53074
   164
        val view = jEdit.getActiveView()
wenzelm@44963
   165
wenzelm@53074
   166
        val buffers = JEdit_Lib.jedit_buffers().toList
wenzelm@53074
   167
        if (buffers.forall(_.isLoaded)) {
wenzelm@53074
   168
          def loaded_buffer(name: String): Boolean =
wenzelm@53074
   169
            buffers.exists(buffer => JEdit_Lib.buffer_name(buffer) == name)
wenzelm@44574
   170
wenzelm@53074
   171
          val thys =
wenzelm@54509
   172
            for {
wenzelm@54509
   173
              buffer <- buffers
wenzelm@54509
   174
              model <- PIDE.document_model(buffer)
wenzelm@54509
   175
              if model.is_theory
wenzelm@55490
   176
            } yield (model.node_name, Position.none)
wenzelm@46761
   177
wenzelm@53074
   178
          val thy_info = new Thy_Info(PIDE.thy_load)
wenzelm@53074
   179
          // FIXME avoid I/O in Swing thread!?!
wenzelm@53074
   180
          val files = thy_info.dependencies(thys).deps.map(_.name.node).
wenzelm@53074
   181
            filter(file => !loaded_buffer(file) && PIDE.thy_load.check_file(view, file))
wenzelm@44574
   182
wenzelm@53074
   183
          if (!files.isEmpty) {
wenzelm@53715
   184
            if (PIDE.options.bool("jedit_auto_load")) {
wenzelm@53715
   185
              files.foreach(file => jEdit.openFile(null: View, file))
wenzelm@53715
   186
            }
wenzelm@53715
   187
            else {
wenzelm@53715
   188
              val files_list = new ListView(files.sorted)
wenzelm@53715
   189
              for (i <- 0 until files.length)
wenzelm@53715
   190
                files_list.selection.indices += i
wenzelm@44606
   191
wenzelm@53715
   192
              val answer =
wenzelm@53715
   193
                GUI.confirm_dialog(view,
wenzelm@53715
   194
                  "Auto loading of required files",
wenzelm@53715
   195
                  JOptionPane.YES_NO_OPTION,
wenzelm@53715
   196
                  "The following files are required to resolve theory imports.",
wenzelm@53715
   197
                  "Reload selected files now?",
wenzelm@53715
   198
                  new ScrollPane(files_list),
wenzelm@53715
   199
                  new Isabelle.Continuous_Checking)
wenzelm@53715
   200
              if (answer == 0) {
wenzelm@53715
   201
                files.foreach(file =>
wenzelm@53715
   202
                  if (files_list.selection.items.contains(file))
wenzelm@53715
   203
                    jEdit.openFile(null: View, file))
wenzelm@53715
   204
              }
wenzelm@53074
   205
            }
wenzelm@46761
   206
          }
wenzelm@46761
   207
        }
wenzelm@44606
   208
      }
wenzelm@44574
   209
    }
wenzelm@44573
   210
wenzelm@44574
   211
wenzelm@44574
   212
  /* session manager */
wenzelm@44573
   213
wenzelm@39633
   214
  private val session_manager = actor {
wenzelm@39633
   215
    loop {
wenzelm@39633
   216
      react {
wenzelm@39735
   217
        case phase: Session.Phase =>
wenzelm@39735
   218
          phase match {
wenzelm@50808
   219
            case Session.Inactive | Session.Failed =>
wenzelm@46918
   220
              Swing_Thread.later {
wenzelm@51616
   221
                GUI.error_dialog(jEdit.getActiveView, "Prover process terminated",
wenzelm@51616
   222
                    "Isabelle Syslog", GUI.scrollable_text(PIDE.session.current_syslog()))
wenzelm@39735
   223
              }
wenzelm@39735
   224
wenzelm@44573
   225
            case Session.Ready =>
wenzelm@52084
   226
              PIDE.session.update_options(PIDE.options.value)
wenzelm@50344
   227
              PIDE.init_models(JEdit_Lib.jedit_buffers().toList)
wenzelm@49195
   228
              Swing_Thread.later { delay_load.invoke() }
wenzelm@44573
   229
wenzelm@46740
   230
            case Session.Shutdown =>
wenzelm@50344
   231
              PIDE.exit_models(JEdit_Lib.jedit_buffers().toList)
wenzelm@49195
   232
              Swing_Thread.later { delay_load.revoke() }
wenzelm@46740
   233
wenzelm@39735
   234
            case _ =>
wenzelm@39735
   235
          }
wenzelm@49406
   236
        case bad => java.lang.System.err.println("session_manager: ignoring bad message " + bad)
wenzelm@39630
   237
      }
wenzelm@39630
   238
    }
wenzelm@39630
   239
  }
wenzelm@39630
   240
wenzelm@39630
   241
wenzelm@34618
   242
  /* main plugin plumbing */
wenzelm@34433
   243
wenzelm@34767
   244
  override def handleMessage(message: EBMessage)
wenzelm@34618
   245
  {
wenzelm@43510
   246
    Swing_Thread.assert()
wenzelm@39630
   247
wenzelm@50205
   248
    if (PIDE.startup_failure.isDefined && !PIDE.startup_notified) {
wenzelm@49099
   249
      message match {
wenzelm@49100
   250
        case msg: EditorStarted =>
wenzelm@51616
   251
          GUI.error_dialog(null, "Isabelle plugin startup failure",
wenzelm@51616
   252
            GUI.scrollable_text(Exn.message(PIDE.startup_failure.get)),
wenzelm@49099
   253
            "Prover IDE inactive!")
wenzelm@50205
   254
          PIDE.startup_notified = true
wenzelm@49099
   255
        case _ =>
wenzelm@49099
   256
      }
wenzelm@49099
   257
    }
wenzelm@49099
   258
wenzelm@50205
   259
    if (PIDE.startup_failure.isEmpty) {
wenzelm@49099
   260
      message match {
wenzelm@49099
   261
        case msg: EditorStarted =>
wenzelm@50408
   262
          PIDE.session.start(Isabelle_Logic.session_args())
wenzelm@37557
   263
wenzelm@49099
   264
        case msg: BufferUpdate
wenzelm@49099
   265
        if msg.getWhat == BufferUpdate.LOADED || msg.getWhat == BufferUpdate.PROPERTIES_CHANGED =>
wenzelm@50205
   266
          if (PIDE.session.is_ready) {
wenzelm@49099
   267
            val buffer = msg.getBuffer
wenzelm@50344
   268
            if (buffer != null && !buffer.isLoading) delay_init.invoke()
wenzelm@53074
   269
            load_theories()
wenzelm@49099
   270
          }
wenzelm@34784
   271
wenzelm@49099
   272
        case msg: EditPaneUpdate
wenzelm@49099
   273
        if (msg.getWhat == EditPaneUpdate.BUFFER_CHANGING ||
wenzelm@49099
   274
            msg.getWhat == EditPaneUpdate.BUFFER_CHANGED ||
wenzelm@49099
   275
            msg.getWhat == EditPaneUpdate.CREATED ||
wenzelm@49099
   276
            msg.getWhat == EditPaneUpdate.DESTROYED) =>
wenzelm@49099
   277
          val edit_pane = msg.getEditPane
wenzelm@49099
   278
          val buffer = edit_pane.getBuffer
wenzelm@49099
   279
          val text_area = edit_pane.getTextArea
wenzelm@49099
   280
wenzelm@49099
   281
          if (buffer != null && text_area != null) {
wenzelm@49099
   282
            if (msg.getWhat == EditPaneUpdate.BUFFER_CHANGED ||
wenzelm@49099
   283
                msg.getWhat == EditPaneUpdate.CREATED) {
wenzelm@50205
   284
              if (PIDE.session.is_ready)
wenzelm@50205
   285
                PIDE.init_view(buffer, text_area)
wenzelm@49099
   286
            }
wenzelm@52867
   287
            else {
wenzelm@53244
   288
              PIDE.dismissed_popups(text_area.getView)
wenzelm@52867
   289
              PIDE.exit_view(buffer, text_area)
wenzelm@52867
   290
            }
wenzelm@53274
   291
wenzelm@53274
   292
            if (msg.getWhat == EditPaneUpdate.CREATED)
wenzelm@53274
   293
              Completion_Popup.Text_Area.init(text_area)
wenzelm@53274
   294
wenzelm@53274
   295
            if (msg.getWhat == EditPaneUpdate.DESTROYED)
wenzelm@53274
   296
              Completion_Popup.Text_Area.exit(text_area)
wenzelm@43510
   297
          }
wenzelm@34784
   298
wenzelm@49099
   299
        case msg: PropertiesChanged =>
wenzelm@52084
   300
          PIDE.session.update_options(PIDE.options.value)
wenzelm@34784
   301
wenzelm@49099
   302
        case _ =>
wenzelm@49099
   303
      }
wenzelm@34318
   304
    }
wenzelm@34318
   305
  }
wenzelm@34318
   306
wenzelm@34618
   307
  override def start()
wenzelm@49099
   308
  {
wenzelm@49099
   309
    try {
wenzelm@50709
   310
      Debug.DISABLE_SEARCH_DIALOG_POOL = true
wenzelm@50709
   311
wenzelm@50205
   312
      PIDE.plugin = this
wenzelm@49099
   313
      Isabelle_System.init()
wenzelm@51614
   314
      Isabelle_Font.install_fonts()
wenzelm@49099
   315
wenzelm@53338
   316
      PIDE.options.update(Options.init())
wenzelm@53337
   317
      PIDE.completion_history.load()
wenzelm@49245
   318
wenzelm@49099
   319
      SyntaxUtilities.setStyleExtender(new Token_Markup.Style_Extender)
wenzelm@49099
   320
      if (ModeProvider.instance.isInstanceOf[ModeProvider])
wenzelm@49099
   321
        ModeProvider.instance = new Token_Markup.Mode_Provider(ModeProvider.instance)
wenzelm@48870
   322
wenzelm@53274
   323
      JEdit_Lib.jedit_text_areas.foreach(Completion_Popup.Text_Area.init _)
wenzelm@53274
   324
wenzelm@49246
   325
      val content = Isabelle_Logic.session_content(false)
wenzelm@49099
   326
      val thy_load = new JEdit_Thy_Load(content.loaded_theories, content.syntax)
wenzelm@49524
   327
wenzelm@50205
   328
      PIDE.session = new Session(thy_load) {
wenzelm@50207
   329
        override def output_delay = PIDE.options.seconds("editor_output_delay")
wenzelm@50205
   330
        override def reparse_limit = PIDE.options.int("editor_reparse_limit")
wenzelm@49288
   331
      }
wenzelm@48870
   332
wenzelm@50205
   333
      PIDE.session.phase_changed += session_manager
wenzelm@50205
   334
      PIDE.startup_failure = None
wenzelm@49099
   335
    }
wenzelm@49099
   336
    catch {
wenzelm@49099
   337
      case exn: Throwable =>
wenzelm@50205
   338
        PIDE.startup_failure = Some(exn)
wenzelm@50205
   339
        PIDE.startup_notified = false
wenzelm@49099
   340
    }
wenzelm@34318
   341
  }
wenzelm@34618
   342
wenzelm@39628
   343
  override def stop()
wenzelm@34618
   344
  {
wenzelm@53274
   345
    JEdit_Lib.jedit_text_areas.foreach(Completion_Popup.Text_Area.exit _)
wenzelm@53274
   346
wenzelm@53337
   347
    if (PIDE.startup_failure.isEmpty) {
wenzelm@50205
   348
      PIDE.options.value.save_prefs()
wenzelm@53337
   349
      PIDE.completion_history.value.save()
wenzelm@53337
   350
    }
wenzelm@49245
   351
wenzelm@50205
   352
    PIDE.session.phase_changed -= session_manager
wenzelm@50344
   353
    PIDE.exit_models(JEdit_Lib.jedit_buffers().toList)
wenzelm@50205
   354
    PIDE.session.stop()
wenzelm@34318
   355
  }
wenzelm@34318
   356
}