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