src/Tools/jEdit/src/completion_popup.scala
author wenzelm
Thu Aug 29 22:40:50 2013 +0200 (2013-08-29 ago)
changeset 53297 64c31de7f21c
parent 53296 65c60c782da5
child 53322 a4cd032172e0
permissions -rw-r--r--
border as for Pretty_Tooltip;
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@53292
    94
    def action(immediate: Boolean)
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@53292
   109
            syntax.completion.complete(Isabelle_Encoding.is_active(buffer), text) match {
wenzelm@53296
   110
              case Some((_, List(item))) if item.immediate && immediate =>
wenzelm@53292
   111
                insert(item)
wenzelm@53292
   112
wenzelm@53292
   113
              case Some((original, items)) =>
wenzelm@53292
   114
                val font =
wenzelm@53292
   115
                  painter.getFont.deriveFont(Rendering.font_size("jedit_popup_font_scale"))
wenzelm@53292
   116
wenzelm@53292
   117
                val loc1 = text_area.offsetToXY(caret - original.length)
wenzelm@53292
   118
                if (loc1 != null) {
wenzelm@53292
   119
                  val loc2 =
wenzelm@53292
   120
                    SwingUtilities.convertPoint(painter,
wenzelm@53292
   121
                      loc1.x, loc1.y + painter.getFontMetrics.getHeight, layered)
wenzelm@53292
   122
wenzelm@53292
   123
                  val completion =
wenzelm@53292
   124
                    new Completion_Popup(layered, loc2, font, items) {
wenzelm@53292
   125
                      override def complete(item: Completion.Item) { insert(item) }
wenzelm@53292
   126
                      override def propagate(evt: KeyEvent) {
wenzelm@53292
   127
                        JEdit_Lib.propagate_key(view, evt)
wenzelm@53292
   128
                        input(evt)
wenzelm@53292
   129
                      }
wenzelm@53292
   130
                      override def refocus() { text_area.requestFocus }
wenzelm@53292
   131
                    }
wenzelm@53292
   132
                  completion_popup = Some(completion)
wenzelm@53292
   133
                  completion.show_popup()
wenzelm@53292
   134
                }
wenzelm@53292
   135
              case None =>
wenzelm@53292
   136
            }
wenzelm@53292
   137
          case None =>
wenzelm@53292
   138
        }
wenzelm@53292
   139
      }
wenzelm@53292
   140
    }
wenzelm@53292
   141
wenzelm@53292
   142
wenzelm@53292
   143
    /* input key events */
wenzelm@53273
   144
wenzelm@53272
   145
    def input(evt: KeyEvent)
wenzelm@53242
   146
    {
wenzelm@53242
   147
      Swing_Thread.require()
wenzelm@53233
   148
wenzelm@53273
   149
      if (PIDE.options.bool("jedit_completion")) {
wenzelm@53273
   150
        if (!evt.isConsumed) {
wenzelm@53273
   151
          dismissed()
wenzelm@53296
   152
wenzelm@53296
   153
          val mod = evt.getModifiers
wenzelm@53296
   154
          val special =
wenzelm@53296
   155
            evt.getKeyChar == '\b' ||
wenzelm@53296
   156
            // cf. 5.1.0/jEdit/org/gjt/sp/jedit/gui/KeyEventWorkaround.java
wenzelm@53296
   157
            (mod & InputEvent.CTRL_MASK) != 0 && (mod & InputEvent.ALT_MASK) == 0 ||
wenzelm@53296
   158
            (mod & InputEvent.CTRL_MASK) == 0 && (mod & InputEvent.ALT_MASK) != 0 &&
wenzelm@53296
   159
              !Debug.ALT_KEY_PRESSED_DISABLED ||
wenzelm@53296
   160
            (mod & InputEvent.META_MASK) != 0
wenzelm@53296
   161
wenzelm@53296
   162
          if (PIDE.options.seconds("jedit_completion_delay").is_zero && !special) {
wenzelm@53292
   163
            input_delay.revoke()
wenzelm@53292
   164
            action(PIDE.options.bool("jedit_completion_immediate"))
wenzelm@53292
   165
          }
wenzelm@53292
   166
          else input_delay.invoke()
wenzelm@53242
   167
        }
wenzelm@53228
   168
      }
wenzelm@53228
   169
    }
wenzelm@53273
   170
wenzelm@53273
   171
    private val input_delay =
wenzelm@53292
   172
      Swing_Thread.delay_last(PIDE.options.seconds("jedit_completion_delay")) {
wenzelm@53292
   173
        action(false)
wenzelm@53292
   174
      }
wenzelm@53273
   175
wenzelm@53273
   176
