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