src/Tools/jEdit/src/isabelle.scala
author wenzelm
Sat Mar 01 19:55:01 2014 +0100 (2014-03-01)
changeset 55827 8a881f83e206
parent 55825 694833e3e4a0
child 56170 638b29331549
permissions -rw-r--r--
clarified module structure;
wenzelm@50208
     1
/*  Title:      Tools/jEdit/src/isabelle.scala
wenzelm@50183
     2
    Author:     Makarius
wenzelm@50183
     3
wenzelm@53277
     4
Global configuration and convenience operations for Isabelle/jEdit.
wenzelm@50183
     5
*/
wenzelm@50183
     6
wenzelm@50183
     7
package isabelle.jedit
wenzelm@50183
     8
wenzelm@50183
     9
wenzelm@50183
    10
import isabelle._
wenzelm@50183
    11
wenzelm@53715
    12
import scala.swing.CheckBox
wenzelm@53715
    13
import scala.swing.event.ButtonClicked
wenzelm@53715
    14
wenzelm@50198
    15
import org.gjt.sp.jedit.{jEdit, View, Buffer}
wenzelm@50183
    16
import org.gjt.sp.jedit.textarea.JEditTextArea
wenzelm@53293
    17
import org.gjt.sp.jedit.gui.{DockableWindowManager, CompleteWord}
wenzelm@50183
    18
wenzelm@50183
    19
wenzelm@50208
    20
