src/Tools/jEdit/src/jedit_lib.scala
author wenzelm
Mon Apr 14 21:51:41 2014 +0200 (2014-04-14)
changeset 56574 2b38472a4695
parent 56457 eea4bbe15745
child 56587 83777a91f5de
permissions -rw-r--r--
some actions to maintain spell-checker dictionary;
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@53019
    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 swing_buffer_lock[A](buffer: JEditBuffer)(body: => A): A =
wenzelm@49406
    98
    Swing_Thread.now { buffer_lock(buffer) { body } }
wenzelm@49406
    99
wenzelm@49406
   100
  def buffer_text(buffer: JEditBuffer): String =
wenzelm@49406
   101
    buffer_lock(buffer) { buffer.getText(0, buffer.getLength) }
wenzelm@49406
   102
wenzelm@53274
   103
  def buffer_mode(buffer: JEditBuffer): String =
wenzelm@53274
   104
  {
wenzelm@53274
   105
    val mode = buffer.getMode
wenzelm@53274
   106
    if (mode == null) ""
wenzelm@53274
   107
    else {
wenzelm@53274
   108
      val name = mode.getName
wenzelm@53274
   109
      if (name == null) "" else name
wenzelm@53274
   110
    }
wenzelm@53274
   111
  }
wenzelm@53274
   112
wenzelm@49406
   113
  def buffer_name(buffer: Buffer): String = buffer.getSymlinkPath
wenzelm@49406
   114
wenzelm@49406
   115
wenzelm@49406
   116
  /* main jEdit components */
wenzelm@49406
   117
wenzelm@49406
   118
  def jedit_buffers(): Iterator[Buffer] = jEdit.getBuffers().iterator
wenzelm@49406
   119
wenzelm@49406
   120
  def jedit_buffer(name: String): Option[Buffer] =
wenzelm@49406
   121
    jedit_buffers().find(buffer => buffer_name(buffer) == name)
wenzelm@49406
   122
wenzelm@56457
   123
  def jedit_buffer(name: Document.Node.Name): Option[Buffer] =
wenzelm@56457
   124
    jedit_buffer(name.node)
wenzelm@56457
   125
wenzelm@49406
   126
  def jedit_views(): Iterator[View] = jEdit.getViews().iterator
wenzelm@49406
   127
wenzelm@49406
   128
  def jedit_text_areas(view: View): Iterator[JEditTextArea] =
wenzelm@49406
   129
    view.getEditPanes().iterator.map(_.getTextArea)
wenzelm@49406
   130
wenzelm@49406
   131
  def jedit_text_areas(): Iterator[JEditTextArea] =
wenzelm@49406
   132
    jedit_views().flatMap(jedit_text_areas(_))
wenzelm@49406
   133
wenzelm@49406
   134
  def jedit_text_areas(buffer: JEditBuffer): Iterator[JEditTextArea] =
wenzelm@49406
   135
    jedit_text_areas().filter(_.getBuffer == buffer)
wenzelm@49406
   136
wenzelm@49406
   137
  def buffer_lock[A](buffer: JEditBuffer)(body: => A): A =
wenzelm@49406
   138
  {
wenzelm@49406
   139
    try { buffer.readLock(); body }
wenzelm@49406
   140
    finally { buffer.readUnlock() }
wenzelm@49406
   141
  }
wenzelm@49407
   142
wenzelm@50195
   143
  def buffer_edit[A](buffer: JEditBuffer)(body: => A): A =
wenzelm@50195
   144
  {
wenzelm@50195
   145
    try { buffer.beginCompoundEdit(); body }
wenzelm@50195
   146
    finally { buffer.endCompoundEdit() }
wenzelm@50195
   147
  }
wenzelm@50195
   148
wenzelm@49407
   149
wenzelm@50215
   150
  /* get text */
wenzelm@50215
   151
wenzelm@50215
   152
  def try_get_text(buffer: JEditBuffer, range: Text.Range): Option[String] =
wenzelm@50215
   153
    try { Some(buffer.getText(range.start, range.length)) }
wenzelm@50215
   154
    catch { case _: ArrayIndexOutOfBoundsException => None }
wenzelm@50215
   155
wenzelm@53784
   156
  def try_get_text(text: String, range: Text.Range): Option[String] =
wenzelm@53784
   157
    try { Some(text.substring(range.start, range.stop)) }
