src/Tools/jEdit/src/jedit_lib.scala
author wenzelm
Thu Aug 29 12:38:33 2013 +0200 (2013-08-29)
changeset 53274 1760c01f1c78
parent 53247 bd595338ca18
child 53712 ea51046be71b
permissions -rw-r--r--
maintain Completion_Popup.Text_Area as client property like Document_View;
global Completion_Popup.Text_Area init/exit like SideKickPlugin;
eliminated old SideKick completion -- cover all Isabelle modes uniformly;
dynamic lookup of Isabelle.mode_syntax -- NB: buffer mode might be undefined in intermediate stages;
     1 /*  Title:      Tools/jEdit/src/jedit_lib.scala
     2     Author:     Makarius
     3 
     4 Misc library functions for jEdit.
     5 */
     6 
     7 package isabelle.jedit
     8 
     9 
    10 import isabelle._
    11 
    12 import java.awt.{Component, Container, Window, GraphicsEnvironment, Point, Rectangle, Dimension}
    13 import java.awt.event.{KeyEvent, KeyListener}
    14 import javax.swing.{Icon, ImageIcon, JWindow, SwingUtilities}
    15 
    16 import scala.annotation.tailrec
    17 
    18 import org.gjt.sp.jedit.{jEdit, Buffer, View, GUIUtilities}
    19 import org.gjt.sp.jedit.gui.KeyEventWorkaround
    20 import org.gjt.sp.jedit.buffer.JEditBuffer
    21 import org.gjt.sp.jedit.textarea.{JEditTextArea, TextArea, TextAreaPainter}
    22 
    23 
    24 object JEdit_Lib
    25 {
    26   /* location within multi-screen environment */
    27 
    28   final case class Screen_Location(point: Point, bounds: Rectangle)
    29   {
    30     def relative(parent: Component, size: Dimension): Point =
    31     {
    32       val w = size.width
    33       val h = size.height
    34 
    35       val x0 = parent.getLocationOnScreen.x
    36       val y0 = parent.getLocationOnScreen.y
    37       val x1 = x0 + parent.getWidth - w
    38       val y1 = y0 + parent.getHeight - h
    39       val x2 = point.x min (bounds.x + bounds.width - w)
    40       val y2 = point.y min (bounds.y + bounds.height - h)
    41 
    42       val location = new Point((x2 min x1) max x0, (y2 min y1) max y0)
    43       SwingUtilities.convertPointFromScreen(location, parent)
    44       location
    45     }
    46   }
    47 
    48   def screen_location(component: Component, point: Point): Screen_Location =
    49   {
    50     val screen_point = new Point(point.x, point.y)
    51     SwingUtilities.convertPointToScreen(screen_point, component)
    52 
    53     val ge = GraphicsEnvironment.getLocalGraphicsEnvironment
    54     val screen_bounds =
    55       (for {
    56         device <- ge.getScreenDevices.iterator
    57         config <- device.getConfigurations.iterator
    58         bounds = config.getBounds
    59       } yield bounds).find(_.contains(screen_point)) getOrElse ge.getMaximumWindowBounds
    60 
    61     Screen_Location(screen_point, screen_bounds)
    62   }
    63 
    64 
    65   /* window geometry measurement */
    66 
    67   private lazy val dummy_window = new JWindow
    68 
    69   final case class Window_Geometry(width: Int, height: Int, inner_width: Int, inner_height: Int)
    70   {
    71     def deco_width: Int = width - inner_width
    72     def deco_height: Int = height - inner_height
    73   }
    74 
    75   def window_geometry(outer: Container, inner: Component): Window_Geometry =
    76   {
    77     Swing_Thread.require()
    78 
    79     val old_content = dummy_window.getContentPane
    80 
    81     dummy_window.setContentPane(outer)
    82     dummy_window.pack
    83     dummy_window.revalidate
    84 
    85     val geometry =
    86       Window_Geometry(
    87         dummy_window.getWidth, dummy_window.getHeight, inner.getWidth, inner.getHeight)
    88 
    89     dummy_window.setContentPane(old_content)
    90 
    91     geometry
    92   }
    93 
    94 
    95   /* GUI components */
    96 
    97   def get_parent(component: Component): Option[Container] =
    98     component.getParent match {
    99       case null => None
   100       case parent => Some(parent)
   101     }
   102 
   103   def ancestors(component: Component): Iterator[Container] = new Iterator[Container] {
   104     private var next_elem = get_parent(component)
   105     def hasNext(): Boolean = next_elem.isDefined
   106     def next(): Container =
   107       next_elem match {
   108         case Some(parent) =>
   109           next_elem = get_parent(parent)
   110           parent
   111         case None => Iterator.empty.next()
   112       }
   113   }
   114 
   115   def parent_window(component: Component): Option[Window] =
   116     ancestors(component).collectFirst({ case x: Window => x })
   117 
   118 
   119   /* basic tooltips, with multi-line support */
   120 
   121   def wrap_tooltip(text: String): String =
   122     if (text == "") null
   123     else "<html><pre>" + HTML.encode(text) + "</pre></html>"
   124 
   125 
   126   /* buffers */
   127 
   128   def swing_buffer_lock[A](buffer: JEditBuffer)(body: => A): A =
   129     Swing_Thread.now { buffer_lock(buffer) { body } }
   130 
   131   def buffer_text(buffer: JEditBuffer): String =
   132     buffer_lock(buffer) { buffer.getText(0, buffer.getLength) }
   133 
   134   def buffer_mode(buffer: JEditBuffer): String =
   135   {
   136     val mode = buffer.getMode
   137     if (mode == null) ""
   138     else {
   139       val name = mode.getName
   140       if (name == null) "" else name
   141     }
   142   }
   143 
   144   def buffer_name(buffer: Buffer): String = buffer.getSymlinkPath
   145 
   146 
   147   /* main jEdit components */
   148 
   149   def jedit_buffers(): Iterator[Buffer] = jEdit.getBuffers().iterator
   150 
   151   def jedit_buffer(name: String): Option[Buffer] =
   152     jedit_buffers().find(buffer => buffer_name(buffer) == name)
   153 
   154   def jedit_views(): Iterator[View] = jEdit.getViews().iterator
   155 
   156   def jedit_text_areas(view: View): Iterator[JEditTextArea] =
   157     view.getEditPanes().iterator.map(_.getTextArea)
   158 
   159   def jedit_text_areas(): Iterator[JEditTextArea] =
   160     jedit_views().flatMap(jedit_text_areas(_))
   161 
   162   def jedit_text_areas(buffer: JEditBuffer): Iterator[JEditTextArea] =
   163     jedit_text_areas().filter(_.getBuffer == buffer)
   164 
   165   def buffer_lock[A](buffer: JEditBuffer)(body: => A): A =
   166   {
   167     try { buffer.readLock(); body }
   168     finally { buffer.readUnlock() }
   169   }
   170 
   171   def buffer_edit[A](buffer: JEditBuffer)(body: => A): A =
   172   {
   173     try { buffer.beginCompoundEdit(); body }
   174     finally { buffer.endCompoundEdit() }
   175   }
   176 
   177 
   178   /* get text */
   179 
   180   def try_get_text(buffer: JEditBuffer, range: Text.Range): Option[String] =
   181     try { Some(buffer.getText(range.start, range.length)) }
   182     catch { case _: ArrayIndexOutOfBoundsException => None }
   183 
   184 
   185   /* buffer range */
   186 
   187   def buffer_range(buffer: JEditBuffer): Text.Range =
   188     Text.Range(0, (buffer.getLength - 1) max 0)
   189 
   190 
   191   /* point range */
   192 
   193   def point_range(buffer: JEditBuffer, offset: Text.Offset): Text.Range =
   194     buffer_lock(buffer) {
   195       def text(i: Text.Offset): Char = buffer.getText(i, 1).charAt(0)
   196       try {
   197         val c = text(offset)
   198         if (Character.isHighSurrogate(c) && Character.isLowSurrogate(text(offset + 1)))
   199           Text.Range(offset, offset + 2)
   200         else if (Character.isLowSurrogate(c) && Character.isHighSurrogate(text(offset - 1)))
   201           Text.Range(offset - 1, offset + 1)
   202         else Text.Range(offset, offset + 1)
   203       }
   204       catch { case _: ArrayIndexOutOfBoundsException => Text.Range(offset, offset + 1) }
   205     }
   206 
   207 
   208   /* visible text range */
   209 
   210   def visible_range(text_area: TextArea): Option[Text.Range] =
   211   {
   212     val buffer = text_area.getBuffer
   213     val n = text_area.getVisibleLines
   214     if (n > 0) {
   215       val start = text_area.getScreenLineStartOffset(0)
   216       val raw_end = text_area.getScreenLineEndOffset(n - 1)
   217       val end = if (raw_end >= 0) raw_end min buffer.getLength else buffer.getLength
   218       Some(Text.Range(start, end))
   219     }
   220     else None
   221   }
   222 
   223   def invalidate_range(text_area: TextArea, range: Text.Range)
   224   {
   225     val buffer = text_area.getBuffer
   226     text_area.invalidateLineRange(
   227       buffer.getLineOfOffset(range.start),
   228       buffer.getLineOfOffset(range.stop))
   229   }
   230 
   231 
   232   /* graphics range */
   233 
   234   case class Gfx_Range(val x: Int, val y: Int, val length: Int)
   235 
   236   // NB: jEdit always normalizes \r\n and \r to \n
   237   // NB: last line lacks \n
   238   def gfx_range(text_area: TextArea, range: Text.Range): Option[Gfx_Range] =
   239   {
   240     val metric = pretty_metric(text_area.getPainter)
   241     val char_width = (metric.unit * metric.average).round.toInt
   242 
   243     val buffer = text_area.getBuffer
   244 
   245     val end = buffer.getLength
   246     val stop = range.stop
   247 
   248     val (p, q, r) =
   249       try {
   250         val p = text_area.offsetToXY(range.start)
   251         val (q, r) =
   252           if (stop >= end) (text_area.offsetToXY(end), char_width * (stop - end))
   253           else if (stop > 0 && buffer.getText(stop - 1, 1) == "\n")
   254             (text_area.offsetToXY(stop - 1), char_width)
   255           else (text_area.offsetToXY(stop), 0)
   256         (p, q, r)
   257       }
   258       catch { case _: ArrayIndexOutOfBoundsException => (null, null, 0) }
   259 
   260     if (p != null && q != null && p.x < q.x + r && p.y == q.y)
   261       Some(Gfx_Range(p.x, p.y, q.x + r - p.x))
   262     else None
   263   }
   264 
   265 
   266   /* pixel range */
   267 
   268   def pixel_range(text_area: TextArea, x: Int, y: Int): Option[Text.Range] =
   269   {
   270     // coordinates wrt. inner painter component
   271     val painter = text_area.getPainter
   272     if (0 <= x && x < painter.getWidth && 0 <= y && y < painter.getHeight) {
   273       val offset = text_area.xyToOffset(x, y, false)
   274       if (offset >= 0) {
   275         val range = point_range(text_area.getBuffer, offset)
   276         gfx_range(text_area, range) match {
   277           case Some(g) if (g.x <= x && x < g.x + g.length) => Some(range)
   278           case _ => None
   279         }
   280       }
   281       else None
   282     }
   283     else None
   284   }
   285 
   286 
   287   /* pretty text metric */
   288 
   289   abstract class Pretty_Metric extends Pretty.Metric
   290   {
   291     def average: Double
   292   }
   293 
   294   def pretty_metric(painter: TextAreaPainter): Pretty_Metric =
   295     new Pretty_Metric {
   296       def string_width(s: String): Double =
   297         painter.getFont.getStringBounds(s, painter.getFontRenderContext).getWidth
   298 
   299       val unit = string_width(Pretty.space)
   300       val average = string_width("mix") / (3 * unit)
   301       def apply(s: String): Double = if (s == "\n") 1.0 else string_width(s) / unit
   302     }
   303 
   304 
   305   /* icons */
   306 
   307   def load_icon(name: String): Icon =
   308   {
   309     val name1 =
   310       if (name.startsWith("idea-icons/")) {
   311         val file =
   312           Isabelle_System.platform_file_url(Path.explode("$JEDIT_HOME/dist/jars/idea-icons.jar"))
   313         "jar:" + file + "!/" + name
   314       }
   315       else name
   316     val icon = GUIUtilities.loadIcon(name1)
   317     if (icon.getIconWidth < 0 || icon.getIconHeight < 0) error("Bad icon: " + name)
   318     else icon
   319   }
   320 
   321   def load_image_icon(name: String): ImageIcon =
   322     load_icon(name) match {
   323       case icon: ImageIcon => icon
   324       case _ => error("Bad image icon: " + name)
   325     }
   326 
   327 
   328   /* key event handling */
   329 
   330   def request_focus_view
   331   {
   332     val view = jEdit.getActiveView()
   333     if (view != null) {
   334       val text_area = view.getTextArea
   335       if (text_area != null) text_area.requestFocus
   336     }
   337   }
   338 
   339   def propagate_key(view: View, evt: KeyEvent)
   340   {
   341     if (view != null && !evt.isConsumed)
   342       view.getInputHandler().processKeyEvent(evt, View.ACTION_BAR, false)
   343   }
   344 
   345   def key_listener(
   346     key_typed: KeyEvent => Unit = _ => (),
   347     key_pressed: KeyEvent => Unit = _ => (),
   348     key_released: KeyEvent => Unit = _ => ()): KeyListener =
   349   {
   350     def process_key_event(evt0: KeyEvent, handle: KeyEvent => Unit)
   351     {
   352       val evt = KeyEventWorkaround.processKeyEvent(evt0)
   353       if (evt != null) handle(evt)
   354     }
   355 
   356     new KeyListener
   357     {
   358       def keyTyped(evt: KeyEvent) { process_key_event(evt, key_typed) }
   359       def keyPressed(evt: KeyEvent) { process_key_event(evt, key_pressed) }
   360       def keyReleased(evt: KeyEvent) { process_key_event(evt, key_released) }
   361     }
   362   }
   363 }
   364