author | wenzelm |
Mon, 31 Dec 2012 21:01:00 +0100 | |
changeset 50658 | 0464c2007a25 |
parent 50566 | b43c4f660320 |
child 50849 | 70f7483df9cb |
permissions | -rw-r--r-- |
49406 | 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 |
||
50658 | 12 |
import java.awt.{Component, Container, Window, GraphicsEnvironment, Point, Rectangle} |
49710
21d88a631fcc
refer to parent frame -- relevant for floating dockables in particular;
wenzelm
parents:
49409
diff
changeset
|
13 |
|
21d88a631fcc
refer to parent frame -- relevant for floating dockables in particular;
wenzelm
parents:
49409
diff
changeset
|
14 |
import scala.annotation.tailrec |
49406 | 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 |
{ |
|
50554
0493efcc97e9
more general handling of graphics configurations, to increase chance of proper positioning of tooltips in multi-screen environment;
wenzelm
parents:
50363
diff
changeset
|
23 |
/* bounds within multi-screen environment */ |
0493efcc97e9
more general handling of graphics configurations, to increase chance of proper positioning of tooltips in multi-screen environment;
wenzelm
parents:
50363
diff
changeset
|
24 |
|
0493efcc97e9
more general handling of graphics configurations, to increase chance of proper positioning of tooltips in multi-screen environment;
wenzelm
parents:
50363
diff
changeset
|
25 |
def screen_bounds(screen_point: Point): Rectangle = |
0493efcc97e9
more general handling of graphics configurations, to increase chance of proper positioning of tooltips in multi-screen environment;
wenzelm
parents:
50363
diff
changeset
|
26 |
{ |
0493efcc97e9
more general handling of graphics configurations, to increase chance of proper positioning of tooltips in multi-screen environment;
wenzelm
parents:
50363
diff
changeset
|
27 |
val ge = GraphicsEnvironment.getLocalGraphicsEnvironment |
0493efcc97e9
more general handling of graphics configurations, to increase chance of proper positioning of tooltips in multi-screen environment;
wenzelm
parents:
50363
diff
changeset
|
28 |
(for { |
0493efcc97e9
more general handling of graphics configurations, to increase chance of proper positioning of tooltips in multi-screen environment;
wenzelm
parents:
50363
diff
changeset
|
29 |
device <- ge.getScreenDevices.iterator |
0493efcc97e9
more general handling of graphics configurations, to increase chance of proper positioning of tooltips in multi-screen environment;
wenzelm
parents:
50363
diff
changeset
|
30 |
config <- device.getConfigurations.iterator |
0493efcc97e9
more general handling of graphics configurations, to increase chance of proper positioning of tooltips in multi-screen environment;
wenzelm
parents:
50363
diff
changeset
|
31 |
bounds = config.getBounds |
0493efcc97e9
more general handling of graphics configurations, to increase chance of proper positioning of tooltips in multi-screen environment;
wenzelm
parents:
50363
diff
changeset
|
32 |
} yield bounds).find(_.contains(screen_point)) getOrElse ge.getMaximumWindowBounds |
0493efcc97e9
more general handling of graphics configurations, to increase chance of proper positioning of tooltips in multi-screen environment;
wenzelm
parents:
50363
diff
changeset
|
33 |
} |
0493efcc97e9
more general handling of graphics configurations, to increase chance of proper positioning of tooltips in multi-screen environment;
wenzelm
parents:
50363
diff
changeset
|
34 |
|
0493efcc97e9
more general handling of graphics configurations, to increase chance of proper positioning of tooltips in multi-screen environment;
wenzelm
parents:
50363
diff
changeset
|
35 |
|
49712 | 36 |
/* GUI components */ |
37 |
||
38 |
def get_parent(component: Component): Option[Container] = |
|
39 |
component.getParent match { |
|
40 |
case null => None |
|
41 |
case parent => Some(parent) |
|
42 |
} |
|
43 |
||
44 |
def ancestors(component: Component): Iterator[Container] = new Iterator[Container] { |
|
45 |
private var next_elem = get_parent(component) |
|
46 |
def hasNext(): Boolean = next_elem.isDefined |
|
47 |
def next(): Container = |
|
48 |
next_elem match { |
|
49 |
case Some(parent) => |
|
50 |
next_elem = get_parent(parent) |
|
51 |
parent |
|
52 |
case None => Iterator.empty.next() |
|
53 |
} |
|
54 |
} |
|
55 |
||
56 |
def parent_window(component: Component): Option[Window] = |
|
57 |
ancestors(component).find(_.isInstanceOf[Window]).map(_.asInstanceOf[Window]) |
|
49710
21d88a631fcc
refer to parent frame -- relevant for floating dockables in particular;
wenzelm
parents:
49409
diff
changeset
|
58 |
|
21d88a631fcc
refer to parent frame -- relevant for floating dockables in particular;
wenzelm
parents:
49409
diff
changeset
|
59 |
|
50186
f83cab68c788
recovered some tooltip wrapping from e2762f962042, with multi-line support via HTML.encode;
wenzelm
parents:
50116
diff
changeset
|
60 |
/* basic tooltips, with multi-line support */ |
f83cab68c788
recovered some tooltip wrapping from e2762f962042, with multi-line support via HTML.encode;
wenzelm
parents:
50116
diff
changeset
|
61 |
|
f83cab68c788
recovered some tooltip wrapping from e2762f962042, with multi-line support via HTML.encode;
wenzelm
parents:
50116
diff
changeset
|
62 |
def wrap_tooltip(text: String): String = |
f83cab68c788
recovered some tooltip wrapping from e2762f962042, with multi-line support via HTML.encode;
wenzelm
parents:
50116
diff
changeset
|
63 |
if (text == "") null |
f83cab68c788
recovered some tooltip wrapping from e2762f962042, with multi-line support via HTML.encode;
wenzelm
parents:
50116
diff
changeset
|
64 |
else "<html><pre>" + HTML.encode(text) + "</pre></html>" |
f83cab68c788
recovered some tooltip wrapping from e2762f962042, with multi-line support via HTML.encode;
wenzelm
parents:
50116
diff
changeset
|
65 |
|
f83cab68c788
recovered some tooltip wrapping from e2762f962042, with multi-line support via HTML.encode;
wenzelm
parents:
50116
diff
changeset
|
66 |
|
49406 | 67 |
/* buffers */ |
68 |
||
69 |
def swing_buffer_lock[A](buffer: JEditBuffer)(body: => A): A = |
|
70 |
Swing_Thread.now { buffer_lock(buffer) { body } } |
|
71 |
||
72 |
def buffer_text(buffer: JEditBuffer): String = |
|
73 |
buffer_lock(buffer) { buffer.getText(0, buffer.getLength) } |
|
74 |
||
75 |
def buffer_name(buffer: Buffer): String = buffer.getSymlinkPath |
|
76 |
||
77 |
||
78 |
/* main jEdit components */ |
|
79 |
||
80 |
def jedit_buffers(): Iterator[Buffer] = jEdit.getBuffers().iterator |
|
81 |
||
82 |
def jedit_buffer(name: String): Option[Buffer] = |
|
83 |
jedit_buffers().find(buffer => buffer_name(buffer) == name) |
|
84 |
||
85 |
def jedit_views(): Iterator[View] = jEdit.getViews().iterator |
|
86 |
||
87 |
def jedit_text_areas(view: View): Iterator[JEditTextArea] = |
|
88 |
view.getEditPanes().iterator.map(_.getTextArea) |
|
89 |
||
90 |
def jedit_text_areas(): Iterator[JEditTextArea] = |
|
91 |
jedit_views().flatMap(jedit_text_areas(_)) |
|
92 |
||
93 |
def jedit_text_areas(buffer: JEditBuffer): Iterator[JEditTextArea] = |
|
94 |
jedit_text_areas().filter(_.getBuffer == buffer) |
|
95 |
||
96 |
def buffer_lock[A](buffer: JEditBuffer)(body: => A): A = |
|
97 |
{ |
|
98 |
try { buffer.readLock(); body } |
|
99 |
finally { buffer.readUnlock() } |
|
100 |
} |
|
49407 | 101 |
|
50195
863b1dfc396c
prefer buffer_edit combinator over Java-style boilerplate;
wenzelm
parents:
50186
diff
changeset
|
102 |
def buffer_edit[A](buffer: JEditBuffer)(body: => A): A = |
863b1dfc396c
prefer buffer_edit combinator over Java-style boilerplate;
wenzelm
parents:
50186
diff
changeset
|
103 |
{ |
863b1dfc396c
prefer buffer_edit combinator over Java-style boilerplate;
wenzelm
parents:
50186
diff
changeset
|
104 |
try { buffer.beginCompoundEdit(); body } |
863b1dfc396c
prefer buffer_edit combinator over Java-style boilerplate;
wenzelm
parents:
50186
diff
changeset
|
105 |
finally { buffer.endCompoundEdit() } |
863b1dfc396c
prefer buffer_edit combinator over Java-style boilerplate;
wenzelm
parents:
50186
diff
changeset
|
106 |
} |
863b1dfc396c
prefer buffer_edit combinator over Java-style boilerplate;
wenzelm
parents:
50186
diff
changeset
|
107 |
|
49407 | 108 |
|
50215 | 109 |
/* get text */ |
110 |
||
111 |
def try_get_text(buffer: JEditBuffer, range: Text.Range): Option[String] = |
|
112 |
try { Some(buffer.getText(range.start, range.length)) } |
|
113 |
catch { case _: ArrayIndexOutOfBoundsException => None } |
|
114 |
||
115 |
||
50363
2f8dc9e65401
tuned signature in accordance to document operations;
wenzelm
parents:
50215
diff
changeset
|
116 |
/* buffer range */ |
2f8dc9e65401
tuned signature in accordance to document operations;
wenzelm
parents:
50215
diff
changeset
|
117 |
|
2f8dc9e65401
tuned signature in accordance to document operations;
wenzelm
parents:
50215
diff
changeset
|
118 |
def buffer_range(buffer: JEditBuffer): Text.Range = |
2f8dc9e65401
tuned signature in accordance to document operations;
wenzelm
parents:
50215
diff
changeset
|
119 |
Text.Range(0, (buffer.getLength - 1) max 0) |
2f8dc9e65401
tuned signature in accordance to document operations;
wenzelm
parents:
50215
diff
changeset
|
120 |
|
2f8dc9e65401
tuned signature in accordance to document operations;
wenzelm
parents:
50215
diff
changeset
|
121 |
|
49407 | 122 |
/* point range */ |
123 |
||
124 |
def point_range(buffer: JEditBuffer, offset: Text.Offset): Text.Range = |
|
125 |
buffer_lock(buffer) { |
|
126 |
def text(i: Text.Offset): Char = buffer.getText(i, 1).charAt(0) |
|
127 |
try { |
|
128 |
val c = text(offset) |
|
129 |
if (Character.isHighSurrogate(c) && Character.isLowSurrogate(text(offset + 1))) |
|
130 |
Text.Range(offset, offset + 2) |
|
131 |
else if (Character.isLowSurrogate(c) && Character.isHighSurrogate(text(offset - 1))) |
|
132 |
Text.Range(offset - 1, offset + 1) |
|
133 |
else Text.Range(offset, offset + 1) |
|
134 |
} |
|
135 |
catch { case _: ArrayIndexOutOfBoundsException => Text.Range(offset, offset + 1) } |
|
136 |
} |
|
49408 | 137 |
|
138 |
||
139 |
/* visible text range */ |
|
140 |
||
141 |
def visible_range(text_area: TextArea): Option[Text.Range] = |
|
142 |
{ |
|
143 |
val buffer = text_area.getBuffer |
|
144 |
val n = text_area.getVisibleLines |
|
145 |
if (n > 0) { |
|
146 |
val start = text_area.getScreenLineStartOffset(0) |
|
147 |
val raw_end = text_area.getScreenLineEndOffset(n - 1) |
|
49843
afddf4e26fac
further refinement of jEdit line range, avoiding lack of final \n;
wenzelm
parents:
49712
diff
changeset
|
148 |
val end = if (raw_end >= 0) raw_end min buffer.getLength else buffer.getLength |
afddf4e26fac
further refinement of jEdit line range, avoiding lack of final \n;
wenzelm
parents:
49712
diff
changeset
|
149 |
Some(Text.Range(start, end)) |
49408 | 150 |
} |
151 |
else None |
|
152 |
} |
|
153 |
||
154 |
def invalidate_range(text_area: TextArea, range: Text.Range) |
|
155 |
{ |
|
156 |
val buffer = text_area.getBuffer |
|
157 |
text_area.invalidateLineRange( |
|
158 |
buffer.getLineOfOffset(range.start), |
|
159 |
buffer.getLineOfOffset(range.stop)) |
|
160 |
} |
|
49409 | 161 |
|
162 |
||
163 |
/* char width */ |
|
164 |
||
165 |
def char_width(text_area: TextArea): Int = |
|
166 |
{ |
|
167 |
val painter = text_area.getPainter |
|
168 |
val font = painter.getFont |
|
169 |
val font_context = painter.getFontRenderContext |
|
170 |
font.getStringBounds(" ", font_context).getWidth.round.toInt |
|
171 |
} |
|
172 |
||
173 |
||
174 |
/* graphics range */ |
|
175 |
||
50115 | 176 |
case class Gfx_Range(val x: Int, val y: Int, val length: Int) |
49409 | 177 |
|
49843
afddf4e26fac
further refinement of jEdit line range, avoiding lack of final \n;
wenzelm
parents:
49712
diff
changeset
|
178 |
// NB: jEdit always normalizes \r\n and \r to \n |
49409 | 179 |
// NB: last line lacks \n |
180 |
def gfx_range(text_area: TextArea, range: Text.Range): Option[Gfx_Range] = |
|
181 |
{ |
|
182 |
val buffer = text_area.getBuffer |
|
183 |
||
184 |
val p = text_area.offsetToXY(range.start) |
|
185 |
||
186 |
val end = buffer.getLength |
|
187 |
val stop = range.stop |
|
188 |
val (q, r) = |
|
49843
afddf4e26fac
further refinement of jEdit line range, avoiding lack of final \n;
wenzelm
parents:
49712
diff
changeset
|
189 |
if (stop >= end) (text_area.offsetToXY(end), char_width(text_area) * (stop - end)) |
49409 | 190 |
else if (stop > 0 && buffer.getText(stop - 1, 1) == "\n") |
191 |
(text_area.offsetToXY(stop - 1), char_width(text_area)) |
|
192 |
else (text_area.offsetToXY(stop), 0) |
|
193 |
||
194 |
if (p != null && q != null && p.x < q.x + r && p.y == q.y) |
|
50115 | 195 |
Some(Gfx_Range(p.x, p.y, q.x + r - p.x)) |
49409 | 196 |
else None |
197 |
} |
|
49941
f2db0596bd61
more precise pixel_range: avoid popup when pointing into empty space after actual end-of-line;
wenzelm
parents:
49843
diff
changeset
|
198 |
|
f2db0596bd61
more precise pixel_range: avoid popup when pointing into empty space after actual end-of-line;
wenzelm
parents:
49843
diff
changeset
|
199 |
|
f2db0596bd61
more precise pixel_range: avoid popup when pointing into empty space after actual end-of-line;
wenzelm
parents:
49843
diff
changeset
|
200 |
/* pixel range */ |
f2db0596bd61
more precise pixel_range: avoid popup when pointing into empty space after actual end-of-line;
wenzelm
parents:
49843
diff
changeset
|
201 |
|
f2db0596bd61
more precise pixel_range: avoid popup when pointing into empty space after actual end-of-line;
wenzelm
parents:
49843
diff
changeset
|
202 |
def pixel_range(text_area: TextArea, x: Int, y: Int): Option[Text.Range] = |
f2db0596bd61
more precise pixel_range: avoid popup when pointing into empty space after actual end-of-line;
wenzelm
parents:
49843
diff
changeset
|
203 |
{ |
50116
88b971fca902
more accurate pixel_range -- do not round offset here;
wenzelm
parents:
50115
diff
changeset
|
204 |
val range = point_range(text_area.getBuffer, text_area.xyToOffset(x, y, false)) |
49941
f2db0596bd61
more precise pixel_range: avoid popup when pointing into empty space after actual end-of-line;
wenzelm
parents:
49843
diff
changeset
|
205 |
gfx_range(text_area, range) match { |
f2db0596bd61
more precise pixel_range: avoid popup when pointing into empty space after actual end-of-line;
wenzelm
parents:
49843
diff
changeset
|
206 |
case Some(g) if (g.x <= x && x < g.x + g.length) => Some(range) |
f2db0596bd61
more precise pixel_range: avoid popup when pointing into empty space after actual end-of-line;
wenzelm
parents:
49843
diff
changeset
|
207 |
case _ => None |
f2db0596bd61
more precise pixel_range: avoid popup when pointing into empty space after actual end-of-line;
wenzelm
parents:
49843
diff
changeset
|
208 |
} |
f2db0596bd61
more precise pixel_range: avoid popup when pointing into empty space after actual end-of-line;
wenzelm
parents:
49843
diff
changeset
|
209 |
} |
49406 | 210 |
} |
211 |