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