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     Vec keywatchers = new Vec();
  46
  47     public Box root;                                   ///< The Box at the root of this surface
  48     public String cursor = "default";                  ///< The active cursor to switch to when syncCursor() is called
  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     private 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, Box.whoIs(root, mousex, mousey));
  92         else if (button == 2) new SimpleMessage("Press2", T, Box.whoIs(root, mousex, mousey));
  93         else if (button == 3) {
  94             final Box who = Box.whoIs(root, mousex, mousey);
  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, Box.whoIs(root, mousex, mousey));
 112         else if (button == 2) new SimpleMessage("Release2", T, Box.whoIs(root, mousex, mousey));
 113         else if (button == 3) new SimpleMessage("Release3", T, Box.whoIs(root, mousex, mousey));
 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, Box.whoIs(root, mousex, mousey));
 122         else if (button == 2) new SimpleMessage("Click2", T, Box.whoIs(root, mousex, mousey));
 123         else if (button == 3) new SimpleMessage("Click3", T, Box.whoIs(root, mousex, mousey));
 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     protected final void DoubleClick(int button) {
 133         if (button == 1) new SimpleMessage("DoubleClick1", T, Box.whoIs(root, mousex, mousey));
 134         else if (button == 2) new SimpleMessage("DoubleClick2", T, Box.whoIs(root, mousex, mousey));
 135         else if (button == 3) new SimpleMessage("DoubleClick3", T, Box.whoIs(root, mousex, mousey));
 136     }
 137
 138     /** Send a KeyPressed message; subclasses should not add the C- or A- prefixes or should they capitalize alphabet chars */
 139     protected final void KeyPressed(String key) {
 140         if (key == null) return;
 141         if (key.toLowerCase().endsWith("shift")) shift = true;     else if (shift) key = key.toUpperCase();
 142         if (key.toLowerCase().equals("alt")) alt = true;           else if (alt) key = "A-" + key;
 143         if (key.toLowerCase().endsWith("control")) control = true; else if (control) key = "C-" + key;
 144         Scheduler.add(new KMessage(key));
 145     }
 146
 147     // This is implemented as a private static class instead of an anonymous class to work around a GCJ bug
 148     private class KMessage implements Scheduler.Task {
 149         String key = null;
 150         public KMessage(String k) { key = k; }
 151         public void perform() {
 152             if (key.equals("C-v") || key.equals("A-v")) Platform.clipboardReadEnabled = true;
 153             outer: for(int i=0; i<keywatchers.size(); i++) {
 154                 Box b = (Box)keywatchers.elementAt(i);
 155                 for(Box cur = b; cur != null; cur = cur.parent)
 156                     if (!cur.test(cur.VISIBLE)) continue outer;
 157                 try {
 158                     b.putAndTriggerTraps("KeyPressed", key);
 159                 } catch (JSExn e) {
 160                     Log.log(Surface.class, "Exception thrown from KeyPressed handler");
 161                     Log.logJS(e);
 162                 }
 163             }
 164             Platform.clipboardReadEnabled = false;
 165         }
 166     }
 167
 168     /** sends a KeyReleased message; subclasses should not add the C- or A- prefixes or capitalize alpha chars */
 169     protected final void KeyReleased(final String key) {
 170         if (key == null) return;
 171         if (key.toLowerCase().equals("alt")) alt = false;
 172         else if (key.toLowerCase().equals("control")) control = false;
 173         else if (key.toLowerCase().equals("shift")) shift = false;
 174         Scheduler.add(new Scheduler.Task() { public void perform() {
 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                 try {
 180                     b.putAndTriggerTraps("KeyReleased", key);
 181                 } catch (JSExn e) {
 182                     Log.log(Surface.class, "Exception thrown from KeyReleased handler");
 183                     Log.logJS(e);
 184                 }
 185             }
 186         }});
 187     }
 188
 189     /** we enqueue ourselves in the Scheduler when we have a Move message to deal with */
 190     public void perform() {
 191         if (mousex == newmousex && mousey == newmousey) return;
 192         int oldmousex = mousex;     mousex = newmousex;
 193         int oldmousey = mousey;     mousey = newmousey;
 194         String oldcursor = cursor;  cursor = "default";
 195         // Root gets motion events outside itself (if trapped)
 196         if (!root.inside(oldmousex, oldmousey) && !root.inside(mousex, mousey) && (button1 || button2 || button3))
 197             try {
 198                 root.putAndTriggerTraps("Move", T);
 199             } catch (JSExn e) {
 200                 Log.log(Surface.class, "Exception thrown from Move message handler");
 201                 Log.logJS(e);
 202             }
 203         root.Move(oldmousex, oldmousey, mousex, mousey);
 204         if (!cursor.equals(oldcursor)) syncCursor();
 205     }
 206
 207     /**
 208      *  Notify XWT that the mouse has moved. If the mouse leaves the
 209      *  surface, but the host windowing system does not provide its new
 210      *  position (for example, a Java MouseListener.mouseExited()
 211      *  message), the subclass should use (-1,-1).
 212      */
 213     protected final void Move(final int newmousex, final int newmousey) {
 214         this.newmousex = newmousex;
 215         this.newmousey = newmousey;
 216         Scheduler.add(this);
 217     }
 218
 219     // FEATURE: can we avoid creating objects here?
 220     /** subclasses should invoke this method when the user resizes the window */
 221     protected final void SizeChange(final int width, final int height) {
 222         Scheduler.addAtFront(new Scheduler.Task() { public void perform() {
 223             // dirty the place where the scar used to be
 224             root.dirty(0, root.maxheight - Main.scarImage.height, Main.scarImage.width, Main.scarImage.height);
 225             root.setMaxWidth(JS.N(width));
 226             root.setMaxHeight(JS.N(height));
 227         }});
 228         abort = true;
 229     }
 230
 231     // FEATURE: can we avoid creating objects here?
 232     protected final void PosChange(final int x, final int y) {
 233         Scheduler.add(new Scheduler.Task() { public void perform() throws JSExn {
 234             root.x = x;
 235             root.y = y;
 236             root.putAndTriggerTraps("PosChange", T);
 237         }});
 238     }
 239
 240     protected final void Close() { new SimpleMessage("Close", T, root); }
 241     protected final void Minimized(boolean b) { minimized = b; new SimpleMessage("Minimized", b ? T : F, root); }
 242     protected final void Maximized(boolean b) { maximized = b; new SimpleMessage("Maximized", b ? T : F, root); }
 243     protected final void Focused(boolean b) { new SimpleMessage("Focused", b ? T : F, root); }
 244     public static void Refresh() { Scheduler.add(renderAll); }
 245
 246     public static final Scheduler.Task renderAll = new Scheduler.Task() { public void perform() {
 247         for(int i=0; i<allSurfaces.size(); i++)
 248             ((Surface)allSurfaces.elementAt(i)).render();
 249     } };
 250
 251     public final void setMaximized(boolean b) { if (b != maximized) _setMaximized(maximized = b); }
 252     public final void setMinimized(boolean b) { if (b != minimized) _setMinimized(minimized = b); }
 253
 254
 255     // Other Methods ///////////////////////////////////////////////////////////////////////////////
 256
 257     /** Indicates that the Surface is no longer needed */
 258     public final void dispose(boolean quitIfAllSurfacesGone) {
 259         if (Log.on) Log.log(this, "disposing " + this);
 260         allSurfaces.removeElement(this);
 261         _dispose();
 262         if (allSurfaces.size() == 0) {
 263             if (Log.on) Log.log(this, "exiting because last surface was destroyed");
 264             System.exit(0);
 265         }
 266     }
 267
 268     public void dirty(int x, int y, int w, int h) {
 269         dirtyRegions.dirty(x, y, w, h);
 270         Refresh();
 271     }
 272
 273     public static Surface fromBox(Box b) {
 274         for(int i=0; i<allSurfaces.size(); i++) {
 275             Surface s = (Surface)allSurfaces.elementAt(i);
 276             if (s.root == b) return s;
 277         }
 278         return null;
 279     }
 280
 281     public Surface(Box root) {
 282         this.root = root;
 283         root.setMaxWidth(JS.N(Math.min(Platform.getScreenWidth(), root.maxwidth)));
 284         root.setMaxHeight(JS.N(Math.min(Platform.getScreenHeight(), root.maxheight)));
 285         Surface old = fromBox(root);
 286         if (old != null) old.dispose(false);
 287         else root.removeSelf();
 288         Refresh();
 289     }
 290
 291     private static VectorGraphics.Affine identity = VectorGraphics.Affine.identity();
 292
 293     /** runs the prerender() and render() pipelines in the root Box to regenerate the backbuffer, then blits it to the screen */
 294     public synchronized void render() {
 295
 296         // dirty the place where the scar used to be in case the root window size was programmatically changed
 297         if (root.maxwidth != root.width || root.maxheight != root.height)
 298             root.dirty(0, root.height - Main.scarImage.height, Main.scarImage.width, Main.scarImage.height);
 299
 300         // make sure the root is properly sized
 301         do {
 302             abort = false;
 303             root.repack();
 304             root.resize(root.x, root.y, root.maxwidth, root.maxheight);
 305             root.resize_children();
 306             _setSize(root.width, root.height);
 307             String oldcursor = cursor;
 308             cursor = "default";
 309             root.Move(mousex, mousey, mousex, mousey);
 310             if (!cursor.equals(oldcursor)) syncCursor();
 311         } while(abort);
 312
 313         int[][] dirt = dirtyRegions.flush();
 314         for(int i = 0; dirt != null && i < dirt.length; i++) {
 315             if (dirt[i] == null) continue;
 316             int x = dirt[i][0], y = dirt[i][1], w = dirt[i][2], h = dirt[i][3];
 317             if (x < 0) x = 0;
 318             if (y < 0) y = 0;
 319             if (x+w > root.width) w = root.width - x;
 320             if (y+h > root.height) h = root.height - y;
 321             if (w <= 0 || h <= 0) continue;
 322
 323             root.render(0, 0, x, y, x + w, y + h, this, identity);
 324             drawPicture(Main.scarImage, 0, root.height - Main.scarImage.height, x, y, w, h);
 325
 326             if (abort) {
 327
 328                 // x,y,w,h is only partially reconstructed, so we must be careful not to re-blit it
 329                 dirtyRegions.dirty(x, y, w, h);
 330
 331                 // put back all the dirty regions we haven't yet processed (including the current one)
 332                 for(int j=i; j<dirt.length; j++)
 333                     if (dirt[j] != null)
 334                         dirtyRegions.dirty(dirt[j][0], dirt[j][1], dirt[j][2], dirt[j][3]);
 335
 336                 // tail-recurse
 337                 render();
 338                 return;
 339             }
 340         }
 341     }
 342
 343     // FEATURE: reinstate recycler
 344     public class SimpleMessage implements Scheduler.Task {
 345
 346         private Box boxContainingMouse;
 347         private Object value;
 348         public String name;
 349
 350         SimpleMessage(String name, Object value, Box boxContainingMouse) {
 351             this.boxContainingMouse = boxContainingMouse;
 352             this.name = name;
 353             this.value = value;
 354             Scheduler.add(this);
 355         }
 356
 357         public void perform() throws JSExn { boxContainingMouse.putAndTriggerTraps(name, value); }
 358         public String toString() { return "SimpleMessage [name=" + name + ", value=" + value + "]"; }
 359
 360     }
 361
 362
 363     // Default PixelBuffer implementation /////////////////////////////////////////////////////////
 364
 365     public static abstract class DoubleBufferedSurface extends Surface {
 366
 367         public DoubleBufferedSurface(Box root) { super(root); }
 368         PixelBuffer backbuffer = Platform.createPixelBuffer(Platform.getScreenWidth(), Platform.getScreenHeight(), this);
 369         DirtyList screenDirtyRegions = new DirtyList();
 370
 371         public void drawPicture(Picture source, int dx, int dy, int cx1, int cy1, int cx2, int cy2) {
 372             screenDirtyRegions.dirty(cx1, cy1, cx2 - cx1, cy2 - cy1);
 373             backbuffer.drawPicture(source, dx, dy, cx1, cy1, cx2, cy2);
 374         }
 375
 376         public void drawGlyph(Font.Glyph source, int dx, int dy, int cx1, int cy1, int cx2, int cy2, int argb) {
 377             screenDirtyRegions.dirty(cx1, cy1, cx2 - cx1, cy2 - cy1);
 378             backbuffer.drawGlyph(source, dx, dy, cx1, cy1, cx2, cy2, argb);
 379         }
 380
 381         public void fillTrapezoid(int x1, int x2, int y1, int x3, int x4, int y2, int color) {
 382             screenDirtyRegions.dirty(Math.min(x1, x3), y1, Math.max(x2, x4) - Math.min(x1, x3), y2 - y1);
 383             backbuffer.fillTrapezoid(x1, x2, y1, x3, x4, y2, color);
 384         }
 385
 386         public void render() {
 387             super.render();
 388             render_();
 389         }
 390
 391         public void render_() {
 392             int[][] dirt = screenDirtyRegions.flush();
 393             for(int i = 0; dirt != null && i < dirt.length; i++) {
 394                 if (dirt[i] == null) continue;
 395                 int x = dirt[i][0];
 396                 int y = dirt[i][1];
 397                 int w = dirt[i][2];
 398                 int h = dirt[i][3];
 399                 if (x < 0) x = 0;
 400                 if (y < 0) y = 0;
 401                 if (x+w > root.width) w = root.width - x;
 402                 if (y+h > root.height) h = root.height - y;
 403                 if (w <= 0 || h <= 0) continue;
 404                 blit(backbuffer, x, y, x, y, w + x, h + y);
 405             }
 406         }
 407
 408         /** This is how subclasses signal a 'shallow dirty', indicating that although the backbuffer is valid, the screen is not */
 409         public final void Dirty(int x, int y, int w, int h) {
 410             screenDirtyRegions.dirty(x, y, w, h);
 411             Refresh();
 412         }
 413
 414         /** copies a region from the doublebuffer to this surface */
 415         public abstract void blit(PixelBuffer source, int sx, int sy, int dx, int dy, int dx2, int dy2);
 416
 417     }
 418
 419 }