1 // Copyright 2004 Adam Megacz, see the COPYING file for licensing [GPL]
2 package org.ibex.graphics;
5 import org.ibex.util.*;
6 import org.ibex.plat.*;
8 import org.ibex.core.*; // FIXME
11 * A Surface, as described in the Ibex Reference.
13 * Platform subclasses should include an inner class subclass of
14 * Surface to return from the Platform._createSurface() method
16 public abstract class Surface extends PixelBuffer implements Task {
18 // Static Data ////////////////////////////////////////////////////////////////////////////////
20 private static Boolean T = Boolean.TRUE;
21 private static Boolean F = Boolean.FALSE;
23 /** all instances of Surface which need to be refreshed by the Scheduler */
24 public static Vec allSurfaces = new Vec();
26 /** When set to true, render() should abort as soon as possible and restart the rendering process */
27 public volatile boolean abort = false;
29 // these three variables are used to ensure that user resizes trump programmatic resizes
30 public volatile boolean syncRootBoxToSurface = false;
31 public volatile int pendingWidth = 0;
32 public volatile int pendingHeight = 0;
34 public static boolean alt = false; ///< true iff the alt button is pressed down
35 public static boolean control = false; ///< true iff the control button is pressed down
36 public static boolean shift = false; ///< true iff the shift button is pressed down
37 public static boolean button1 = false; ///< true iff button 1 is depressed
38 public static boolean button2 = false; ///< true iff button 2 is depressed
39 public static boolean button3 = false; ///< true iff button 3 is depressed
42 // Instance Data ///////////////////////////////////////////////////////////////////////
44 public Box root; ///< The Box at the root of this surface
45 public String cursor = "default"; ///< The active cursor to switch to when syncCursor() is called
46 public int mousex; ///< x position of the mouse
47 public int mousey; ///< y position of the mouse
48 public int _mousex; ///< x position of the mouse FIXME
49 public int _mousey; ///< y position of the mouse FIXME
50 public int newmousex = -1; ///< x position of the mouse, in real time; this lets us collapse Move's
51 public int newmousey = -1; ///< y position of the mouse, in real time; this lets us collapse Move's
52 public boolean minimized = false; ///< True iff this surface is minimized, in real time
53 public boolean maximized = false; ///< True iff this surface is maximized, in real time
54 DirtyList dirtyRegions = new DirtyList(); ///< Dirty regions on the surface
56 // Used For Simulating Clicks and DoubleClicks /////////////////////////////////////////////////
58 int last_press_x = Integer.MAX_VALUE; ///< the x-position of the mouse the last time a Press message was enqueued
59 int last_press_y = Integer.MAX_VALUE; ///< the y-position of the mouse the last time a Press message was enqueued
60 static int lastClickButton = 0; ///< the last button to recieve a Click message; used for simulating DoubleClick's
61 static long lastClickTime = 0; ///< the last time a Click message was processed; used for simulating DoubleClick's
64 // Methods to be overridden by subclasses ///////////////////////////////////////////////////////
66 public abstract void toBack(); ///< should push surface to the back of the stacking order
67 public abstract void toFront(); ///< should pull surface to the front of the stacking order
68 public abstract void syncCursor(); ///< set the actual cursor to this.cursor if they do not match
69 public abstract void setInvisible(boolean b); ///< If <tt>b</tt>, make window invisible; otherwise, make it non-invisible.
70 protected abstract void _setMaximized(boolean b); ///< If <tt>b</tt>, maximize the surface; otherwise, un-maximize it.
71 protected abstract void _setMinimized(boolean b); ///< If <tt>b</tt>, minimize the surface; otherwise, un-minimize it.
72 public abstract void setLocation(); ///< Set the surface's x/y position to that of the root box
73 protected abstract void _setSize(int w, int h); ///< set the actual size of the surface
74 public abstract void setTitleBarText(String s); ///< Sets the surface's title bar text, if applicable
75 public abstract void setIcon(Picture i); ///< Sets the surface's title bar text, if applicable
76 public abstract void _dispose(); ///< Destroy the surface
77 public void setMinimumSize(int minx, int miny, boolean resizable) { }
78 protected void setSize(int w, int h) { _setSize(w, h); }
80 public static Picture scarImage = null;
82 // Helper methods for subclasses ////////////////////////////////////////////////////////////
84 protected final void Press(final int button) {
85 last_press_x = mousex;
86 last_press_y = mousey;
88 if (button == 1) button1 = true;
89 else if (button == 2) button2 = true;
90 else if (button == 3) button3 = true;
92 if (button == 1) new Message("_Press1", T, root);
93 else if (button == 2) new Message("_Press2", T, root);
94 else if (button == 3) {
95 Scheduler.add(new Task() { public void perform() throws JSExn {
96 Platform.clipboardReadEnabled = true;
98 root.putAndTriggerTraps("_Press3", T);
100 Platform.clipboardReadEnabled = false;
106 protected final void Release(int button) {
107 if (button == 1) button1 = false;
108 else if (button == 2) button2 = false;
109 else if (button == 3) button3 = false;
111 if (button == 1) new Message("_Release1", T, root);
112 else if (button == 2) new Message("_Release2", T, root);
113 else if (button == 3) new Message("_Release3", T, root);
115 if (Platform.needsAutoClick() && Math.abs(last_press_x - mousex) < 5 && Math.abs(last_press_y - mousey) < 5) Click(button);
116 last_press_x = Integer.MAX_VALUE;
117 last_press_y = Integer.MAX_VALUE;
120 protected final void Click(int button) {
121 if (button == 1) new Message("_Click1", T, root);
122 else if (button == 2) new Message("_Click2", T, root);
123 else if (button == 3) new Message("_Click3", T, root);
124 if (Platform.needsAutoDoubleClick()) {
125 long now = System.currentTimeMillis();
126 if (lastClickButton == button && now - lastClickTime < 350) DoubleClick(button);
127 lastClickButton = button;
132 /** we enqueue ourselves in the Scheduler when we have a Move message to deal with */
133 private Task mover = new Task() {
134 public void perform() {
135 if (mousex == newmousex && mousey == newmousey) return;
136 int oldmousex = mousex; mousex = newmousex;
137 int oldmousey = mousey; mousey = newmousey;
138 String oldcursor = cursor; cursor = "default";
139 // FIXME: Root (ONLY) gets motion events outside itself (if trapped)
140 if (oldmousex != mousex || oldmousey != mousey)
141 root.putAndTriggerTrapsAndCatchExceptions("_Move", T);
142 if (!cursor.equals(oldcursor)) syncCursor();
146 * Notify Ibex that the mouse has moved. If the mouse leaves the
147 * surface, but the host windowing system does not provide its new
148 * position (for example, a Java MouseListener.mouseExited()
149 * message), the subclass should use (-1,-1).
151 protected final void Move(final int newmousex, final int newmousey) {
152 this.newmousex = newmousex;
153 this.newmousey = newmousey;
154 Scheduler.add(mover);
157 protected final void HScroll(int pixels) { new Message("_HScroll", new Integer(pixels), root); }
158 protected final void VScroll(int pixels) { new Message("_VScroll", new Integer(pixels), root); }
159 protected final void HScroll(float lines) { new Message("_HScroll", new Float(lines), root); }
160 protected final void VScroll(float lines) { new Message("_VScroll", new Float(lines), root); }
162 /** subclasses should invoke this method when the user resizes the window */
163 protected final void SizeChange(final int width, final int height) {
164 if (pendingWidth == width && pendingHeight == height) return;
165 pendingWidth = width;
166 pendingHeight = height;
167 syncRootBoxToSurface = true;
169 Scheduler.renderAll();
172 // FEATURE: can we avoid creating objects here?
173 protected final void PosChange(final int x, final int y) {
174 Scheduler.add(new Task() { public void perform() throws JSExn {
177 root.putAndTriggerTrapsAndCatchExceptions("PosChange", T);
181 private final String[] doubleClick = new String[] { null, "_DoubleClick1", "_DoubleClick2", "_DoubleClick3" };
182 protected final void DoubleClick(int button) { new Message(doubleClick[button], T, root); }
183 protected final void KeyPressed(String key) { new Message("_KeyPressed", key, root); }
184 protected final void KeyReleased(String key) { new Message("_KeyReleased", key, root); }
185 protected final void Close() { new Message("Close", T, root); }
186 protected final void Minimized(boolean b) { minimized = b; new Message("Minimized", b ? T : F, root); }
187 protected final void Maximized(boolean b) { maximized = b; new Message("Maximized", b ? T : F, root); }
188 protected final void Focused(boolean b) { new Message("Focused", b ? T : F, root); }
190 private boolean scheduled = false;
191 public void Refresh() { if (!scheduled) Scheduler.add(this); scheduled = true; }
192 public void perform() { scheduled = false; Scheduler.renderAll(); }
194 public final void setMaximized(boolean b) { if (b != maximized) _setMaximized(maximized = b); }
195 public final void setMinimized(boolean b) { if (b != minimized) _setMinimized(minimized = b); }
198 // Other Methods ///////////////////////////////////////////////////////////////////////////////
200 /** Indicates that the Surface is no longer needed */
201 public final void dispose(boolean quitIfAllSurfacesGone) {
202 if (Log.on) Log.info(this, "disposing " + this);
203 allSurfaces.removeElement(this);
205 if (allSurfaces.size() == 0) {
206 if (Log.on) Log.info(this, "exiting because last surface was destroyed");
211 public void dirty(int x, int y, int w, int h) {
212 dirtyRegions.dirty(x, y, w, h);
216 public static Surface fromBox(Box b) {
217 // FIXME use a hash table here
218 for(int i=0; i<allSurfaces.size(); i++) {
219 Surface s = (Surface)allSurfaces.elementAt(i);
220 if (s.root == b) return s;
225 public Surface(Box root) {
227 root.setWidth(root.minwidth, Math.min(Platform.getScreenWidth(), root.maxwidth));
228 root.setHeight(root.minheight, Math.min(Platform.getScreenHeight(), root.maxheight));
229 Surface old = fromBox(root);
230 if (old != null) old.dispose(false);
231 else root.removeSelf();
235 private static Affine identity = Affine.identity();
237 /** runs the prerender() and render() pipelines in the root Box to regenerate the backbuffer, then blits it to the screen */
238 public synchronized void render() {
240 // make sure the root is properly sized
244 if (syncRootBoxToSurface) {
245 root.setWidth(root.minwidth, pendingWidth);
246 root.setHeight(root.minheight, pendingHeight);
247 syncRootBoxToSurface = false;
249 if (root.maxwidth != root.width || root.maxheight != root.height) {
250 // dirty the place where the scar used to be and where it is now
251 dirty(0, root.height - scarImage.height, scarImage.width, scarImage.height);
252 dirty(0, root.maxheight - scarImage.height, scarImage.width, scarImage.height);
255 setSize(root.width, root.height);
256 /*String oldcursor = cursor;
258 root.putAndTriggerTrapsAndCatchExceptions("_Move", JS.T);
259 if (!cursor.equals(oldcursor)) syncCursor();*/
262 int[][] dirt = dirtyRegions.flush();
263 for(int i = 0; dirt != null && i < dirt.length; i++) {
264 if (dirt[i] == null) continue;
265 int x = dirt[i][0], y = dirt[i][1], w = dirt[i][2], h = dirt[i][3];
268 if (x+w > root.width) w = root.width - x;
269 if (y+h > root.height) h = root.height - y;
270 if (w <= 0 || h <= 0) continue;
272 root.render(0, 0, x, y, x + w, y + h, this, identity);
273 drawPicture(scarImage, 0, root.height - scarImage.height, x, y, x+w, y+h);
276 // x,y,w,h is only partially reconstructed, so we must be careful not to re-blit it
277 dirtyRegions.dirty(x, y, w, h);
278 // put back all the dirty regions we haven't yet processed (including the current one)
279 for(int j=i; j<dirt.length; j++)
281 dirtyRegions.dirty(dirt[j][0], dirt[j][1], dirt[j][2], dirt[j][3]);
287 // FEATURE: reinstate recycler
288 public class Message implements Task {
290 private Box boxContainingMouse;
291 private Object value;
294 Message(String name, Object value, Box boxContainingMouse) {
295 this.boxContainingMouse = boxContainingMouse;
301 public void perform() {
302 if (name.equals("_KeyPressed")) {
303 String value = (String)this.value;
304 if (value.toLowerCase().endsWith("shift")) shift = true; else if (shift) value = value.toUpperCase();
305 if (value.toLowerCase().equals("alt")) alt = true; else if (alt) value = "A-" + value;
306 if (value.toLowerCase().endsWith("control")) control = true; else if (control) value = "C-" + value;
307 if (value.equals("C-v") || value.equals("A-v")) Platform.clipboardReadEnabled = true;
309 } else if (name.equals("_KeyReleased")) {
310 String value = (String)this.value;
311 if (value.toLowerCase().equals("alt")) alt = false;
312 else if (value.toLowerCase().equals("control")) control = false;
313 else if (value.toLowerCase().equals("shift")) shift = false;
315 } else if (name.equals("_HScroll") || name.equals("_VScroll")) {
316 // FIXME: technically points != pixels
317 if (value instanceof Integer)
318 value = new Float(((Integer)value).intValue() * root.fontSize());
321 boxContainingMouse.putAndTriggerTrapsAndCatchExceptions(name, value);
323 Platform.clipboardReadEnabled = false;
326 public String toString() { return "Message [name=" + name + ", value=" + value + "]"; }
330 // Default PixelBuffer implementation /////////////////////////////////////////////////////////
332 public static abstract class DoubleBufferedSurface extends Surface {
334 public DoubleBufferedSurface(Box root) { super(root); }
335 PixelBuffer backbuffer = Platform.createPixelBuffer(Platform.getScreenWidth(), Platform.getScreenHeight(), this);
336 DirtyList screenDirtyRegions = new DirtyList();
338 public void drawPicture(Picture source, int dx, int dy, int cx1, int cy1, int cx2, int cy2) {
339 screenDirtyRegions.dirty(cx1, cy1, cx2 - cx1, cy2 - cy1);
340 backbuffer.drawPicture(source, dx, dy, cx1, cy1, cx2, cy2);
343 public void drawGlyph(Font.Glyph source, int dx, int dy, int cx1, int cy1, int cx2, int cy2, int argb) {
344 screenDirtyRegions.dirty(cx1, cy1, cx2 - cx1, cy2 - cy1);
345 backbuffer.drawGlyph(source, dx, dy, cx1, cy1, cx2, cy2, argb);
348 public void fillTrapezoid(int x1, int x2, int y1, int x3, int x4, int y2, int color) {
349 screenDirtyRegions.dirty(Math.min(x1, x3), y1, Math.max(x2, x4) - Math.min(x1, x3), y2 - y1);
350 backbuffer.fillTrapezoid(x1, x2, y1, x3, x4, y2, color);
353 public void render() {
356 int[][] dirt = screenDirtyRegions.flush();
357 for(int i = 0; dirt != null && i < dirt.length; i++) {
358 if (dirt[i] == null) continue;
365 if (x+w > root.width) w = root.width - x;
366 if (y+h > root.height) h = root.height - y;
367 if (w <= 0 || h <= 0) continue;
369 blit(backbuffer, x, y, x, y, w + x, h + y);
373 /** This is how subclasses signal a 'shallow dirty', indicating that although the backbuffer is valid, the screen is not */
374 public final void Dirty(int x, int y, int w, int h) {
375 screenDirtyRegions.dirty(x, y, w, h);
376 Scheduler.renderAll();
379 public void dirty(int x, int y, int w, int h) {
380 screenDirtyRegions.dirty(x, y, w, h);
381 super.dirty(x, y, w, h);
384 /** copies a region from the doublebuffer to this surface */
385 public abstract void blit(PixelBuffer source, int sx, int sy, int dx, int dy, int dx2, int dy2);