78b417b8e3999cf20482bf51efa77ca20ef46adf
[org.ibex.core.git] / 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 // FIXME
6 package org.ibex.core;
7
8 // FIXME: are traps on x/y meaningful?
9 // FIXME: if we trap on cols, then set rows to 0 (forcing cols to 1), does the cols trap get triggered?
10 // FIXME: if we change min{width/height}, thereby forcing a change to max{min/height}, does a trap on those get triggered?
11 // FIXME: trap on numchildren?  replaces ChildChanged?
12 // FIXME: trap on visible, trigger when parent visibility changes
13
14 // FIXME: ax/ay nonsense
15 // FIXME: mouse move/release still needs to propagate to boxen in which the mouse was pressed and is still held down
16
17 // FEATURE: mark to reflow starting with a certain child
18 // FEATURE: reintroduce surface.abort
19
20 import java.util.*;
21 import org.ibex.js.*;
22 import org.ibex.util.*;
23 import org.ibex.graphics.*;
24
25 /**
26  *  <p>
27  *  Encapsulates the data for a single Ibex box as well as all layout
28  *  rendering logic.
29  *  </p>
30  *
31  *  <p>The rendering process consists of four phases; each requires
32  *     one DFS pass over the tree</p>
33  *  <ol><li> <b>pack()</b>: each box sets its childrens' row/col
34  *  <ol><li> <b>constrain()</b>: contentwidth is computed
35  *      <li> <b>resize()</b>: width/height and x/y positions are set
36  *      <li> <b>render()</b>: children draw their content onto the PixelBuffer.
37  *  </ol>
38  *
39  *  The first three passes together are called the <i>reflow</i>
40  *  phase.  Reflowing is done in a seperate pass since SizeChanges
41  *  trigger a Surface.abort; if rendering were done in the same pass,
42  *  rendering work done prior to the Surface.abort would be wasted.
43  */
44 public final class Box extends JS.Obj implements Callable {
45
46     private static final JS.Method METHOD = new JS.Method();
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     final void REPACK() { for(Box b2 = this; b2 != null && !b2.test(REPACK); b2 = b2.parent) b2.set(REPACK); }
53
54     //#define CHECKSET_SHORT(prop) short nu = (short)JSU.toInt(value); if (nu == prop) break; prop = nu;
55     //#define CHECKSET_INT(prop) int nu = JSU.toInt(value); if (nu == prop) break; prop = nu;
56     //#define CHECKSET_FLAG(flag) boolean nu=JSU.toBoolean(value);if(nu == test(flag)) break; if (nu) set(flag); else clear(flag);
57     //#define CHECKSET_BOOLEAN.N(prop) boolean nu = JSU.toBoolean(value); if (nu == prop) break; prop = nu;
58     //#define CHECKSET_STRING(prop) if((value==null&&prop==null)||(value!=null&&JSU.toString(value).equals(prop)))break;prop=JSU.toString(value);
59
60     // FIXME memory leak
61     static Basket.Map boxToCursor = new Basket.Hash(500, 3);
62
63     public static final Font DEFAULT_FONT = Font.getFont(Main.vera, 10);
64
65
66     // Flags //////////////////////////////////////////////////////////////////////
67
68     static final int MOUSEINSIDE             = 0x00000001;
69     static final int VISIBLE                 = 0x00000002;
70     static final int PACKED                  = 0x00000004;
71     public static final int HSHRINK          = 0x00000008;
72     public static final int VSHRINK          = 0x00000010;
73     static final int BLACK                   = 0x00000020;  // for red-black code
74
75     static final int FIXED                   = 0x00000040;
76     static final boolean ROWS                = true;
77     static final boolean COLS                = false;
78
79     static final int ISROOT                  = 0x00000080;
80     static final int REPACK                  = 0x00000100;
81     static final int RECONSTRAIN             = 0x00000200;
82     static final int REPLACE                 = 0x00000400;
83
84     static final int CURSOR                  = 0x00010000;  // if true, this box has cursor in the cursor hash; FEATURE: GC issues?
85     static final int CLIP                    = 0x00020000;
86     static final int STOP_UPWARD_PROPAGATION = 0x00040000;
87     static final int MOVED                   = 0x00080000;
88
89
90     // Instance Data //////////////////////////////////////////////////////////////////////
91
92     Box parent = null;
93     Box redirect = this;
94     int flags = VISIBLE | PACKED | REPACK | RECONSTRAIN | REPLACE | FIXED | STOP_UPWARD_PROPAGATION | CLIP | MOVED;
95
96     private BalancedTree bt;
97     
98     private String text = null;
99     private Font font = DEFAULT_FONT; 
100     private Picture texture = null;
101     private short strokewidth = 1;
102     public int fillcolor = 0x00000000;
103     private int strokecolor = 0xFF000000;
104
105     private int aspect = 0;
106
107     // specified directly by user
108     public int minwidth = 0;
109     public int maxwidth = Integer.MAX_VALUE;
110     public int minheight = 0;
111     public int maxheight = Integer.MAX_VALUE;
112     public int minwidth() { return minwidth; }
113     public int minheight() { return minheight; }
114     public int maxwidth() { return maxwidth; }
115     public int maxheight() { return maxheight; }
116     private short rows = 1;
117     private short cols = 0;
118     private short rowspan = 1;
119     private short colspan = 1;
120
121     // computed during reflow
122     private short row = 0;
123     private short col = 0;
124     public int x = 0;
125     public int y = 0;
126     public int width = 0;
127     public int height = 0;
128     public int contentwidth = 0;      // == max(minwidth, textwidth, sum(child.contentwidth))
129     public int contentheight = 0;
130
131     private Path path = null;
132     /*
133     private Affine transform = null;
134     private VectorGraphics.RasterPath rpath = null;
135     private Affine rtransform = null;
136     */
137
138     // Instance Methods /////////////////////////////////////////////////////////////////////
139
140     public final int fontSize() { return font == null ? DEFAULT_FONT.pointsize : font.pointsize; }
141
142     /** invoked when a resource needed to render ourselves finishes loading */
143     public Object run(Object o) throws JSExn {
144         if (texture == null) { Log.warn(Box.class, "perform() called with null texture"); return null; }
145         if (texture.isLoaded) {
146             setWidth(max(texture.width, minwidth), maxwidth); 
147             setHeight(max(texture.height, minheight), maxheight); 
148             dirty(); }
149         else { JS res = texture.stream; texture = null; throw new JSExn("image not found: "+res.unclone()); }
150         return null;
151     }
152
153     // FEATURE: use cx2/cy2 format
154     /** Adds the intersection of (x,y,w,h) and the node's current actual geometry to the Surface's dirty list */
155     public void dirty() { dirty(0, 0, width, height); }
156     public void dirty(int x, int y, int w, int h) {
157         for(Box cur = this; cur != null; cur = cur.parent) {
158             // x and y have a different meaning on the root box
159             if (cur.parent != null && cur.test(CLIP)) {
160                 w = min(x + w, cur.width) - max(x, 0);
161                 h = min(y + h, cur.height) - max(y, 0);
162                 x = max(x, 0);
163                 y = max(y, 0);
164             }
165             if (w <= 0 || h <= 0) return;
166             if (cur.parent == null && cur.getSurface() != null) cur.getSurface().dirty(x, y, w, h);
167             x += cur.x;
168             y += cur.y;
169         }
170     }
171
172
173     // Reflow ////////////////////////////////////////////////////////////////////////////////////////
174
175     /** should only be invoked on the root box */
176     public void reflow() {
177         pack();
178         resize(x, y,
179                test(HSHRINK) ? contentwidth : maxwidth,
180                test(VSHRINK) ? contentheight : maxheight);
181         place();
182     }
183     
184     private static Box[] frontier = new Box[65535];
185     /** pack the boxes into rows and columns, compute contentwidth */
186     public void pack() {
187         if (!test(REPACK)) { constrain(); return; }
188         boolean haskid = false;
189         for(Box child = getChild(0); child != null; child = child.nextSibling()) { haskid = true; child.pack(); }
190         if (!haskid) { clear(REPACK); constrain(); return; }
191         int frontier_size = 0;
192         //#repeat COLS/ROWS rows/cols cols/rows col/row row/col colspan/rowspan rowspan/colspan \
193         //        contentheight/contentwidth contentwidth/contentheight
194         if (test(FIXED) == COLS) {
195             rows = 0;
196             for(Box child = getChild(0); child != null; child = child.nextSibling()) {
197                 if (!child.test(PACKED) || !child.test(VISIBLE)) continue;
198                 if (cols == 1) { child.row = rows; rows += child.rowspan; child.col = 0; continue; }
199                 child.col = (short)(frontier_size <= 0 ? 0 : (frontier[frontier_size-1].col + frontier[frontier_size-1].colspan));
200                 child.row = (short)(frontier_size <= 0 ? 0 : frontier[frontier_size-1].row);
201                 if (child.col + min(cols,child.colspan) > cols) { child.col = 0; child.row++; }
202                 for(int i=0; i<frontier_size; i++)
203                     if (frontier[i].row + frontier[i].rowspan <= child.row) {
204                         frontier[i--] = frontier[--frontier_size]; frontier[frontier_size] = null;
205                     } else if (frontier[i].col<child.col+min(cols,child.colspan)&&frontier[i].col+frontier[i].colspan>child.col) {
206                         child.col = (short)(frontier[i].col + frontier[i].colspan);
207                         if (child.col + min(cols,child.colspan) > cols) {
208                             child.row = (short)(frontier[i].row + frontier[i].rowspan);
209                             for(i--; i>0; i--) child.row = (short)min(row, frontier[i].row + frontier[i].rowspan);
210                             child.col = (short)0;
211                         }
212                         i = -1;
213                     } else break;
214                 frontier[frontier_size++] = child;
215             }
216             for(int i=0; i<frontier_size; i++){ rows=(short)max(rows, frontier[i].row + frontier[i].rowspan); frontier[i] = null; }
217         }
218         //#end
219         clear(REPACK);
220         set(RECONSTRAIN);   // FIXME: be smarter / more incremental
221         constrain();
222     }
223
224     public void constrain() {
225         if (!test(RECONSTRAIN)) return;
226         solve(true);
227         //#repeat contentwidth/contentheight contentheight/contentwidth minwidth/minheight row/col col/row \
228         //        textwidth/textheight maxwidth/maxheight cols/rows rows/cols colspan/rowspan rowspan/colspan
229         contentwidth = bound(minwidth,
230                              max(contentwidth, font == null || text == null ? 0 : font.textwidth(text)),
231                              maxwidth);
232         //#end
233         set(REPLACE); // FIXME: be smarter / more incremental
234     }
235     
236     private final static JS SIZECHANGE = JSU.S("SizeChange");
237     
238     void resize(int x, int y, int width, int height) {
239         if (x == this.x && y == this.y && width == this.width && height == this.height) return;
240         boolean sizechange = (this.width != width || this.height != height);
241         try { sizechange = sizechange && getTrap(SIZECHANGE) != null; } catch (JSExn e) {}
242         int thisx = parent == null ? 0 : this.x;
243         int thisy = parent == null ? 0 : this.y;
244         Box who = (parent == null ? this : parent);
245         if (this.x != x || this.y != y) set(MOVED);
246         if (texture == null && (text == null || text.equals("")) && !test(MOVED)) {
247             if ((fillcolor & 0xff000000) != 0 || parent == null) {
248                 who.dirty(thisx+min(this.width,width), thisy, Math.abs(width-this.width), max(this.height, height));
249                 who.dirty(thisx, thisy+min(this.height,height), max(this.width, width), Math.abs(height-this.height));
250             }
251             this.width = width; this.height = height; this.x = x; this.y = y;
252         } else {
253             who.dirty(thisx, thisy, this.width, this.height);
254             this.width = width; this.height = height; this.x = x; this.y = y;
255             dirty();
256         }
257         if (sizechange) putAndTriggerTrapsAndCatchExceptions(SIZECHANGE, JSU.T);
258     }
259
260     private float targetColumnSize = (float)0.0;
261     private float targetRowSize = (float)0.0;
262     private static float[] sizes = new float[65535];
263     private static float[] sizes_v = new float[65535];
264     private static int[] regions = new int[65535];
265     private static int[] regions_v = new int[65535];
266     private static int numregions = 0;
267     private static int numregions_v = 0;
268
269     void solve(boolean findMinimum) {
270         int numkids = 0; for(Box c = firstPackedChild(); c != null; c = c.nextPackedSibling()) numkids++;
271         //#repeat col/row colspan/rowspan contentwidth/contentheight width/height HSHRINK/VSHRINK numregions/numregions_v \
272         //        maxwidth/maxheight cols/rows minwidth/minheight regions/regions_v targetColumnSize/targetRowSize sizes/sizes_v \
273         //        HSHRINK/VSHRINK
274         if (numkids == 0) {
275             if (findMinimum) contentwidth = 0;
276             else targetColumnSize = 0;
277         } else if (cols == 1) {
278             if (findMinimum) {
279                 contentwidth = 0;
280                 for(Box c = firstPackedChild(); c != null; c = c.nextPackedSibling())
281                     contentwidth = max(contentwidth, c.contentwidth);
282             } else {
283                 targetColumnSize = width;
284             }
285         } else if (cols > 1) do {
286
287             // FIXME: cache these?
288             // compute regions
289             numregions = 0;
290             for(Box c = firstPackedChild(); c != null; c = c.nextPackedSibling()) {
291                 regions[numregions++] = c.col;
292                 regions[numregions++] = min(cols, c.col+c.colspan);
293             }
294             Vec.sortInts(regions, 0, numregions);
295             int j = 0;
296             int newnumregions = numregions;
297             for(int i=1; i<numregions; i++) {
298                 if (regions[j] != regions[i]) j++;
299                 else newnumregions--;
300                 regions[j] = regions[i];
301             }
302             numregions = newnumregions;
303             if (regions[numregions-1] == cols) numregions--;
304             else regions[numregions] = cols;
305
306             int target = findMinimum ? 0 : Math.max(width, contentwidth);
307             // priority 0: (inviolable) honor minwidths
308             // priority 1: sum of columns no greater than parent
309             // priority 2: honor maxwidths
310             // priority 3: equalize columns
311             float targetColumnSize = target == 0 ? 0 : this.targetColumnSize;
312             float last_columnsize = 0;
313             float last_total = 0;
314             float total;
315             boolean first = true;
316             while(true) {
317                 total = (float)0.0;
318                 for(int r=0; r<numregions; r++) total += (sizes[r] = (float)(targetColumnSize * (regions[r+1]-regions[r])));
319                 int minregion = 0;
320                 for(Box child = firstPackedChild(); child != null; child = child.nextPackedSibling())
321                     for(int r=(child.col==0?0:minregion); r<numregions; r++) {
322                         if (regions[r+1] < child.col) continue;
323                         if (regions[r] >= min(child.col+child.colspan,cols)) { minregion = r; break; }
324                         total -= sizes[r];
325                         int child_maxwidth = child.test(HSHRINK)?child.contentwidth:child.maxwidth;
326                         if (sizes[r] <= (float)(targetColumnSize*(regions[r+1]-regions[r])))
327                             if ((child.colspan * targetColumnSize) > (child_maxwidth + (float)0.5))
328                                 sizes[r] = (float)Math.min(sizes[r], (regions[r+1]-regions[r])*(child_maxwidth/child.colspan));
329                         if ((child.colspan * targetColumnSize) < (child.contentwidth - (float)0.5))
330                             sizes[r] = (float)Math.max(sizes[r], (regions[r+1]-regions[r])*(child.contentwidth/child.colspan));
331                         total += sizes[r];
332                     }
333                 float save = targetColumnSize;
334                 if (Math.abs(total - target) <= (float)1.0) break;
335                 if (!first) {
336                     if (Math.abs(total - last_total) <= (float)1.0) break;
337                 } else {
338                     last_columnsize = ((total - target) / (float)cols) + targetColumnSize;
339                 }
340                 if (total < target)      targetColumnSize += Math.abs((last_columnsize - targetColumnSize) / (float)1.1);
341                 else if (total > target) targetColumnSize -= Math.abs((last_columnsize - targetColumnSize) / (float)1.1);
342                 last_columnsize = save;
343                 last_total = total;
344                 first = false;
345             }
346             if (findMinimum) contentwidth = Math.round(total);
347             else this.targetColumnSize = targetColumnSize;
348         } while(false);
349         //#end
350     }
351
352     void place() {
353         solve(false);
354         for(Box child = getChild(0); child != null; child = child.nextSibling()) {
355             if (!child.test(VISIBLE)) continue;
356             if (!child.test(REPLACE)) continue;
357             int child_width, child_height, child_x, child_y;
358             if (!child.test(PACKED)) {
359                 child_width = child.test(HSHRINK) ? child.contentwidth : min(child.maxwidth, width);
360                 child_height = child.test(VSHRINK) ? child.contentheight : min(child.maxheight, height);
361                 child_width = max(child.minwidth, child_width);
362                 child_height = max(child.minheight, child_height);
363                 int gap_x = width - child_width;
364                 int gap_y = height - child_height;
365                 child_x = gap_x / 2;
366                 child_y = gap_y / 2;
367             } else {
368                 int diff;
369                 //#repeat col/row colspan/rowspan contentwidth/contentheight width/height colMaxWidth/rowMaxHeight \
370                 //        child_x/child_y x/y HSHRINK/VSHRINK maxwidth/maxheight cols/rows minwidth/minheight x_slack/y_slack \
371                 //        child_width/child_height lp_h/lp \
372                 //        numregions/numregions_v regions/regions_v targetColumnSize/targetRowSize sizes/sizes_v
373                 child_x = 0;
374                 if (cols == 1) {
375                     child_width = width;
376                 } else {
377                     child_width = 0;
378                     for(int r=0; r<numregions; r++) {
379                         if (regions[r] < child.col) child_x += Math.round(sizes[r]);
380                         else if (regions[r] < child.col+child.colspan) child_width += Math.round(sizes[r]);
381                     }
382                 }
383                 diff = (child_width - (child.test(HSHRINK) ? child.contentwidth : min(child_width, child.maxwidth)));
384                 child_x += diff / 2;
385                 child_width -= diff;
386                 //#end
387             }
388             if (test(MOVED)) child.set(MOVED);
389             child.resize(child_x, child_y, child_width, child_height);
390         }
391         clear(MOVED);
392
393         for(Box child = getChild(0); child != null; child = child.nextSibling())
394             if (child.test(VISIBLE) && child.treeSize() > 0)
395                 child.place();
396     }
397
398
399
400     // Rendering Pipeline /////////////////////////////////////////////////////////////////////
401
402     /** Renders self and children within the specified region. All rendering operations are clipped to xIn,yIn,wIn,hIn */
403     public void render(int parentx, int parenty, int cx1, int cy1, int cx2, int cy2, PixelBuffer buf, Affine a) {
404         if (!test(VISIBLE)) return;
405         int globalx = parentx + (parent == null ? 0 : x);
406         int globaly = parenty + (parent == null ? 0 : y);
407
408         // intersect the x,y,w,h rendering window with ourselves; quit if it's empty
409         if (test(CLIP)) {
410             cx1 = max(cx1, globalx);
411             cy1 = max(cy1, globaly);
412             cx2 = min(cx2, globalx + width);
413             cy2 = min(cy2, globaly + height);
414             if (cx2 <= cx1 || cy2 <= cy1) return;
415         }
416
417         if ((fillcolor & 0xFF000000) != 0x00000000 || parent == null)
418             buf.fillTrapezoid(cx1, cx2, cy1, cx1, cx2, cy2, (fillcolor & 0xFF000000) == 0 ? 0xffffffff : fillcolor);
419
420         if (texture != null && texture.isLoaded)
421             for(int x = globalx; x < cx2; x += texture.width)
422                 for(int y = globaly; y < cy2; y += texture.height)
423                     buf.drawPicture(texture, x, y, cx1, cy1, cx2, cy2);
424  
425         if (text != null && !text.equals("") && font != null) {
426             int gap_x = width - font.textwidth(text);
427             int gap_y = height - font.textheight(text);
428             int text_x = globalx + gap_x/2;
429             int text_y = globaly + gap_y/2;
430             font.rasterizeGlyphs(text, buf, strokecolor, text_x, text_y, cx1, cy1, cx2, cy2);
431         }
432
433         if (path != null) new Polygon(path, Affine.translate(globalx, globaly)).stroke(buf, strokecolor);
434
435         for(Box b = getChild(0); b != null; b = b.nextSibling())
436             b.render(globalx, globaly, cx1, cy1, cx2, cy2, buf, null);
437     }
438     
439     
440     // Methods to implement org.ibex.js.JS //////////////////////////////////////
441   
442     public JS call(JS method, JS[] args) throws JSExn {
443         switch (args.length) {
444             case 1: {
445                 //#switch(JSU.toString(method))
446                 case "indexof":
447                     Box b = (Box)args[0];
448                     if (b.parent != this)
449                         return (redirect == null || redirect == this) ?
450                             JSU.N(-1) : redirect.call(method, args);
451                     return JSU.N(b.getIndexInParent());
452
453                 case "distanceto":
454                     Box b = (Box)args[0];
455                     JS ret = new JS.Obj();
456                     ret.put(JSU.S("x"), JSU.N(b.localToGlobalX(0) - localToGlobalX(0)));
457                     ret.put(JSU.S("y"), JSU.N(b.localToGlobalY(0) - localToGlobalY(0)));
458                     return ret;
459
460                 //#end
461             }
462         }
463         return super.call(method, args);
464     }
465
466     public JS get(JS name) throws JSExn {
467         if (JSU.isInt(name))
468             return redirect == null ? null : redirect == this ? getChild(JSU.toInt(name)) : redirect.get(name);
469
470         //#switch(JSU.toString(name))
471         case "surface": return parent == null ? null : parent.getAndTriggerTraps(name);
472         case "indexof": return METHOD;
473         case "distanceto": return METHOD;
474         case "text": return JSU.S(text);
475         case "path": {
476             if (path != null) return JSU.S(path.toString());
477             if (text == null) return null;
478             if (font == null) return null;
479             String ret = "";
480             for(int i=0; i<text.length(); i++) ret += font.glyphs[text.charAt(i)].path;
481             return JSU.S(ret);
482         }
483         case "fill": return JSU.S(Color.colorToString(fillcolor));
484         case "strokecolor": return JSU.S(Color.colorToString(strokecolor));
485         case "textcolor": return JSU.S(Color.colorToString(strokecolor));
486         case "font": return font == null ? null : font.stream;
487         case "fontsize": return font == null ? JSU.N(10) : JSU.N(font.pointsize);
488         case "strokewidth": return JSU.N(strokewidth);
489         case "thisbox": return this;
490         case "shrink": return JSU.B(test(HSHRINK) || test(VSHRINK));
491         case "hshrink": return JSU.B(test(HSHRINK));
492         case "vshrink": return JSU.B(test(VSHRINK));
493         case "aspect": return JSU.N(aspect);
494         case "x": return JSU.N(x);
495         case "y": return JSU.N(y);
496         case "cols": return test(FIXED) == COLS ? JSU.N(cols) : JSU.N(0);
497         case "rows": return test(FIXED) == ROWS ? JSU.N(rows) : JSU.N(0);
498         case "colspan": return JSU.N(colspan);
499         case "rowspan": return JSU.N(rowspan);
500         case "width": getRoot().reflow(); return JSU.N(width);
501         case "height": getRoot().reflow(); return JSU.N(height);
502         case "minwidth": return JSU.N(minwidth);
503         case "maxwidth": return JSU.N(maxwidth);
504         case "minheight": return JSU.N(minheight);
505         case "maxheight": return JSU.N(maxheight);
506         case "clip": return JSU.B(test(CLIP));
507         case "visible": return JSU.B(test(VISIBLE) && (parent == null || (parent.get(JSU.S("visible")) == JSU.T)));
508         case "packed": return JSU.B(test(PACKED));
509         case "globalx": return JSU.N(localToGlobalX(0));
510         case "globaly": return JSU.N(localToGlobalY(0));
511         case "cursor": return test(CURSOR) ? JSU.S((String)boxToCursor.get(this)) : null;
512         case "mouse":
513             if (getSurface() == null) return null;
514             if (getSurface()._mousex == Integer.MAX_VALUE)
515                 throw new JSExn("you cannot read from the box.mouse property in background thread context");
516             return new Mouse();
517         case "numchildren": return redirect == null ? JSU.N(0) : redirect == this ? JSU.N(treeSize()) : redirect.get(JSU.S("numchildren"));
518         case "redirect": return redirect == null ? null : redirect == this ? JSU.T : redirect.get(JSU.S("redirect"));
519         case "Minimized": if (parent == null && getSurface() != null) return JSU.B(getSurface().minimized);
520         default: return super.get(name);
521         //#end
522         throw new Error("unreachable"); // unreachable
523     }
524
525     private class Mouse extends JS.Immutable implements JS.Cloneable {
526         public JS get(JS key) throws JSExn {
527             //#switch(JSU.toString(key))
528             case "x": return JSU.N(globalToLocalX(getSurface()._mousex));
529             case "y": return JSU.N(globalToLocalY(getSurface()._mousey));
530
531             // this might not get recomputed if we change mousex/mousey...
532             case "inside": return JSU.B(test(MOUSEINSIDE));
533             //#end
534             return super.get(key);
535         }
536     }
537
538     //#repeat setWidth/setHeight minwidth/minheight maxwidth/maxheight pendingWidth/pendingHeight
539     public void setWidth(int min, int max) {
540         // FIXME: deal with conflicting min/max
541         if (this.minwidth == min && this.maxwidth == max) return;
542         this.minwidth = min;
543         this.maxwidth = max;
544         RECONSTRAIN();
545         if (parent != null || getSurface() == null) return;
546         getSurface().pendingWidth = maxwidth;
547
548         // FIXME: the repeat doesn't work right here
549         getSurface().setMinimumSize(minwidth, minheight, minwidth != maxwidth || minheight != maxheight);
550     }
551     //#end
552
553     public void put(JS name, JS value) throws JSExn {
554         if (JSU.isInt(name)) { put(JSU.toInt(name), value); return; }
555         //#switch(JSU.toString(name))
556         case "thisbox":     if (value == null) removeSelf();
557         case "text":        { String s = value == null ?  "" : JSU.toString(value); CHECKSET_STRING(text); RECONSTRAIN(); dirty(); }
558         case "strokecolor": value = JSU.N(Color.stringToColor(JSU.toString(value))); CHECKSET_INT(strokecolor); dirty();
559         case "textcolor":   value = JSU.N(Color.stringToColor(JSU.toString(value))); CHECKSET_INT(strokecolor); dirty();
560         case "strokewidth": CHECKSET_SHORT(strokewidth); dirty();
561         case "shrink":      CHECKSET_FLAG(HSHRINK | VSHRINK); RECONSTRAIN();
562         case "hshrink":     CHECKSET_FLAG(HSHRINK); RECONSTRAIN();
563         case "vshrink":     CHECKSET_FLAG(VSHRINK); RECONSTRAIN();
564         case "path":        path = new Path(JSU.toString(value)); RECONSTRAIN(); dirty();
565         case "width":       setWidth(JSU.toInt(value), JSU.toInt(value));
566         case "height":      setHeight(JSU.toInt(value), JSU.toInt(value));
567         case "maxwidth":    setWidth(minwidth, JSU.toInt(value));
568         case "minwidth":    setWidth(JSU.toInt(value), maxwidth);
569         case "maxheight":   setHeight(minheight, JSU.toInt(value));
570         case "minheight":   setHeight(JSU.toInt(value), maxheight);
571         case "colspan":     if (JSU.toInt(value) > 0) { CHECKSET_SHORT(colspan); if (parent != null) parent.REPACK(); }
572         case "rowspan":     if (JSU.toInt(value) > 0) { CHECKSET_SHORT(rowspan); if (parent != null) parent.REPACK(); }
573         case "visible":     CHECKSET_FLAG(VISIBLE); RECONSTRAIN(); dirty();
574         case "packed":      CHECKSET_FLAG(PACKED); if (parent != null) { parent.REPACK(); } else { REPACK(); }
575         case "cursor":      setCursor(JSU.toString(value));
576         case "fill":        setFill(value);
577         case "clip":        CHECKSET_FLAG(CLIP); if (parent == null) dirty(); else parent.dirty();
578         case "rows": CHECKSET_SHORT(rows); if (rows==0){set(FIXED, COLS);if(cols==0)cols=1;} else set(FIXED, ROWS); REPACK();
579         case "cols": CHECKSET_SHORT(cols); if (cols==0){set(FIXED, ROWS);if(rows==0)rows=1;} else set(FIXED, COLS); REPACK();
580
581         // FIXME: remove
582         case "mouse":
583             int mousex = JSU.toInt(((JS)value).get(JSU.S("x")));
584             int mousey = JSU.toInt(((JS)value).get(JSU.S("y")));
585             getSurface()._mousex = localToGlobalX(mousex);
586             getSurface()._mousey = localToGlobalY(mousey);
587
588         case "Minimized": if (parent == null && getSurface() != null) getSurface().minimized = JSU.toBoolean(value);  // FEATURE
589         case "Maximized": if (parent == null && getSurface() != null) getSurface().maximized = JSU.toBoolean(value);  // FEATURE
590         case "Close":     if (parent == null && getSurface() != null) getSurface().dispose(true);
591         case "redirect":
592             for(Box cur = (Box)value; cur != null || cur == redirect; cur = cur.parent)
593                 if (cur == redirect) { redirect = (Box)value; return; }
594             JSU.error("redirect can only be set to a descendant of its current value");
595         case "fontsize": font = Font.getFont(font == null ? null : font.stream, JSU.toInt(value)); RECONSTRAIN(); dirty();
596         case "font":
597             if(!(value instanceof Fountain)) throw new JSExn("You can only put streams to the font property");
598             //FIXME: if (font == value) return;  // FIXME: unclone()
599             font = value == null ? null : Font.getFont((Fountain)value, font == null ? 10 : font.pointsize);
600             RECONSTRAIN();
601             dirty();
602         case "x": if (parent==null && Surface.fromBox(this)!=null) { CHECKSET_INT(x); }
603         case "y": if (parent==null && Surface.fromBox(this)!=null) { CHECKSET_INT(y); }
604         case "titlebar": if (getSurface()!=null) getSurface().setTitleBarText(JSU.toString(value)); super.put(name,value);
605         // FIXME: icon
606
607         case "Press1":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
608         case "Press2":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
609         case "Press3":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
610         case "Release1":      if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
611         case "Release2":      if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
612         case "Release3":      if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
613         case "Click1":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
614         case "Click2":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
615         case "Click3":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
616         case "DoubleClick1":  if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
617         case "DoubleClick2":  if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
618         case "DoubleClick3":  if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
619         case "KeyPressed":    if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
620         case "KeyReleased":   if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
621         case "Move":          if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
622         case "HScroll":       if (!test(STOP_UPWARD_PROPAGATION) && parent != null)
623             parent.putAndTriggerTraps(name, JSU.N(JSU.toFloat(value) * ((float)parent.fontSize()) / ((float)fontSize())));
624         case "VScroll":       if (!test(STOP_UPWARD_PROPAGATION) && parent != null)
625             parent.putAndTriggerTraps(name, JSU.N(JSU.toFloat(value) * ((float)parent.fontSize()) / ((float)fontSize())));
626
627         case "_Move":         propagateDownward(name, value, false);
628         case "_Press1":       propagateDownward(name, value, false);
629         case "_Press2":       propagateDownward(name, value, false);
630         case "_Press3":       propagateDownward(name, value, false);
631         case "_Release1":     propagateDownward(name, value, false);
632         case "_Release2":     propagateDownward(name, value, false);
633         case "_Release3":     propagateDownward(name, value, false);
634         case "_Click1":       propagateDownward(name, value, false);
635         case "_Click2":       propagateDownward(name, value, false);
636         case "_Click3":       propagateDownward(name, value, false);
637         case "_DoubleClick1": propagateDownward(name, value, false);
638         case "_DoubleClick2": propagateDownward(name, value, false);
639         case "_DoubleClick3": propagateDownward(name, value, false);
640         case "_KeyPressed":   propagateDownward(name, value, false);
641         case "_KeyReleased":  propagateDownward(name, value, false);
642         case "_HScroll":      propagateDownward(name, value, false);
643         case "_VScroll":      propagateDownward(name, value, false);
644
645         case "SizeChange":    return;
646         case "ChildChange":   return;
647         case "Enter":         return;
648         case "Leave":         return;
649
650         default:              super.put(name, value);
651         //#end
652     }
653
654     private void setCursor(String value) throws JSExn {
655         if (value == null) { clear(CURSOR); boxToCursor.remove(this); return; }
656         if (value.equals(boxToCursor.get(this))) return;
657         set(CURSOR);
658         boxToCursor.put(this, value);
659         Surface surface = getSurface();
660         if (surface == null) return;
661         String tempcursor = surface.cursor;
662         propagateDownward(null, null, false);
663         if (surface.cursor != tempcursor) surface.syncCursor();
664     }
665
666     private void setFill(JS value) throws JSExn {
667         if (value == null) {
668             if (texture == null && fillcolor == 0) return;
669             texture = null;
670             fillcolor = 0;
671         } else if (JSU.isString(value)) {
672             int newfillcolor = Color.stringToColor(JSU.toString(value));
673             if (newfillcolor == fillcolor) return;
674             fillcolor = newfillcolor;
675             texture = null;
676         } else {
677             Picture newtex = Picture.load((JS)value, this);
678             if (texture == newtex) return;
679             texture = newtex;
680             fillcolor = 0;
681             if (texture != null && texture.isLoaded) run(null);
682         }
683         dirty();
684     }
685
686     /**
687      *  Handles events which propagate down the box tree.  If obscured
688      *  is set, then we merely check for Enter/Leave.
689      */
690     private void propagateDownward(JS name_, JS value, boolean obscured) throws JSExn {
691
692         String name = JSU.toString(name_);
693         if (getSurface() == null) return;
694         int x = globalToLocalX(getSurface()._mousex);
695         int y = globalToLocalY(getSurface()._mousey);
696         boolean wasinside = test(MOUSEINSIDE);
697         boolean isinside = test(VISIBLE) && inside(x, y) && !obscured;
698         if (!wasinside && isinside) {
699             set(MOUSEINSIDE);
700             putAndTriggerTrapsAndCatchExceptions(JSU.S("Enter"), JSU.T);
701         }
702         if (isinside && test(CURSOR)) getSurface().cursor = (String)boxToCursor.get(this);
703         if (wasinside && !isinside) {
704             clear(MOUSEINSIDE);
705             putAndTriggerTrapsAndCatchExceptions(JSU.S("Leave"), JSU.T);
706         }
707
708         boolean found = false;
709         if (wasinside || isinside)
710             for(Box child = getChild(treeSize() - 1); child != null; child = child.prevSibling()) {
711                 boolean save_stop = child.test(STOP_UPWARD_PROPAGATION);
712                 JS value2 = value;
713                 if (name.equals("_HScroll") || name.equals("_VScroll"))
714                     value2 = JSU.N(JSU.toFloat(value) * ((float)child.fontSize()) / (float)fontSize());
715                 if (obscured || !child.inside(x - child.x, y - child.y)) {
716                     child.propagateDownward(name_, value2, true);
717                 } else try {
718                     found = true;
719                     child.clear(STOP_UPWARD_PROPAGATION);
720                     if (name != null) child.putAndTriggerTrapsAndCatchExceptions(name_, value2);
721                     else child.propagateDownward(name_, value2, obscured);
722                 } finally {
723                     if (save_stop) child.set(STOP_UPWARD_PROPAGATION); else child.clear(STOP_UPWARD_PROPAGATION);
724                 }
725                 if (child.inside(x - child.x, y - child.y))
726                     if (name != null && name.equals("_Move")) obscured = true;
727                     else break;
728             }
729
730         if (!obscured && !found)
731             if ("_Move".equals(name) || name.startsWith("_Release") || wasinside)
732                 if (name != null)
733                     putAndTriggerTrapsAndCatchExceptions(JSU.S(name.substring(1)), value);
734     }
735
736     /** figures out what box in this subtree of the Box owns the pixel at x,y relitave to the Surface */
737     public static Box whoIs(Box cur, int x, int y) {
738
739         if (cur.parent != null) throw new Error("whoIs may only be invoked on the root box of a surface");
740         int globalx = 0;
741         int globaly = 0;
742
743         // WARNING: this method is called from the event-queueing thread -- it may run concurrently with
744         // ANY part of Ibex, and is UNSYNCHRONIZED for performance reasons.  BE CAREFUL HERE.
745
746         if (!cur.test(VISIBLE)) return null;
747         if (!cur.inside(x - globalx, y - globaly)) return cur.parent == null ? cur : null;
748         OUTER: while(true) {
749             for(int i=cur.treeSize() - 1; i>=0; i--) {
750                 Box child = cur.getChild(i);
751                 if (child == null) continue;        // since this method is unsynchronized, we have to double-check
752                 globalx += child.x;
753                 globaly += child.y;
754                 if (child.test(VISIBLE) && child.inside(x - globalx, y - globaly)) { cur = child; continue OUTER; }
755                 globalx -= child.x;
756                 globaly -= child.y;
757             }
758             break;
759         }
760         return cur;
761     }
762
763
764     // Trivial Helper Methods (should be inlined) /////////////////////////////////////////
765
766     void mark_for_repack() { REPACK(); }
767     public Enumeration keys() { throw new Error("you cannot apply for..in to a " + this.getClass().getName()); }
768     public Box getRoot() { return parent == null ? this : parent.getRoot(); }
769     public Surface getSurface() { return Surface.fromBox(getRoot()); }
770     Box nextPackedSibling() { Box b = nextSibling(); return b == null || (b.test(PACKED | VISIBLE)) ? b : b.nextPackedSibling(); }
771     Box firstPackedChild() { Box b = getChild(0); return b == null || (b.test(PACKED | VISIBLE)) ? b : b.nextPackedSibling(); }
772     public int globalToLocalX(int x) { return parent == null ? x : parent.globalToLocalX(x - this.x); }
773     public int globalToLocalY(int y) { return parent == null ? y : parent.globalToLocalY(y - this.y); }
774     public int localToGlobalX(int x) { return parent == null ? x : parent.globalToLocalX(x + this.x); }
775     public int localToGlobalY(int y) { return parent == null ? y : parent.globalToLocalY(y + this.y); }
776
777     static short min(short a, short b) { if (a<b) return a; else return b; }
778     static int min(int a, int b) { if (a<b) return a; else return b; }
779     static float min(float a, float b) { if (a<b) return a; else return b; }
780
781     static short max(short a, short b) { if (a>b) return a; else return b; }
782     static int max(int a, int b) { if (a>b) return a; else return b; }
783     static float max(float a, float b) { if (a>b) return a; else return b; }
784
785     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; }
786     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; }
787     static int bound(int a, int b, int c) { if (c < b) return c; if (a > b) return a; return b; }
788     final boolean inside(int x, int y) { return test(VISIBLE) && x >= 0 && y >= 0 && x < width && y < height; }
789
790     void set(int mask) { flags |= mask; }
791     void set(int mask, boolean setclear) { if (setclear) set(mask); else clear(mask); }
792     void clear(int mask) { flags &= ~mask; }
793     public boolean test(int mask) { return ((flags & mask) == mask); }
794     
795
796     // Tree Handling //////////////////////////////////////////////////////////////////////
797
798     public final int getIndexInParent() { return parent == null ? 0 : parent.indexNode(this); }
799     public final Box nextSibling() { return parent == null ? null : parent.getChild(parent.indexNode(this) + 1); }
800     public final Box prevSibling() { return parent == null ? null : parent.getChild(parent.indexNode(this) - 1); }
801     public final Box getChild(int i) {
802         if (i < 0) return null;
803         if (i >= treeSize()) return null;
804         return (Box)getNode(i);
805     }
806
807     // Tree Manipulation /////////////////////////////////////////////////////////////////////
808
809     public void removeSelf() {
810         if (parent != null) { parent.removeChild(parent.indexNode(this)); return; }
811         Surface surface = Surface.fromBox(this); 
812         if (surface != null) surface.dispose(true);
813     }
814
815     /** remove the i^th child */
816     public void removeChild(int i) {
817         Box b = getChild(i);
818         b.RECONSTRAIN();
819         b.dirty();
820         b.clear(MOUSEINSIDE);
821         deleteNode(i);
822         b.parent = null;
823         REPACK();
824         putAndTriggerTrapsAndCatchExceptions(JSU.S("ChildChange"), b);
825     }
826     
827     public void put(int i, JS value) throws JSExn {
828         if (i < 0) return;
829             
830         if (value != null && !(value instanceof Box)) {
831             if (Log.on) JSU.warn("attempt to set a numerical property on a box to a non-box");
832             return;
833         }
834
835         if (redirect == null) {
836             if (value == null) putAndTriggerTrapsAndCatchExceptions(JSU.S("ChildChange"), getChild(i));
837             else JSU.warn("attempt to add/remove children to/from a node with a null redirect");
838
839         } else if (redirect != this) {
840             if (value != null) putAndTriggerTrapsAndCatchExceptions(JSU.S("ChildChange"), value);
841             redirect.put(i, value);
842             if (value == null) {
843                 Box b = (Box)redirect.get(JSU.N(i));
844                 if (b != null) putAndTriggerTrapsAndCatchExceptions(JSU.S("ChildChange"), b);
845             }
846
847         } else if (value == null) {
848             if (i < 0 || i > treeSize()) return;
849             Box b = getChild(i);
850             removeChild(i);
851             putAndTriggerTrapsAndCatchExceptions(JSU.S("ChildChange"), b);
852
853         } else {
854             Box b = (Box)value;
855
856             // check if box being moved is currently target of a redirect
857             for(Box cur = b.parent; cur != null; cur = cur.parent)
858                 if (cur.redirect == b) {
859                     if (Log.on) JSU.warn("attempt to move a box that is the target of a redirect");
860                     return;
861                 }
862
863             // check for recursive ancestor violation
864             for(Box cur = this; cur != null; cur = cur.parent)
865                 if (cur == b) {
866                     if (Log.on) JSU.warn("attempt to make a node a parent of its own ancestor");
867                     if (Log.on) Log.info(this, "box == " + this + "  ancestor == " + b);
868                     return;
869                 }
870
871             if (b.parent != null) b.parent.removeChild(b.parent.indexNode(b));
872             insertNode(i, b);
873             b.parent = this;
874             
875             // need both of these in case child was already uncalc'ed
876             b.REPACK();
877             REPACK();
878             
879             b.dirty(); 
880             putAndTriggerTrapsAndCatchExceptions(JSU.S("ChildChange"), b);
881         }
882     }
883     
884     public void putAndTriggerTrapsAndCatchExceptions(JS name, JS val) {
885         try {
886             putAndTriggerTraps(name, val);
887         } catch (JSExn e) {
888             JSU.log("caught js exception while putting to trap \""+ JSU.str(name)+"\"");
889             JSU.log(e);
890         } catch (Exception e) {
891             JSU.log("caught exception while putting to trap \""+ JSU.str(name)+"\"");
892             JSU.log(e);
893         }
894     }
895     
896     // BalancedTree functions
897     private void insertNode(int p, Box b) {
898         if(bt == null) bt = new BalancedTree();
899         bt.insertNode(p,b);
900     }
901     
902     private int treeSize() { return bt == null ? 0 : bt.treeSize(); }
903     private int indexNode(Box b) { return bt == null ? -1 : bt.indexNode(b); }
904     private void deleteNode(int p) { bt.deleteNode(p); }
905     private Box getNode(int p) { return (Box)bt.getNode(p); }
906 }