ibex.core updates for new api
[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;
61     static {
62         try { DEFAULT_FONT = Font.getFont(Main.builtin.get(JS.S("fonts/vera/Vera.ttf")), 10); }
63         catch(JSExn e) { throw new Error("Error loading default font: " + e); }
64     }
65
66
67     // Flags //////////////////////////////////////////////////////////////////////
68
69     static final int MOUSEINSIDE  = 0x00000001;
70     static final int VISIBLE      = 0x00000002;
71     static final int PACKED       = 0x00000004;
72     public static final int HSHRINK      = 0x00000008;
73     public static final int VSHRINK      = 0x00000010;
74     static final int BLACK        = 0x00000020;  // for red-black code
75
76     static final int FIXED        = 0x00000040;
77     static final boolean ROWS     = true;
78     static final boolean COLS     = false;
79
80     static final int ISROOT       = 0x00000080;
81     static final int REPACK       = 0x00000100;
82     static final int RECONSTRAIN  = 0x00000200;
83     static final int REPLACE      = 0x00000400;
84
85     static final int ALIGN_TOP    = 0x00001000;
86     static final int ALIGN_BOTTOM = 0x00002000;
87     static final int ALIGN_LEFT   = 0x00004000;
88     static final int ALIGN_RIGHT  = 0x00008000;
89     static final int ALIGNS       = 0x0000f000;
90     static final int CURSOR       = 0x00010000;  // if true, this box has a cursor in the cursor hash; FEATURE: GC issues?
91     static final int CLIP         = 0x00020000;
92     static final int STOP_UPWARD_PROPAGATION    = 0x00040000;
93     static final int MOVED         = 0x00080000;
94
95
96     // Instance Data //////////////////////////////////////////////////////////////////////
97
98     Box parent = null;
99     Box redirect = this;
100     int flags = VISIBLE | PACKED | REPACK | RECONSTRAIN | REPLACE | FIXED | STOP_UPWARD_PROPAGATION | CLIP | MOVED;
101
102     private String text = null;
103     private Font font = DEFAULT_FONT; 
104     private Picture texture = null;
105     private short strokewidth = 1;
106     public int fillcolor = 0x00000000;
107     private int strokecolor = 0xFF000000;
108
109     private int aspect = 0;
110
111     // specified directly by user
112     public int minwidth = 0;
113     public int maxwidth = Integer.MAX_VALUE;
114     public int minheight = 0;
115     public int maxheight = Integer.MAX_VALUE;
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 ax = 0;   // FEATURE: roll these into x/y; requires lots of changes
127     public int ay = 0;   // FEATURE: roll these into x/y; requires lots of changes; perhaps y()?
128     public int width = 0;
129     public int height = 0;
130     public int contentwidth = 0;      // == max(minwidth, textwidth, sum(child.contentwidth))
131     public int contentheight = 0;
132
133     private Path path = null;
134     /*
135     private Affine transform = null;
136     private VectorGraphics.RasterPath rpath = null;
137     private Affine rtransform = null;
138     */
139
140     // Instance Methods /////////////////////////////////////////////////////////////////////
141
142     public final int fontSize() { return font == null ? DEFAULT_FONT.pointsize : font.pointsize; }
143
144     /** invoked when a resource needed to render ourselves finishes loading */
145     public void perform() throws JSExn {
146         if (texture == null) { Log.warn(Box.class, "perform() called with null texture"); return; }
147         if (texture.isLoaded) {
148             setWidth(max(texture.width, minwidth), maxwidth); 
149             setHeight(max(texture.height, minheight), maxheight); 
150             dirty(); }
151         else { JS res = texture.stream; texture = null; throw new JSExn("image not found: "+res.unclone()); }
152     }
153
154     // FEATURE: use cx2/cy2 format
155     /** Adds the intersection of (x,y,w,h) and the node's current actual geometry to the Surface's dirty list */
156     public void dirty() { dirty(0, 0, width, height); }
157     public void dirty(int x, int y, int w, int h) {
158         for(Box cur = this; cur != null; cur = cur.parent) {
159             // x and y have a different meaning on the root box
160             if (cur.parent != null && cur.test(CLIP)) {
161                 w = min(x + w, cur.width) - max(x, 0);
162                 h = min(y + h, cur.height) - max(y, 0);
163                 x = max(x, 0);
164                 y = max(y, 0);
165             }
166             if (w <= 0 || h <= 0) return;
167             if (cur.parent == null && cur.getSurface() != null) cur.getSurface().dirty(x, y, w, h);
168             x += cur.x;
169             y += cur.y;
170         }
171     }
172
173
174     // Reflow ////////////////////////////////////////////////////////////////////////////////////////
175
176     /** should only be invoked on the root box */
177     public void reflow() {
178         pack();
179         resize(x, y,
180                test(HSHRINK) ? contentwidth : maxwidth,
181                test(VSHRINK) ? contentheight : maxheight);
182         place();
183     }
184     
185     private static Box[] frontier = new Box[65535];
186     /** pack the boxes into rows and columns, compute contentwidth */
187     public void pack() {
188         if (!test(REPACK)) { constrain(); return; }
189         boolean haskid = false;
190         for(Box child = getChild(0); child != null; child = child.nextSibling()) { haskid = true; child.pack(); }
191         if (!haskid) { clear(REPACK); constrain(); return; }
192         int frontier_size = 0;
193         //#repeat COLS/ROWS rows/cols cols/rows col/row row/col colspan/rowspan rowspan/colspan \
194         //        contentheight/contentwidth contentwidth/contentheight
195         if (test(FIXED) == COLS) {
196             rows = 0;
197             for(Box child = getChild(0); child != null; child = child.nextSibling()) {
198                 if (!child.test(PACKED) || !child.test(VISIBLE)) continue;
199                 if (cols == 1) { child.row = rows; rows += child.rowspan; child.col = 0; continue; }
200                 child.col = (short)(frontier_size <= 0 ? 0 : (frontier[frontier_size-1].col + frontier[frontier_size-1].colspan));
201                 child.row = (short)(frontier_size <= 0 ? 0 : frontier[frontier_size-1].row);
202                 if (child.col + min(cols,child.colspan) > cols) { child.col = 0; child.row++; }
203                 for(int i=0; i<frontier_size; i++)
204                     if (frontier[i].row + frontier[i].rowspan <= child.row) {
205                         frontier[i--] = frontier[--frontier_size]; frontier[frontier_size] = null;
206                     } else if (frontier[i].col<child.col+min(cols,child.colspan)&&frontier[i].col+frontier[i].colspan>child.col) {
207                         child.col = (short)(frontier[i].col + frontier[i].colspan);
208                         if (child.col + min(cols,child.colspan) > cols) {
209                             child.row = (short)(frontier[i].row + frontier[i].rowspan);
210                             for(i--; i>0; i--) child.row = (short)min(row, frontier[i].row + frontier[i].rowspan);
211                             child.col = (short)0;
212                         }
213                         i = -1;
214                     } else break;
215                 frontier[frontier_size++] = child;
216             }
217             for(int i=0; i<frontier_size; i++){ rows=(short)max(rows, frontier[i].row + frontier[i].rowspan); frontier[i] = null; }
218         }
219         //#end
220         clear(REPACK);
221         set(RECONSTRAIN);   // FIXME: be smarter / more incremental
222         constrain();
223     }
224
225     public void constrain() {
226         if (!test(RECONSTRAIN)) return;
227         solve(true);
228         //#repeat contentwidth/contentheight contentheight/contentwidth minwidth/minheight row/col col/row \
229         //        textwidth/textheight maxwidth/maxheight cols/rows rows/cols colspan/rowspan rowspan/colspan
230         contentwidth = bound(minwidth,
231                              max(contentwidth, font == null || text == null ? 0 : font.textwidth(text)),
232                              maxwidth);
233         //#end
234         set(REPLACE); // FIXME: be smarter / more incremental
235     }
236     
237     private final static JS SIZECHANGE = JS.S("SizeChange");
238     
239     void resize(int x, int y, int width, int height) {
240         if (x == this.x && y == this.y && width == this.width && height == this.height) return;
241         boolean sizechange = (this.width != width || this.height != height) && hasTrap(SIZECHANGE);
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, 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 - Math.abs(child.ax));
360                 child_height = child.test(VSHRINK) ? child.contentheight : min(child.maxheight, height - Math.abs(child.ay));
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 = child.ax + (child.test(ALIGN_RIGHT) ? gap_x : !child.test(ALIGN_LEFT) ? gap_x / 2 : 0);
366                 child_y = child.ay + (child.test(ALIGN_BOTTOM) ? gap_y : !child.test(ALIGN_TOP) ? gap_y / 2 : 0);
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 ALIGN_RIGHT/ALIGN_BOTTOM ALIGN_LEFT/ALIGN_TOP 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 += (child.test(ALIGN_RIGHT) ? diff : child.test(ALIGN_LEFT) ? 0 : 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 + (test(ALIGN_RIGHT) ? gap_x : !test(ALIGN_LEFT) ? gap_x/2 : 0);
429             int text_y = globaly + (test(ALIGN_BOTTOM) ? gap_y : !test(ALIGN_TOP) ? gap_y/2 : 0);
430             font.rasterizeGlyphs(text, buf, strokecolor, text_x, text_y, cx1, cy1, cx2, cy2);
431         }
432
433         if (path != null) path.realize(Affine.translate(globalx, globaly)).stroke(buf, 1, 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   
443     public JS callMethod(JS method, JS a0, JS a1, JS a2, JS[] rest, int nargs) throws JSExn {
444         switch (nargs) {
445             case 1: {
446                 //#switch(JS.toString(method))
447                 case "indexof":
448                     Box b = (Box)a0;
449                     if (b.parent != this)
450                         return (redirect == null || redirect == this) ?
451                             N(-1) :
452                             redirect.callMethod(method, a0, a1, a2, rest, nargs);
453                     return N(b.getIndexInParent());
454
455                 case "distanceto":
456                     Box b = (Box)a0;
457                     JS ret = new JS.O();
458                     ret.put(JS.S("x"), N(b.localToGlobalX(0) - localToGlobalX(0)));
459                     ret.put(JS.S("y"), N(b.localToGlobalY(0) - localToGlobalY(0)));
460                     return ret;
461
462                 //#end
463             }
464         }
465         return super.callMethod(method, a0, a1, a2, rest, nargs);
466     }
467
468     public JS get(JS name) throws JSExn {
469         if (JS.isInt(name))
470             return redirect == null ? null : redirect == this ? getChild(JS.toInt(name)) : redirect.get(name);
471
472         //#switch(JS.toString(name))
473         case "surface": return parent == null ? null : parent.getAndTriggerTraps(name);
474         case "indexof": return METHOD;
475         case "distanceto": return METHOD;
476         case "text": return JS.S(text);
477         case "path": {
478             if (path != null) return JS.S(path.toString());
479             if (text == null) return null;
480             if (font == null) return null;
481             String ret = "";
482             for(int i=0; i<text.length(); i++) ret += font.glyphs[text.charAt(i)].path;
483             return JS.S(ret);
484         }
485         case "fill": return JS.S(Color.colorToString(fillcolor));
486         case "strokecolor": return JS.S(Color.colorToString(strokecolor));
487         case "textcolor": return JS.S(Color.colorToString(strokecolor));
488         case "font": return font == null ? null : font.stream;
489         case "fontsize": return font == null ? N(10) : N(font.pointsize);
490         case "strokewidth": return N(strokewidth);
491         case "align": return JS.S(alignToString());
492         case "thisbox": return this;
493         case "shrink": return B(test(HSHRINK) || test(VSHRINK));
494         case "hshrink": return B(test(HSHRINK));
495         case "vshrink": return B(test(VSHRINK));
496         case "aspect": return N(aspect);
497         case "x": return (parent == null || !test(VISIBLE)) ? N(0) : test(PACKED) ? N(x) : N(ax);
498         case "y": return (parent == null || !test(VISIBLE)) ? N(0) : test(PACKED) ? N(y) : N(ay);
499         case "cols": return test(FIXED) == COLS ? N(cols) : N(0);
500         case "rows": return test(FIXED) == ROWS ? N(rows) : N(0);
501         case "colspan": return N(colspan);
502         case "rowspan": return N(rowspan);
503         case "width": getRoot().reflow(); return N(width);
504         case "height": getRoot().reflow(); return N(height);
505         case "minwidth": return N(minwidth);
506         case "maxwidth": return N(maxwidth);
507         case "minheight": return N(minheight);
508         case "maxheight": return N(maxheight);
509         case "clip": return B(test(CLIP));
510         case "visible": return B(test(VISIBLE) && (parent == null || (parent.get(JS.S("visible")) == T)));
511         case "packed": return B(test(PACKED));
512         case "globalx": return N(localToGlobalX(0));
513         case "globaly": return N(localToGlobalY(0));
514         case "cursor": return test(CURSOR) ? JS.S((String)boxToCursor.get(this)) : null;
515         case "mouse":
516             if (getSurface() == null) return null;
517             if (getSurface()._mousex == Integer.MAX_VALUE)
518                 throw new JSExn("you cannot read from the box.mouse property in background thread context");
519             return new Mouse();
520         case "numchildren": return redirect == null ? N(0) : redirect == this ? N(treeSize()) : redirect.get(JS.S("numchildren"));
521         case "redirect": return redirect == null ? null : redirect == this ? T : redirect.get(JS.S("redirect"));
522         case "Minimized": if (parent == null && getSurface() != null) return B(getSurface().minimized);
523         default: return super.get(name);
524         //#end
525         throw new Error("unreachable"); // unreachable
526     }
527
528     private class Mouse extends JS implements JS.Cloneable {
529         public JS get(JS key) throws JSExn {
530             //#switch(JS.toString(key))
531             case "x": return N(globalToLocalX(getSurface()._mousex));
532             case "y": return N(globalToLocalY(getSurface()._mousey));
533
534             // this might not get recomputed if we change mousex/mousey...
535             case "inside": return B(test(MOUSEINSIDE));
536             //#end
537             return null;
538         }
539     }
540
541     //#repeat setWidth/setHeight minwidth/minheight maxwidth/maxheight pendingWidth/pendingHeight
542     public void setWidth(int min, int max) {
543         // FIXME: deal with conflicting min/max
544         if (this.minwidth == min && this.maxwidth == max) return;
545         this.minwidth = min;
546         this.maxwidth = max;
547         RECONSTRAIN();
548         if (parent != null || getSurface() == null) return;
549         getSurface().pendingWidth = maxwidth;
550
551         // FIXME: the repeat doesn't work right here
552         getSurface().setMinimumSize(minwidth, minheight, minwidth != maxwidth || minheight != maxheight);
553     }
554     //#end
555
556     public void put(JS name, JS value) throws JSExn {
557         if (JS.isInt(name)) { put(JS.toInt(name), value); return; }
558         //#switch(JS.toString(name))
559         case "thisbox":     if (value == null) removeSelf();
560         case "text":        { String s = value == null ?  "" : JS.toString(value); CHECKSET_STRING(text); RECONSTRAIN(); dirty(); }
561         case "strokecolor": value = N(Color.stringToColor(JS.toString(value))); CHECKSET_INT(strokecolor); dirty();
562         case "textcolor":   value = N(Color.stringToColor(JS.toString(value))); CHECKSET_INT(strokecolor); dirty();
563         case "strokewidth": CHECKSET_SHORT(strokewidth); dirty();
564         case "shrink":      CHECKSET_FLAG(HSHRINK | VSHRINK); RECONSTRAIN();
565         case "hshrink":     CHECKSET_FLAG(HSHRINK); RECONSTRAIN();
566         case "vshrink":     CHECKSET_FLAG(VSHRINK); RECONSTRAIN();
567         case "path":        path = Path.parse(toString(value)); RECONSTRAIN(); dirty();
568         case "width":       setWidth(toInt(value), toInt(value));
569         case "height":      setHeight(toInt(value), toInt(value));
570         case "maxwidth":    setWidth(minwidth, toInt(value));
571         case "minwidth":    setWidth(toInt(value), maxwidth);
572         case "maxheight":   setHeight(minheight, toInt(value));
573         case "minheight":   setHeight(toInt(value), maxheight);
574         case "colspan":     if (toInt(value) > 0) { CHECKSET_SHORT(colspan); if (parent != null) parent.REPACK(); }
575         case "rowspan":     if (toInt(value) > 0) { CHECKSET_SHORT(rowspan); if (parent != null) parent.REPACK(); }
576         case "visible":     CHECKSET_FLAG(VISIBLE); RECONSTRAIN(); dirty();
577         case "packed":      CHECKSET_FLAG(PACKED); if (parent != null) { parent.REPACK(); } else { REPACK(); }
578         case "align":       clear(ALIGNS); setAlign(value == null ? "center" : JS.toString(value)); REPLACE();
579         case "cursor":      setCursor(JS.toString(value));
580         case "fill":        setFill(value);
581         case "clip":        CHECKSET_FLAG(CLIP); if (parent == null) dirty(); else parent.dirty();
582         case "rows": CHECKSET_SHORT(rows); if (rows==0){set(FIXED, COLS);if(cols==0)cols=1;} else set(FIXED, ROWS); REPACK();
583         case "cols": CHECKSET_SHORT(cols); if (cols==0){set(FIXED, ROWS);if(rows==0)rows=1;} else set(FIXED, COLS); REPACK();
584
585         // FIXME: remove
586         case "mouse":
587             int mousex = toInt(((JS)value).get(JS.S("x")));
588             int mousey = toInt(((JS)value).get(JS.S("y")));
589             getSurface()._mousex = localToGlobalX(mousex);
590             getSurface()._mousey = localToGlobalY(mousey);
591
592         case "Minimized": if (parent == null && getSurface() != null) getSurface().minimized = toBoolean(value);  // FEATURE
593         case "Maximized": if (parent == null && getSurface() != null) getSurface().maximized = toBoolean(value);  // FEATURE
594         case "Close":     if (parent == null && getSurface() != null) getSurface().dispose(true);
595         case "redirect":
596             for(Box cur = (Box)value; cur != null || cur == redirect; cur = cur.parent)
597                 if (cur == redirect) { redirect = (Box)value; return; }
598             JS.error("redirect can only be set to a descendant of its current value");
599         case "fontsize": font = Font.getFont(font == null ? null : font.stream, toInt(value)); RECONSTRAIN(); dirty();
600         case "font":
601             if(!(value instanceof Stream)) throw new JSExn("You can only put streams to the font property");
602             //FIXME: if (font == value) return;  // FIXME: unclone()
603             font = value == null ? null : Font.getFont((Stream)value, font == null ? 10 : font.pointsize);
604             RECONSTRAIN();
605             dirty();
606         case "x": if (parent==null && Surface.fromBox(this)!=null) {
607             CHECKSET_INT(x);
608         } else {
609             if (test(PACKED) && parent != null) return;
610             CHECKSET_INT(ax);
611             REPLACE();
612         }
613         case "y": if (parent==null && Surface.fromBox(this)!=null) {
614             CHECKSET_INT(y);
615         } else {
616             if (test(PACKED) && parent != null) return;
617             CHECKSET_INT(ay);
618             REPLACE();
619         }
620         case "titlebar": if (getSurface()!=null) getSurface().setTitleBarText(toString(value)); super.put(name,value);
621         // FIXME: icon
622
623         case "Press1":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
624         case "Press2":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
625         case "Press3":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
626         case "Release1":      if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
627         case "Release2":      if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
628         case "Release3":      if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
629         case "Click1":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
630         case "Click2":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
631         case "Click3":        if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
632         case "DoubleClick1":  if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
633         case "DoubleClick2":  if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
634         case "DoubleClick3":  if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
635         case "KeyPressed":    if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
636         case "KeyReleased":   if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
637         case "Move":          if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
638         case "HScroll":       if (!test(STOP_UPWARD_PROPAGATION) && parent != null)
639             parent.putAndTriggerTraps(name, N(JS.toFloat(value) * ((float)parent.fontSize()) / ((float)fontSize())));
640         case "VScroll":       if (!test(STOP_UPWARD_PROPAGATION) && parent != null)
641             parent.putAndTriggerTraps(name, N(JS.toFloat(value) * ((float)parent.fontSize()) / ((float)fontSize())));
642
643         case "_Move":         propagateDownward(name, value, false);
644         case "_Press1":       propagateDownward(name, value, false);
645         case "_Press2":       propagateDownward(name, value, false);
646         case "_Press3":       propagateDownward(name, value, false);
647         case "_Release1":     propagateDownward(name, value, false);
648         case "_Release2":     propagateDownward(name, value, false);
649         case "_Release3":     propagateDownward(name, value, false);
650         case "_Click1":       propagateDownward(name, value, false);
651         case "_Click2":       propagateDownward(name, value, false);
652         case "_Click3":       propagateDownward(name, value, false);
653         case "_DoubleClick1": propagateDownward(name, value, false);
654         case "_DoubleClick2": propagateDownward(name, value, false);
655         case "_DoubleClick3": propagateDownward(name, value, false);
656         case "_KeyPressed":   propagateDownward(name, value, false);
657         case "_KeyReleased":  propagateDownward(name, value, false);
658         case "_HScroll":      propagateDownward(name, value, false);
659         case "_VScroll":      propagateDownward(name, value, false);
660
661         case "SizeChange":    return;
662         case "ChildChange":   return;
663         case "Enter":         return;
664         case "Leave":         return;
665
666         default:              super.put(name, value);
667         //#end
668     }
669
670     private String alignToString() {
671         switch(flags & ALIGNS) {
672             case (ALIGN_TOP | ALIGN_LEFT): return "topleft";
673             case (ALIGN_BOTTOM | ALIGN_LEFT): return "bottomleft";
674             case (ALIGN_TOP | ALIGN_RIGHT): return "topright";
675             case (ALIGN_BOTTOM | ALIGN_RIGHT): return "bottomright";
676             case ALIGN_TOP: return "top";
677             case ALIGN_BOTTOM: return "bottom";
678             case ALIGN_LEFT: return "left";
679             case ALIGN_RIGHT: return "right";
680             case 0: return "center";
681             default: throw new Error("invalid alignment flags: " + (flags & ALIGNS));
682         }
683     }
684
685     private void setAlign(String value) {
686         clear(ALIGNS);
687         //#switch(value)
688         case "topleft": set(ALIGN_TOP | ALIGN_LEFT);
689         case "bottomleft": set(ALIGN_BOTTOM | ALIGN_LEFT);
690         case "topright": set(ALIGN_TOP | ALIGN_RIGHT);
691         case "bottomright": set(ALIGN_BOTTOM | ALIGN_RIGHT);
692         case "top": set(ALIGN_TOP);
693         case "bottom": set(ALIGN_BOTTOM);
694         case "left": set(ALIGN_LEFT);
695         case "right": set(ALIGN_RIGHT);
696         default: JS.log("invalid alignment \"" + value + "\"");
697         //#end
698     }
699     
700     private void setCursor(String value) throws JSExn {
701         if (value == null) { clear(CURSOR); boxToCursor.remove(this); return; }
702         if (value.equals(boxToCursor.get(this))) return;
703         set(CURSOR);
704         boxToCursor.put(this, value);
705         Surface surface = getSurface();
706         if (surface == null) return;
707         String tempcursor = surface.cursor;
708         propagateDownward(null, null, false);
709         if (surface.cursor != tempcursor) surface.syncCursor();
710     }
711
712     private void setFill(JS value) throws JSExn {
713         if (value == null) {
714             if (texture == null && fillcolor == 0) return;
715             texture = null;
716             fillcolor = 0;
717         } else if (JS.isString(value)) {
718             int newfillcolor = Color.stringToColor(JS.toString(value));
719             if (newfillcolor == fillcolor) return;
720             fillcolor = newfillcolor;
721             texture = null;
722         } else {
723             Picture newtex = Picture.load((JS)value, this);
724             if (texture == newtex) return;
725             texture = newtex;
726             fillcolor = 0;
727             if (texture != null && texture.isLoaded) perform();
728         }
729         dirty();
730     }
731
732     /**
733      *  Handles events which propagate down the box tree.  If obscured
734      *  is set, then we merely check for Enter/Leave.
735      */
736     private void propagateDownward(JS name_, JS value, boolean obscured) throws JSExn {
737
738         String name = JS.toString(name_);
739         if (getSurface() == null) return;
740         int x = globalToLocalX(getSurface()._mousex);
741         int y = globalToLocalY(getSurface()._mousey);
742         boolean wasinside = test(MOUSEINSIDE);
743         boolean isinside = test(VISIBLE) && inside(x, y) && !obscured;
744         if (!wasinside && isinside) {
745             set(MOUSEINSIDE);
746             putAndTriggerTrapsAndCatchExceptions(JS.S("Enter"), T);
747         }
748         if (isinside && test(CURSOR)) getSurface().cursor = (String)boxToCursor.get(this);
749         if (wasinside && !isinside) {
750             clear(MOUSEINSIDE);
751             putAndTriggerTrapsAndCatchExceptions(JS.S("Leave"), T);
752         }
753
754         boolean found = false;
755         if (wasinside || isinside)
756             for(Box child = getChild(treeSize() - 1); child != null; child = child.prevSibling()) {
757                 boolean save_stop = child.test(STOP_UPWARD_PROPAGATION);
758                 JS value2 = value;
759                 if (name.equals("_HScroll") || name.equals("_VScroll"))
760                     value2 = N(JS.toFloat(value) * ((float)child.fontSize()) / (float)fontSize());
761                 if (obscured || !child.inside(x - child.x, y - child.y)) {
762                     child.propagateDownward(name_, value2, true);
763                 } else try {
764                     found = true;
765                     child.clear(STOP_UPWARD_PROPAGATION);
766                     if (name != null) child.putAndTriggerTrapsAndCatchExceptions(name_, value2);
767                     else child.propagateDownward(name_, value2, obscured);
768                 } finally {
769                     if (save_stop) child.set(STOP_UPWARD_PROPAGATION); else child.clear(STOP_UPWARD_PROPAGATION);
770                 }
771                 if (child.inside(x - child.x, y - child.y))
772                     if (name != null && name.equals("_Move")) obscured = true;
773                     else break;
774             }
775
776         if (!obscured && !found)
777             if ("_Move".equals(name) || name.startsWith("_Release") || wasinside)
778                 if (name != null)
779                     putAndTriggerTrapsAndCatchExceptions(JS.S(name.substring(1)), value);
780     }
781
782     /** figures out what box in this subtree of the Box owns the pixel at x,y relitave to the Surface */
783     public static Box whoIs(Box cur, int x, int y) {
784
785         if (cur.parent != null) throw new Error("whoIs may only be invoked on the root box of a surface");
786         int globalx = 0;
787         int globaly = 0;
788
789         // WARNING: this method is called from the event-queueing thread -- it may run concurrently with
790         // ANY part of Ibex, and is UNSYNCHRONIZED for performance reasons.  BE CAREFUL HERE.
791
792         if (!cur.test(VISIBLE)) return null;
793         if (!cur.inside(x - globalx, y - globaly)) return cur.parent == null ? cur : null;
794         OUTER: while(true) {
795             for(int i=cur.treeSize() - 1; i>=0; i--) {
796                 Box child = cur.getChild(i);
797                 if (child == null) continue;        // since this method is unsynchronized, we have to double-check
798                 globalx += child.x;
799                 globaly += child.y;
800                 if (child.test(VISIBLE) && child.inside(x - globalx, y - globaly)) { cur = child; continue OUTER; }
801                 globalx -= child.x;
802                 globaly -= child.y;
803             }
804             break;
805         }
806         return cur;
807     }
808
809
810     // Trivial Helper Methods (should be inlined) /////////////////////////////////////////
811
812     void mark_for_repack() { REPACK(); }
813     public Enumeration keys() { throw new Error("you cannot apply for..in to a " + this.getClass().getName()); }
814     public Box getRoot() { return parent == null ? this : parent.getRoot(); }
815     public Surface getSurface() { return Surface.fromBox(getRoot()); }
816     Box nextPackedSibling() { Box b = nextSibling(); return b == null || (b.test(PACKED | VISIBLE)) ? b : b.nextPackedSibling(); }
817     Box firstPackedChild() { Box b = getChild(0); return b == null || (b.test(PACKED | VISIBLE)) ? b : b.nextPackedSibling(); }
818     public int globalToLocalX(int x) { return parent == null ? x : parent.globalToLocalX(x - this.x); }
819     public int globalToLocalY(int y) { return parent == null ? y : parent.globalToLocalY(y - this.y); }
820     public int localToGlobalX(int x) { return parent == null ? x : parent.globalToLocalX(x + this.x); }
821     public int localToGlobalY(int y) { return parent == null ? y : parent.globalToLocalY(y + this.y); }
822
823     static short min(short a, short b) { if (a<b) return a; else return b; }
824     static int min(int a, int b) { if (a<b) return a; else return b; }
825     static float min(float a, float b) { if (a<b) return a; else return b; }
826
827     static short max(short a, short b) { if (a>b) return a; else return b; }
828     static int max(int a, int b) { if (a>b) return a; else return b; }
829     static float max(float a, float b) { if (a>b) return a; else return b; }
830
831     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; }
832     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; }
833     static int bound(int a, int b, int c) { if (c < b) return c; if (a > b) return a; return b; }
834     final boolean inside(int x, int y) { return test(VISIBLE) && x >= 0 && y >= 0 && x < width && y < height; }
835
836     void set(int mask) { flags |= mask; }
837     void set(int mask, boolean setclear) { if (setclear) set(mask); else clear(mask); }
838     void clear(int mask) { flags &= ~mask; }
839     public boolean test(int mask) { return ((flags & mask) == mask); }
840     
841
842     // Tree Handling //////////////////////////////////////////////////////////////////////
843
844     public final int getIndexInParent() { return parent == null ? 0 : parent.indexNode(this); }
845     public final Box nextSibling() { return parent == null ? null : parent.getChild(parent.indexNode(this) + 1); }
846     public final Box prevSibling() { return parent == null ? null : parent.getChild(parent.indexNode(this) - 1); }
847     public final Box getChild(int i) {
848         if (i < 0) return null;
849         if (i >= treeSize()) return null;
850         return (Box)getNode(i);
851     }
852
853     // Tree Manipulation /////////////////////////////////////////////////////////////////////
854
855     public void removeSelf() {
856         if (parent != null) { parent.removeChild(parent.indexNode(this)); return; }
857         Surface surface = Surface.fromBox(this); 
858         if (surface != null) surface.dispose(true);
859     }
860
861     /** remove the i^th child */
862     public void removeChild(int i) {
863         Box b = getChild(i);
864         b.RECONSTRAIN();
865         b.dirty();
866         b.clear(MOUSEINSIDE);
867         deleteNode(i);
868         b.parent = null;
869         REPACK();
870         putAndTriggerTrapsAndCatchExceptions(JS.S("ChildChange"), b);
871     }
872     
873     public void put(int i, JS value) throws JSExn {
874         if (i < 0) return;
875             
876         if (value != null && !(value instanceof Box)) {
877             if (Log.on) JS.warn("attempt to set a numerical property on a box to a non-box");
878             return;
879         }
880
881         if (redirect == null) {
882             if (value == null) putAndTriggerTrapsAndCatchExceptions(JS.S("ChildChange"), getChild(i));
883             else JS.warn("attempt to add/remove children to/from a node with a null redirect");
884
885         } else if (redirect != this) {
886             if (value != null) putAndTriggerTrapsAndCatchExceptions(JS.S("ChildChange"), value);
887             redirect.put(i, value);
888             if (value == null) {
889                 Box b = (Box)redirect.get(JS.N(i));
890                 if (b != null) putAndTriggerTrapsAndCatchExceptions(JS.S("ChildChange"), b);
891             }
892
893         } else if (value == null) {
894             if (i < 0 || i > treeSize()) return;
895             Box b = getChild(i);
896             removeChild(i);
897             putAndTriggerTrapsAndCatchExceptions(JS.S("ChildChange"), b);
898
899         } else {
900             Box b = (Box)value;
901
902             // check if box being moved is currently target of a redirect
903             for(Box cur = b.parent; cur != null; cur = cur.parent)
904                 if (cur.redirect == b) {
905                     if (Log.on) JS.warn("attempt to move a box that is the target of a redirect");
906                     return;
907                 }
908
909             // check for recursive ancestor violation
910             for(Box cur = this; cur != null; cur = cur.parent)
911                 if (cur == b) {
912                     if (Log.on) JS.warn("attempt to make a node a parent of its own ancestor");
913                     if (Log.on) Log.info(this, "box == " + this + "  ancestor == " + b);
914                     return;
915                 }
916
917             if (b.parent != null) b.parent.removeChild(b.parent.indexNode(b));
918             insertNode(i, b);
919             b.parent = this;
920             
921             // need both of these in case child was already uncalc'ed
922             b.REPACK();
923             REPACK();
924             
925             b.dirty(); 
926             putAndTriggerTrapsAndCatchExceptions(JS.S("ChildChange"), b);
927         }
928     }
929     
930     public void putAndTriggerTrapsAndCatchExceptions(JS name, JS val) {
931         try {
932             putAndTriggerTraps(name, val);
933         } catch (JSExn e) {
934             JS.log("caught js exception while putting to trap \""+ JS.debugToString(name)+"\"");
935             JS.log(e);
936         } catch (Exception e) {
937             JS.log("caught exception while putting to trap \""+ JS.debugToString(name)+"\"");
938             JS.log(e);
939         }
940     }
941 }