wenzelm@53784
   158
    catch { case _: IndexOutOfBoundsException => None }
wenzelm@53784
   159
wenzelm@50215
   160
wenzelm@49407
   161
  /* point range */
wenzelm@49407
   162
wenzelm@49407
   163
  def point_range(buffer: JEditBuffer, offset: Text.Offset): Text.Range =
wenzelm@49407
   164
    buffer_lock(buffer) {
wenzelm@49407
   165
      def text(i: Text.Offset): Char = buffer.getText(i, 1).charAt(0)
wenzelm@49407
   166
      try {
wenzelm@49407
   167
        val c = text(offset)
wenzelm@49407
   168
        if (Character.isHighSurrogate(c) && Character.isLowSurrogate(text(offset + 1)))
wenzelm@49407
   169
          Text.Range(offset, offset + 2)
wenzelm@49407
   170
        else if (Character.isLowSurrogate(c) && Character.isHighSurrogate(text(offset - 1)))
wenzelm@49407
   171
          Text.Range(offset - 1, offset + 1)
wenzelm@55691
   172
        else
wenzelm@55691
   173
          Text.Range(offset, offset + 1)
wenzelm@49407
   174
      }
wenzelm@49407
   175
      catch { case _: ArrayIndexOutOfBoundsException => Text.Range(offset, offset + 1) }
wenzelm@49407
   176
    }
wenzelm@49408
   177
wenzelm@49408
   178
wenzelm@56574
   179
  /* caret */
wenzelm@56574
   180
wenzelm@56574
   181
  def before_caret_range(text_area: TextArea, rendering: Rendering): Text.Range =
wenzelm@56574
   182
  {
wenzelm@56574
   183
    val snapshot = rendering.snapshot
wenzelm@56574
   184
    val former_caret = snapshot.revert(text_area.getCaretPosition)
wenzelm@56574
   185
    snapshot.convert(Text.Range(former_caret - 1, former_caret))
wenzelm@56574
   186
  }
wenzelm@56574
   187
wenzelm@56574
   188
wenzelm@55812
   189
  /* text ranges */
wenzelm@55812
   190
wenzelm@55812
   191
  def buffer_range(buffer: JEditBuffer): Text.Range =
wenzelm@55812
   192
    Text.Range(0, buffer.getLength)
wenzelm@49408
   193
wenzelm@49408
   194
  def visible_range(text_area: TextArea): Option[Text.Range] =
wenzelm@49408
   195
  {
wenzelm@49408
   196
    val buffer = text_area.getBuffer
wenzelm@49408
   197
    val n = text_area.getVisibleLines
wenzelm@49408
   198
    if (n > 0) {
wenzelm@49408
   199
      val start = text_area.getScreenLineStartOffset(0)
wenzelm@49408
   200
      val raw_end = text_area.getScreenLineEndOffset(n - 1)
wenzelm@49843
   201
      val end = if (raw_end >= 0) raw_end min buffer.getLength else buffer.getLength
wenzelm@49843
   202
      Some(Text.Range(start, end))
wenzelm@49408
   203
    }
wenzelm@49408
   204
    else None
wenzelm@49408
   205
  }
wenzelm@49408
   206
wenzelm@49408
   207
  def invalidate_range(text_area: TextArea, range: Text.Range)
wenzelm@49408
   208
  {
wenzelm@49408
   209
    val buffer = text_area.getBuffer
wenzelm@55812
   210
    buffer_range(buffer).try_restrict(range) match {
wenzelm@55812
   211
      case Some(range1) if !range1.is_singularity =>
wenzelm@55812
   212
        text_area.invalidateLineRange(
wenzelm@55812
   213
          buffer.getLineOfOffset(range1.start),
wenzelm@55812
   214
          buffer.getLineOfOffset(range1.stop))
wenzelm@55812
   215
      case _ =>
wenzelm@55812
   216
    }
wenzelm@49408
   217
  }
wenzelm@49409
   218
wenzelm@49409
   219
wenzelm@49409
   220
  /* graphics range */
wenzelm@49409
   221
wenzelm@50115
   222
  case class Gfx_Range(val x: Int, val y: Int, val length: Int)
wenzelm@49409
   223
wenzelm@49843
   224
  // NB: jEdit always normalizes \r\n and \r to \n
wenzelm@49409
   225
  // NB: last line lacks \n
