src/org/xwt/Surface.java

   1 // Copyright 2003 Adam Megacz, see the COPYING file for licensing [GPL]
   2 package org.xwt;
   3
   4 import org.bouncycastle.util.encoders.Base64;
   5 import org.xwt.js.*;
   6 import org.xwt.util.*;
   7 import java.io.*;
   8 import java.util.*;
   9
  10 /**
  11  *  A Surface, as described in the XWT Reference.
  12  *
  13  *  Platform subclasses should include an inner class subclass of
  14  *  Surface to return from the Platform._createSurface() method
  15  *
  16  *  Note that the members in the section 'state variables' are either
  17  *  in real-time (the actual size/position/state), or in
  18  *  Scheduler-time (the size/position/state at the time that the
  19  *  now-executing message was enqueued). This distinction is important.
  20  */
  21 public abstract class Surface extends PixelBuffer {
  22
  23     public int getWidth() { return root == null ? 0 : root.width; }
  24     public int getHeight() { return root == null ? 0 : root.height; }
  25
  26     // Static Data ////////////////////////////////////////////////////////////////////////////////
  27
  28     /**< the most recently enqueued Move message; used to throttle the message rate */
  29     private static Scheduler.Task lastMoveMessage = null;
  30
  31     /** all instances of Surface which need to be refreshed by the Scheduler */
  32     public static Vec allSurfaces = new Vec();
  33
  34     /** When set to true, render() should abort as soon as possible and restart the rendering process */
  35     static volatile boolean abort = false;
  36
  37     public static boolean alt = false;          ///< true iff the alt button is pressed down, in real time
  38     public static boolean control = false;      ///< true iff the control button is pressed down, in real time
  39     public static boolean shift = false;        ///< true iff the shift button is pressed down, in real time
  40     public static boolean button1 = false;      ///< true iff button 1 is depressed, in Scheduler-time
  41     public static boolean button2 = false;      ///< true iff button 2 is depressed, in Scheduler-time
  42     public static boolean button3 = false;      ///< true iff button 3 is depressed, in Scheduler-time
  43
  44
  45
  46     // Instance Data ///////////////////////////////////////////////////////////////////////
  47
  48     public Box root;      /**< The Box at the root of this surface */
  49     public String cursor = "default";
  50
  51     public int mousex;                    ///< the x position of the mouse, relative to this Surface, in Scheduler-time
  52     public int mousey;                    ///< the y position of the mouse, relative to this Surface, in Scheduler-time
  53     public boolean minimized = false;     ///< True iff this surface is minimized, in real time
  54     public boolean maximized = false;     ///< True iff this surface is maximized, in real time
  55
  56     /** Dirty regions on the backbuffer which need to be rebuilt using Box.render() */
  57     private DirtyList dirtyRegions = new DirtyList();
  58
  59
  60     // Used For Simulating Clicks and DoubleClicks /////////////////////////////////////////////////
  61
  62     int last_press_x = Integer.MAX_VALUE;      ///< the x-position of the mouse the last time a Press message was enqueued
  63     int last_press_y = Integer.MAX_VALUE;      ///< the y-position of the mouse the last time a Press message was enqueued
  64     static int lastClickButton = 0;            ///< the last button to recieve a Click message; used for simulating DoubleClick's
  65     static long lastClickTime = 0;             ///< the last time a Click message was processed; used for simulating DoubleClick's
  66
  67
  68     // Methods to be overridden by subclasses ///////////////////////////////////////////////////////
  69
  70     public abstract void toBack();      ///< when invoked, the surface should push itself to the back of the stacking order
  71     public abstract void toFront();     ///< when invoked, the surface should pull itself to the front of the stacking order
  72     public abstract void syncCursor();  ///< the <i>actual</i> cursor for this surface to the cursor referenced by <tt>cursor</tt>
  73     public abstract void setInvisible(boolean b);      ///< If <tt>b</tt>, make window invisible; otherwise, make it non-invisible.
  74     protected abstract void _setMaximized(boolean b);  ///< If <tt>b</tt>, maximize the surface; otherwise, un-maximize it.
  75     protected abstract void _setMinimized(boolean b);  ///< If <tt>b</tt>, minimize the surface; otherwise, un-minimize it.
  76     public abstract void setLocation();                      ///< Set the surface's x/y position to that of the root box
  77     public abstract void setTitleBarText(String s);      ///< Sets the surface's title bar text, if applicable
  78     public abstract void setIcon(Picture i);      ///< Sets the surface's title bar text, if applicable
  79     public abstract void _dispose();      ///< Destroy the surface
  80     public void setLimits(int min_width, int min_height, int max_width, int max_height) { }
  81     protected abstract void _setSize(int width, int height);  ///< Sets the surface's width and height.
  82
  83
  84     private int platform_window_width = 0;
  85     private int platform_window_height = 0;
  86     protected final void setSize(int width, int height) {
  87         if (root.width != width || root.height != height) {
  88             root.dirty(0, root.height - Main.scarImage.getHeight(), Main.scarImage.getWidth(), Main.scarImage.getHeight());
  89             root.width = Math.max(Main.scarImage.getWidth(), width);
  90             root.height = Math.max(Main.scarImage.getHeight(), height);
  91         }
  92         if (root.width > 0 && root.height > 0 && platform_window_width != root.width && platform_window_height != root.height)
  93             _setSize(root.width, root.height);
  94     }
  95
  96     // Helper methods for subclasses ////////////////////////////////////////////////////////////
  97
  98     protected final void Press(final int button) {
  99         last_press_x = mousex;
 100         last_press_y = mousey;
 101
 102         if (button == 1) button1 = true;
 103         else if (button == 2) button2 = true;
 104         else if (button == 3) button3 = true;
 105
 106         if (button == 1) new SimpleMessage("Press1", Boolean.TRUE, Box.whoIs(root, mousex, mousey));
 107         else if (button == 2) new SimpleMessage("Press2", Boolean.TRUE, Box.whoIs(root, mousex, mousey));
 108         else if (button == 3) {
 109             final Box who = Box.whoIs(root, mousex, mousey);
 110             Scheduler.add(new Scheduler.Task() { public void perform() {
 111                 Platform.clipboardReadEnabled = true;
 112                 root.putAndTriggerTraps("Press3", Boolean.TRUE);
 113                 Platform.clipboardReadEnabled = false;
 114             }});
 115         }
 116     }
 117
 118     protected final void Release(int button) {
 119         if (button == 1) button1 = false;
 120         else if (button == 2) button2 = false;
 121         else if (button == 3) button3 = false;
 122
 123         if (button == 1) new SimpleMessage("Release1", Boolean.TRUE, Box.whoIs(root, mousex, mousey));
 124         else if (button == 2) new SimpleMessage("Release2", Boolean.TRUE, Box.whoIs(root, mousex, mousey));
 125         else if (button == 3) new SimpleMessage("Release3", Boolean.TRUE, Box.whoIs(root, mousex, mousey));
 126
 127         if (Platform.needsAutoClick() && Math.abs(last_press_x - mousex) < 5 && Math.abs(last_press_y - mousey) < 5) Click(button);
 128         last_press_x = Integer.MAX_VALUE;
 129         last_press_y = Integer.MAX_VALUE;
 130     }
 131
 132     protected final void Click(int button) {
 133         if (button == 1) new SimpleMessage("Click1", Boolean.TRUE, Box.whoIs(root, mousex, mousey));
 134         else if (button == 2) new SimpleMessage("Click2", Boolean.TRUE, Box.whoIs(root, mousex, mousey));
 135         else if (button == 3) new SimpleMessage("Click3", Boolean.TRUE, Box.whoIs(root, mousex, mousey));
 136         if (Platform.needsAutoDoubleClick()) {
 137             long now = System.currentTimeMillis();
 138             if (lastClickButton == button && now - lastClickTime < 350) DoubleClick(button);
 139             lastClickButton = button;
 140             lastClickTime = now;
 141         }
 142     }
 143
 144     protected final void DoubleClick(int button) {
 145         if (button == 1) new SimpleMessage("DoubleClick1", Boolean.TRUE, Box.whoIs(root, mousex, mousey));
 146         else if (button == 2) new SimpleMessage("DoubleClick2", Boolean.TRUE, Box.whoIs(root, mousex, mousey));
 147         else if (button == 3) new SimpleMessage("DoubleClick3", Boolean.TRUE, Box.whoIs(root, mousex, mousey));
 148     }
 149
 150     /** Sends a KeyPressed message; subclasses should not add the C- or A- prefixes,
 151      *  nor should they capitalize alphabet characters
 152      */
 153     protected final void KeyPressed(String key) {
 154         if (key == null) return;
 155
 156         if (key.toLowerCase().endsWith("shift")) shift = true;
 157         else if (shift) key = key.toUpperCase();
 158
 159         if (key.toLowerCase().equals("alt")) alt = true;
 160         else if (alt) key = "A-" + key;
 161
 162         if (key.toLowerCase().endsWith("control")) control = true;
 163         else if (control) key = "C-" + key;
 164
 165         final String fkey = key;
 166         Scheduler.add(new KMessage(key));
 167     }
 168
 169     // This is implemented as a private static class instead of an anonymous class to work around a GCJ bug
 170     private class KMessage extends Scheduler.Task {
 171         String key = null;
 172         public KMessage(String k) { key = k; }
 173         public void perform() {
 174             if (key.equals("C-v") || key.equals("A-v")) Platform.clipboardReadEnabled = true;
 175             outer: for(int i=0; i<keywatchers.size(); i++) {
 176                 Box b = (Box)keywatchers.elementAt(i);
 177                 for(Box cur = b; cur != null; cur = cur.parent)
 178                     if (!cur.test(cur.VISIBLE)) continue outer;
 179                 b.putAndTriggerTraps("KeyPressed", key);
 180             }
 181             Platform.clipboardReadEnabled = false;
 182         }
 183     }
 184
 185     Vec keywatchers = new Vec();
 186
 187     /** sends a KeyReleased message; subclasses should not add the C- or A- prefixes,
 188      *  nor should they capitalize alphabet characters */
 189     protected final void KeyReleased(final String key) {
 190         if (key == null) return;
 191         if (key.toLowerCase().equals("alt")) alt = false;
 192         else if (key.toLowerCase().equals("control")) control = false;
 193         else if (key.toLowerCase().equals("shift")) shift = false;
 194         Scheduler.add(new Scheduler.Task() { public void perform() {
 195             outer: for(int i=0; i<keywatchers.size(); i++) {
 196                 Box b = (Box)keywatchers.elementAt(i);
 197                 for(Box cur = b; cur != null; cur = cur.parent)
 198                     if (!cur.test(cur.VISIBLE)) continue outer;
 199                 b.putAndTriggerTraps("KeyReleased", key);
 200             }
 201         }});
 202     }
 203
 204     /**
 205      *  Notify XWT that the mouse has moved. If the mouse leaves the
 206      *  surface, but the host windowing system does not provide its new
 207      *  position (for example, a Java MouseListener.mouseExited()
 208      *  message), the subclass should use (-1,-1).
 209      */
 210     protected final void Move(final int newmousex, final int newmousey) {
 211         Scheduler.add(lastMoveMessage = new Scheduler.Task() { public void perform() {
 212             synchronized(Surface.this) {
 213
 214                 // if move messages are arriving faster than we can process them, we just start ignoring them
 215                 if (lastMoveMessage != this) return;
 216
 217                 int oldmousex = mousex;
 218                 int oldmousey = mousey;
 219                 mousex = newmousex;
 220                 mousey = newmousey;
 221
 222                 String oldcursor = cursor;
 223                 cursor = "default";
 224
 225                 // Root gets motion events outside itself (if trapped, of course)
 226                 if (!root.inside(oldmousex, oldmousey) && !root.inside(mousex, mousey) && (button1 || button2 || button3))
 227                     root.putAndTriggerTraps("Move", Boolean.TRUE);
 228
 229                 root.Move(oldmousex, oldmousey, mousex, mousey);
 230                 if (!cursor.equals(oldcursor)) syncCursor();
 231             }
 232         }});
 233     }
 234
 235     protected final void SizeChange(final int width, final int height) {
 236         Scheduler.add(new Scheduler.Task() { public void perform() {
 237             if (width == root.width && height == root.height) return;
 238             root.set(root.REFLOW);
 239             platform_window_width = width;
 240             platform_window_height = height;
 241             do { abort = false; root.reflow(width, height); } while(abort);
 242         }});
 243         abort = true;
 244     }
 245
 246     protected final void PosChange(final int x, final int y) {
 247         Scheduler.add(new Scheduler.Task() { public void perform() {
 248             root.x = x;
 249             root.y = y;
 250             root.putAndTriggerTraps("PosChange", Boolean.TRUE);
 251         }});
 252     }
 253
 254     protected final void Close() { new SimpleMessage("Close", Boolean.TRUE, root); }
 255     protected final void Minimized(boolean b) { minimized = b; new SimpleMessage("Minimized", b ? Boolean.TRUE : Boolean.FALSE, root); }
 256     protected final void Maximized(boolean b) { maximized = b; new SimpleMessage("Maximized", b ? Boolean.TRUE : Boolean.FALSE, root); }
 257     protected final void Focused(boolean b) { new SimpleMessage("Focused", b ? Boolean.TRUE : Boolean.FALSE, root); }
 258     public static void Refresh() {
 259         Scheduler.add(new Scheduler.Task() { public void perform() {
 260             renderAll();
 261         }}); }
 262
 263     public static void renderAll() {
 264         for(int i=0; i<allSurfaces.size(); i++)
 265             ((Surface)allSurfaces.elementAt(i)).render();
 266     }
 267
 268     public final void setMaximized(boolean b) { if (b != maximized) _setMaximized(maximized = b); }
 269     public final void setMinimized(boolean b) { if (b != minimized) _setMinimized(minimized = b); }
 270
 271
 272     // Other Methods ///////////////////////////////////////////////////////////////////////////////
 273
 274     /** Indicates that the Surface is no longer needed */
 275     public final void dispose(boolean quitIfAllSurfacesGone) {
 276         if (Log.on) Log.log(this, "disposing " + this);
 277         allSurfaces.removeElement(this);
 278         _dispose();
 279         if (allSurfaces.size() == 0) {
 280             if (Log.on) Log.log(this, "exiting because last surface was destroyed");
 281             System.exit(0);
 282         }
 283     }
 284
 285     public void dirty(int x, int y, int w, int h) {
 286         dirtyRegions.dirty(x, y, w, h);
 287         Refresh();
 288     }
 289
 290     public static Surface fromBox(Box b) {
 291         for(int i=0; i<allSurfaces.size(); i++) {
 292             Surface s = (Surface)allSurfaces.elementAt(i);
 293             if (s.root == b) return s;
 294         }
 295         return null;
 296     }
 297
 298     public Surface(Box root) {
 299         this.root = root;
 300         Surface old = fromBox(root);
 301         if (old != null) old.dispose(false);
 302         else try {
 303             root.put("thisbox", null);
 304         } catch (JSExn e) {
 305             throw new Error("this should never happen");
 306         }
 307
 308         // make sure the root is properly sized
 309         do { abort = false; root.reflow(root.width, root.height); } while(abort);
 310
 311         root.dirty();
 312         Refresh();
 313     }
 314
 315     private static VectorGraphics.Affine identity = VectorGraphics.Affine.identity();
 316
 317     /** runs the prerender() and render() pipelines in the root Box to regenerate the backbuffer, then blits it to the screen */
 318     public synchronized void render() {
 319
 320         // make sure the root is properly sized
 321         do {
 322             abort = false;
 323             root.reflow(root.width, root.height);
 324             setSize(root.width, root.height);
 325             // update mouseinside and trigger Enter/Leave as a result of box size/position changes
 326             String oldcursor = cursor;
 327             cursor = "default";
 328             root.Move(mousex, mousey, mousex, mousey);
 329             if (!cursor.equals(oldcursor)) syncCursor();
 330         } while(abort);
 331
 332         //Box.sizePosChangesSinceLastRender = 0;
 333         int[][] dirt = dirtyRegions.flush();
 334         for(int i = 0; dirt != null && i < dirt.length; i++) {
 335             if (dirt[i] == null) continue;
 336             int x = dirt[i][0], y = dirt[i][1], w = dirt[i][2], h = dirt[i][3];
 337             if (x < 0) x = 0;
 338             if (y < 0) y = 0;
 339             if (x+w > root.width) w = root.width - x;
 340             if (y+h > root.height) h = root.height - y;
 341             if (w <= 0 || h <= 0) continue;
 342
 343             root.render(0, 0, x, y, x + w, y + h, this, identity);
 344             drawPicture(Main.scarImage,
 345                         0, root.height - Main.scarImage.getHeight(),
 346                         x, y, w, h);
 347
 348             if (abort) {
 349
 350                 // x,y,w,h is only partially reconstructed, so we must be careful not to re-blit it
 351                 dirtyRegions.dirty(x, y, w, h);
 352
 353                 // put back all the dirty regions we haven't yet processed (including the current one)
 354                 for(int j=i; j<dirt.length; j++)
 355                     if (dirt[j] != null)
 356                         dirtyRegions.dirty(dirt[j][0], dirt[j][1], dirt[j][2], dirt[j][3]);
 357
 358                 // tail-recurse
 359                 render();
 360                 return;
 361             }
 362         }
 363     }
 364
 365     // FEATURE: reinstate recycler
 366     public class SimpleMessage extends Scheduler.Task {
 367
 368         private Box boxContainingMouse;
 369         private Object value;
 370         public String name;
 371
 372         SimpleMessage(String name, Object value, Box boxContainingMouse) {
 373             this.boxContainingMouse = boxContainingMouse;
 374             this.name = name;
 375             this.value = value;
 376             Scheduler.add(this);
 377         }
 378
 379         public void perform() { boxContainingMouse.putAndTriggerTraps(name, value); }
 380         public String toString() { return "SimpleMessage [name=" + name + ", value=" + value + "]"; }
 381
 382     }
 383
 384
 385     // Default PixelBuffer implementation /////////////////////////////////////////////////////////
 386
 387     public static abstract class DoubleBufferedSurface extends Surface {
 388
 389         public DoubleBufferedSurface(Box root) { super(root); }
 390         PixelBuffer backbuffer = Platform.createPixelBuffer(Platform.getScreenWidth(), Platform.getScreenHeight(), this);
 391         DirtyList screenDirtyRegions = new DirtyList();
 392
 393         public void drawPicture(Picture source, int dx, int dy, int cx1, int cy1, int cx2, int cy2) {
 394             screenDirtyRegions.dirty(cx1, cy1, cx2 - cx1, cy2 - cy1);
 395             backbuffer.drawPicture(source, dx, dy, cx1, cy1, cx2, cy2);
 396         }
 397
 398         public void drawPictureAlphaOnly(Picture source, int dx, int dy, int cx1, int cy1, int cx2, int cy2, int argb) {
 399             screenDirtyRegions.dirty(cx1, cy1, cx2 - cx1, cy2 - cy1);
 400             backbuffer.drawPictureAlphaOnly(source, dx, dy, cx1, cy1, cx2, cy2, argb);
 401         }
 402
 403         public void fillTrapezoid(int x1, int x2, int y1, int x3, int x4, int y2, int color) {
 404             screenDirtyRegions.dirty(Math.min(x1, x3), y1, Math.max(x2, x4) - Math.min(x1, x3), y2 - y1);
 405             backbuffer.fillTrapezoid(x1, x2, y1, x3, x4, y2, color);
 406         }
 407
 408         public void render() {
 409             super.render();
 410             render_();
 411         }
 412
 413         public void render_() {
 414             int[][] dirt = screenDirtyRegions.flush();
 415             for(int i = 0; dirt != null && i < dirt.length; i++) {
 416                 if (dirt[i] == null) continue;
 417                 int x = dirt[i][0];
 418                 int y = dirt[i][1];
 419                 int w = dirt[i][2];
 420                 int h = dirt[i][3];
 421                 if (x < 0) x = 0;
 422                 if (y < 0) y = 0;
 423                 if (x+w > root.width) w = root.width - x;
 424                 if (y+h > root.height) h = root.height - y;
 425                 if (w <= 0 || h <= 0) continue;
 426                 blit(backbuffer, x, y, x, y, w + x, h + y);
 427             }
 428         }
 429
 430         /** This is how subclasses signal a 'shallow dirty', indicating that although the backbuffer is valid, the screen is not */
 431         public final void Dirty(int x, int y, int w, int h) {
 432             screenDirtyRegions.dirty(x, y, w, h);
 433             Refresh();
 434         }
 435
 436         /** copies a region from the doublebuffer to this surface */
 437         public abstract void blit(PixelBuffer source, int sx, int sy, int dx, int dy, int dx2, int dy2);
 438
 439     }
 440
 441 }