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