wenzelm@49409
   226
  def gfx_range(text_area: TextArea, range: Text.Range): Option[Gfx_Range] =
wenzelm@49409
   227
  {
wenzelm@51507
   228
    val metric = pretty_metric(text_area.getPainter)
wenzelm@51492
   229
    val char_width = (metric.unit * metric.average).round.toInt
wenzelm@50849
   230
wenzelm@49409
   231
    val buffer = text_area.getBuffer
wenzelm@49409
   232
wenzelm@49409
   233
    val end = buffer.getLength
wenzelm@49409
   234
    val stop = range.stop
wenzelm@51078
   235
wenzelm@51078
   236
    val (p, q, r) =
wenzelm@51078
   237
      try {
wenzelm@51078
   238
        val p = text_area.offsetToXY(range.start)
wenzelm@51078
   239
        val (q, r) =
wenzelm@55549
   240
          if (try_get_text(buffer, Text.Range(stop - 1, stop)) == Some("\n"))
wenzelm@51078
   241
            (text_area.offsetToXY(stop - 1), char_width)
wenzelm@55549
   242
          else if (stop >= end)
wenzelm@55549
   243
            (text_area.offsetToXY(end), char_width * (stop - end))
wenzelm@51078
   244
          else (text_area.offsetToXY(stop), 0)
wenzelm@51078
   245
        (p, q, r)
wenzelm@51078
   246
      }
wenzelm@51078
   247
      catch { case _: ArrayIndexOutOfBoundsException => (null, null, 0) }
wenzelm@49409
   248
wenzelm@49409
   249
    if (p != null && q != null && p.x < q.x + r && p.y == q.y)
wenzelm@50115
   250
      Some(Gfx_Range(p.x, p.y, q.x + r - p.x))
wenzelm@49409
   251
    else None
wenzelm@49409
   252
  }
wenzelm@49941
   253
wenzelm@49941
   254
wenzelm@49941
   255
  /* pixel range */
wenzelm@49941
   256
wenzelm@49941
   257
  def pixel_range(text_area: TextArea, x: Int, y: Int): Option[Text.Range] =
wenzelm@49941
   258
  {
wenzelm@53183
   259
    // coordinates wrt. inner painter component
wenzelm@53183
   260
    val painter = text_area.getPainter
wenzelm@53183
   261
    if (0 <= x && x < painter.getWidth && 0 <= y && y < painter.getHeight) {
wenzelm@53183
   262
      val offset = text_area.xyToOffset(x, y, false)
wenzelm@53183
   263
      if (offset >= 0) {
wenzelm@53183
   264
        val range = point_range(text_area.getBuffer, offset)
wenzelm@53183
   265
        gfx_range(text_area, range) match {
wenzelm@53183
   266
          case Some(g) if (g.x <= x && x < g.x + g.length) => Some(range)
wenzelm@53183
   267
          case _ => None
wenzelm@53183
   268
        }
wenzelm@53183
   269
      }
wenzelm@53183
   270
      else None
wenzelm@49941
   271
    }
wenzelm@53183
   272
    else None
wenzelm@49941
   273
  }
wenzelm@51492
   274
wenzelm@51492
   275
wenzelm@51492
   276
  /* pretty text metric */
wenzelm@51492
   277
wenzelm@51507
   278
  abstract class Pretty_Metric extends Pretty.Metric
wenzelm@51507
   279
  {
wenzelm@51507
   280
    def average: Double
wenzelm@51507
   281
  }
wenzelm@51492
   282
wenzelm@51507
   283
  def pretty_metric(painter: TextAreaPainter): Pretty_Metric =
wenzelm@51507
   284
    new Pretty_Metric {
wenzelm@51507
   285
      def string_width(s: String): Double =
wenzelm@51507
   286
        painter.getFont.getStringBounds(s, painter.getFontRenderContext).getWidth
wenzelm@51507
   287
wenzelm@51507
   288
      val unit = string_width(Pretty.space)
wenzelm@51507
   289
      val average = string_width("mix") / (3 * unit)
wenzelm@51507
   290
      def apply(s: String): Double = if (s == "\n") 1.0 else string_width(s) / unit
wenzelm@51492
   291
    }
wenzelm@52873
   292
wenzelm@52873
   293
wenzelm@52873
   294
  /* icons */
wenzelm@52873
   295
wenzelm@52873
   296
  def load_icon(name: String): Icon =
