src/Tools/jEdit/src/jedit_lib.scala
author wenzelm
Fri Oct 05 14:32:56 2012 +0200 (2012-10-05)
changeset 49712 a1bd8fe5131b
parent 49710 21d88a631fcc
child 49843 afddf4e26fac
permissions -rw-r--r--
further support for nested tooltips;
     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, Frame, Window}
    13 
    14 import scala.annotation.tailrec
    15 
    16 import org.gjt.sp.jedit.{jEdit, Buffer, View}
    17 import org.gjt.sp.jedit.buffer.JEditBuffer
    18 import org.gjt.sp.jedit.textarea.{JEditTextArea, TextArea}
    19 
    20 
    21 object JEdit_Lib
    22 {
    23   /* GUI components */
    24 
    25   def get_parent(component: Component): Option[Container] =
    26     component.getParent match {
    27       case null => None
    28       case parent => Some(parent)
    29     }
    30 
    31   def ancestors(component: Component): Iterator[Container] = new Iterator[Container] {
    32     private var next_elem = get_parent(component)
    33     def hasNext(): Boolean = next_elem.isDefined
    34     def next(): Container =
    35       next_elem match {
    36         case Some(parent) =>
    37           next_elem = get_parent(parent)
    38           parent
    39         case None => Iterator.empty.next()
    40       }
    41   }
    42 
    43   def parent_window(component: Component): Option[Window] =
    44     ancestors(component).find(_.isInstanceOf[Window]).map(_.asInstanceOf[Window])
    45 
    46   def parent_frame(component: Component): Option[Frame] =
    47     ancestors(component).find(_.isInstanceOf[Frame]).map(_.asInstanceOf[Frame])
    48 
    49 
    50   /* buffers */
    51 
    52   def swing_buffer_lock[A](buffer: JEditBuffer)(body: => A): A =
    53     Swing_Thread.now { buffer_lock(buffer) { body } }
    54 
    55   def buffer_text(buffer: JEditBuffer): String =
    56     buffer_lock(buffer) { buffer.getText(0, buffer.getLength) }
    57 
    58   def buffer_name(buffer: Buffer): String = buffer.getSymlinkPath
    59 
    60   def buffer_node_dummy(buffer: Buffer): Option[Document.Node.Name] =
    61     Some(Document.Node.Name(buffer_name(buffer), buffer.getDirectory, buffer.getName))
    62 
    63   def buffer_node_name(buffer: Buffer): Option[Document.Node.Name] =
    64   {
    65     val name = buffer_name(buffer)
    66     Thy_Header.thy_name(name).map(theory => Document.Node.Name(name, buffer.getDirectory, theory))
    67   }
    68 
    69 
    70   /* main jEdit components */
    71 
    72   def jedit_buffers(): Iterator[Buffer] = jEdit.getBuffers().iterator
    73 
    74   def jedit_buffer(name: String): Option[Buffer] =
    75     jedit_buffers().find(buffer => buffer_name(buffer) == name)
    76 
    77   def jedit_views(): Iterator[View] = jEdit.getViews().iterator
    78 
    79   def jedit_text_areas(view: View): Iterator[JEditTextArea] =
    80     view.getEditPanes().iterator.map(_.getTextArea)
    81 
    82   def jedit_text_areas(): Iterator[JEditTextArea] =
    83     jedit_views().flatMap(jedit_text_areas(_))
    84 
    85   def jedit_text_areas(buffer: JEditBuffer): Iterator[JEditTextArea] =
    86     jedit_text_areas().filter(_.getBuffer == buffer)
    87 
    88   def buffer_lock[A](buffer: JEditBuffer)(body: => A): A =
    89   {
    90     try { buffer.readLock(); body }
    91     finally { buffer.readUnlock() }
    92   }
    93 
    94 
    95   /* point range */
    96 
    97   def point_range(buffer: JEditBuffer, offset: Text.Offset): Text.Range =
    98     buffer_lock(buffer) {
    99       def text(i: Text.Offset): Char = buffer.getText(i, 1).charAt(0)
   100       try {
   101         val c = text(offset)
   102         if (Character.isHighSurrogate(c) && Character.isLowSurrogate(text(offset + 1)))
   103           Text.Range(offset, offset + 2)
   104         else if (Character.isLowSurrogate(c) && Character.isHighSurrogate(text(offset - 1)))
   105           Text.Range(offset - 1, offset + 1)
   106         else Text.Range(offset, offset + 1)
   107       }
   108       catch { case _: ArrayIndexOutOfBoundsException => Text.Range(offset, offset + 1) }
   109     }
   110 
   111 
   112   /* proper line range */
   113 
   114   // NB: TextArea.getScreenLineEndOffset of last line is beyond Buffer.getLength
   115   def proper_line_range(buffer: JEditBuffer, start: Text.Offset, end: Text.Offset): Text.Range =
   116     Text.Range(start, end min buffer.getLength)
   117 
   118 
   119   /* visible text range */
   120 
   121   def visible_range(text_area: TextArea): Option[Text.Range] =
   122   {
   123     val buffer = text_area.getBuffer
   124     val n = text_area.getVisibleLines
   125     if (n > 0) {
   126       val start = text_area.getScreenLineStartOffset(0)
   127       val raw_end = text_area.getScreenLineEndOffset(n - 1)
   128       Some(proper_line_range(buffer, start, if (raw_end >= 0) raw_end else buffer.getLength))
   129     }
   130     else None
   131   }
   132 
   133   def invalidate_range(text_area: TextArea, range: Text.Range)
   134   {
   135     val buffer = text_area.getBuffer
   136     text_area.invalidateLineRange(
   137       buffer.getLineOfOffset(range.start),
   138       buffer.getLineOfOffset(range.stop))
   139   }
   140 
   141 
   142   /* char width */
   143 
   144   def char_width(text_area: TextArea): Int =
   145   {
   146     val painter = text_area.getPainter
   147     val font = painter.getFont
   148     val font_context = painter.getFontRenderContext
   149     font.getStringBounds(" ", font_context).getWidth.round.toInt
   150   }
   151 
   152 
   153   /* graphics range */
   154 
   155   class Gfx_Range(val x: Int, val y: Int, val length: Int)
   156 
   157   // NB: jEdit already normalizes \r\n and \r to \n
   158   // NB: last line lacks \n
   159   def gfx_range(text_area: TextArea, range: Text.Range): Option[Gfx_Range] =
   160   {
   161     val buffer = text_area.getBuffer
   162 
   163     val p = text_area.offsetToXY(range.start)
   164 
   165     val end = buffer.getLength
   166     val stop = range.stop
   167     val (q, r) =
   168       if (stop >= end) (text_area.offsetToXY(end), char_width(text_area))
   169       else if (stop > 0 && buffer.getText(stop - 1, 1) == "\n")
   170         (text_area.offsetToXY(stop - 1), char_width(text_area))
   171       else (text_area.offsetToXY(stop), 0)
   172 
   173     if (p != null && q != null && p.x < q.x + r && p.y == q.y)
   174       Some(new Gfx_Range(p.x, p.y, q.x + r - p.x))
   175     else None
   176   }
   177 }
   178