src/Tools/jEdit/src/completion_popup.scala
author wenzelm
Fri Aug 30 13:24:14 2013 +0200 (2013-08-30 ago)
changeset 53325 ffabc0083786
parent 53322 a4cd032172e0
child 53337 b3817a0e3211
permissions -rw-r--r--
more explicit indication of unique result (see also 45be26b98ca6, 3d654643cf56);
wenzelm@53023
     1
/*  Title:      Tools/jEdit/src/completion_popup.scala
wenzelm@53023
     2
    Author:     Makarius
wenzelm@53023
     3
wenzelm@53246
     4
Completion popup.
wenzelm@53023
     5
*/
wenzelm@53023
     6
wenzelm@53023
     7
package isabelle.jedit
wenzelm@53023
     8
wenzelm@53023
     9
wenzelm@53023
    10
import isabelle._
wenzelm@53023
    11
wenzelm@53297
    12
import java.awt.{Color, Font, Point, BorderLayout, Dimension}
wenzelm@53296
    13
import java.awt.event.{InputEvent, KeyEvent, MouseEvent, MouseAdapter, FocusAdapter, FocusEvent}
wenzelm@53246
    14
import javax.swing.{JPanel, JComponent, JLayeredPane, SwingUtilities}
wenzelm@53297
    15
import javax.swing.border.LineBorder
wenzelm@53023
    16
wenzelm@53023
    17
import scala.swing.{ListView, ScrollPane}
wenzelm@53023
    18
import scala.swing.event.MouseClicked
wenzelm@53023
    19
wenzelm@53296
    20
import org.gjt.sp.jedit.{View, Debug}
wenzelm@53228
    21
import org.gjt.sp.jedit.textarea.JEditTextArea
wenzelm@53023
    22
wenzelm@53023
    23
wenzelm@53023
    24
