src/Tools/jEdit/src/plugin.scala
author wenzelm
Wed Dec 05 12:22:55 2012 +0100 (2012-12-05)
changeset 50363 2f8dc9e65401
parent 50362 1a539d7a0438
child 50408 1fac4ff86381
permissions -rw-r--r--
tuned signature in accordance to document operations;
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@49406
    16
import org.gjt.sp.jedit.{jEdit, EBMessage, EBPlugin, Buffer, View}
wenzelm@39043
    17
import org.gjt.sp.jedit.textarea.{JEditTextArea, TextArea}
wenzelm@50362
    18
import org.gjt.sp.jedit.syntax.ModeProvider
wenzelm@49100
    19
import org.gjt.sp.jedit.msg.{EditorStarted, BufferUpdate, EditPaneUpdate, PropertiesChanged}
wenzelm@34429
    20
wenzelm@43443
    21
import org.gjt.sp.util.SyntaxUtilities
wenzelm@39241
    22
wenzelm@44721
    23
import scala.actors.Actor._
wenzelm@39630
    24
wenzelm@34318
    25
wenzelm@50205
    26
object PIDE
wenzelm@34618
    27
{
wenzelm@34784
    28
  /* plugin instance */
wenzelm@34784
    29
wenzelm@49245
    30
  val options = new JEdit_Options
wenzelm@49245
    31
wenzelm@49099
    32
  @volatile var startup_failure: Option[Throwable] = None
wenzelm@49099
    33
  @volatile var startup_notified = false
wenzelm@34784
    34
wenzelm@49101
    35
  @volatile var plugin: Plugin = null
wenzelm@49101
    36
  @volatile var session: Session = new Session(new JEdit_Thy_Load(Set.empty, Outer_Syntax.empty))
wenzelm@49101
    37
wenzelm@48870
    38
  def thy_load(): JEdit_Thy_Load =
wenzelm@48870
    39
    session.thy_load.asInstanceOf[JEdit_Thy_Load]
wenzelm@44955
    40
wenzelm@48884
    41
  def get_recent_syntax(): Option[Outer_Syntax] =
wenzelm@48884
    42
  {
wenzelm@48884
    43
    val current_session = session
wenzelm@49101
    44
    if (current_session.recent_syntax == Outer_Syntax.empty) None
wenzelm@49101
    45
    else Some(current_session.recent_syntax)
wenzelm@48884
    46
  }
wenzelm@48884
    47
wenzelm@34784
    48
wenzelm@43449
    49
  /* document model and view */
wenzelm@43449
    50
wenzelm@43449
    51
  def document_model(buffer: Buffer): Option[Document_Model] = Document_Model(buffer)
wenzelm@43449
    52
  def document_view(text_area: JEditTextArea): Option[Document_View] = Document_View(text_area)
wenzelm@43449
    53
wenzelm@44379
    54
  def document_views(buffer: Buffer): List[Document_View] =
wenzelm@44379
    55
    for {
wenzelm@49406
    56
      text_area <- JEdit_Lib.jedit_text_areas(buffer).toList
wenzelm@46997
    57
      doc_view = document_view(text_area)
wenzelm@44379
    58
      if doc_view.isDefined
wenzelm@44379
    59
    } yield doc_view.get
wenzelm@44379
    60
wenzelm@50344
    61
  def exit_models(buffers: List[Buffer])
wenzelm@47058
    62
  {
wenzelm@50344
    63
    Swing_Thread.now {
wenzelm@50344
    64
      buffers.foreach(buffer =>
wenzelm@50344
    65
        JEdit_Lib.buffer_lock(buffer) {
wenzelm@50344
    66
          JEdit_Lib.jedit_text_areas(buffer).foreach(Document_View.exit)
wenzelm@50344
    67
          Document_Model.exit(buffer)
wenzelm@50344
    68
        })
wenzelm@50344
    69
      }
wenzelm@47058
    70
  }
wenzelm@47058
    71
wenzelm@50344
    72
  def init_models(buffers: List[Buffer])
wenzelm@43510
    73
  {
wenzelm@50344
    74
    Swing_Thread.now {
wenzelm@50344
    75
      val init_edits =
wenzelm@50344
    76
        (List.empty[Document.Edit_Text] /: buffers) { case (edits, buffer) =>
wenzelm@50344
    77
          JEdit_Lib.buffer_lock(buffer) {
wenzelm@50344
    78
            val (model_edits, opt_model) =
wenzelm@50344
    79
              JEdit_Lib.buffer_node_name(buffer) match {
wenzelm@50344
    80
                case Some(node_name) =>
wenzelm@50344
    81
                  document_model(buffer) match {
wenzelm@50344
    82
                    case Some(model) if model.name == node_name => (Nil, Some(model))
wenzelm@50344
    83
                    case _ =>
wenzelm@50344
    84
                      val model = Document_Model.init(session, buffer, node_name)
wenzelm@50344
    85
                      (model.init_edits(), Some(model))
wenzelm@50344
    86
                  }
wenzelm@50344
    87
                case None => (Nil, None)
wenzelm@50344
    88
              }
wenzelm@50344
    89
            if (opt_model.isDefined) {
wenzelm@50344
    90
              for (text_area <- JEdit_Lib.jedit_text_areas(buffer)) {
wenzelm@50344
    91
                if (document_view(text_area).map(_.model) != opt_model)
wenzelm@50344
    92
                  Document_View.init(opt_model.get, text_area)
wenzelm@50344
    93
              }
wenzelm@43510
    94
            }
wenzelm@50344
    95
            model_edits ::: edits
wenzelm@50344
    96
          }
wenzelm@43510
    97
        }
wenzelm@50363
    98
      PIDE.session.update(init_edits)
wenzelm@43510
    99
    }
wenzelm@43510
   100
  }
wenzelm@43510
   101
wenzelm@43510
   102
  def init_view(buffer: Buffer, text_area: JEditTextArea)
wenzelm@43510
   103
  {
wenzelm@49406
   104
    JEdit_Lib.swing_buffer_lock(buffer) {
wenzelm@43510
   105
      document_model(buffer) match {
wenzelm@43510
   106
        case Some(model) => Document_View.init(model, text_area)
wenzelm@43510
   107
        case None =>
wenzelm@43510
   108
      }
wenzelm@43510
   109
    }
wenzelm@43510
   110
  }
wenzelm@43510
   111
wenzelm@43510
   112
  def exit_view(buffer: Buffer, text_area: JEditTextArea)
wenzelm@43510
   113
  {
wenzelm@49406
   114
    JEdit_Lib.swing_buffer_lock(buffer) {
wenzelm@43510
   115
      Document_View.exit(text_area)
wenzelm@43510
   116
    }
wenzelm@43510
   117
  }
wenzelm@50209
   118
wenzelm@50209
   119
wenzelm@50209
   120
  /* full checking */
wenzelm@50209
   121
wenzelm@50209
   122
  def check_buffer(buffer: Buffer)
wenzelm@50209
   123
  {
wenzelm@50209
   124
    PIDE.document_model(buffer) match {
wenzelm@50362
   125
      case Some(model) => model.full_perspective()
wenzelm@50209
   126
      case None =>
wenzelm@50209
   127
    }
wenzelm@50209
   128
  }
wenzelm@50209
   129
wenzelm@50209
   130
  def cancel_execution() { PIDE.session.cancel_execution() }
wenzelm@34318
   131
}
wenzelm@34318
   132
