/* Title: Tools/jEdit/src/completion_popup.scala
Author: Makarius
Completion popup based on javax.swing.PopupFactory.
*/
package isabelle.jedit
import isabelle._
import java.awt.{Font, Point, BorderLayout, Dimension}
import java.awt.event.{KeyEvent, MouseEvent, MouseAdapter, FocusAdapter, FocusEvent}
import javax.swing.{JPanel, JComponent, PopupFactory, SwingUtilities}
import scala.swing.{ListView, ScrollPane}
import scala.swing.event.MouseClicked
import org.gjt.sp.jedit.View
import org.gjt.sp.jedit.textarea.JEditTextArea
object Completion_Popup
{
/* items */
private sealed case class Item(original: String, replacement: String, description: String)
{ override def toString: String = description }
/* register single instance within root */
private def register(root: JComponent, completion: Completion_Popup)
{
Swing_Thread.require()
root.getClientProperty(Completion_Popup) match {
case old_completion: Completion_Popup => old_completion.hide_popup
case _ =>
}
root.putClientProperty(Completion_Popup, completion)
}
/* jEdit text area operations */
object Text_Area
{
private def insert(text_area: JEditTextArea, item: Item)
{
Swing_Thread.require()
val buffer = text_area.getBuffer
val len = item.original.length
if (buffer.isEditable && len > 0) {
JEdit_Lib.buffer_edit(buffer) {
val caret = text_area.getCaretPosition
JEdit_Lib.try_get_text(buffer, Text.Range(caret - len, caret)) match {
case Some(text) if text == item.original =>
buffer.remove(caret - len, len)
buffer.insert(caret - len, item.replacement)
case _ =>
}
}
}
}
def input(text_area: JEditTextArea, get_syntax: => Option[Outer_Syntax], evt: KeyEvent)
{
Swing_Thread.require()
val view = text_area.getView
val root = view.getRootPane
val buffer = text_area.getBuffer
val painter = text_area.getPainter
register(root, null)
if (buffer.isEditable && !evt.isConsumed) {
get_syntax match {
case Some(syntax) =>
val caret = text_area.getCaretPosition
val result =
{
val line = buffer.getLineOfOffset(caret)
val start = buffer.getLineStartOffset(line)
val text = buffer.getSegment(start, caret - start)
syntax.completion.complete(text) match {
case Some((word, cs)) =>
val ds =
(if (Isabelle_Encoding.is_active(buffer))
cs.map(Symbol.decode(_)).sorted
else cs).filter(_ != word)
if (ds.isEmpty) None
else Some((word, ds.map(s => Item(word, s, s))))
case None => None
}
}
result match {
case Some((original, items)) =>
val popup_font =
painter.getFont.deriveFont(
(painter.getFont.getSize2D * PIDE.options.real("jedit_popup_font_scale")).toFloat
max 10.0f)
val location = text_area.offsetToXY(caret - original.length)
if (location != null) {
location.y = location.y + painter.getFontMetrics.getHeight
SwingUtilities.convertPointToScreen(location, painter)
val completion =
new Completion_Popup(root, popup_font, location, items) {
override def complete(item: Item) { insert(text_area, item) }
override def propagate(e: KeyEvent) {
JEdit_Lib.propagate_key(view, e)
input(text_area, get_syntax, e)
}
override def refocus() { text_area.requestFocus }
}
register(root, completion)
}
case None =>
}
case None =>
}
}
}
}
}
class Completion_Popup private(
root: JComponent,
popup_font: Font,
screen_point: Point,
items: List[Completion_Popup.Item]) extends JPanel(new BorderLayout)
{
completion =>
Swing_Thread.require()
require(!items.isEmpty)
/* actions */
def complete(item: Completion_Popup.Item) { }
def propagate(evt: KeyEvent) { }
def refocus() { }
/* list view */
private val list_view = new ListView(items)
{
font = popup_font
}
list_view.selection.intervalMode = ListView.IntervalMode.Single
list_view.peer.setFocusTraversalKeysEnabled(false)
list_view.peer.setVisibleRowCount(items.length min 8)
list_view.peer.setSelectedIndex(0)
private def complete_selected(): Boolean =
{
list_view.selection.items.toList match {
case item :: _ => complete(item); true
case _ => false
}
}
private def move_items(n: Int)
{
val i = list_view.peer.getSelectedIndex
val j = ((i + n) min (items.length - 1)) max 0
if (i != j) {
list_view.peer.setSelectedIndex(j)
list_view.peer.ensureIndexIsVisible(j)
}
}
private def move_pages(n: Int)
{
val page_size = list_view.peer.getVisibleRowCount - 1
move_items(page_size * n)
}
/* event handling */
private val key_listener =
JEdit_Lib.key_listener(
key_pressed = (e: KeyEvent) =>
{
if (!e.isConsumed) {
e.getKeyCode match {
case KeyEvent.VK_TAB =>
if (complete_selected()) e.consume
hide_popup()
case KeyEvent.VK_ESCAPE =>
hide_popup()
e.consume
case KeyEvent.VK_UP => move_items(-1); e.consume
case KeyEvent.VK_DOWN => move_items(1); e.consume
case KeyEvent.VK_PAGE_UP => move_pages(-1); e.consume
case KeyEvent.VK_PAGE_DOWN => move_pages(1); e.consume
case _ =>
if (e.isActionKey || e.isAltDown || e.isMetaDown || e.isControlDown)
hide_popup()
}
}
propagate(e)
},
key_typed = propagate _
)
list_view.peer.addKeyListener(key_listener)
list_view.peer.addMouseListener(new MouseAdapter {
override def mouseClicked(e: MouseEvent) {
if (complete_selected()) e.consume
hide_popup()
}
})
list_view.peer.addFocusListener(new FocusAdapter {
override def focusLost(e: FocusEvent) { hide_popup() }
})
/* main content */
override def getFocusTraversalKeysEnabled = false
completion.add((new ScrollPane(list_view)).peer.asInstanceOf[JComponent])
/* popup */
private val popup =
{
val screen_bounds = JEdit_Lib.screen_bounds(screen_point)
val x0 = root.getLocationOnScreen.x
val y0 = root.getLocationOnScreen.y
val w0 = root.getWidth
val h0 = root.getHeight
val (w, h) =
{
val geometry = JEdit_Lib.window_geometry(completion, completion)
val bounds = Rendering.popup_bounds
val w = geometry.width min (screen_bounds.width * bounds).toInt min w0
val h = geometry.height min (screen_bounds.height * bounds).toInt min h0
(w, h)
}
val (x, y) =
{
val x1 = x0 + w0 - w
val y1 = y0 + h0 - h
val x2 = screen_point.x min (screen_bounds.x + screen_bounds.width - w)
val y2 = screen_point.y min (screen_bounds.y + screen_bounds.height - h)
((x2 min x1) max x0, (y2 min y1) max y0)
}
completion.setSize(new Dimension(w, h))
completion.setPreferredSize(new Dimension(w, h))
PopupFactory.getSharedInstance.getPopup(root, completion, x, y)
}
private def hide_popup()
{
val had_focus = list_view.peer.isFocusOwner
popup.hide
if (had_focus) refocus()
}
popup.show
list_view.requestFocus
}