src/org/ibex/core/Box.java

   1 // Copyright 2000-2005 the Contributors, as shown in the revision logs.
   2 // Licensed under the GNU General Public License version 2 ("the License").
   3 // You may not use this file except in compliance with the License.
   4
   5 package org.ibex.core;
   6
   7 // FIXME: are traps on x/y meaningful?
   8 // FIXME: trap on visible, trigger when parent visibility changes
   9 // FIXME: mouse move/release still needs to propagate to boxen in which the mouse was pressed and is still held down
  10 // FEATURE: reintroduce surface.abort
  11
  12 // Broken:
  13 // - textures
  14 // - align/origin
  15 // - clipping (all forms)
  16
  17 import java.util.*;
  18 import org.ibex.js.*;
  19 import org.ibex.util.*;
  20 import org.ibex.plat.*;
  21 import org.ibex.graphics.*;
  22
  23 /**
  24  *  <p>
  25  *  Encapsulates the data for a single Ibex box as well as all layout
  26  *  rendering logic.
  27  *  </p>
  28  *
  29  *  <p>The rendering process consists of four phases; each requires
  30  *     one DFS pass over the tree</p>
  31  *  <ol><li> <b>pack()</b>: each box sets its childrens' row/col
  32  *  <ol><li> <b>constrain()</b>: contentwidth is computed
  33  *      <li> <b>resize()</b>: width/height and x/y positions are set
  34  *      <li> <b>render()</b>: children draw their content onto the PixelBuffer.
  35  *  </ol>
  36  *
  37  *  The first three passes together are called the <i>reflow</i>
  38  *  phase.  Reflowing is done in a seperate pass since SizeChanges
  39  *  trigger a Surface.abort; if rendering were done in the same pass,
  40  *  rendering work done prior to the Surface.abort would be wasted.
  41  */
  42 public final class Box extends JS.Obj implements Callable, Mesh.Chain {
  43
  44     public Mesh.Chain getMeshChainParent() { return parent; }
  45     public Mesh       getMesh()            { return mesh; }
  46     public Affine     getAffine()          { return transform; }
  47
  48     // Macros //////////////////////////////////////////////////////////////////////
  49
  50     final void REPLACE() { for(Box b2 = this; b2 != null && !b2.test(REPLACE); b2 = b2.parent) b2.set(REPLACE); }
  51     final void RECONSTRAIN() { for(Box b2 = this; b2 != null && !b2.test(RECONSTRAIN); b2 = b2.parent) b2.set(RECONSTRAIN); }
  52
  53     //#define CHECKSET_SHORT(prop) short nu = (short)JSU.toInt(value); if (nu == prop) break; prop = nu;
  54     //#define CHECKSET_INT(prop) int nu = JSU.toInt(value); if (nu == prop) break; prop = nu;
  55     //#define CHECKSET_FLAG(flag) boolean nu=JSU.toBoolean(value);if(nu == test(flag)) break; if (nu) set(flag); else clear(flag);
  56     //#define CHECKSET_BOOLEAN.N(prop) boolean nu = JSU.toBoolean(value); if (nu == prop) break; prop = nu;
  57     //#define CHECKSET_STRING(prop) if((value==null&&prop==null)||(value!=null&&JSU.toString(value).equals(prop)))break;prop=JSU.toString(value);
  58
  59     // Instance Data //////////////////////////////////////////////////////////////////////
  60
  61     private Box          parent       = null;
  62     private Box          redirect     = this;
  63     private int          flags        = VISIBLE | RECONSTRAIN | REPLACE | STOP_UPWARD_PROPAGATION | CLIP | MOVED;
  64     private BalancedTree bt           = null;
  65     private String       text         = null;
  66     private Font         font         = DEFAULT_FONT;
  67     private Picture      texture      = null;
  68     public  int          fillcolor    = 0x00000000;
  69     private int          strokecolor  = 0xFF000000;
  70     public  float        flex         = 1;
  71     private Path         path         = null;
  72     private Path         clippath     = null;
  73     private Affine       transform    = Affine.identity();
  74
  75     // FEATURE: polygon caching
  76     private Mesh      polygon      = null;
  77     private Mesh         mesh         = null;
  78
  79     // specified directly by user
  80     public int minwidth = 0;
  81     public int maxwidth = Integer.MAX_VALUE;
  82     public int minheight = 0;
  83     public int maxheight = Integer.MAX_VALUE;
  84
  85     // computed during reflow
  86     public int width = 0;
  87     public int height = 0;
  88     public int contentwidth = 0;      // == max(minwidth, textwidth, sum(child.contentwidth))
  89     public int contentheight = 0;
  90
  91
  92     // Instance Methods /////////////////////////////////////////////////////////////////////
  93
  94     /** invoked when a resource needed to render ourselves finishes loading */
  95     public Object run(Object o) throws JSExn {
  96         if (texture == null) { Log.warn(Box.class, "perform() called with null texture"); return null; }
  97         if (texture.isLoaded) {
  98             setWidth(max(texture.width, minwidth), maxwidth);
  99             setHeight(max(texture.height, minheight), maxheight);
 100             dirty(); }
 101         else { JS res = texture.stream; texture = null; throw new JSExn("image not found: "+res.unclone()); }
 102         return null;
 103     }
 104
 105     /** Adds the intersection of (x,y,w,h) and the node's current actual geometry to the Surface's dirty list */
 106     public void dirty() { if (path==null) dirty(0, 0, contentwidth, contentheight); else dirty(path); }
 107     public void dirty(int x, int y, int w, int h) { }
 108     public void dirty(Path p) {
 109         Affine a = transform.copy();
 110         for(Box cur = this; cur != null; cur = cur.parent) a.premultiply(cur.transform);
 111         long hbounds = p.horizontalBounds(a);
 112         long vbounds = p.verticalBounds(a);
 113         int x1 = (int)Encode.longToFloat2(hbounds);
 114         int x2 = (int)Encode.longToFloat1(hbounds);
 115         int y1 = (int)Encode.longToFloat2(vbounds);
 116         int y2 = (int)Encode.longToFloat1(vbounds);
 117         if (getSurface() != null) getSurface().dirty(x1, y1, x2-x1, y2-y1);
 118     }
 119
 120
 121     // Reflow ////////////////////////////////////////////////////////////////////////////////////////
 122
 123     /** should only be invoked on the root box */
 124     public void reflow() {
 125         constrain(this, Affine.identity());
 126         width = maxwidth;
 127         height = maxheight;
 128         transform.e = 0;
 129         transform.f = 0;
 130         place();
 131     }
 132
 133     void place() {
 134         if (!packed()) {
 135             for(Box child = getChild(0); child != null; child = child.nextSibling()) {
 136                 child.width = max(child.minwidth, min(child.test(HSHRINK) ? child.contentwidth : width, child.maxwidth));
 137                 child.height = max(child.minheight, min(child.test(VSHRINK) ? child.contentheight : height, child.maxheight));
 138                 child.place();
 139             }
 140             return;
 141         }
 142         float slack = width, oldslack = 0, flex = 0, newflex = 0;
 143         for(Box child = getChild(0); child != null; child = child.nextSibling()) {
 144             if (!child.test(VISIBLE)) continue;
 145             slack -= (child.width = child.contentwidth);
 146             if (child.width < (child.test(HSHRINK)?child.contentwidth:child.maxwidth)) flex += child.flex;
 147             child.height = child.test(HSHRINK) ? child.contentheight : bound(child.contentheight, height, child.maxheight);
 148         }
 149         while(slack > 0 && flex > 0 && oldslack!=slack) {
 150             oldslack = slack;
 151             slack = width;
 152             for(Box child = getChild(0); child != null; child = child.nextSibling()) {
 153                 if (!child.test(VISIBLE)) continue;
 154                 if (child.width < child.maxwidth && !child.test(HSHRINK))
 155                     child.width = bound(child.contentwidth, (int)(child.width + (slack/flex)), child.maxwidth);
 156                 newflex += child.width < child.maxwidth && !child.test(HSHRINK) ? child.flex : 0;
 157                 slack -= child.width;
 158             }
 159             flex = newflex;
 160         }
 161         float pos = slack / 2;
 162         for(Box child = getChild(0); child != null; child = child.nextSibling()) {
 163             if (!child.test(VISIBLE)) continue;
 164             child.transform.e += pos;
 165             child.transform.f += (height-child.height)/2;
 166             pos += child.width;
 167             child.place();
 168         }
 169     }
 170
 171     /** used (single-threadedly) in constrain() */
 172     private static int xmin = 0, ymin = 0, xmax = 0, ymax = 0;
 173     public void constrain(Box b, Affine a) {
 174         contentwidth = 0;
 175         contentheight = 0;
 176         a = a.copy().premultiply(transform);
 177
 178         //boolean relevant = packed() || ((fillcolor&0xff000000)!=0x0) || path!=null;
 179         boolean relevant = true;
 180         int save_xmin = xmin, save_ymin = ymin, save_xmax = xmax, save_ymax = ymax;
 181         if (!relevant) {
 182             for(Box child = getChild(0); child != null; child = child.nextSibling()) {
 183                 child.constrain(b, a);
 184                 contentwidth = max(contentwidth, child.contentwidth);
 185                 contentheight = max(contentheight, child.contentheight);
 186             }
 187             return;
 188         }
 189
 190         for(Box child = getChild(0); child != null; child = child.nextSibling()) {
 191             xmin = Integer.MAX_VALUE; ymin = Integer.MAX_VALUE;
 192             xmax = Integer.MIN_VALUE; ymax = Integer.MIN_VALUE;
 193             if (packed()) {
 194                 child.transform.e = 0;
 195                 child.transform.f = 0;
 196             }
 197             child.constrain(this, Affine.identity());
 198             if (xmin==Integer.MAX_VALUE||xmax==Integer.MIN_VALUE||ymin==Integer.MAX_VALUE||ymax== Integer.MIN_VALUE) continue;
 199             if (packed()) {
 200                 child.transform.e = -1 * xmin;
 201                 child.transform.f = -1 * ymin;
 202             }
 203             contentwidth += (xmax-xmin);
 204             contentheight = max(ymax-ymin, contentheight);
 205         }
 206         xmin = save_xmin;
 207         ymin = save_ymin;
 208         xmax = save_xmax;
 209         ymax = save_ymax;
 210
 211         int cw = contentwidth = bound(minwidth, contentwidth, maxwidth);
 212         int ch = contentheight = bound(minheight, contentheight, maxheight);
 213         //#repeat contentwidth/contentheight contentheight/contentwidth minwidth/minheight row/col col/row \
 214         //        textwidth/textheight maxwidth/maxheight bounds/boundsy x1/y1 x2/y2 z1/q1 z2/q2 z3/q3 z4/q4 \
 215         //        horizontalBounds/verticalBounds e/f multiply_px/multiply_py xmin/ymin xmax/ymax
 216         long bounds = path==null ? 0                     : path.horizontalBounds(a);
 217         float z1    = path==null ? a.multiply_px(0, 0)   : Encode.longToFloat2(bounds);
 218         float z2    = path==null ? a.multiply_px(cw, ch) : Encode.longToFloat1(bounds);
 219         float z3    = path==null ? a.multiply_px(cw, 0)  : Encode.longToFloat2(bounds);
 220         float z4    = path==null ? a.multiply_px(0, ch)  : Encode.longToFloat1(bounds);
 221         xmin = min(xmin, (int)min(min(z1, z2), min(z3, z4)));
 222         xmax = max(xmax, (int)max(max(z1, z2), max(z3, z4)));
 223         //#end
 224     }
 225
 226
 227     // Rendering Pipeline /////////////////////////////////////////////////////////////////////
 228
 229     private static final boolean OPTIMIZE = false;
 230
 231     /** Renders self and children within the specified region. All rendering operations are clipped to xIn,yIn,wIn,hIn */
 232     public void render(PixelBuffer buf, Affine a, Mesh clipFrom) { render(buf, a, clipFrom, Affine.identity()); }
 233     public void render(PixelBuffer buf, Affine a, Mesh clipFrom, Affine clipa) {
 234         if (!test(VISIBLE)) return;
 235         a = a.copy().multiply(transform);
 236         clipa = clipa.copy().multiply(transform);
 237
 238         if (mesh == null)
 239             if (path != null) mesh = new Mesh(path, true);
 240             else {
 241                 if (((fillcolor & 0xFF000000) != 0x00000000 || parent == null) && (text==null||"".equals(text)))
 242                     mesh = new Mesh().addRect(0, 0, contentwidth, contentheight);
 243                 // long ret = font.rasterizeGlyphs(text, buf, a, null, 0x777777, 0);
 244                 // minwidth = maxwidth = font.textwidth(text);
 245                 // minheight = maxheight = font.textwidth(text);
 246                 // if (ret == 0) Platform.Scheduler.add(this);
 247                 // FIXME: texture
 248             }
 249         if (mesh==null) {
 250             for(Box b = getChild(0); b != null; b = b.nextSibling()) b.render(buf, a, clipFrom, clipa);
 251             return;
 252         }
 253
 254         // FIXME: mesh clipping code has been getting stuck in loops; to see this,
 255         //        uncomment the next two lines and swap the order of the last two lines.
 256
 257         //if (clipFrom != null) clipFrom.subtract(mesh, clipa);
 258         //Mesh mesh = treeSize() > 0 ? this.mesh.copy() : this.mesh;
 259         mesh.fill(buf, a, null, fillcolor, true);
 260         for(Box b = getChild(0); b != null; b = b.nextSibling()) b.render(buf, a, mesh, Affine.identity());
 261     }
 262
 263     // Methods to implement org.ibex.js.JS //////////////////////////////////////
 264
 265     public JS call(JS method, JS[] args) throws JSExn {
 266         switch (args.length) {
 267             case 1: {
 268                 //#switch(JSU.toString(method))
 269                 case "indexof":
 270                     Box b = (Box)args[0];
 271                     if (b.parent != this)
 272                         return (redirect == null || redirect == this) ? JSU.N(-1) : redirect.call(method, args);
 273                     return JSU.N(b.getIndexInParent());
 274
 275                 case "distanceto":
 276                     Box b = (Box)args[0];
 277                     JS ret = new JS.Obj();
 278                     ret.put(JSU.S("x"), JSU.N(b.localToGlobalX(0) - localToGlobalX(0)));
 279                     ret.put(JSU.S("y"), JSU.N(b.localToGlobalY(0) - localToGlobalY(0)));
 280                     return ret;
 281
 282                 //#end
 283             }
 284         }
 285         return super.call(method, args);
 286     }
 287
 288     public JS get(JS name) throws JSExn {
 289         if (JSU.isInt(name))
 290             return redirect == null ? null : redirect == this ? getChild(JSU.toInt(name)) : redirect.get(name);
 291
 292         //#switch(JSU.toString(name))
 293         case "surface": return parent == null ? null : parent.getAndTriggerTraps(name);
 294         case "indexof": return METHOD;
 295         case "distanceto": return METHOD;
 296         case "text": return JSU.S(text);
 297         case "path": {
 298             if (path != null) return JSU.S(path.toString());
 299             if (text == null) return null;
 300             if (font == null) return null;
 301             String ret = "";
 302             for(int i=0; i<text.length(); i++) ret += font.glyphs[text.charAt(i)].path;
 303             return JSU.S(ret);
 304         }
 305         case "fill": return JSU.S(Color.colorToString(fillcolor));
 306         case "strokecolor": return JSU.S(Color.colorToString(strokecolor));
 307         case "textcolor": return JSU.S(Color.colorToString(strokecolor));
 308         case "font": return font == null ? null : font.stream;
 309         case "fontsize": return font == null ? JSU.N(10) : JSU.N(font.pointsize);
 310         case "thisbox": return this;
 311         case "shrink": return JSU.B(test(HSHRINK) || test(VSHRINK));
 312         case "hshrink": return JSU.B(test(HSHRINK));
 313         case "vshrink": return JSU.B(test(VSHRINK));
 314         case "flex": return JSU.N(flex);
 315         case "width": getRoot().reflow(); return JSU.N(width);
 316         case "height": getRoot().reflow(); return JSU.N(height);
 317         case "minwidth": return JSU.N(minwidth);
 318         case "maxwidth": return JSU.N(maxwidth);
 319         case "minheight": return JSU.N(minheight);
 320         case "maxheight": return JSU.N(maxheight);
 321         case "clip": return JSU.B(test(CLIP));
 322         case "visible": return JSU.B(test(VISIBLE) && (parent == null || (parent.get(JSU.S("visible")) == JSU.T)));
 323         case "axis": return test(XAXIS) ? JSU.S("x") : test(YAXIS) ? JSU.S("y") : JSU.S("z");
 324         case "globalx": return JSU.N(localToGlobalX(0));
 325         case "globaly": return JSU.N(localToGlobalY(0));
 326         case "cursor": return test(CURSOR) ? JSU.S((String)boxToCursor.get(this)) : null;
 327         case "mouse":
 328             if (getSurface() == null) return null;
 329             if (getSurface()._mousex == Integer.MAX_VALUE)
 330                 throw new JSExn("you cannot read from the box.mouse property in background thread context");
 331             return new Mouse();
 332         case "numchildren": return redirect == null ? JSU.N(0) : redirect == this ? JSU.N(treeSize()) : redirect.get(JSU.S("numchildren"));
 333         case "redirect": return redirect == null ? null : redirect == this ? JSU.T : redirect.get(JSU.S("redirect"));
 334         case "Minimized": if (parent == null && getSurface() != null) return JSU.B(getSurface().minimized);
 335         default: return super.get(name);
 336         //#end
 337         throw new Error("unreachable"); // unreachable
 338     }
 339
 340     private class Mouse extends JS.Immutable implements JS.Cloneable {
 341         public JS get(JS key) throws JSExn {
 342             //#switch(JSU.toString(key))
 343             case "x": return JSU.N(globalToLocalX(getSurface()._mousex));
 344             case "y": return JSU.N(globalToLocalY(getSurface()._mousey));
 345
 346             // this might not get recomputed if we change mousex/mousey...
 347             case "inside": return JSU.B(test(MOUSEINSIDE));
 348             //#end
 349             return super.get(key);
 350         }
 351     }
 352
 353     //#repeat setWidth/setHeight minwidth/minheight maxwidth/maxheight pendingWidth/pendingHeight
 354     public void setWidth(int min, int max) {
 355         // FIXME: deal with conflicting min/max
 356         if (this.minwidth == min && this.maxwidth == max) return;
 357         this.minwidth = min;
 358         this.maxwidth = max;
 359         RECONSTRAIN();
 360         if (parent != null || getSurface() == null) return;
 361         getSurface().pendingWidth = maxwidth;
 362
 363         // FIXME: the repeat doesn't work right here
 364         getSurface().setMinimumSize(minwidth, minheight, minwidth != maxwidth || minheight != maxheight);
 365     }
 366     //#end
 367
 368     public void put(JS name, JS value) throws JSExn {
 369         if (JSU.isInt(name)) { put(JSU.toInt(name), value); return; }
 370         //#switch(JSU.toString(name))
 371         case "thisbox":     if (value == null) removeSelf();
 372         case "text":        {
 373             String s = value==null ?  "" : JSU.toString(value);
 374             text = s;
 375             minwidth = maxwidth = font.textwidth(text);
 376             System.out.println("width=" + width);
 377             minheight = maxheight = font.textheight(text);
 378             System.out.println("height=" + height);
 379             RECONSTRAIN();
 380             dirty();
 381         }
 382         case "strokecolor": value = JSU.N(Color.stringToColor(JSU.toString(value))); CHECKSET_INT(strokecolor); dirty();
 383         case "textcolor":   value = JSU.N(Color.stringToColor(JSU.toString(value))); CHECKSET_INT(strokecolor); dirty();
 384         case "shrink":      CHECKSET_FLAG(HSHRINK | VSHRINK); RECONSTRAIN();
 385         case "hshrink":     CHECKSET_FLAG(HSHRINK); RECONSTRAIN();
 386         case "vshrink":     CHECKSET_FLAG(VSHRINK); RECONSTRAIN();
 387         case "path":        {
 388             mesh = null;
 389             path = new Path(JSU.toString(value));
 390             float tx = -1 * Encode.longToFloat2(path.horizontalBounds(Affine.identity()));
 391             float ty = -1 * Encode.longToFloat2(path.verticalBounds(Affine.identity()));
 392             path.transform(Affine.translate(tx, ty), true);
 393             REPLACE();
 394             RECONSTRAIN();
 395             dirty();
 396             polygon = null;
 397         }
 398         case "clippath":        {
 399             clippath = new Path(JSU.toString(value));
 400             //float tx = -1 * Encode.longToFloat2(clippath.horizontalBounds(Affine.identity()));
 401             //float ty = -1 * Encode.longToFloat2(clippath.verticalBounds(Affine.identity()));
 402             //clippath.transform(Affine.translate(tx, ty), true);
 403             REPLACE();
 404             RECONSTRAIN();
 405             dirty();
 406             polygon = null;
 407         }
 408         case "x":           transform.e = JSU.toInt(value);
 409         case "y":           transform.f = JSU.toInt(value);
 410         case "transform":   {
 411             transform = Affine.parse(JSU.toString(value));
 412             //transform.e = 0;
 413             //transform.f = 0;
 414             if (getSurface() != null)  // FIXME
 415                 getSurface().dirty(0, 0, getSurface().root.contentwidth, getSurface().root.contentheight);
 416             REPLACE();
 417             RECONSTRAIN(); dirty(); polygon = null;
 418         }
 419         case "width":       setWidth(JSU.toInt(value), JSU.toInt(value));
 420         case "height":      setHeight(JSU.toInt(value), JSU.toInt(value));
 421         case "flex":        flex = JSU.toFloat(value);
 422         case "maxwidth":    setWidth(minwidth, JSU.toInt(value));
 423         case "minwidth":    setWidth(JSU.toInt(value), maxwidth);
 424         case "maxheight":   setHeight(minheight, JSU.toInt(value));
 425         case "minheight":   setHeight(JSU.toInt(value), maxheight);
 426         case "visible":     CHECKSET_FLAG(VISIBLE); RECONSTRAIN(); dirty();
 427         case "cursor":      setCursor(JSU.toString(value));
 428         case "fill":        setFill(value);
 429         case "clip":        CHECKSET_FLAG(CLIP); if (parent == null) dirty(); else parent.dirty();
 430         case "mouse":
 431             int mousex = JSU.toInt(((JS)value).get(JSU.S("x")));
 432             int mousey = JSU.toInt(((JS)value).get(JSU.S("y")));
 433             getSurface()._mousex = (int)localToGlobalX(mousex);
 434             getSurface()._mousey = (int)localToGlobalY(mousey);
 435         case "axis":        {
 436             String s = JSU.toString(value);
 437             if (s.equals("x")) { clear(YAXIS); set(XAXIS); }
 438             else if (s.equals("y")) { clear(XAXIS); set(YAXIS); }
 439             else if (s.equals("z")) { clear(XAXIS); clear(YAXIS); }
 440             else JSU.warn("attempted to set axis property to invalid value: " + s);
 441         }
 442         case "Minimized": if (parent == null && getSurface() != null) getSurface().minimized = JSU.toBoolean(value);  // FEATURE
 443         case "Maximized": if (parent == null && getSurface() != null) getSurface().maximized = JSU.toBoolean(value);  // FEATURE
 444         case "Close":     if (parent == null && getSurface() != null) getSurface().dispose(true);
 445         case "redirect":
 446             for(Box cur = (Box)value; cur != null || cur == redirect; cur = cur.parent)
 447                 if (cur == redirect) { redirect = (Box)value; return; }
 448             JSU.error("redirect can only be set to a descendant of its current value");
 449         case "fontsize": font = Font.getFont(font == null ? null : font.stream, JSU.toInt(value)); RECONSTRAIN(); dirty();
 450         case "font":
 451             if(!(value instanceof Fountain)) throw new JSExn("You can only put streams to the font property");
 452             //FIXME: if (font == value) return;  // FIXME: unclone()
 453             font = value == null ? null : Font.getFont((Fountain)value, font == null ? 10 : font.pointsize);
 454             RECONSTRAIN();
 455             dirty();
 456         case "titlebar": if (getSurface()!=null) getSurface().setTitleBarText(JSU.toString(value)); super.put(name,value);
 457         // FIXME: icon
 458
 459         case "Press1":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
 460         case "Press2":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
 461         case "Press3":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
 462         case "Release1":      if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
 463         case "Release2":      if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
 464         case "Release3":      if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
 465         case "Click1":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
 466         case "Click2":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
 467         case "Click3":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
 468         case "DoubleClick1":  if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
 469         case "DoubleClick2":  if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
 470         case "DoubleClick3":  if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
 471         case "KeyPressed":    if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
 472         case "KeyReleased":   if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
 473         case "Move":          if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
 474         case "HScroll":       if (!test(STOP_UPWARD_PROPAGATION) && parent != null)
 475             parent.putAndTriggerTraps(name, JSU.N(JSU.toFloat(value) * ((float)parent.fontSize()) / ((float)fontSize())));
 476         case "VScroll":       if (!test(STOP_UPWARD_PROPAGATION) && parent != null)
 477             parent.putAndTriggerTraps(name, JSU.N(JSU.toFloat(value) * ((float)parent.fontSize()) / ((float)fontSize())));
 478
 479         case "_Move":         propagateDownward(name, value, false);
 480         case "_Press1":       propagateDownward(name, value, false);
 481         case "_Press2":       propagateDownward(name, value, false);
 482         case "_Press3":       propagateDownward(name, value, false);
 483         case "_Release1":     propagateDownward(name, value, false);
 484         case "_Release2":     propagateDownward(name, value, false);
 485         case "_Release3":     propagateDownward(name, value, false);
 486         case "_Click1":       propagateDownward(name, value, false);
 487         case "_Click2":       propagateDownward(name, value, false);
 488         case "_Click3":       propagateDownward(name, value, false);
 489         case "_DoubleClick1": propagateDownward(name, value, false);
 490         case "_DoubleClick2": propagateDownward(name, value, false);
 491         case "_DoubleClick3": propagateDownward(name, value, false);
 492         case "_KeyPressed":   propagateDownward(name, value, false);
 493         case "_KeyReleased":  propagateDownward(name, value, false);
 494         case "_HScroll":      propagateDownward(name, value, false);
 495         case "_VScroll":      propagateDownward(name, value, false);
 496
 497         case "SizeChange":    return;
 498         case "ChildChange":   return;
 499         case "Enter":         return;
 500         case "Leave":         return;
 501
 502         default:              super.put(name, value);
 503         //#end
 504     }
 505
 506     private void setCursor(String value) throws JSExn {
 507         if (value == null) { clear(CURSOR); boxToCursor.remove(this); return; }
 508         if (value.equals(boxToCursor.get(this))) return;
 509         set(CURSOR);
 510         boxToCursor.put(this, value);
 511         Surface surface = getSurface();
 512         if (surface == null) return;
 513         String tempcursor = surface.cursor;
 514         propagateDownward(null, null, false);
 515         if (surface.cursor != tempcursor) surface.syncCursor();
 516     }
 517
 518     private void setFill(JS value) throws JSExn {
 519         if (value == null) {
 520             if (texture == null && fillcolor == 0) return;
 521             texture = null;
 522             fillcolor = 0;
 523         } else if (JSU.isString(value)) {
 524             int newfillcolor = Color.stringToColor(JSU.toString(value));
 525             if (newfillcolor == fillcolor) return;
 526             fillcolor = newfillcolor;
 527             texture = null;
 528         } else {
 529             Picture newtex = Picture.load((JS)value, this);
 530             if (texture == newtex) return;
 531             texture = newtex;
 532             fillcolor = 0;
 533             if (texture != null && texture.isLoaded) run(null);
 534         }
 535         dirty();
 536     }
 537
 538     /**
 539      *  Handles events which propagate down the box tree.  If obscured
 540      *  is set, then we merely check for Enter/Leave.
 541      */
 542     private void propagateDownward(JS name_, JS value, boolean obscured) throws JSExn {
 543
 544         String name = JSU.toString(name_);
 545         if (getSurface() == null) return;
 546         int x = (int)globalToLocalX(getSurface()._mousex);
 547         int y = (int)globalToLocalY(getSurface()._mousey);
 548         boolean wasinside = test(MOUSEINSIDE);
 549         boolean isinside = test(VISIBLE) && inside(x, y) && !obscured;
 550         if (!wasinside && isinside) {
 551             set(MOUSEINSIDE);
 552             putAndTriggerTrapsAndCatchExceptions(JSU.S("Enter"), JSU.T);
 553         }
 554         if (isinside && test(CURSOR)) getSurface().cursor = (String)boxToCursor.get(this);
 555         if (wasinside && !isinside) {
 556             clear(MOUSEINSIDE);
 557             putAndTriggerTrapsAndCatchExceptions(JSU.S("Leave"), JSU.T);
 558         }
 559
 560         boolean found = false;
 561         if (wasinside || isinside)
 562             for(Box child = getChild(treeSize() - 1); child != null; child = child.prevSibling()) {
 563                 boolean save_stop = child.test(STOP_UPWARD_PROPAGATION);
 564                 JS value2 = value;
 565                 if (name.equals("_HScroll") || name.equals("_VScroll"))
 566                     value2 = JSU.N(JSU.toFloat(value) * ((float)child.fontSize()) / (float)fontSize());
 567                 if (obscured /*|| !child.inside(x - child.x, y - child.y) FIXME FIXME */) {
 568                     child.propagateDownward(name_, value2, true);
 569                 } else try {
 570                     found = true;
 571                     child.clear(STOP_UPWARD_PROPAGATION);
 572                     if (name != null) child.putAndTriggerTrapsAndCatchExceptions(name_, value2);
 573                     else child.propagateDownward(name_, value2, obscured);
 574                 } finally {
 575                     if (save_stop) child.set(STOP_UPWARD_PROPAGATION); else child.clear(STOP_UPWARD_PROPAGATION);
 576                 }
 577                 /* FIXME FIXME
 578                 if (child.inside(x - child.x, y - child.y))
 579                     if (name != null && name.equals("_Move")) obscured = true;
 580                     else break;
 581  */
 582             }
 583
 584         if (!obscured && !found)
 585             if ("_Move".equals(name) || name.startsWith("_Release") || wasinside)
 586                 if (name != null)
 587                     putAndTriggerTrapsAndCatchExceptions(JSU.S(name.substring(1)), value);
 588     }
 589
 590     /** figures out what box in this subtree of the Box owns the pixel at x,y relitave to the Surface */
 591     public static Box whoIs(Box cur, int x, int y) {
 592
 593         if (cur.parent != null) throw new Error("whoIs may only be invoked on the root box of a surface");
 594         int globalx = 0;
 595         int globaly = 0;
 596
 597         // WARNING: this method is called from the event-queueing thread -- it may run concurrently with
 598         // ANY part of Ibex, and is UNSYNCHRONIZED for performance reasons.  BE CAREFUL HERE.
 599
 600         if (!cur.test(VISIBLE)) return null;
 601         if (!cur.inside(x - globalx, y - globaly)) return cur.parent == null ? cur : null;
 602         OUTER: while(true) {
 603             for(int i=cur.treeSize() - 1; i>=0; i--) {
 604                 Box child = cur.getChild(i);
 605                 if (child == null) continue;        // since this method is unsynchronized, we have to double-check
 606                 globalx += child.transform.e;
 607                 globaly += child.transform.f;
 608                 if (child.test(VISIBLE) && child.inside(x - globalx, y - globaly)) { cur = child; continue OUTER; }
 609                 globalx -= child.transform.e;
 610                 globaly -= child.transform.f;
 611             }
 612             break;
 613         }
 614         return cur;
 615     }
 616
 617
 618     // Trivial Helper Methods (should be inlined) /////////////////////////////////////////
 619
 620     public final int fontSize() { return font == null ? DEFAULT_FONT.pointsize : font.pointsize; }
 621     public Enumeration keys() { throw new Error("you cannot apply for..in to a " + this.getClass().getName()); }
 622     public Box getRoot() { return parent == null ? this : parent.getRoot(); }
 623     public Surface getSurface() { return Surface.fromBox(getRoot()); }
 624     private final boolean packed() { return test(YAXIS) || test(XAXIS); }
 625     Box nextPackedSibling() { Box b = nextSibling(); return b == null || (b.packed() && b.test(VISIBLE))?b:b.nextPackedSibling(); }
 626     Box firstPackedChild() { Box b = getChild(0); return b == null || (b.packed() && b.test(VISIBLE))?b:b.nextPackedSibling(); }
 627     public float globalToLocalX(float x) { return parent == null ? x : parent.globalToLocalX(x - transform.e); }
 628     public float globalToLocalY(float y) { return parent == null ? y : parent.globalToLocalY(y - transform.f); }
 629     public float localToGlobalX(float x) { return parent == null ? x : parent.globalToLocalX(x + transform.e); }
 630     public float localToGlobalY(float y) { return parent == null ? y : parent.globalToLocalY(y + transform.f); }
 631
 632     static short min(short a, short b) { if (a<b) return a; else return b; }
 633     static int min(int a, int b) { if (a<b) return a; else return b; }
 634     static float min(float a, float b) { if (a<b) return a; else return b; }
 635
 636     static short max(short a, short b) { if (a>b) return a; else return b; }
 637     static int max(int a, int b) { if (a>b) return a; else return b; }
 638     static float max(float a, float b) { if (a>b) return a; else return b; }
 639
 640     static int min(int a, int b, int c) { if (a<=b && a<=c) return a; else if (b<=c && b<=a) return b; else return c; }
 641     static int max(int a, int b, int c) { if (a>=b && a>=c) return a; else if (b>=c && b>=a) return b; else return c; }
 642     static int bound(int a, int b, int c) { if (c < b) return c; if (a > b) return a; return b; }
 643     final boolean inside(int x, int y) { return test(VISIBLE) && x >= 0 && y >= 0 && x < width && y < height; }
 644
 645     void set(int mask) { flags |= mask; }
 646     void set(int mask, boolean setclear) { if (setclear) set(mask); else clear(mask); }
 647     void clear(int mask) { flags &= ~mask; }
 648     public boolean test(int mask) { return ((flags & mask) == mask); }
 649
 650
 651     // Tree Handling //////////////////////////////////////////////////////////////////////
 652
 653     public final int getIndexInParent() { return parent == null ? 0 : parent.indexNode(this); }
 654     public final Box nextSibling() { return parent == null ? null : parent.getChild(parent.indexNode(this) + 1); }
 655     public final Box prevSibling() { return parent == null ? null : parent.getChild(parent.indexNode(this) - 1); }
 656     public final Box getChild(int i) {
 657         if (i < 0) return null;
 658         if (i >= treeSize()) return null;
 659         return (Box)getNode(i);
 660     }
 661
 662     // Tree Manipulation /////////////////////////////////////////////////////////////////////
 663
 664     public void removeSelf() {
 665         if (parent != null) { parent.removeChild(parent.indexNode(this)); return; }
 666         Surface surface = Surface.fromBox(this);
 667         if (surface != null) surface.dispose(true);
 668     }
 669
 670     /** remove the i^th child */
 671     public void removeChild(int i) {
 672         Box b = getChild(i);
 673         b.RECONSTRAIN();
 674         b.dirty();
 675         b.clear(MOUSEINSIDE);
 676         deleteNode(i);
 677         b.parent = null;
 678         RECONSTRAIN();
 679         putAndTriggerTrapsAndCatchExceptions(JSU.S("ChildChange"), b);
 680     }
 681
 682     public void put(int i, JS value) throws JSExn {
 683         if (i < 0) return;
 684
 685         if (value != null && !(value instanceof Box)) {
 686             if (Log.on) JSU.warn("attempt to set a numerical property on a box to a non-box");
 687             return;
 688         }
 689
 690         if (redirect == null) {
 691             if (value == null) putAndTriggerTrapsAndCatchExceptions(JSU.S("ChildChange"), getChild(i));
 692             else JSU.warn("attempt to add/remove children to/from a node with a null redirect");
 693
 694         } else if (redirect != this) {
 695             if (value != null) putAndTriggerTrapsAndCatchExceptions(JSU.S("ChildChange"), value);
 696             redirect.put(i, value);
 697             if (value == null) {
 698                 Box b = (Box)redirect.get(JSU.N(i));
 699                 if (b != null) putAndTriggerTrapsAndCatchExceptions(JSU.S("ChildChange"), b);
 700             }
 701
 702         } else if (value == null) {
 703             if (i < 0 || i > treeSize()) return;
 704             Box b = getChild(i);
 705             removeChild(i);
 706             putAndTriggerTrapsAndCatchExceptions(JSU.S("ChildChange"), b);
 707
 708         } else {
 709             Box b = (Box)value;
 710
 711             // check if box being moved is currently target of a redirect
 712             for(Box cur = b.parent; cur != null; cur = cur.parent)
 713                 if (cur.redirect == b) {
 714                     if (Log.on) JSU.warn("attempt to move a box that is the target of a redirect");
 715                     return;
 716                 }
 717
 718             // check for recursive ancestor violation
 719             for(Box cur = this; cur != null; cur = cur.parent)
 720                 if (cur == b) {
 721                     if (Log.on) JSU.warn("attempt to make a node a parent of its own ancestor");
 722                     if (Log.on) Log.info(this, "box == " + this + "  ancestor == " + b);
 723                     return;
 724                 }
 725
 726             if (b.parent != null) b.parent.removeChild(b.parent.indexNode(b));
 727             insertNode(i, b);
 728             b.parent = this;
 729
 730             // need both of these in case child was already uncalc'ed
 731             b.RECONSTRAIN();
 732             RECONSTRAIN();
 733
 734             b.dirty();
 735             putAndTriggerTrapsAndCatchExceptions(JSU.S("ChildChange"), b);
 736         }
 737     }
 738
 739     public void putAndTriggerTrapsAndCatchExceptions(JS name, JS val) {
 740         try {
 741             putAndTriggerTraps(name, val);
 742         } catch (JSExn e) {
 743             JSU.log("caught js exception while putting to trap \""+ JSU.str(name)+"\"");
 744             JSU.log(e);
 745         } catch (Exception e) {
 746             JSU.log("caught exception while putting to trap \""+ JSU.str(name)+"\"");
 747             JSU.log(e);
 748         }
 749     }
 750
 751     // BalancedTree functions
 752     private void insertNode(int p, Box b) { if(bt == null) bt = new BalancedTree(); bt.insertNode(p,b); }
 753     private int treeSize() { return bt == null ? 0 : bt.treeSize(); }
 754     private int indexNode(Box b) { return bt == null ? -1 : bt.indexNode(b); }
 755     private void deleteNode(int p) { bt.deleteNode(p); }
 756     private Box getNode(int p) { return (Box)bt.getNode(p); }
 757
 758     // FIXME memory leak
 759     final static JS.Method METHOD = new JS.Method();
 760     final static Basket.Map boxToCursor = new Basket.Hash(500, 3);
 761     final static JS SIZECHANGE = JSU.S("SizeChange");
 762     final static Font DEFAULT_FONT = Font.getFont(Main.vera, 10);
 763
 764
 765     // Flags //////////////////////////////////////////////////////////////////////
 766
 767     public static final int MOUSEINSIDE             = 0x00000001;
 768     public static final int XAXIS                   = 0x00000002;
 769     public static final int YAXIS                   = 0x00000004;
 770     public static final int VISIBLE                 = 0x00000008;
 771     public static final int VSHRINK                 = 0x00000010;
 772     public static final int HSHRINK                 = 0x00000020;
 773     public static final int RECONSTRAIN             = 0x00000040;
 774     public static final int REPLACE                 = 0x00000080;
 775
 776     // if true, this box has cursor in the cursor hash; FEATURE: GC issues?
 777     public static final int CURSOR                  = 0x00010000;
 778     public static final int CLIP                    = 0x00020000;
 779     public static final int STOP_UPWARD_PROPAGATION = 0x00040000;
 780     public static final int MOVED                   = 0x00080000;
 781
 782
 783 }