src/org/ibex/graphics/Surface.java

   1 // Copyright 2004 Adam Megacz, see the COPYING file for licensing [GPL]
   2 package org.ibex.graphics;
   3
   4 import org.ibex.js.*;
   5 import org.ibex.util.*;
   6 import org.ibex.plat.*;
   7
   8 import org.ibex.core.*;  // FIXME
   9
  10 /**
  11  *  A Surface, as described in the Ibex Reference.
  12  *
  13  *  Platform subclasses should include an inner class subclass of
  14  *  Surface to return from the Platform._createSurface() method
  15  */
  16 public abstract class Surface extends PixelBuffer implements Task {
  17
  18     // Static Data ////////////////////////////////////////////////////////////////////////////////
  19
  20     private static Boolean T = Boolean.TRUE;
  21     private static Boolean F = Boolean.FALSE;
  22
  23     /** all instances of Surface which need to be refreshed by the Scheduler */
  24     public static Vec allSurfaces = new Vec();
  25
  26     /** When set to true, render() should abort as soon as possible and restart the rendering process */
  27     public volatile boolean abort = false;
  28
  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;
  33
  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
  40
  41
  42     // Instance Data ///////////////////////////////////////////////////////////////////////
  43
  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     public boolean unrendered = true;                  ///< True iff this surface has not yet been rendered
  55     DirtyList dirtyRegions = new DirtyList();          ///< Dirty regions on the surface
  56
  57     // Used For Simulating Clicks and DoubleClicks /////////////////////////////////////////////////
  58
  59     int last_press_x = Integer.MAX_VALUE;      ///< the x-position of the mouse the last time a Press message was enqueued
  60     int last_press_y = Integer.MAX_VALUE;      ///< the y-position of the mouse the last time a Press message was enqueued
  61     static int lastClickButton = 0;            ///< the last button to recieve a Click message; used for simulating DoubleClick's
  62     static long lastClickTime = 0;             ///< the last time a Click message was processed; used for simulating DoubleClick's
  63
  64
  65     // Methods to be overridden by subclasses ///////////////////////////////////////////////////////
  66
  67     public abstract void toBack();                     ///< should push surface to the back of the stacking order
  68     public abstract void toFront();                    ///< should pull surface to the front of the stacking order
  69     public abstract void syncCursor();                 ///< set the actual cursor to this.cursor if they do not match
  70     public abstract void setInvisible(boolean b);      ///< If <tt>b</tt>, make window invisible; otherwise, make it non-invisible.
  71     protected abstract void _setMaximized(boolean b);  ///< If <tt>b</tt>, maximize the surface; otherwise, un-maximize it.
  72     protected abstract void _setMinimized(boolean b);  ///< If <tt>b</tt>, minimize the surface; otherwise, un-minimize it.
  73     public abstract void setLocation();                ///< Set the surface's x/y position to that of the root box
  74     protected abstract void _setSize(int w, int h);    ///< set the actual size of the surface
  75     public abstract void setTitleBarText(String s);    ///< Sets the surface's title bar text, if applicable
  76     public abstract void setIcon(Picture i);           ///< Sets the surface's title bar text, if applicable
  77     public abstract void _dispose();                   ///< Destroy the surface
  78     public void setMinimumSize(int minx, int miny, boolean resizable) { }
  79     protected void setSize(int w, int h) { _setSize(w, h); }
  80
  81     public static Picture scarImage = null;
  82
  83     // Helper methods for subclasses ////////////////////////////////////////////////////////////
  84
  85     protected final void Press(final int button) {
  86         last_press_x = mousex;
  87         last_press_y = mousey;
  88
  89         if (button == 1) button1 = true;
  90         else if (button == 2) button2 = true;
  91         else if (button == 3) button3 = true;
  92
  93         if (button == 1) new Message("_Press1", T, root);
  94         else if (button == 2) new Message("_Press2", T, root);
  95         else if (button == 3) {
  96             Scheduler.add(new Task() { public void perform() throws JSExn {
  97                 Platform.clipboardReadEnabled = true;
  98                 try {
  99                     root.putAndTriggerTraps("_Press3", T);
 100                 } finally {
 101                     Platform.clipboardReadEnabled = false;
 102                 }
 103             }});
 104         }
 105     }
 106
 107     protected final void Release(int button) {
 108         if (button == 1) button1 = false;
 109         else if (button == 2) button2 = false;
 110         else if (button == 3) button3 = false;
 111
 112         if (button == 1) new Message("_Release1", T, root);
 113         else if (button == 2) new Message("_Release2", T, root);
 114         else if (button == 3) new Message("_Release3", T, root);
 115
 116         if (Platform.needsAutoClick() && Math.abs(last_press_x - mousex) < 5 && Math.abs(last_press_y - mousey) < 5) Click(button);
 117         last_press_x = Integer.MAX_VALUE;
 118         last_press_y = Integer.MAX_VALUE;
 119     }
 120
 121     protected final void Click(int button) {
 122         if (button == 1) new Message("_Click1", T, root);
 123         else if (button == 2) new Message("_Click2", T, root);
 124         else if (button == 3) new Message("_Click3", T, root);
 125         if (Platform.needsAutoDoubleClick()) {
 126             long now = System.currentTimeMillis();
 127             if (lastClickButton == button && now - lastClickTime < 350) DoubleClick(button);
 128             lastClickButton = button;
 129             lastClickTime = now;
 130         }
 131     }
 132
 133     /** we enqueue ourselves in the Scheduler when we have a Move message to deal with */
 134     private Task mover = new Task() {
 135             public void perform() {
 136                 if (mousex == newmousex && mousey == newmousey) return;
 137                 int oldmousex = mousex;     mousex = newmousex;
 138                 int oldmousey = mousey;     mousey = newmousey;
 139                 String oldcursor = cursor;  cursor = "default";
 140                 // FIXME: Root (ONLY) gets motion events outside itself (if trapped)
 141                 if (oldmousex != mousex || oldmousey != mousey)
 142                     root.putAndTriggerTrapsAndCatchExceptions("_Move", T);
 143                 if (!cursor.equals(oldcursor)) syncCursor();
 144             } };
 145
 146     /**
 147      *  Notify Ibex that the mouse has moved. If the mouse leaves the
 148      *  surface, but the host windowing system does not provide its new
 149      *  position (for example, a Java MouseListener.mouseExited()
 150      *  message), the subclass should use (-1,-1).
 151      */
 152     protected final void Move(final int newmousex, final int newmousey) {
 153         this.newmousex = newmousex;
 154         this.newmousey = newmousey;
 155         Scheduler.add(mover);
 156     }
 157
 158     protected final void HScroll(int pixels) { new Message("_HScroll", new Integer(pixels), root); }
 159     protected final void VScroll(int pixels) { new Message("_VScroll", new Integer(pixels), root); }
 160     protected final void HScroll(float lines) { new Message("_HScroll", new Float(lines), root); }
 161     protected final void VScroll(float lines) { new Message("_VScroll", new Float(lines), root); }
 162
 163     /** subclasses should invoke this method when the user resizes the window */
 164     protected final void SizeChange(final int width, final int height) {
 165         if (unrendered || (pendingWidth == width && pendingHeight == height)) return;
 166         pendingWidth = width;
 167         pendingHeight = height;
 168         syncRootBoxToSurface = true;
 169         abort = true;
 170         Scheduler.renderAll();
 171     }
 172
 173     // FEATURE: can we avoid creating objects here?
 174     protected final void PosChange(final int x, final int y) {
 175         Scheduler.add(new Task() { public void perform() throws JSExn {
 176             root.x = x;
 177             root.y = y;
 178             root.putAndTriggerTrapsAndCatchExceptions("PosChange", T);
 179         }});
 180     }
 181
 182     private final String[] doubleClick = new String[] { null, "_DoubleClick1", "_DoubleClick2", "_DoubleClick3" };
 183     protected final void DoubleClick(int button) { new Message(doubleClick[button], T, root); }
 184     protected final void KeyPressed(String key) { new Message("_KeyPressed", key, root); }
 185     protected final void KeyReleased(String key) { new Message("_KeyReleased", key, root); }
 186     protected final void Close() { new Message("Close", T, root); }
 187     protected final void Minimized(boolean b) { minimized = b; new Message("Minimized", b ? T : F, root); }
 188     protected final void Maximized(boolean b) { maximized = b; new Message("Maximized", b ? T : F, root); }
 189     protected final void Focused(boolean b) { new Message("Focused", b ? T : F, root); }
 190
 191     private boolean scheduled = false;
 192     public void Refresh() { if (!scheduled) Scheduler.add(this); scheduled = true; }
 193     public void perform() { scheduled = false; Scheduler.renderAll(); }
 194
 195     public final void setMaximized(boolean b) { if (b != maximized) _setMaximized(maximized = b); }
 196     public final void setMinimized(boolean b) { if (b != minimized) _setMinimized(minimized = b); }
 197
 198
 199     // Other Methods ///////////////////////////////////////////////////////////////////////////////
 200
 201     /** Indicates that the Surface is no longer needed */
 202     public final void dispose(boolean quitIfAllSurfacesGone) {
 203         if (Log.on) Log.info(this, "disposing " + this);
 204         allSurfaces.removeElement(this);
 205         _dispose();
 206         if (allSurfaces.size() == 0) {
 207             if (Log.on) Log.info(this, "exiting because last surface was destroyed");
 208             System.exit(0);
 209         }
 210     }
 211
 212     public void dirty(int x, int y, int w, int h) {
 213         dirtyRegions.dirty(x, y, w, h);
 214         Refresh();
 215     }
 216
 217     public static Surface fromBox(Box b) {
 218         // FIXME use a hash table here
 219         for(int i=0; i<allSurfaces.size(); i++) {
 220             Surface s = (Surface)allSurfaces.elementAt(i);
 221             if (s.root == b) return s;
 222         }
 223         return null;
 224     }
 225
 226     public Surface(Box root) {
 227         this.root = root;
 228         root.setWidth(root.minwidth, Math.min(Platform.getScreenWidth(), root.maxwidth));
 229         root.setHeight(root.minheight, Math.min(Platform.getScreenHeight(), root.maxheight));
 230         Surface old = fromBox(root);
 231         if (old != null) old.dispose(false);
 232         else root.removeSelf();
 233         Refresh();
 234     }
 235
 236     private static Affine identity = Affine.identity();
 237
 238     /** runs the prerender() and render() pipelines in the root Box to regenerate the backbuffer, then blits it to the screen */
 239     public synchronized void render() {
 240         scheduled = false;
 241         // make sure the root is properly sized
 242         do {
 243             abort = false;
 244             root.pack();
 245             if (syncRootBoxToSurface) {
 246                 root.setWidth(root.minwidth, pendingWidth);
 247                 root.setHeight(root.minheight, pendingHeight);
 248                 syncRootBoxToSurface = false;
 249             }
 250             if (root.maxwidth != root.width || root.maxheight != root.height) {
 251                 // dirty the place where the scar used to be and where it is now
 252                 dirty(0, root.height - scarImage.height, scarImage.width, scarImage.height);
 253                 dirty(0, root.maxheight - scarImage.height, scarImage.width, scarImage.height);
 254             }
 255             root.reflow();
 256             setSize(root.width, root.height);
 257             /*String oldcursor = cursor;
 258             cursor = "default";
 259             root.putAndTriggerTrapsAndCatchExceptions("_Move", JS.T);
 260             if (!cursor.equals(oldcursor)) syncCursor();*/
 261         } while(abort);
 262
 263         int[][] dirt = dirtyRegions.flush();
 264         for(int i = 0; dirt != null && i < dirt.length; i++) {
 265             if (dirt[i] == null) continue;
 266             int x = dirt[i][0], y = dirt[i][1], w = dirt[i][2], h = dirt[i][3];
 267             if (x < 0) x = 0;
 268             if (y < 0) y = 0;
 269             if (x+w > root.width) w = root.width - x;
 270             if (y+h > root.height) h = root.height - y;
 271             if (w <= 0 || h <= 0) continue;
 272
 273             root.render(0, 0, x, y, x + w, y + h, this, identity);
 274             drawPicture(scarImage, 0, root.height - scarImage.height, x, y, x+w, y+h);
 275
 276             if (abort) {
 277                 // x,y,w,h is only partially reconstructed, so we must be careful not to re-blit it
 278                 dirtyRegions.dirty(x, y, w, h);
 279                 // put back all the dirty regions we haven't yet processed (including the current one)
 280                 for(int j=i; j<dirt.length; j++)
 281                     if (dirt[j] != null)
 282                         dirtyRegions.dirty(dirt[j][0], dirt[j][1], dirt[j][2], dirt[j][3]);
 283                 return;
 284             }
 285         }
 286
 287         unrendered = false;
 288     }
 289
 290     // FEATURE: reinstate recycler
 291     public class Message implements Task {
 292
 293         private Box boxContainingMouse;
 294         private Object value;
 295         public String name;
 296
 297         Message(String name, Object value, Box boxContainingMouse) {
 298             this.boxContainingMouse = boxContainingMouse;
 299             this.name = name;
 300             this.value = value;
 301             Scheduler.add(this);
 302         }
 303
 304         public void perform() {
 305             if (name.equals("_KeyPressed")) {
 306                 String value = (String)this.value;
 307                 if (value.toLowerCase().endsWith("shift")) shift = true;     else if (shift) value = value.toUpperCase();
 308                 if (value.toLowerCase().equals("alt")) alt = true;           else if (alt) value = "A-" + value;
 309                 if (value.toLowerCase().endsWith("control")) control = true; else if (control) value = "C-" + value;
 310                 if (value.equals("C-v") || value.equals("A-v")) Platform.clipboardReadEnabled = true;
 311                 this.value = value;
 312             } else if (name.equals("_KeyReleased")) {
 313                 String value = (String)this.value;
 314                 if (value.toLowerCase().equals("alt")) alt = false;
 315                 else if (value.toLowerCase().equals("control")) control = false;
 316                 else if (value.toLowerCase().equals("shift")) shift = false;
 317                 this.value = value;
 318             } else if (name.equals("_HScroll") || name.equals("_VScroll")) {
 319                 // FIXME: technically points != pixels
 320                 if (value instanceof Integer)
 321                     value = new Float(((Integer)value).intValue() * root.fontSize());
 322             }
 323             try {
 324                 boxContainingMouse.putAndTriggerTrapsAndCatchExceptions(name, value);
 325             } finally {
 326                 Platform.clipboardReadEnabled = false;
 327             }
 328         }
 329         public String toString() { return "Message [name=" + name + ", value=" + value + "]"; }
 330     }
 331
 332
 333     // Default PixelBuffer implementation /////////////////////////////////////////////////////////
 334
 335     public static abstract class DoubleBufferedSurface extends Surface {
 336
 337         public DoubleBufferedSurface(Box root) { super(root); }
 338         PixelBuffer backbuffer = Platform.createPixelBuffer(Platform.getScreenWidth(), Platform.getScreenHeight(), this);
 339         DirtyList screenDirtyRegions = new DirtyList();
 340
 341         public void drawPicture(Picture source, int dx, int dy, int cx1, int cy1, int cx2, int cy2) {
 342             screenDirtyRegions.dirty(cx1, cy1, cx2 - cx1, cy2 - cy1);
 343             backbuffer.drawPicture(source, dx, dy, cx1, cy1, cx2, cy2);
 344         }
 345
 346         public void drawGlyph(Font.Glyph source, int dx, int dy, int cx1, int cy1, int cx2, int cy2, int argb) {
 347             screenDirtyRegions.dirty(cx1, cy1, cx2 - cx1, cy2 - cy1);
 348             backbuffer.drawGlyph(source, dx, dy, cx1, cy1, cx2, cy2, argb);
 349         }
 350
 351         public void fillTrapezoid(int x1, int x2, int y1, int x3, int x4, int y2, int color) {
 352             screenDirtyRegions.dirty(Math.min(x1, x3), y1, Math.max(x2, x4) - Math.min(x1, x3), y2 - y1);
 353             backbuffer.fillTrapezoid(x1, x2, y1, x3, x4, y2, color);
 354         }
 355
 356         public void render() {
 357             super.render();
 358             if (abort) return;
 359             int[][] dirt = screenDirtyRegions.flush();
 360             for(int i = 0; dirt != null && i < dirt.length; i++) {
 361                 if (dirt[i] == null) continue;
 362                 int x = dirt[i][0];
 363                 int y = dirt[i][1];
 364                 int w = dirt[i][2];
 365                 int h = dirt[i][3];
 366                 if (x < 0) x = 0;
 367                 if (y < 0) y = 0;
 368                 if (x+w > root.width) w = root.width - x;
 369                 if (y+h > root.height) h = root.height - y;
 370                 if (w <= 0 || h <= 0) continue;
 371                 if (abort) return;
 372                 blit(backbuffer, x, y, x, y, w + x, h + y);
 373             }
 374         }
 375
 376         /** This is how subclasses signal a 'shallow dirty', indicating that although the backbuffer is valid, the screen is not */
 377         public final void Dirty(int x, int y, int w, int h) {
 378             screenDirtyRegions.dirty(x, y, w, h);
 379             Scheduler.renderAll();
 380         }
 381
 382         public void dirty(int x, int y, int w, int h) {
 383             screenDirtyRegions.dirty(x, y, w, h);
 384             super.dirty(x, y, w, h);
 385         }
 386
 387         /** copies a region from the doublebuffer to this surface */
 388         public abstract void blit(PixelBuffer source, int sx, int sy, int dx, int dy, int dx2, int dy2);
 389
 390     }
 391
 392 }