wenzelm@53292
   177
    /* dismiss popup */
wenzelm@53273
   178
wenzelm@53292
   179
    def dismissed(): Boolean =
wenzelm@53292
   180
    {
wenzelm@53292
   181
      Swing_Thread.require()
wenzelm@53273
   182
wenzelm@53292
   183
      completion_popup match {
wenzelm@53292
   184
        case Some(completion) =>
wenzelm@53292
   185
          completion.hide_popup()
wenzelm@53292
   186
          completion_popup = None
wenzelm@53292
   187
          true
wenzelm@53292
   188
        case None =>
wenzelm@53292
   189
          false
wenzelm@53273
   190
      }
wenzelm@53292
   191
    }
wenzelm@53274
   192
wenzelm@53274
   193
wenzelm@53274
   194
    /* activation */
wenzelm@53274
   195
wenzelm@53274
   196
    private val outer_key_listener =
wenzelm@53274
   197
      JEdit_Lib.key_listener(key_typed = input _)
wenzelm@53274
   198
wenzelm@53274
   199
    private def activate()
wenzelm@53274
   200
    {
wenzelm@53274
   201
      text_area.addKeyListener(outer_key_listener)
wenzelm@53274
   202
    }
wenzelm@53274
   203
wenzelm@53274
   204
    private def deactivate()
wenzelm@53274
   205
    {
wenzelm@53274
   206
      dismissed()
wenzelm@53274
   207
      text_area.removeKeyListener(outer_key_listener)
wenzelm@53274
   208
    }
wenzelm@53228
   209
  }
wenzelm@53023
   210
}
wenzelm@53023
   211
wenzelm@53233
   212
wenzelm@53023
   213
class Completion_Popup private(
wenzelm@53246
   214
  layered: JLayeredPane,
wenzelm@53246
   215
  location: Point,
wenzelm@53272
   216
  font: Font,
wenzelm@53275
   217
  items: List[Completion.Item]) extends JPanel(new BorderLayout)