wenzelm@34429
   133
wenzelm@34618
   134
class Plugin extends EBPlugin
wenzelm@34618
   135
{
wenzelm@44577
   136
  /* theory files */
wenzelm@44574
   137
wenzelm@50344
   138
  private lazy val delay_init =
wenzelm@50344
   139
    Swing_Thread.delay_last(PIDE.options.seconds("editor_load_delay"))
wenzelm@50344
   140
    {
wenzelm@50344
   141
      PIDE.init_models(JEdit_Lib.jedit_buffers().toList)
wenzelm@50344
   142
    }
wenzelm@50344
   143
wenzelm@44573
   144
  private lazy val delay_load =
wenzelm@50207
   145
    Swing_Thread.delay_last(PIDE.options.seconds("editor_load_delay"))
wenzelm@44574
   146
    {
wenzelm@44963
   147
      val view = jEdit.getActiveView()
wenzelm@44963
   148
wenzelm@49406
   149
      val buffers = JEdit_Lib.jedit_buffers().toList
wenzelm@46761
   150
      if (buffers.forall(_.isLoaded)) {
wenzelm@46761
   151
        def loaded_buffer(name: String): Boolean =
wenzelm@49406
   152
          buffers.exists(buffer => JEdit_Lib.buffer_name(buffer) == name)
wenzelm@44574
   153
wenzelm@46761
   154
        val thys =
wenzelm@50205
   155
          for (buffer <- buffers; model <- PIDE.document_model(buffer))
wenzelm@46761
   156
            yield model.name
wenzelm@46761
   157
wenzelm@50205
   158
        val thy_info = new Thy_Info(PIDE.thy_load)
wenzelm@46761
   159
        // FIXME avoid I/O in Swing thread!?!
wenzelm@49098
   160
        val files = thy_info.dependencies(true, thys).deps.map(_._1.node).
wenzelm@50205
   161
          filter(file => !loaded_buffer(file) && PIDE.thy_load.check_file(view, file))
wenzelm@44574
   162
wenzelm@46761
   163
        if (!files.isEmpty) {
wenzelm@46761
   164
          val files_list = new ListView(files.sorted)
wenzelm@46761
   165
          for (i <- 0 until files.length)
wenzelm@46761
   166
            files_list.selection.indices += i
wenzelm@44606
   167
wenzelm@46761
   168
          val answer =
wenzelm@46761
   169
            Library.confirm_dialog(view,
wenzelm@46761
   170
              "Auto loading of required files",
wenzelm@46761
   171
              JOptionPane.YES_NO_OPTION,
wenzelm@46761
   172
              "The following files are required to resolve theory imports.",
wenzelm@46761
   173
              "Reload selected files now?",
wenzelm@46761
   174
              new ScrollPane(files_list))
wenzelm@46761
   175
          if (answer == 0) {
wenzelm@46761
   176
            files.foreach(file =>
wenzelm@46761
   177
              if (files_list.selection.items.contains(file))
wenzelm@46761
   178
                jEdit.openFile(null: View, file))
wenzelm@46761
   179
          }
wenzelm@46761
   180
        }
wenzelm@44606
   181
      }
wenzelm@44574
   182
    }
wenzelm@44573
   183
wenzelm@44574
   184
wenzelm@44574
   185
  /* session manager */
wenzelm@44573
   186
wenzelm@39633
   187
  private val session_manager = actor {
wenzelm@39633
   188
    loop {
wenzelm@39633
   189
      react {
wenzelm@39735
   190
        case phase: Session.Phase =>
wenzelm@39735
   191
          phase match {
wenzelm@39735
   192
            case Session.Failed =>
wenzelm@46918
   193
              Swing_Thread.later {
wenzelm@48022
   194
                Library.error_dialog(jEdit.getActiveView, "Prover process failure",
wenzelm@50205
   195
                    "Isabelle Syslog", Library.scrollable_text(PIDE.session.current_syslog()))
wenzelm@39735
   196
              }
wenzelm@39735
   197
wenzelm@44573
   198
            case Session.Ready =>
wenzelm@50205
   199
              PIDE.session.global_options.event(Session.Global_Options(PIDE.options.value))
wenzelm@50344
   200
              PIDE.init_models(JEdit_Lib.jedit_buffers().toList)
wenzelm@49195
   201
              Swing_Thread.later { delay_load.invoke() }
wenzelm@44573
   202
wenzelm@46740
   203
            case Session.Shutdown =>
wenzelm@50344
   204
              PIDE.exit_models(JEdit_Lib.jedit_buffers().toList)
wenzelm@49195
   205
              Swing_Thread.later { delay_load.revoke() }
wenzelm@46740
   206
wenzelm@39735
   207
            case _ =>
wenzelm@39735
   208
          }
wenzelm@49406
   209
        case bad => java.lang.System.err.println("session_manager: ignoring bad message " + bad)
wenzelm@39630
   210
      }
wenzelm@39630
   211
    }
wenzelm@39630
   212
  }
wenzelm@39630
   213
wenzelm@39630
   214
wenzelm@34618
   215
  /* main plugin plumbing */
wenzelm@34433
   216
wenzelm@34767
   217
  override def handleMessage(message: EBMessage)
wenzelm@34618
   218
  {
wenzelm@43510
   219
    Swing_Thread.assert()
wenzelm@39630
   220
wenzelm@50205
   221
    if (PIDE.startup_failure.isDefined && !PIDE.startup_notified) {
wenzelm@49099
   222
      message match {
wenzelm@49100
   223
        case msg: EditorStarted =>
wenzelm@49100
   224
          Library.error_dialog(null, "Isabelle plugin startup failure",
wenzelm@50205
   225
            Library.scrollable_text(Exn.message(PIDE.startup_failure.get)),
wenzelm@49099
   226
            "Prover IDE inactive!")
wenzelm@50205
   227
          PIDE.startup_notified = true
wenzelm@49099
   228
        case _ =>
wenzelm@49099
   229
      }
wenzelm@49099
   230
    }
wenzelm@49099
   231
wenzelm@50205
   232
    if (PIDE.startup_failure.isEmpty) {
wenzelm@49099
   233
      message match {
wenzelm@49099
   234
        case msg: EditorStarted =>
wenzelm@50205
   235
          if (PIDE.options.bool("jedit_auto_start"))
wenzelm@50205
   236
            PIDE.session.start(Isabelle_Logic.session_args())
wenzelm@37557
   237
wenzelm@49099
   238
        case msg: BufferUpdate
wenzelm@49099
   239
        if msg.getWhat == BufferUpdate.LOADED || msg.getWhat == BufferUpdate.PROPERTIES_CHANGED =>
wenzelm@50205
   240
          if (PIDE.session.is_ready) {
wenzelm@49099
   241
            val buffer = msg.getBuffer
wenzelm@50344
   242
            if (buffer != null && !buffer.isLoading) delay_init.invoke()
wenzelm@49195
   243
            Swing_Thread.later { delay_load.invoke() }
wenzelm@49099
   244
          }
wenzelm@34784
   245
wenzelm@49099
   246
        case msg: EditPaneUpdate
wenzelm@49099
   247
        if (msg.getWhat == EditPaneUpdate.BUFFER_CHANGING ||
wenzelm@49099
   248
            msg.getWhat == EditPaneUpdate.BUFFER_CHANGED ||
wenzelm@49099
   249
            msg.getWhat == EditPaneUpdate.CREATED ||
wenzelm@49099
   250
            msg.getWhat == EditPaneUpdate.DESTROYED) =>
wenzelm@49099
   251
          val edit_pane = msg.getEditPane
wenzelm@49099
   252
          val buffer = edit_pane.getBuffer
wenzelm@49099
   253
          val text_area = edit_pane.getTextArea
wenzelm@49099
   254
wenzelm@49099
   255
          if (buffer != null && text_area != null) {
wenzelm@49099
   256
            if (msg.getWhat == EditPaneUpdate.BUFFER_CHANGED ||
wenzelm@49099
   257
                msg.getWhat == EditPaneUpdate.CREATED) {
wenzelm@50205
   258
              if (PIDE.session.is_ready)
wenzelm@50205
   259
                PIDE.init_view(buffer, text_area)
wenzelm@49099
   260
            }
wenzelm@50205
   261
            else PIDE.exit_view(buffer, text_area)
wenzelm@43510
   262
          }
wenzelm@34784
   263
wenzelm@49099
   264
        case msg: PropertiesChanged =>
wenzelm@50205
   265
          PIDE.session.global_options.event(Session.Global_Options(PIDE.options.value))
wenzelm@34784
   266
wenzelm@49099
   267
        case _ =>
wenzelm@49099
   268
      }
wenzelm@34318
   269
    }
wenzelm@34318
   270
  }
wenzelm@34318
   271
wenzelm@34618
   272
  override def start()
wenzelm@49099
   273
  {
wenzelm@49099
   274
    try {
wenzelm@50205
   275
      PIDE.plugin = this
wenzelm@49099
   276
      Isabelle_System.init()
wenzelm@49099
   277
      Isabelle_System.install_fonts()
wenzelm@49099
   278
wenzelm@49245
   279
      val init_options = Options.init()
wenzelm@50205
   280
      Swing_Thread.now { PIDE.options.update(init_options)  }
wenzelm@49245
   281
wenzelm@49099
   282
      SyntaxUtilities.setStyleExtender(new Token_Markup.Style_Extender)
wenzelm@49099
   283
      if (ModeProvider.instance.isInstanceOf[ModeProvider])
wenzelm@49099
   284
        ModeProvider.instance = new Token_Markup.Mode_Provider(ModeProvider.instance)
wenzelm@48870
   285
wenzelm@49246
   286
      val content = Isabelle_Logic.session_content(false)
wenzelm@49099
   287
      val thy_load = new JEdit_Thy_Load(content.loaded_theories, content.syntax)
wenzelm@49524
   288
wenzelm@50205
   289
      PIDE.session = new Session(thy_load) {
wenzelm@50207
   290
        override def output_delay = PIDE.options.seconds("editor_output_delay")
wenzelm@50205
   291
        override def reparse_limit = PIDE.options.int("editor_reparse_limit")
wenzelm@49288
   292
      }
wenzelm@48870
   293
wenzelm@50205
   294
      PIDE.session.phase_changed += session_manager
wenzelm@50205
   295
      PIDE.startup_failure = None
wenzelm@49099
   296
    }
wenzelm@49099
   297
    catch {
wenzelm@49099
   298
      case exn: Throwable =>
wenzelm@50205
   299
        PIDE.startup_failure = Some(exn)
wenzelm@50205
   300
        PIDE.startup_notified = false
wenzelm@49099
   301
    }
wenzelm@34318
   302
  }
wenzelm@34618
   303
wenzelm@39628
   304
  override def stop()
wenzelm@34618
   305
  {
wenzelm@50205
   306
    if (PIDE.startup_failure.isEmpty)
wenzelm@50205
   307
      PIDE.options.value.save_prefs()
wenzelm@49245
   308
wenzelm@50205
   309
    PIDE.session.phase_changed -= session_manager
wenzelm@50344
   310
    PIDE.exit_models(JEdit_Lib.jedit_buffers().toList)
wenzelm@50205
   311
    PIDE.session.stop()
wenzelm@34318
   312
  }
wenzelm@34318
   313
}