object Isabelle
wenzelm@50183
    21
{
wenzelm@53274
    22
  /* editor modes */
wenzelm@53274
    23
wenzelm@53277
    24
  val modes =
wenzelm@53277
    25
    List(
wenzelm@53277
    26
      "isabelle",         // theory source
wenzelm@55500
    27
      "isabelle-ml",      // ML source
wenzelm@53281
    28
      "isabelle-markup",  // SideKick markup tree
wenzelm@53277
    29
      "isabelle-news",    // NEWS
wenzelm@53277
    30
      "isabelle-options", // etc/options
wenzelm@53277
    31
      "isabelle-output",  // pretty text area output
wenzelm@53277
    32
      "isabelle-root")    // session ROOT
wenzelm@53274
    33
wenzelm@55616
    34
  private lazy val ml_syntax: Outer_Syntax =
wenzelm@55616
    35
    Outer_Syntax.init().no_tokens.
wenzelm@55749
    36
      set_language_context(Completion.Language_Context.ML_outer)
wenzelm@55616
    37
wenzelm@55616
    38
  private lazy val news_syntax: Outer_Syntax =
wenzelm@55616
    39
    Outer_Syntax.init().no_tokens
wenzelm@53276
    40
wenzelm@53274
    41
  def mode_syntax(name: String): Option[Outer_Syntax] =
wenzelm@53274
    42
    name match {
wenzelm@53281
    43
      case "isabelle" | "isabelle-markup" =>
wenzelm@53277
    44
        val syntax = PIDE.session.recent_syntax
wenzelm@53277
    45
        if (syntax == Outer_Syntax.empty) None else Some(syntax)
wenzelm@53274
    46
      case "isabelle-options" => Some(Options.options_syntax)
wenzelm@53274
    47
      case "isabelle-root" => Some(Build.root_syntax)
wenzelm@55616
    48
      case "isabelle-ml" => Some(ml_syntax)
wenzelm@55616
    49
      case "isabelle-news" => Some(news_syntax)
wenzelm@53277
    50
      case "isabelle-output" => None
wenzelm@53274
    51
      case _ => None
wenzelm@53274
    52
    }
wenzelm@53274
    53
wenzelm@53274
    54
wenzelm@53277
    55
  /* token markers */
wenzelm@53277
    56
wenzelm@53277
    57
  private val markers =
wenzelm@53280
    58
    Map(modes.map(name => (name, new Token_Markup.Marker(name))): _*)
wenzelm@53277
    59
wenzelm@53277
    60
  def token_marker(name: String): Option[Token_Markup.Marker] = markers.get(name)
wenzelm@53277
    61
wenzelm@53277
    62
wenzelm@50208
    63
  /* dockable windows */
wenzelm@50208
    64
wenzelm@50208
    65
  private def wm(view: View): DockableWindowManager = view.getDockableWindowManager
wenzelm@50208
    66
wenzelm@55558
    67
  def documentation_dockable(view: View): Option[Documentation_Dockable] =
wenzelm@55558
    68
    wm(view).getDockableWindow("isabelle-documentation") match {
wenzelm@55558
    69
      case dockable: Documentation_Dockable => Some(dockable)
wenzelm@50208
    70
      case _ => None
wenzelm@50208
    71
    }
wenzelm@50208
    72
wenzelm@55558
    73
  def find_dockable(view: View): Option[Find_Dockable] =
wenzelm@55558
    74
    wm(view).getDockableWindow("isabelle-find") match {
wenzelm@55558
    75
      case dockable: Find_Dockable => Some(dockable)
wenzelm@51533
    76
      case _ => None
wenzelm@51533
    77
    }
wenzelm@51533
    78
wenzelm@55558
    79
  def monitor_dockable(view: View): Option[Monitor_Dockable] =
wenzelm@55558
    80
    wm(view).getDockableWindow("isabelle-monitor") match {
wenzelm@55558
    81
      case dockable: Monitor_Dockable => Some(dockable)
wenzelm@55558
    82
      case _ => None
wenzelm@55558
    83
    }
wenzelm@55558
    84
wenzelm@55558
    85
  def output_dockable(view: View): Option[Output_Dockable] =
wenzelm@50208
    86
    wm(view).getDockableWindow("isabelle-output") match {
wenzelm@50208
    87
      case dockable: Output_Dockable => Some(dockable)
wenzelm@50208
    88
      case _ => None
wenzelm@50208
    89
    }
wenzelm@50208
    90
wenzelm@55558
    91
  def protocol_dockable(view: View): Option[Protocol_Dockable] =
wenzelm@55558
    92
    wm(view).getDockableWindow("isabelle-protocol") match {
wenzelm@55558
    93
      case dockable: Protocol_Dockable => Some(dockable)
wenzelm@55558
    94
      case _ => None
wenzelm@55558
    95
    }
wenzelm@55558
    96
wenzelm@55558
    97
  def raw_output_dockable(view: View): Option[Raw_Output_Dockable] =
wenzelm@50208
    98
    wm(view).getDockableWindow("isabelle-raw-output") match {
wenzelm@50208
    99
      case dockable: Raw_Output_Dockable => Some(dockable)
wenzelm@50208
   100
      case _ => None
wenzelm@50208
   101
    }
wenzelm@50208
   102
wenzelm@55558
   103
  def simplifier_trace_dockable(view: View): Option[Simplifier_Trace_Dockable] =
wenzelm@55557
   104
    wm(view).getDockableWindow("isabelle-simplifier-trace") match {
lars@55316
   105
      case dockable: Simplifier_Trace_Dockable => Some(dockable)
lars@55316
   106
      case _ => None
lars@55316
   107
    }
lars@55316
   108
wenzelm@55558
   109
  def sledgehammer_dockable(view: View): Option[Sledgehammer_Dockable] =
wenzelm@55558
   110
    wm(view).getDockableWindow("isabelle-sledgehammer") match {
wenzelm@55558
   111
      case dockable: Sledgehammer_Dockable => Some(dockable)
wenzelm@55558
   112
      case _ => None
wenzelm@55558
   113
    }
wenzelm@55558
   114
wenzelm@55558
   115
  def symbols_dockable(view: View): Option[Symbols_Dockable] =
wenzelm@55558
   116
    wm(view).getDockableWindow("isabelle-symbols") match {
wenzelm@55558
   117
      case dockable: Symbols_Dockable => Some(dockable)
wenzelm@50208
   118
      case _ => None
wenzelm@50208
   119
    }
wenzelm@50208
   120
wenzelm@55558
   121
  def syslog_dockable(view: View): Option[Syslog_Dockable] =
wenzelm@55558
   122
    wm(view).getDockableWindow("isabelle-syslog") match {
wenzelm@55558
   123
      case dockable: Syslog_Dockable => Some(dockable)
wenzelm@55558
   124
      case _ => None
wenzelm@55558
   125
    }
wenzelm@55558
   126
wenzelm@55558
   127
  def theories_dockable(view: View): Option[Theories_Dockable] =
wenzelm@55558
   128
    wm(view).getDockableWindow("isabelle-theories") match {
wenzelm@55558
   129
      case dockable: Theories_Dockable => Some(dockable)
wenzelm@55558
   130
      case _ => None
wenzelm@55558
   131
    }
wenzelm@55558
   132
wenzelm@55558
   133
  def timing_dockable(view: View): Option[Timing_Dockable] =
wenzelm@55558
   134
    wm(view).getDockableWindow("isabelle-timing") match {
wenzelm@55558
   135
      case dockable: Timing_Dockable => Some(dockable)
wenzelm@50433
   136
      case _ => None
wenzelm@50433
   137
    }
wenzelm@50433
   138
wenzelm@50208
   139
wenzelm@52815
   140
  /* continuous checking */
wenzelm@52815
   141
wenzelm@52815
   142
  private val CONTINUOUS_CHECKING = "editor_continuous_checking"
wenzelm@52815
   143
wenzelm@52815
   144
  def continuous_checking: Boolean = PIDE.options.bool(CONTINUOUS_CHECKING)
wenzelm@52815
   145
wenzelm@52815
   146
  def continuous_checking_=(b: Boolean)
wenzelm@52815
   147
  {
wenzelm@52815
   148
    Swing_Thread.require()
wenzelm@52815
   149
wenzelm@52815
   150
    if (continuous_checking != b) {
wenzelm@52815
   151
      PIDE.options.bool(CONTINUOUS_CHECKING) = b
wenzelm@52815
   152
      PIDE.options_changed()
wenzelm@52974
   153
      PIDE.editor.flush()
wenzelm@52815
   154
    }
wenzelm@52815
   155
  }
wenzelm@52815
   156
wenzelm@52815
   157
  def set_continuous_checking() { continuous_checking = true }
wenzelm@52815
   158
  def reset_continuous_checking() { continuous_checking = false }
wenzelm@52815
   159
  def toggle_continuous_checking() { continuous_checking = !continuous_checking }
wenzelm@52815
   160
wenzelm@53715
   161
  class Continuous_Checking extends CheckBox("Continuous checking")
wenzelm@53715
   162
  {
wenzelm@53715
   163
    tooltip = "Continuous checking of proof document (visible and required parts)"
wenzelm@53715
   164
    reactions += { case ButtonClicked(_) => continuous_checking = selected }
wenzelm@53715
   165
    def load() { selected = continuous_checking }
wenzelm@53715
   166
    load()
wenzelm@53715
   167
  }
wenzelm@53715
   168
wenzelm@52815
   169
wenzelm@52815
   170
  /* required document nodes */
wenzelm@52815
   171
wenzelm@52815
   172
  private def node_required_update(view: View, toggle: Boolean = false, set: Boolean = false)
wenzelm@52815
   173
  {
wenzelm@52815
   174
    Swing_Thread.require()
wenzelm@52815
   175
    PIDE.document_model(view.getBuffer) match {
wenzelm@52815
   176
      case Some(model) =>
wenzelm@52816
   177
        model.node_required = (if (toggle) !model.node_required else set)
wenzelm@52815
   178
      case None =>
wenzelm@52815
   179
    }
wenzelm@52815
   180
  }
wenzelm@52815
   181
wenzelm@52815
   182
  def set_node_required(view: View) { node_required_update(view, set = true) }
wenzelm@52815
   183
  def reset_node_required(view: View) { node_required_update(view, set = false) }
wenzelm@52815
   184
  def toggle_node_required(view: View) { node_required_update(view, toggle = true) }
wenzelm@52815
   185
wenzelm@52815
   186
wenzelm@50198
   187
  /* font size */
wenzelm@50198
   188
wenzelm@55827
   189
  def reset_font_size() {
wenzelm@55827
   190
    Font_Info.main_change.reset(PIDE.options.int("jedit_reset_font_size").toFloat)
wenzelm@55823
   191
  }
wenzelm@55827
   192
  def increase_font_size() { Font_Info.main_change.step(1) }
wenzelm@55827
   193
  def decrease_font_size() { Font_Info.main_change.step(-1) }
wenzelm@50198
   194
wenzelm@50198
   195
wenzelm@53497
   196
  /* structured edits */
wenzelm@50341
   197
wenzelm@50341
   198
  def insert_line_padding(text_area: JEditTextArea, text: String)
wenzelm@50341
   199
  {
wenzelm@50341
   200
    val buffer = text_area.getBuffer
wenzelm@50341
   201
    JEdit_Lib.buffer_edit(buffer) {
wenzelm@50341
   202
      val text1 =
wenzelm@50341
   203
        if (text_area.getSelectionCount == 0) {
wenzelm@50341
   204
          def pad(range: Text.Range): String =
wenzelm@50341
   205
            if (JEdit_Lib.try_get_text(buffer, range) == Some("\n")) "" else "\n"
wenzelm@50341
   206
wenzelm@50341
   207
          val caret = JEdit_Lib.point_range(buffer, text_area.getCaretPosition)
wenzelm@50341
   208
          val before_caret = JEdit_Lib.point_range(buffer, caret.start - 1)
wenzelm@50341
   209
          pad(before_caret) + text + pad(caret)
wenzelm@50341
   210
        }
wenzelm@50341
   211
        else text
wenzelm@50341
   212
      text_area.setSelectedText(text1)
wenzelm@50341
   213
    }
wenzelm@50341
   214
  }
wenzelm@50341
   215
wenzelm@53497
   216
  def edit_command(
wenzelm@53497
   217
    snapshot: Document.Snapshot,
wenzelm@53497
   218
    buffer: Buffer,
wenzelm@53497
   219
    padding: Boolean,
wenzelm@54640
   220
    id: Document_ID.Generic,
wenzelm@53497
   221
    s: String)
wenzelm@53497
   222
  {
wenzelm@54640
   223
    if (!snapshot.is_outdated) {
wenzelm@54640
   224
      snapshot.state.find_command(snapshot.version, id) match {
wenzelm@54640
   225
        case Some((node, command)) =>
wenzelm@54640
   226
          node.command_start(command) match {
wenzelm@54640
   227
            case Some(start) =>
wenzelm@54640
   228
              JEdit_Lib.buffer_edit(buffer) {
wenzelm@54640
   229
                val range = command.proper_range + start
wenzelm@54640
   230
                if (padding) {
wenzelm@54640
   231
                  buffer.insert(start + range.length, "\n" + s)
wenzelm@54640
   232
                }
wenzelm@54640
   233
                else {
wenzelm@54640
   234
                  buffer.remove(start, range.length)
wenzelm@54640
   235
                  buffer.insert(start, s)
wenzelm@54640
   236
                }
wenzelm@53497
   237
              }
wenzelm@54640
   238
            case None =>
wenzelm@54640
   239
          }
wenzelm@54640
   240
        case None =>
wenzelm@54640
   241
      }
wenzelm@53497
   242
    }
wenzelm@53497
   243
  }
wenzelm@53497
   244
wenzelm@50341
   245
wenzelm@53293
   246
  /* completion */
wenzelm@53293
   247
wenzelm@53293
   248
  def complete(view: View)
wenzelm@53293
   249
  {
wenzelm@53293
   250
    Completion_Popup.Text_Area(view.getTextArea) match {
wenzelm@53322
   251
      case Some(text_area_completion) =>
wenzelm@53322
   252
        text_area_completion.action(immediate = true, explicit = true)
wenzelm@53293
   253
      case None => CompleteWord.completeWord(view)
wenzelm@53293
   254
    }
wenzelm@53293
   255
  }
wenzelm@53293
   256
wenzelm@53293
   257
wenzelm@50183
   258
  /* control styles */
wenzelm@50183
   259
wenzelm@50183
   260
  def control_sub(text_area: JEditTextArea)
wenzelm@50187
   261
  { Token_Markup.edit_control_style(text_area, Symbol.sub_decoded) }
wenzelm@50183
   262
wenzelm@50183
   263
  def control_sup(text_area: JEditTextArea)
wenzelm@50187
   264
  { Token_Markup.edit_control_style(text_area, Symbol.sup_decoded) }
wenzelm@50183
   265
wenzelm@50183
   266
  def control_bold(text_area: JEditTextArea)
wenzelm@50187
   267
  { Token_Markup.edit_control_style(text_area, Symbol.bold_decoded) }
wenzelm@50183
   268
wenzelm@50183
   269
  def control_reset(text_area: JEditTextArea)
wenzelm@50187
   270
  { Token_Markup.edit_control_style(text_area, "") }
wenzelm@50183
   271
wenzelm@50183
   272
wenzelm@50183
   273
  /* block styles */
wenzelm@50183
   274
wenzelm@50183
   275
  private def enclose_input(text_area: JEditTextArea, s1: String, s2: String)
wenzelm@50183
   276
  {
wenzelm@50183
   277
    s1.foreach(text_area.userInput(_))
wenzelm@50183
   278
    s2.foreach(text_area.userInput(_))
wenzelm@50183
   279
    s2.foreach(_ => text_area.goToPrevCharacter(false))
wenzelm@50183
   280
  }
wenzelm@50183
   281
wenzelm@50183
   282
  def input_bsub(text_area: JEditTextArea)
wenzelm@50183
   283
  { enclose_input(text_area, Symbol.bsub_decoded, Symbol.esub_decoded) }
wenzelm@50183
   284
wenzelm@50183
   285
  def input_bsup(text_area: JEditTextArea)
wenzelm@50183
   286
  { enclose_input(text_area, Symbol.bsup_decoded, Symbol.esup_decoded) }
wenzelm@50183
   287
}
wenzelm@50183
   288