1 // Copyright 2004 Adam Megacz, see the COPYING file for licensing [GPL]
5 import org.ibex.util.*;
8 * A Surface, as described in the Ibex Reference.
10 * Platform subclasses should include an inner class subclass of
11 * Surface to return from the Platform._createSurface() method
13 public abstract class Surface extends PixelBuffer implements Scheduler.Task {
15 // Static Data ////////////////////////////////////////////////////////////////////////////////
17 private static Boolean T = Boolean.TRUE;
18 private static Boolean F = Boolean.FALSE;
20 /** all instances of Surface which need to be refreshed by the Scheduler */
21 public static Vec allSurfaces = new Vec();
23 /** When set to true, render() should abort as soon as possible and restart the rendering process */
24 volatile boolean abort = false;
26 // these three variables are used to ensure that user resizes trump programmatic resizes
27 volatile boolean syncRootBoxToSurface = false;
28 volatile int pendingWidth = 0;
29 volatile int pendingHeight = 0;
31 public static boolean alt = false; ///< true iff the alt button is pressed down
32 public static boolean control = false; ///< true iff the control button is pressed down
33 public static boolean shift = false; ///< true iff the shift button is pressed down
34 public static boolean button1 = false; ///< true iff button 1 is depressed
35 public static boolean button2 = false; ///< true iff button 2 is depressed
36 public static boolean button3 = false; ///< true iff button 3 is depressed
39 // Instance Data ///////////////////////////////////////////////////////////////////////
41 public Box root; ///< The Box at the root of this surface
42 public String cursor = "default"; ///< The active cursor to switch to when syncCursor() is called
43 public int mousex; ///< x position of the mouse
44 public int mousey; ///< y position of the mouse
45 public int _mousex; ///< x position of the mouse FIXME
46 public int _mousey; ///< y position of the mouse FIXME
47 public int newmousex = -1; ///< x position of the mouse, in real time; this lets us collapse Move's
48 public int newmousey = -1; ///< y position of the mouse, in real time; this lets us collapse Move's
49 public boolean minimized = false; ///< True iff this surface is minimized, in real time
50 public boolean maximized = false; ///< True iff this surface is maximized, in real time
51 DirtyList dirtyRegions = new DirtyList(); ///< Dirty regions on the surface
53 // Used For Simulating Clicks and DoubleClicks /////////////////////////////////////////////////
55 int last_press_x = Integer.MAX_VALUE; ///< the x-position of the mouse the last time a Press message was enqueued
56 int last_press_y = Integer.MAX_VALUE; ///< the y-position of the mouse the last time a Press message was enqueued
57 static int lastClickButton = 0; ///< the last button to recieve a Click message; used for simulating DoubleClick's
58 static long lastClickTime = 0; ///< the last time a Click message was processed; used for simulating DoubleClick's
61 // Methods to be overridden by subclasses ///////////////////////////////////////////////////////
63 public abstract void toBack(); ///< should push surface to the back of the stacking order
64 public abstract void toFront(); ///< should pull surface to the front of the stacking order
65 public abstract void syncCursor(); ///< set the actual cursor to this.cursor if they do not match
66 public abstract void setInvisible(boolean b); ///< If <tt>b</tt>, make window invisible; otherwise, make it non-invisible.
67 protected abstract void _setMaximized(boolean b); ///< If <tt>b</tt>, maximize the surface; otherwise, un-maximize it.
68 protected abstract void _setMinimized(boolean b); ///< If <tt>b</tt>, minimize the surface; otherwise, un-minimize it.
69 public abstract void setLocation(); ///< Set the surface's x/y position to that of the root box
70 protected abstract void _setSize(int w, int h); ///< set the actual size of the surface
71 public abstract void setTitleBarText(String s); ///< Sets the surface's title bar text, if applicable
72 public abstract void setIcon(Picture i); ///< Sets the surface's title bar text, if applicable
73 public abstract void _dispose(); ///< Destroy the surface
74 public void setMinimumSize(int minx, int miny, boolean resizable) { }
75 protected void setSize(int w, int h) { _setSize(w, h); }
78 // Helper methods for subclasses ////////////////////////////////////////////////////////////
80 protected final void Press(final int button) {
81 last_press_x = mousex;
82 last_press_y = mousey;
84 if (button == 1) button1 = true;
85 else if (button == 2) button2 = true;
86 else if (button == 3) button3 = true;
88 if (button == 1) new Message("_Press1", T, root);
89 else if (button == 2) new Message("_Press2", T, root);
90 else if (button == 3) {
91 Scheduler.add(new Scheduler.Task() { public void perform() throws JSExn {
92 Platform.clipboardReadEnabled = true;
94 root.putAndTriggerTraps("_Press3", T);
96 Platform.clipboardReadEnabled = false;
102 protected final void Release(int button) {
103 if (button == 1) button1 = false;
104 else if (button == 2) button2 = false;
105 else if (button == 3) button3 = false;
107 if (button == 1) new Message("_Release1", T, root);
108 else if (button == 2) new Message("_Release2", T, root);
109 else if (button == 3) new Message("_Release3", T, root);
111 if (Platform.needsAutoClick() && Math.abs(last_press_x - mousex) < 5 && Math.abs(last_press_y - mousey) < 5) Click(button);
112 last_press_x = Integer.MAX_VALUE;
113 last_press_y = Integer.MAX_VALUE;
116 protected final void Click(int button) {
117 if (button == 1) new Message("_Click1", T, root);
118 else if (button == 2) new Message("_Click2", T, root);
119 else if (button == 3) new Message("_Click3", T, root);
120 if (Platform.needsAutoDoubleClick()) {
121 long now = System.currentTimeMillis();
122 if (lastClickButton == button && now - lastClickTime < 350) DoubleClick(button);
123 lastClickButton = button;
128 /** we enqueue ourselves in the Scheduler when we have a Move message to deal with */
129 public void perform() {
130 if (mousex == newmousex && mousey == newmousey) return;
131 int oldmousex = mousex; mousex = newmousex;
132 int oldmousey = mousey; mousey = newmousey;
133 String oldcursor = cursor; cursor = "default";
134 // Root gets motion events outside itself (if trapped)
135 if (!root.inside(oldmousex, oldmousey) && !root.inside(mousex, mousey) && (button1 || button2 || button3))
136 root.putAndTriggerTrapsAndCatchExceptions("_Move", T);
137 if (!cursor.equals(oldcursor)) syncCursor();
141 * Notify Ibex that the mouse has moved. If the mouse leaves the
142 * surface, but the host windowing system does not provide its new
143 * position (for example, a Java MouseListener.mouseExited()
144 * message), the subclass should use (-1,-1).
146 protected final void Move(final int newmousex, final int newmousey) {
147 this.newmousex = newmousex;
148 this.newmousey = newmousey;
152 protected final void HScroll(int pixels) { new Message("_HScroll", new Integer(pixels), root); }
153 protected final void VScroll(int pixels) { new Message("_VScroll", new Integer(pixels), root); }
154 protected final void HScroll(float lines) { new Message("_HScroll", new Float(lines), root); }
155 protected final void VScroll(float lines) { new Message("_VScroll", new Float(lines), root); }
157 /** subclasses should invoke this method when the user resizes the window */
158 protected final void SizeChange(final int width, final int height) {
159 if (pendingWidth == width && pendingHeight == height) return;
160 pendingWidth = width;
161 pendingHeight = height;
162 syncRootBoxToSurface = true;
164 Scheduler.renderAll();
167 // FEATURE: can we avoid creating objects here?
168 protected final void PosChange(final int x, final int y) {
169 Scheduler.add(new Scheduler.Task() { public void perform() throws JSExn {
172 root.putAndTriggerTrapsAndCatchExceptions("PosChange", T);
176 private final String[] doubleClick = new String[] { null, "_DoubleClick1", "_DoubleClick2", "_DoubleClick3" };
177 protected final void DoubleClick(int button) { new Message(doubleClick[button], T, root); }
178 protected final void KeyPressed(String key) { new Message("_KeyPressed", key, root); }
179 protected final void KeyReleased(String key) { new Message("_KeyReleased", key, root); }
180 protected final void Close() { new Message("Close", T, root); }
181 protected final void Minimized(boolean b) { minimized = b; new Message("Minimized", b ? T : F, root); }
182 protected final void Maximized(boolean b) { maximized = b; new Message("Maximized", b ? T : F, root); }
183 protected final void Focused(boolean b) { new Message("Focused", b ? T : F, root); }
184 public void Refresh() { Scheduler.add(new Scheduler.Task() { public void perform() { } }); }
186 public final void setMaximized(boolean b) { if (b != maximized) _setMaximized(maximized = b); }
187 public final void setMinimized(boolean b) { if (b != minimized) _setMinimized(minimized = b); }
190 // Other Methods ///////////////////////////////////////////////////////////////////////////////
192 /** Indicates that the Surface is no longer needed */
193 public final void dispose(boolean quitIfAllSurfacesGone) {
194 if (Log.on) Log.info(this, "disposing " + this);
195 allSurfaces.removeElement(this);
197 if (allSurfaces.size() == 0) {
198 if (Log.on) Log.info(this, "exiting because last surface was destroyed");
203 public void dirty(int x, int y, int w, int h) {
204 dirtyRegions.dirty(x, y, w, h);
208 public static Surface fromBox(Box b) {
209 // FIXME use a hash table here
210 for(int i=0; i<allSurfaces.size(); i++) {
211 Surface s = (Surface)allSurfaces.elementAt(i);
212 if (s.root == b) return s;
217 public Surface(Box root) {
219 root.setMaxWidth(JS.N(Math.min(Platform.getScreenWidth(), root.maxwidth)));
220 root.setMaxHeight(JS.N(Math.min(Platform.getScreenHeight(), root.maxheight)));
221 Surface old = fromBox(root);
222 if (old != null) old.dispose(false);
223 else root.removeSelf();
227 private static VectorGraphics.Affine identity = VectorGraphics.Affine.identity();
229 /** runs the prerender() and render() pipelines in the root Box to regenerate the backbuffer, then blits it to the screen */
230 public synchronized void render() {
232 // make sure the root is properly sized
236 if (syncRootBoxToSurface) {
237 root.setMaxWidth(JS.N(pendingWidth));
238 root.setMaxHeight(JS.N(pendingHeight));
239 syncRootBoxToSurface = false;
241 if (root.maxwidth != root.width || root.maxheight != root.height) {
242 // dirty the place where the scar used to be and where it is now
243 dirty(0, root.height - Main.scarImage.height, Main.scarImage.width, Main.scarImage.height);
244 dirty(0, root.maxheight - Main.scarImage.height, Main.scarImage.width, Main.scarImage.height);
246 root.resize(root.x, root.y, root.maxwidth, root.maxheight);
247 root.resize_children();
248 setSize(root.width, root.height);
249 String oldcursor = cursor;
251 root.putAndTriggerTrapsAndCatchExceptions("_Move", JS.T);
252 if (!cursor.equals(oldcursor)) syncCursor();
255 int[][] dirt = dirtyRegions.flush();
256 for(int i = 0; dirt != null && i < dirt.length; i++) {
257 if (dirt[i] == null) continue;
258 int x = dirt[i][0], y = dirt[i][1], w = dirt[i][2], h = dirt[i][3];
261 if (x+w > root.width) w = root.width - x;
262 if (y+h > root.height) h = root.height - y;
263 if (w <= 0 || h <= 0) continue;
265 root.render(0, 0, x, y, x + w, y + h, this, identity);
266 drawPicture(Main.scarImage, 0, root.height - Main.scarImage.height, x, y, x+w, y+h);
269 // x,y,w,h is only partially reconstructed, so we must be careful not to re-blit it
270 dirtyRegions.dirty(x, y, w, h);
271 // put back all the dirty regions we haven't yet processed (including the current one)
272 for(int j=i; j<dirt.length; j++)
274 dirtyRegions.dirty(dirt[j][0], dirt[j][1], dirt[j][2], dirt[j][3]);
280 // FEATURE: reinstate recycler
281 public class Message implements Scheduler.Task {
283 private Box boxContainingMouse;
284 private Object value;
287 Message(String name, Object value, Box boxContainingMouse) {
288 this.boxContainingMouse = boxContainingMouse;
294 public void perform() {
295 if (name.equals("_KeyPressed")) {
296 String value = (String)this.value;
297 if (value.toLowerCase().endsWith("shift")) shift = true; else if (shift) value = value.toUpperCase();
298 if (value.toLowerCase().equals("alt")) alt = true; else if (alt) value = "A-" + value;
299 if (value.toLowerCase().endsWith("control")) control = true; else if (control) value = "C-" + value;
300 if (value.equals("C-v") || value.equals("A-v")) Platform.clipboardReadEnabled = true;
302 } else if (name.equals("_KeyReleased")) {
303 String value = (String)this.value;
304 if (value.toLowerCase().equals("alt")) alt = false;
305 else if (value.toLowerCase().equals("control")) control = false;
306 else if (value.toLowerCase().equals("shift")) shift = false;
308 } else if (name.equals("_HScroll") || name.equals("_VScroll")) {
309 // FIXME: technically points != pixels
310 if (value instanceof Integer)
311 value = new Float(((Integer)value).intValue() * root.fontSize());
314 boxContainingMouse.putAndTriggerTrapsAndCatchExceptions(name, value);
316 Platform.clipboardReadEnabled = false;
319 public String toString() { return "Message [name=" + name + ", value=" + value + "]"; }
323 // Default PixelBuffer implementation /////////////////////////////////////////////////////////
325 public static abstract class DoubleBufferedSurface extends Surface {
327 public DoubleBufferedSurface(Box root) { super(root); }
328 PixelBuffer backbuffer = Platform.createPixelBuffer(Platform.getScreenWidth(), Platform.getScreenHeight(), this);
329 DirtyList screenDirtyRegions = new DirtyList();
331 public void drawPicture(Picture source, int dx, int dy, int cx1, int cy1, int cx2, int cy2) {
332 screenDirtyRegions.dirty(cx1, cy1, cx2 - cx1, cy2 - cy1);
333 backbuffer.drawPicture(source, dx, dy, cx1, cy1, cx2, cy2);
336 public void drawGlyph(Font.Glyph source, int dx, int dy, int cx1, int cy1, int cx2, int cy2, int argb) {
337 screenDirtyRegions.dirty(cx1, cy1, cx2 - cx1, cy2 - cy1);
338 backbuffer.drawGlyph(source, dx, dy, cx1, cy1, cx2, cy2, argb);
341 public void fillTrapezoid(int x1, int x2, int y1, int x3, int x4, int y2, int color) {
342 screenDirtyRegions.dirty(Math.min(x1, x3), y1, Math.max(x2, x4) - Math.min(x1, x3), y2 - y1);
343 backbuffer.fillTrapezoid(x1, x2, y1, x3, x4, y2, color);
346 public void render() {
349 int[][] dirt = screenDirtyRegions.flush();
350 for(int i = 0; dirt != null && i < dirt.length; i++) {
351 if (dirt[i] == null) continue;
358 if (x+w > root.width) w = root.width - x;
359 if (y+h > root.height) h = root.height - y;
360 if (w <= 0 || h <= 0) continue;
362 blit(backbuffer, x, y, x, y, w + x, h + y);
366 /** This is how subclasses signal a 'shallow dirty', indicating that although the backbuffer is valid, the screen is not */
367 public final void Dirty(int x, int y, int w, int h) {
368 screenDirtyRegions.dirty(x, y, w, h);
369 Scheduler.renderAll();
372 public void dirty(int x, int y, int w, int h) {
373 screenDirtyRegions.dirty(x, y, w, h);
374 super.dirty(x, y, w, h);
377 /** copies a region from the doublebuffer to this surface */
378 public abstract void blit(PixelBuffer source, int sx, int sy, int dx, int dy, int dx2, int dy2);