wenzelm@53023
   218
{
wenzelm@53023
   219
  completion =>
wenzelm@53023
   220
wenzelm@53023
   221
  Swing_Thread.require()
wenzelm@53232
   222
  require(!items.isEmpty)
wenzelm@53232
   223
wenzelm@53232
   224
wenzelm@53232
   225
  /* actions */
wenzelm@53232
   226
wenzelm@53275
   227
  def complete(item: Completion.Item) { }
wenzelm@53232
   228
  def propagate(evt: KeyEvent) { }
wenzelm@53234
   229
  def refocus() { }
wenzelm@53023
   230
wenzelm@53023
   231
wenzelm@53023
   232
  /* list view */
wenzelm@53023
   233
wenzelm@53023
   234
  private val list_view = new ListView(items)
wenzelm@53272
   235
  list_view.font = font
wenzelm@53023
   236
  list_view.selection.intervalMode = ListView.IntervalMode.Single
wenzelm@53023
   237
  list_view.peer.setFocusTraversalKeysEnabled(false)
wenzelm@53023
   238
  list_view.peer.setVisibleRowCount(items.length min 8)
wenzelm@53023
   239
  list_view.peer.setSelectedIndex(0)
wenzelm@53023
   240
wenzelm@53023
   241
  private def complete_selected(): Boolean =
wenzelm@53023
   242
  {
wenzelm@53023
   243
    list_view.selection.items.toList match {
wenzelm@53023
   244
      case item :: _ => complete(item); true
wenzelm@53023
   245
      case _ => false
wenzelm@53023
   246
    }
wenzelm@53023
   247
  }
wenzelm@53023
   248
wenzelm@53023
   249
  private def move_items(n: Int)
wenzelm@53023
   250
  {
wenzelm@53023
   251
    val i = list_view.peer.getSelectedIndex
wenzelm@53023
   252
    val j = ((i + n) min (items.length - 1)) max 0
wenzelm@53023
   253
    if (i != j) {
wenzelm@53023
   254
      list_view.peer.setSelectedIndex(j)
wenzelm@53023
   255
      list_view.peer.ensureIndexIsVisible(j)
wenzelm@53023
   256
    }
wenzelm@53023
   257
  }
wenzelm@53023
   258
wenzelm@53023
   259
  private def move_pages(n: Int)
wenzelm@53023
   260
  {
wenzelm@53023
   261
    val page_size = list_view.peer.getVisibleRowCount - 1
wenzelm@53023
   262
    move_items(page_size * n)
wenzelm@53023
   263
  }
wenzelm@53023
   264
wenzelm@53023
   265
wenzelm@53023
   266
  /* event handling */
wenzelm@53023
   267
wenzelm@53274
   268
  private val inner_key_listener =
wenzelm@53226
   269
    JEdit_Lib.key_listener(
wenzelm@53226
   270
      key_pressed = (e: KeyEvent) =>
wenzelm@53226
   271
        {
wenzelm@53226
   272
          if (!e.isConsumed) {
wenzelm@53226
   273
            e.getKeyCode match {
wenzelm@53226
   274
              case KeyEvent.VK_TAB =>
wenzelm@53226
   275
                if (complete_selected()) e.consume
wenzelm@53226
   276
                hide_popup()
wenzelm@53226
   277
              case KeyEvent.VK_ESCAPE =>
wenzelm@53226
   278
                hide_popup()
wenzelm@53226
   279
                e.consume
wenzelm@53226
   280
              case KeyEvent.VK_UP => move_items(-1); e.consume
wenzelm@53226
   281
              case KeyEvent.VK_DOWN => move_items(1); e.consume
wenzelm@53226
   282
              case KeyEvent.VK_PAGE_UP => move_pages(-1); e.consume
wenzelm@53226
   283
              case KeyEvent.VK_PAGE_DOWN => move_pages(1); e.consume
wenzelm@53226
   284
              case _ =>
wenzelm@53226
   285
                if (e.isActionKey || e.isAltDown || e.isMetaDown || e.isControlDown)
wenzelm@53226
   286
                  hide_popup()
wenzelm@53226
   287
            }
wenzelm@53226
   288
          }
wenzelm@53232
   289
          propagate(e)
wenzelm@53226
   290
        },
wenzelm@53232
   291
      key_typed = propagate _
wenzelm@53226
   292
    )
wenzelm@53023
   293
wenzelm@53274
   294
  list_view.peer.addKeyListener(inner_key_listener)
wenzelm@53023
   295
wenzelm@53023
   296
  list_view.peer.addMouseListener(new MouseAdapter {
wenzelm@53023
   297
    override def mouseClicked(e: MouseEvent) {
wenzelm@53023
   298
      if (complete_selected()) e.consume
wenzelm@53023
   299
      hide_popup()
wenzelm@53023
   300
    }
wenzelm@53023
   301
  })
wenzelm@53023
   302
wenzelm@53023
   303
  list_view.peer.addFocusListener(new FocusAdapter {
wenzelm@53023
   304
    override def focusLost(e: FocusEvent) { hide_popup() }
wenzelm@53023
   305
  })
wenzelm@53023
   306
wenzelm@53023
   307
wenzelm@53023
   308
  /* main content */
wenzelm@53023
   309
wenzelm@53023
   310
  override def getFocusTraversalKeysEnabled = false
wenzelm@53297
   311
  completion.setBorder(new LineBorder(Color.BLACK))
wenzelm@53023
   312
  completion.add((new ScrollPane(list_view)).peer.asInstanceOf[JComponent])
wenzelm@53023
   313
wenzelm@53023
   314
wenzelm@53023
   315
  /* popup */
wenzelm@53023
   316
wenzelm@53023
   317
  private val popup =
wenzelm@53023
   318
  {
wenzelm@53247
   319
    val screen = JEdit_Lib.screen_location(layered, location)
wenzelm@53247
   320
    val size =
wenzelm@53230
   321
    {
wenzelm@53230
   322
      val geometry = JEdit_Lib.window_geometry(completion, completion)
wenzelm@53230
   323
      val bounds = Rendering.popup_bounds
wenzelm@53247
   324
      val w = geometry.width min (screen.bounds.width * bounds).toInt min layered.getWidth
wenzelm@53247
   325
      val h = geometry.height min (screen.bounds.height * bounds).toInt min layered.getHeight
wenzelm@53247
   326
      new Dimension(w, h)
wenzelm@53230
   327
    }
wenzelm@53247
   328
    new Popup(layered, completion, screen.relative(layered, size), size)
wenzelm@53246
   329
  }
wenzelm@53246
   330
wenzelm@53246
   331
  private def show_popup()
wenzelm@53246
   332
  {
wenzelm@53246
   333
    popup.show
wenzelm@53246
   334
    list_view.requestFocus
wenzelm@53023
   335
  }
wenzelm@53023
   336
wenzelm@53232
   337
  private def hide_popup()
wenzelm@53023
   338
  {
wenzelm@53234
   339
    val had_focus = list_view.peer.isFocusOwner
wenzelm@53229
   340
    popup.hide
wenzelm@53234
   341
    if (had_focus) refocus()
wenzelm@53023
   342
  }
wenzelm@53023
   343
}
wenzelm@53023
   344