src/org/ibex/Surface.java

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