src/org/xwt/Surface.java

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