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 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     static volatile boolean abort = false;
  33
  34     public static boolean alt = false;          ///< true iff the alt button is pressed down, in real time
  35     public static boolean control = false;      ///< true iff the control button is pressed down, in real time
  36     public static boolean shift = false;        ///< true iff the shift button is pressed down, in real time
  37     public static boolean button1 = false;      ///< true iff button 1 is depressed, in Scheduler-time
  38     public static boolean button2 = false;      ///< true iff button 2 is depressed, in Scheduler-time
  39     public static boolean button3 = false;      ///< true iff button 3 is depressed, in Scheduler-tiem
  40
  41
  42
  43     // Instance Data ///////////////////////////////////////////////////////////////////////
  44
  45     public Box root;                                   ///< The Box at the root of this surface
  46     public String cursor = "default";                  ///< The active cursor to switch to when syncCursor() is called
  47     public int mousex;                                 ///< x position of the mouse, in Scheduler-time
  48     public int mousey;                                 ///< y position of the mouse, in Scheduler-time
  49     public int _mousex;                                ///< x position of the mouse, in Scheduler-time
  50     public int _mousey;                                ///< y position of the mouse, in Scheduler-time
  51     public int newmousex = -1;                         ///< x position of the mouse, in realtime
  52     public int newmousey = -1;                         ///< y position of the mouse, in realtime
  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     DirtyList dirtyRegions = new DirtyList();  ///< Dirty regions on the *screen*
  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 setLimits(int min_width, int min_height, int max_width, int max_height) { /* FIXME */ }
  79
  80
  81     // Helper methods for subclasses ////////////////////////////////////////////////////////////
  82
  83     protected final void Press(final int button) {
  84         last_press_x = mousex;
  85         last_press_y = mousey;
  86
  87         if (button == 1) button1 = true;
  88         else if (button == 2) button2 = true;
  89         else if (button == 3) button3 = true;
  90
  91         if (button == 1) new SimpleMessage("_Press1", T, root);
  92         else if (button == 2) new SimpleMessage("_Press2", T, root);
  93         else if (button == 3) {
  94             final Box who = root;
  95             Scheduler.add(new Scheduler.Task() { public void perform() throws JSExn {
  96                 Platform.clipboardReadEnabled = true;
  97                 try {
  98                     root.putAndTriggerTraps("_Press3", T);
  99                 } finally {
 100                     Platform.clipboardReadEnabled = false;
 101                 }
 102             }});
 103         }
 104     }
 105
 106     protected final void Release(int button) {
 107         if (button == 1) button1 = false;
 108         else if (button == 2) button2 = false;
 109         else if (button == 3) button3 = false;
 110
 111         if (button == 1) new SimpleMessage("_Release1", T, root);
 112         else if (button == 2) new SimpleMessage("_Release2", T, root);
 113         else if (button == 3) new SimpleMessage("_Release3", T, root);
 114
 115         if (Platform.needsAutoClick() && Math.abs(last_press_x - mousex) < 5 && Math.abs(last_press_y - mousey) < 5) Click(button);
 116         last_press_x = Integer.MAX_VALUE;
 117         last_press_y = Integer.MAX_VALUE;
 118     }
 119
 120     protected final void Click(int button) {
 121         if (button == 1) new SimpleMessage("_Click1", T, root);
 122         else if (button == 2) new SimpleMessage("_Click2", T, root);
 123         else if (button == 3) new SimpleMessage("_Click3", T, root);
 124         if (Platform.needsAutoDoubleClick()) {
 125             long now = System.currentTimeMillis();
 126             if (lastClickButton == button && now - lastClickTime < 350) DoubleClick(button);
 127             lastClickButton = button;
 128             lastClickTime = now;
 129         }
 130     }
 131
 132     /** we enqueue ourselves in the Scheduler when we have a Move message to deal with */
 133     public void perform() {
 134         if (mousex == newmousex && mousey == newmousey) return;
 135         int oldmousex = mousex;     mousex = newmousex;
 136         int oldmousey = mousey;     mousey = newmousey;
 137         String oldcursor = cursor;  cursor = "default";
 138         // Root gets motion events outside itself (if trapped)
 139         if (!root.inside(oldmousex, oldmousey) && !root.inside(mousex, mousey) && (button1 || button2 || button3))
 140             try {
 141                 root.putAndTriggerTraps("_Move", T);
 142             } catch (JSExn e) {
 143                 Log.log(Surface.class, "Exception thrown from Move message handler");
 144                 Log.logJS(e);
 145             }
 146         if (!cursor.equals(oldcursor)) syncCursor();
 147     }
 148
 149     /**
 150      *  Notify XWT that the mouse has moved. If the mouse leaves the
 151      *  surface, but the host windowing system does not provide its new
 152      *  position (for example, a Java MouseListener.mouseExited()
 153      *  message), the subclass should use (-1,-1).
 154      */
 155     protected final void Move(final int newmousex, final int newmousey) {
 156         this.newmousex = newmousex;
 157         this.newmousey = newmousey;
 158         Scheduler.add(this);
 159     }
 160
 161     private Scheduler.Task nextSizeChange = null;
 162     // FEATURE: can we avoid creating objects here?
 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 (root.maxwidth == width && root.maxheight == height) return;
 166         nextSizeChange = new Scheduler.Task() { public void perform() {
 167             if (nextSizeChange != this) return;
 168             // dirty the place where the scar used to be
 169             root.dirty(0, root.maxheight - Main.scarImage.height, Main.scarImage.width, Main.scarImage.height);
 170             root.setMaxWidth(JS.N(width));
 171             root.setMaxHeight(JS.N(height));
 172             nextSizeChange = null;
 173             Refresh();
 174         }};
 175         Scheduler.addAtFront(nextSizeChange);
 176         abort = true;
 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 static void Refresh() { needRender = true; Scheduler.add(new Scheduler.Task() { public void perform() { } }); }
 197
 198     public static boolean needRender = false;
 199     public static final Scheduler.Task renderAll = new Scheduler.Task() {
 200             public void perform() {
 201                 for(int i=0; i<allSurfaces.size(); i++) {
 202                     Surface s = ((Surface)allSurfaces.elementAt(i));
 203                     do {
 204                         s.render();
 205                     } while(s.abort);
 206                 }
 207             }
 208         };
 209
 210     public final void setMaximized(boolean b) { if (b != maximized) _setMaximized(maximized = b); }
 211     public final void setMinimized(boolean b) { if (b != minimized) _setMinimized(minimized = b); }
 212
 213
 214     // Other Methods ///////////////////////////////////////////////////////////////////////////////
 215
 216     /** Indicates that the Surface is no longer needed */
 217     public final void dispose(boolean quitIfAllSurfacesGone) {
 218         if (Log.on) Log.log(this, "disposing " + this);
 219         allSurfaces.removeElement(this);
 220         _dispose();
 221         if (allSurfaces.size() == 0) {
 222             if (Log.on) Log.log(this, "exiting because last surface was destroyed");
 223             System.exit(0);
 224         }
 225     }
 226
 227     public void dirty(int x, int y, int w, int h) {
 228         dirtyRegions.dirty(x, y, w, h);
 229         Refresh();
 230     }
 231
 232     public static Surface fromBox(Box b) {
 233         for(int i=0; i<allSurfaces.size(); i++) {
 234             Surface s = (Surface)allSurfaces.elementAt(i);
 235             if (s.root == b) return s;
 236         }
 237         return null;
 238     }
 239
 240     public Surface(Box root) {
 241         this.root = root;
 242         root.setMaxWidth(JS.N(Math.min(Platform.getScreenWidth(), root.maxwidth)));
 243         root.setMaxHeight(JS.N(Math.min(Platform.getScreenHeight(), root.maxheight)));
 244         Surface old = fromBox(root);
 245         if (old != null) old.dispose(false);
 246         else root.removeSelf();
 247         Refresh();
 248     }
 249
 250     private static VectorGraphics.Affine identity = VectorGraphics.Affine.identity();
 251
 252     /** runs the prerender() and render() pipelines in the root Box to regenerate the backbuffer, then blits it to the screen */
 253     public synchronized void render() {
 254         // dirty the place where the scar used to be in case the root window size was programmatically changed
 255         if (root.maxwidth != root.width || root.maxheight != root.height)
 256             root.dirty(0, root.height - Main.scarImage.height, Main.scarImage.width, Main.scarImage.height);
 257
 258         // make sure the root is properly sized
 259         do {
 260             abort = false;
 261             root.repack();
 262             root.resize(root.x, root.y, root.maxwidth, root.maxheight);
 263             root.resize_children();
 264             _setSize(root.width, root.height);
 265             String oldcursor = cursor;
 266             cursor = "default";
 267             root.putAndTriggerTrapsAndCatchExceptions("_Move", JS.T);
 268             if (!cursor.equals(oldcursor)) syncCursor();
 269         } while(abort);
 270
 271         int[][] dirt = dirtyRegions.flush();
 272         for(int i = 0; dirt != null && i < dirt.length; i++) {
 273             if (dirt[i] == null) continue;
 274             int x = dirt[i][0], y = dirt[i][1], w = dirt[i][2], h = dirt[i][3];
 275             if (x < 0) x = 0;
 276             if (y < 0) y = 0;
 277             if (x+w > root.width) w = root.width - x;
 278             if (y+h > root.height) h = root.height - y;
 279             if (w <= 0 || h <= 0) continue;
 280
 281             root.render(0, 0, x, y, x + w, y + h, this, identity);
 282             drawPicture(Main.scarImage, 0, root.height - Main.scarImage.height, x, y, w, h);
 283
 284             if (abort) {
 285
 286                 // x,y,w,h is only partially reconstructed, so we must be careful not to re-blit it
 287                 dirtyRegions.dirty(x, y, w, h);
 288
 289                 // put back all the dirty regions we haven't yet processed (including the current one)
 290                 for(int j=i; j<dirt.length; j++)
 291                     if (dirt[j] != null)
 292                         dirtyRegions.dirty(dirt[j][0], dirt[j][1], dirt[j][2], dirt[j][3]);
 293
 294                 return;
 295             }
 296         }
 297     }
 298
 299     // FEATURE: reinstate recycler
 300     public class SimpleMessage implements Scheduler.Task {
 301
 302         private Box boxContainingMouse;
 303         private Object value;
 304         public String name;
 305
 306         SimpleMessage(String name, Object value, Box boxContainingMouse) {
 307             this.boxContainingMouse = boxContainingMouse;
 308             this.name = name;
 309             this.value = value;
 310             Scheduler.add(this);
 311         }
 312
 313         public void perform() {
 314             if (name.equals("_KeyPressed")) {
 315                 String value = (String)this.value;
 316                 if (value.toLowerCase().endsWith("shift")) shift = true;     else if (shift) value = value.toUpperCase();
 317                 if (value.toLowerCase().equals("alt")) alt = true;           else if (alt) value = "A-" + value;
 318                 if (value.toLowerCase().endsWith("control")) control = true; else if (control) value = "C-" + value;
 319                 if (value.equals("C-v") || value.equals("A-v")) Platform.clipboardReadEnabled = true;
 320             } else if (name.equals("_KeyReleased")) {
 321                 String value = (String)this.value;
 322                 if (value.toLowerCase().equals("alt")) alt = false;
 323                 else if (value.toLowerCase().equals("control")) control = false;
 324                 else if (value.toLowerCase().equals("shift")) shift = false;
 325             }
 326             try {
 327                 boxContainingMouse.putAndTriggerTraps(name, value);
 328             } catch (JSExn e) {
 329                 Log.log(Surface.class, "Exception thrown from "+name+" handler");
 330                 Log.logJS(e);
 331             } finally {
 332                 Platform.clipboardReadEnabled = false;
 333             }
 334         }
 335         public String toString() { return "SimpleMessage [name=" + name + ", value=" + value + "]"; }
 336
 337     }
 338
 339
 340     // Default PixelBuffer implementation /////////////////////////////////////////////////////////
 341
 342     public static abstract class DoubleBufferedSurface extends Surface {
 343
 344         public DoubleBufferedSurface(Box root) { super(root); }
 345         PixelBuffer backbuffer = Platform.createPixelBuffer(Platform.getScreenWidth(), Platform.getScreenHeight(), this);
 346         DirtyList screenDirtyRegions = new DirtyList();
 347
 348         public void drawPicture(Picture source, int dx, int dy, int cx1, int cy1, int cx2, int cy2) {
 349             screenDirtyRegions.dirty(cx1, cy1, cx2 - cx1, cy2 - cy1);
 350             backbuffer.drawPicture(source, dx, dy, cx1, cy1, cx2, cy2);
 351         }
 352
 353         public void drawGlyph(Font.Glyph source, int dx, int dy, int cx1, int cy1, int cx2, int cy2, int argb) {
 354             screenDirtyRegions.dirty(cx1, cy1, cx2 - cx1, cy2 - cy1);
 355             backbuffer.drawGlyph(source, dx, dy, cx1, cy1, cx2, cy2, argb);
 356         }
 357
 358         public void fillTrapezoid(int x1, int x2, int y1, int x3, int x4, int y2, int color) {
 359             screenDirtyRegions.dirty(Math.min(x1, x3), y1, Math.max(x2, x4) - Math.min(x1, x3), y2 - y1);
 360             backbuffer.fillTrapezoid(x1, x2, y1, x3, x4, y2, color);
 361         }
 362
 363         public void render_() { render(); }
 364         public void render() {
 365             super.render();
 366             if (abort) return;
 367             int[][] dirt = screenDirtyRegions.flush();
 368             for(int i = 0; dirt != null && i < dirt.length; i++) {
 369                 if (dirt[i] == null) continue;
 370                 int x = dirt[i][0];
 371                 int y = dirt[i][1];
 372                 int w = dirt[i][2];
 373                 int h = dirt[i][3];
 374                 if (x < 0) x = 0;
 375                 if (y < 0) y = 0;
 376                 if (x+w > root.width) w = root.width - x;
 377                 if (y+h > root.height) h = root.height - y;
 378                 if (w <= 0 || h <= 0) continue;
 379                 if (abort) return;
 380                 blit(backbuffer, x, y, x, y, w + x, h + y);
 381             }
 382         }
 383
 384         /** This is how subclasses signal a 'shallow dirty', indicating that although the backbuffer is valid, the screen is not */
 385         public final void Dirty(int x, int y, int w, int h) {
 386             screenDirtyRegions.dirty(x, y, w, h);
 387             Refresh();
 388         }
 389
 390         public void dirty(int x, int y, int w, int h) {
 391             screenDirtyRegions.dirty(x, y, w, h);
 392             super.dirty(x, y, w, h);
 393         }
 394
 395         /** copies a region from the doublebuffer to this surface */
 396         public abstract void blit(PixelBuffer source, int sx, int sy, int dx, int dy, int dx2, int dy2);
 397
 398     }
 399
 400 }