object Completion_Popup
wenzelm@53023
    25
{
wenzelm@53272
    26
  /* setup for jEdit text area */
wenzelm@53235
    27
wenzelm@53242
    28
  object Text_Area
wenzelm@53233
    29
  {
wenzelm@53274
    30
    private val key = new Object
wenzelm@53274
    31
wenzelm@53274
    32
    def apply(text_area: JEditTextArea): Option[Completion_Popup.Text_Area] =
wenzelm@53274
    33
      text_area.getClientProperty(key) match {
wenzelm@53274
    34
        case text_area_completion: Completion_Popup.Text_Area => Some(text_area_completion)
wenzelm@53274
    35
        case _ => None
wenzelm@53274
    36
      }
wenzelm@53274
    37
wenzelm@53274
    38
    def exit(text_area: JEditTextArea)
wenzelm@53274
    39
    {
wenzelm@53274
    40
      Swing_Thread.require()
wenzelm@53274
    41
      apply(text_area) match {
wenzelm@53274
    42
        case None =>
wenzelm@53274
    43
        case Some(text_area_completion) =>
wenzelm@53274
    44
          text_area_completion.deactivate()
wenzelm@53274
    45
          text_area.putClientProperty(key, null)
wenzelm@53274
    46
      }
wenzelm@53274
    47
    }
wenzelm@53274
    48
wenzelm@53274
    49
    def init(text_area: JEditTextArea): Completion_Popup.Text_Area =
wenzelm@53274
    50
    {
wenzelm@53274
    51
      exit(text_area)
wenzelm@53274
    52
      val text_area_completion = new Text_Area(text_area)
wenzelm@53274
    53
      text_area.putClientProperty(key, text_area_completion)
wenzelm@53274
    54
      text_area_completion.activate()
wenzelm@53274
    55
      text_area_completion
wenzelm@53274
    56
    }
wenzelm@53274
    57
wenzelm@53274
    58
    def dismissed(text_area: JEditTextArea): Boolean =
wenzelm@53274
    59
    {
wenzelm@53274
    60
      Swing_Thread.require()
wenzelm@53274
    61
      apply(text_area) match {
wenzelm@53274
    62
        case Some(text_area_completion) => text_area_completion.dismissed()
wenzelm@53274
    63
        case None => false
wenzelm@53274
    64
      }
wenzelm@53274
    65
    }
wenzelm@53272
    66
  }
wenzelm@53272
    67
wenzelm@53274
    68
  class Text_Area private(text_area: JEditTextArea)
wenzelm@53272
    69
  {
wenzelm@53272
    70
    private var completion_popup: Option[Completion_Popup] = None
wenzelm@53272
    71
wenzelm@53272
    72
wenzelm@53292
    73
    /* completion action */
wenzelm@53273
    74
wenzelm@53275
    75
    private def insert(item: Completion.Item)
wenzelm@53242
    76
    {
wenzelm@53242
    77
      Swing_Thread.require()
wenzelm@53023
    78
wenzelm@53242
    79
      val buffer = text_area.getBuffer
wenzelm@53242
    80
      val len = item.original.length
wenzelm@53242
    81
      if (buffer.isEditable && len > 0) {
wenzelm@53242
    82
        JEdit_Lib.buffer_edit(buffer) {
wenzelm@53242
    83
          val caret = text_area.getCaretPosition
wenzelm@53242
    84
          JEdit_Lib.try_get_text(buffer, Text.Range(caret - len, caret)) match {
wenzelm@53242
    85
            case Some(text) if text == item.original =>
wenzelm@53242
    86
              buffer.remove(caret - len, len)
wenzelm@53242
    87
              buffer.insert(caret - len, item.replacement)
wenzelm@53242
    88
            case _ =>
wenzelm@53242
    89
          }
wenzelm@53233
    90
        }
wenzelm@53233
    91
      }
wenzelm@53233
    92
    }
wenzelm@53242
    93
wenzelm@53322
    94
    def action(immediate: Boolean = false, explicit: Boolean = false)
wenzelm@53292
    95
    {
wenzelm@53292
    96
      val view = text_area.getView
wenzelm@53292
    97
      val layered = view.getLayeredPane
wenzelm@53292
    98
      val buffer = text_area.getBuffer
wenzelm@53292
    99
      val painter = text_area.getPainter
wenzelm@53273
   100
wenzelm@53292
   101
      if (buffer.isEditable) {
wenzelm@53292
   102
        Isabelle.mode_syntax(JEdit_Lib.buffer_mode(buffer)) match {
wenzelm@53292
   103
          case Some(syntax) =>
wenzelm@53292
   104
            val caret = text_area.getCaretPosition
wenzelm@53292
   105
            val line = buffer.getLineOfOffset(caret)
wenzelm@53292
   106
            val start = buffer.getLineStartOffset(line)
wenzelm@53292
   107
            val text = buffer.getSegment(start, caret - start)
wenzelm@53292
   108
wenzelm@53322
   109
            val decode = Isabelle_Encoding.is_active(buffer)
wenzelm@53322
   110
            syntax.completion.complete(decode, explicit, text) match {
wenzelm@53325
   111
              case Some(result) =>
wenzelm@53325
   112
                if (result.unique && result.items.head.immediate && immediate)
wenzelm@53325
   113
                  insert(result.items.head)
wenzelm@53325
   114
                else {
wenzelm@53325
   115
                  val font =
wenzelm@53325
   116
                    painter.getFont.deriveFont(Rendering.font_size("jedit_popup_font_scale"))
wenzelm@53292
   117
wenzelm@53325
   118
                  val loc1 = text_area.offsetToXY(caret - result.original.length)
wenzelm@53325
   119
                  if (loc1 != null) {
wenzelm@53325
   120
                    val loc2 =
wenzelm@53325
   121
                      SwingUtilities.convertPoint(painter,
wenzelm@53325
   122
                        loc1.x, loc1.y + painter.getFontMetrics.getHeight, layered)
wenzelm@53292
   123
wenzelm@53325
   124
                    val completion =
wenzelm@53325
   125
                      new Completion_Popup(layered, loc2, font, result.items) {
wenzelm@53325
   126
                        override def complete(item: Completion.Item) { insert(item) }
wenzelm@53325
   127
                        override def propagate(evt: KeyEvent) {
wenzelm@53325
   128
                          JEdit_Lib.propagate_key(view, evt)
wenzelm@53325
   129
                          input(evt)
wenzelm@53325
   130
                        }
wenzelm@53325
   131
                        override def refocus() { text_area.requestFocus }
wenzelm@53292
   132
                      }
wenzelm@53325
   133
                    completion_popup = Some(completion)
wenzelm@53325
   134
                    completion.show_popup()
wenzelm@53325
   135
                  }
wenzelm@53292
   136
                }
wenzelm@53292
   137
              case None =>
wenzelm@53292
   138
            }
wenzelm@53292
   139
          case None =>
wenzelm@53292
   140
        }
wenzelm@53292
   141
      }
wenzelm@53292
   142
    }
wenzelm@53292
   143
wenzelm@53292
   144
wenzelm@53292
   145
    /* input key events */
wenzelm@53273
   146
wenzelm@53272
   147
    def input(evt: KeyEvent)
wenzelm@53242
   148
    {
wenzelm@53242
   149
      Swing_Thread.require()
wenzelm@53233
   150
wenzelm@53273
   151
      if (PIDE.options.bool("jedit_completion")) {
wenzelm@53273
   152
        if (!evt.isConsumed) {
wenzelm@53273
   153
          dismissed()
wenzelm@53296
   154
wenzelm@53296
   155
          val mod = evt.getModifiers
wenzelm@53296
   156
          val special =
wenzelm@53296
   157
            evt.getKeyChar == '\b' ||
wenzelm@53296
   158
            // cf. 5.1.0/jEdit/org/gjt/sp/jedit/gui/KeyEventWorkaround.java
wenzelm@53296
   159
            (mod & InputEvent.CTRL_MASK) != 0 && (mod & InputEvent.ALT_MASK) == 0 ||
wenzelm@53296
   160
            (mod & InputEvent.CTRL_MASK) == 0 && (mod & InputEvent.ALT_MASK) != 0 &&
wenzelm@53296
   161
              !Debug.ALT_KEY_PRESSED_DISABLED ||
wenzelm@53296
   162
            (mod & InputEvent.META_MASK) != 0
wenzelm@53296
   163
wenzelm@53296
   164
          if (PIDE.options.seconds("jedit_completion_delay").is_zero && !special) {
wenzelm@53292
   165
            input_delay.revoke()
wenzelm@53322
   166
            action(immediate = PIDE.options.bool("jedit_completion_immediate"))
wenzelm@53292
   167
          }
wenzelm@53292
   168
          else input_delay.invoke()
wenzelm@53242
   169
        }
wenzelm@53228
   170
      }
wenzelm@53228
   171
    }
wenzelm@53273
   172
wenzelm@53273
   173
    private val input_delay =
wenzelm@53292
   174
      Swing_Thread.delay_last(PIDE.options.seconds("jedit_completion_delay")) {
wenzelm@53322
   175
        action()
wenzelm@53292
   176
      }
wenzelm@53273
   177
wenzelm@53273
   178
wenzelm@53292
   179
    /* dismiss popup */
wenzelm@53273
   180
wenzelm@53292
   181
    def dismissed(): Boolean =
wenzelm@53292
   182
    {
wenzelm@53292
   183
      Swing_Thread.require()
wenzelm@53273
   184
wenzelm@53292
   185
      completion_popup match {
wenzelm@53292
   186
        case Some(completion) =>
wenzelm@53292
   187
          completion.hide_popup()
wenzelm@53292
   188
          completion_popup = None
wenzelm@53292
   189
          true
wenzelm@53292
   190
        case None =>
wenzelm@53292
   191
          false
wenzelm@53273
   192
      }
wenzelm@53292
   193
    }
wenzelm@53274
   194
wenzelm@53274
   195
wenzelm@53274
   196
    /* activation */
wenzelm@53274
   197
wenzelm@53274
   198
    private val outer_key_listener =
wenzelm@53274
   199
      JEdit_Lib.key_listener(key_typed = input _)
wenzelm@53274
   200
wenzelm@53274
   201
    private def activate()
wenzelm@53274
   202
    {
wenzelm@53274
   203
      text_area.addKeyListener(outer_key_listener)
wenzelm@53274
   204
    }
wenzelm@53274
   205
wenzelm@53274
   206
    private def deactivate()
wenzelm@53274
   207
    {
wenzelm@53274
   208
      dismissed()
wenzelm@53274
   209
      text_area.removeKeyListener(outer_key_listener)
wenzelm@53274
   210
    }
wenzelm@53228
   211
  }
wenzelm@53023
   212
}
wenzelm@53023
   213