wenzelm@52873
   297
  {
wenzelm@52873
   298
    val name1 =
wenzelm@52873
   299
      if (name.startsWith("idea-icons/")) {
wenzelm@52873
   300
        val file =
wenzelm@52873
   301
          Isabelle_System.platform_file_url(Path.explode("$JEDIT_HOME/dist/jars/idea-icons.jar"))
wenzelm@52873
   302
        "jar:" + file + "!/" + name
wenzelm@52873
   303
      }
wenzelm@52873
   304
      else name
wenzelm@52873
   305
    val icon = GUIUtilities.loadIcon(name1)
wenzelm@52873
   306
    if (icon.getIconWidth < 0 || icon.getIconHeight < 0) error("Bad icon: " + name)
wenzelm@52873
   307
    else icon
wenzelm@52873
   308
  }
wenzelm@52874
   309
wenzelm@52874
   310
  def load_image_icon(name: String): ImageIcon =
wenzelm@52874
   311
    load_icon(name) match {
wenzelm@52874
   312
      case icon: ImageIcon => icon
wenzelm@52874
   313
      case _ => error("Bad image icon: " + name)
wenzelm@52874
   314
    }
wenzelm@53226
   315
wenzelm@53226
   316
wenzelm@53231
   317
  /* key event handling */
wenzelm@53231
   318
wenzelm@53231
   319
  def request_focus_view
wenzelm@53231
   320
  {
wenzelm@53231
   321
    val view = jEdit.getActiveView()
wenzelm@53231
   322
    if (view != null) {
wenzelm@53231
   323
      val text_area = view.getTextArea
wenzelm@53231
   324
      if (text_area != null) text_area.requestFocus
wenzelm@53231
   325
    }
wenzelm@53231
   326
  }
wenzelm@53231
   327
wenzelm@53231
   328
  def propagate_key(view: View, evt: KeyEvent)
wenzelm@53231
   329
  {
wenzelm@53231
   330
    if (view != null && !evt.isConsumed)
wenzelm@53231
   331
      view.getInputHandler().processKeyEvent(evt, View.ACTION_BAR, false)
wenzelm@53231
   332
  }
wenzelm@53226
   333
wenzelm@53226
   334
  def key_listener(
wenzelm@53226
   335
    key_typed: KeyEvent => Unit = _ => (),
wenzelm@53226
   336
    key_pressed: KeyEvent => Unit = _ => (),
wenzelm@53226
   337
    key_released: KeyEvent => Unit = _ => ()): KeyListener =
wenzelm@53226
   338
  {
wenzelm@53226
   339
    def process_key_event(evt0: KeyEvent, handle: KeyEvent => Unit)
wenzelm@53226
   340
    {
wenzelm@53237
   341
      val evt = KeyEventWorkaround.processKeyEvent(evt0)
wenzelm@53226
   342
      if (evt != null) handle(evt)
wenzelm@53226
   343
    }
wenzelm@53226
   344
wenzelm@53226
   345
    new KeyListener
wenzelm@53226
   346
    {
wenzelm@53226
   347
      def keyTyped(evt: KeyEvent) { process_key_event(evt, key_typed) }
wenzelm@53226
   348
      def keyPressed(evt: KeyEvent) { process_key_event(evt, key_pressed) }
wenzelm@53226
   349
      def keyReleased(evt: KeyEvent) { process_key_event(evt, key_released) }
wenzelm@53226
   350
    }
wenzelm@53226
   351
  }
wenzelm@53784
   352
wenzelm@53784
   353
  def special_key(evt: KeyEvent): Boolean =
wenzelm@53784
   354
  {
wenzelm@53784
   355
    // cf. 5.1.0/jEdit/org/gjt/sp/jedit/gui/KeyEventWorkaround.java
wenzelm@53784
   356
    val mod = evt.getModifiers
wenzelm@53784
   357
    (mod & InputEvent.CTRL_MASK) != 0 && (mod & InputEvent.ALT_MASK) == 0 ||
wenzelm@53784
   358
    (mod & InputEvent.CTRL_MASK) == 0 && (mod & InputEvent.ALT_MASK) != 0 &&
wenzelm@53784
   359
      !Debug.ALT_KEY_PRESSED_DISABLED ||
wenzelm@53784
   360
    (mod & InputEvent.META_MASK) != 0
wenzelm@53784
   361
  }
wenzelm@49406
   362
}
wenzelm@49406
   363