wenzelm@53233
   214
wenzelm@53023
   215
class Completion_Popup private(
wenzelm@53246
   216
  layered: JLayeredPane,
wenzelm@53246
   217
  location: Point,
wenzelm@53272
   218
  font: Font,
wenzelm@53275
   219
  items: List[Completion.Item]) extends JPanel(new BorderLayout)
wenzelm@53023
   220
{
wenzelm@53023
   221
  completion =>
wenzelm@53023
   222
wenzelm@53023
   223
  Swing_Thread.require()
wenzelm@53232
   224
  require(!items.isEmpty)
wenzelm@53232
   225
wenzelm@53232
   226
wenzelm@53232
   227
  /* actions */
wenzelm@53232
   228
wenzelm@53275
   229
  def complete(item: Completion.Item) { }
wenzelm@53232
   230
  def propagate(evt: KeyEvent) { }
wenzelm@53234
   231
  def refocus() { }
wenzelm@53023
   232
wenzelm@53023
   233
wenzelm@53023
   234
  /* list view */
wenzelm@53023
   235
wenzelm@53023
   236
  private val list_view = new ListView(items)
wenzelm@53272
   237
  list_view.font = font
wenzelm@53023
   238
  list_view.selection.intervalMode = ListView.IntervalMode.Single
wenzelm@53023
   239
  list_view.peer.setFocusTraversalKeysEnabled(false)
wenzelm@53023
   240
  list_view.peer.setVisibleRowCount(items.length min 8)
wenzelm@53023
   241
  list_view.peer.setSelectedIndex(0)
wenzelm@53023
   242
wenzelm@53023
   243
  private def complete_selected(): Boolean =
wenzelm@53023
   244
  {
wenzelm@53023
   245
    list_view.selection.items.toList match {
wenzelm@53023
   246
      case item :: _ => complete(item); true
wenzelm@53023
   247
      case _ => false
wenzelm@53023
   248
    }
wenzelm@53023
   249
  }
wenzelm@53023
   250
wenzelm@53023
   251
  private def move_items(n: Int)
wenzelm@53023
   252
  {
wenzelm@53023
   253
    val i = list_view.peer.getSelectedIndex
wenzelm@53023
   254
    val j = ((i + n) min (items.length - 1)) max 0
wenzelm@53023
   255
    if (i != j) {
wenzelm@53023
   256
      list_view.peer.setSelectedIndex(j)
wenzelm@53023
   257
      list_view.peer.ensureIndexIsVisible(j)
wenzelm@53023
   258
    }
wenzelm@53023
   259
  }
wenzelm@53023
   260
wenzelm@53023
   261
  private def move_pages(n: Int)
wenzelm@53023
   262
  {
wenzelm@53023
   263
    val page_size = list_view.peer.getVisibleRowCount - 1
wenzelm@53023
   264
    move_items(page_size * n)
wenzelm@53023
   265
  }
wenzelm@53023
   266
wenzelm@53023
   267
wenzelm@53023
   268
  /* event handling */
wenzelm@53023
   269
wenzelm@53274
   270
  private val inner_key_listener =
wenzelm@53226
   271
    JEdit_Lib.key_listener(
wenzelm@53226
   272
      key_pressed = (e: KeyEvent) =>
wenzelm@53226
   273
        {
wenzelm@53226
   274
          if (!e.isConsumed) {
wenzelm@53226
   275
            e.getKeyCode match {
wenzelm@53226
   276
              case KeyEvent.VK_TAB =>
wenzelm@53226
   277
                if (complete_selected()) e.consume
wenzelm@53226
   278
                hide_popup()
wenzelm@53226
   279
              case KeyEvent.VK_ESCAPE =>
wenzelm@53226
   280
                hide_popup()
wenzelm@53226
   281
                e.consume
wenzelm@53226
   282
              case KeyEvent.VK_UP => move_items(-1); e.consume
wenzelm@53226
   283
              case KeyEvent.VK_DOWN => move_items(1); e.consume
wenzelm@53226
   284
              case KeyEvent.VK_PAGE_UP => move_pages(-1); e.consume
wenzelm@53226
   285
              case KeyEvent.VK_PAGE_DOWN => move_pages(1); e.consume
wenzelm@53226
   286
              case _ =>
wenzelm@53226
   287
                if (e.isActionKey || e.isAltDown || e.isMetaDown || e.isControlDown)
wenzelm@53226
   288
                  hide_popup()
wenzelm@53226
   289
            }
wenzelm@53226
   290
          }
wenzelm@53232
   291
          propagate(e)
wenzelm@53226
   292
        },
wenzelm@53232
   293
      key_typed = propagate _
wenzelm@53226
   294
    )
wenzelm@53023
   295
wenzelm@53274
   296
  list_view.peer.addKeyListener(inner_key_listener)
wenzelm@53023
   297
wenzelm@53023
   298
  list_view.peer.addMouseListener(new MouseAdapter {
wenzelm@53023
   299
    override def mouseClicked(e: MouseEvent) {
wenzelm@53023
   300
      if (complete_selected()) e.consume
wenzelm@53023
   301
      hide_popup()
wenzelm@53023
   302
    }
wenzelm@53023
   303
  })
wenzelm@53023
   304
wenzelm@53023
   305
  list_view.peer.addFocusListener(new FocusAdapter {
wenzelm@53023
   306
    override def focusLost(e: FocusEvent) { hide_popup() }
wenzelm@53023
   307
  })
wenzelm@53023
   308
wenzelm@53023
   309
wenzelm@53023
   310
  /* main content */
wenzelm@53023
   311
wenzelm@53023
   312
  override def getFocusTraversalKeysEnabled = false
wenzelm@53297
   313
  completion.setBorder(new LineBorder(Color.BLACK))
wenzelm@53023
   314
  completion.add((new ScrollPane(list_view)).peer.asInstanceOf[JComponent])
wenzelm@53023
   315
wenzelm@53023
   316
wenzelm@53023
   317
  /* popup */
wenzelm@53023
   318
wenzelm@53023
   319
  private val popup =
wenzelm@53023
   320
  {
wenzelm@53247
   321
    val screen = JEdit_Lib.screen_location(layered, location)
wenzelm@53247
   322
    val size =
wenzelm@53230
   323
    {
wenzelm@53230
   324
      val geometry = JEdit_Lib.window_geometry(completion, completion)
wenzelm@53230
   325
      val bounds = Rendering.popup_bounds
wenzelm@53247
   326
      val w = geometry.width min (screen.bounds.width * bounds).toInt min layered.getWidth
wenzelm@53247
   327
      val h = geometry.height min (screen.bounds.height * bounds).toInt min layered.getHeight
wenzelm@53247
   328
      new Dimension(w, h)
wenzelm@53230
   329
    }
wenzelm@53247
   330
    new Popup(layered, completion, screen.relative(layered, size), size)
wenzelm@53246
   331
  }
wenzelm@53246
   332
wenzelm@53246
   333
  private def show_popup()
wenzelm@53246
   334
  {
wenzelm@53246
   335
    popup.show
wenzelm@53246
   336
    list_view.requestFocus
wenzelm@53023
   337
  }
wenzelm@53023
   338
wenzelm@53232
   339
  private def hide_popup()
wenzelm@53023
   340
  {
wenzelm@53234
   341
    val had_focus = list_view.peer.isFocusOwner
wenzelm@53229
   342
    popup.hide
wenzelm@53234
   343
    if (had_focus) refocus()
wenzelm@53023
   344
  }
wenzelm@53023
   345
}
wenzelm@53023
   346