2 // Copyright 2004 Adam Megacz, see the COPYING file for licensing [GPL]
5 // FEATURE: reflow before allowing js to read from width/height
6 // FEATURE: fastpath for rows=1/cols=1
7 // FEATURE: mark to reflow starting with a certain child
8 // FEATURE: separate mark_for_reflow and mark_for_resize
9 // FEATURE: make all methods final
10 // FEATURE: use a linked list for the "frontier" when packing
11 // FEATURE: or else have a way to mark a column "same as last one"?
12 // FEATURE: reintroduce surface.abort
16 import org.ibex.util.*;
17 import org.ibex.translators.*;
21 * Encapsulates the data for a single Ibex box as well as all layout
25 * <p>The rendering process consists of four phases; each requires
26 * one DFS pass over the tree</p>
27 * <ol><li> <b>repacking</b>: children of a box are packed into columns
28 * and rows according to their colspan/rowspan attributes and
30 * <ol><li> <b>reconstraining</b>: Minimum and maximum sizes of columns are computed.
31 * <li> <b>resizing</b>: width/height and x/y positions of children
32 * are assigned, and PosChange/SizeChanges are triggered.
33 * <li> <b>repainting</b>: children draw their content onto the PixelBuffer.
36 * The first three passes together are called the <i>reflow</i> phase.
37 * Reflowing is done in a seperate pass since PosChanges and
38 * SizeChanges trigger an Surface.abort; if rendering were done in the same
39 * pass, rendering work done prior to the Surface.abort would be wasted.
41 public final class Box extends JSScope implements Scheduler.Task {
43 // Macros //////////////////////////////////////////////////////////////////////
46 //#define MARK_REPACK for(Box b2 = this; b2 != null && !b2.test(REPACK); b2 = b2.parent) b2.set(REPACK);
47 //#define MARK_REPACK_b for(Box b2 = b; b2 != null && !b2.test(REPACK); b2 = b2.parent) b2.set(REPACK);
48 //#define MARK_REPACK_parent for(Box b2 = parent; b2 != null && !b2.test(REPACK); b2 = b2.parent) b2.set(REPACK);
49 //#define MARK_REFLOW for(Box b2 = this; b2 != null && !b2.test(REFLOW); b2 = b2.parent) b2.set(REFLOW);
50 //#define MARK_REFLOW_b for(Box b2 = b; b2 != null && !b2.test(REFLOW); b2 = b2.parent) b2.set(REFLOW);
51 //#define MARK_RESIZE for(Box b2 = this; b2 != null && !b2.test(RESIZE); b2 = b2.parent) b2.set(RESIZE);
52 //#define MARK_RESIZE_b for(Box b2 = b; b2 != null && !b2.test(RESIZE); b2 = b2.parent) b2.set(RESIZE);
53 //#define CHECKSET_SHORT(prop) short nu = (short)toInt(value); if (nu == prop) break; prop = nu;
54 //#define CHECKSET_INT(prop) int nu = toInt(value); if (nu == prop) break; prop = nu;
55 //#define CHECKSET_FLAG(flag) boolean nu = toBoolean(value); if (nu == test(flag)) break; if (nu) set(flag); else clear(flag);
56 //#define CHECKSET_BOOLEAN(prop) boolean nu = toBoolean(value); if (nu == prop) break; prop = nu;
57 //#define CHECKSET_STRING(prop) if ((value==null&&prop==null)||(value!=null&&value.equals(prop))) break; prop=(String)value;
59 protected Box() { super(null); }
61 static Hash boxToCursor = new Hash(500, 3);
62 public static final int MAX_LENGTH = Integer.MAX_VALUE;
63 static final Font DEFAULT_FONT;
67 try { f = Font.getFont((Stream)Main.builtin.get("fonts/vera/Vera.ttf"), 10); }
68 catch(JSExn e) { Log.info(Box.class, "should never happen: "+e); }
73 // box properties can not be trapped
74 static final String[] props = new String[] {
75 "shrink", "hshrink", "vshrink", "x", "y", "width", "height", "cols", "rows",
76 "colspan", "rowspan", "align", "visible", "packed", "globalx", "globaly",
77 "minwidth", "maxwidth", "minheight", "maxheight", "indexof", "thisbox", "clip",
78 "numchildren", "redirect", "cursor", "mouse"
82 // events can have write traps, but not read traps
83 static final String[] events = new String[] {
84 "Press1", "Press2", "Press3",
85 "Release1", "Release2", "Release3",
86 "Click1", "Click2", "Click3",
87 "DoubleClick1", "DoubleClick2", "DoubleClick3",
88 "Enter", "Leave", "Move",
89 "KeyPressed", "KeyReleased", "PosChange", "SizeChange",
90 "childadded", "childremoved",
91 "Focused", "Maximized", "Minimized", "Close",
92 "icon", "titlebar", "toback", "tofront"
95 // Flags //////////////////////////////////////////////////////////////////////
97 static final int MOUSEINSIDE = 0x00000001;
98 static final int VISIBLE = 0x00000002;
99 static final int PACKED = 0x00000004;
100 static final int HSHRINK = 0x00000008;
101 static final int VSHRINK = 0x00000010;
102 static final int BLACK = 0x00000020; // for red-black code
104 static final int FIXED = 0x00000040;
105 static final boolean ROWS = true;
106 static final boolean COLS = false;
108 static final int ISROOT = 0x00000080;
109 static final int REPACK = 0x00000100;
110 static final int REFLOW = 0x00000200;
111 static final int RESIZE = 0x00000400;
112 static final int RECONSTRAIN = 0x00000800;
113 static final int ALIGN_TOP = 0x00001000;
114 static final int ALIGN_BOTTOM = 0x00002000;
115 static final int ALIGN_LEFT = 0x00004000;
116 static final int ALIGN_RIGHT = 0x00008000;
117 static final int ALIGNS = 0x0000f000;
118 static final int CURSOR = 0x00010000; // if true, this box has a cursor in the cursor hash; FEATURE: GC issues?
119 static final int CLIP = 0x00020000;
120 static final int STOP_UPWARD_PROPAGATION = 0x00040000;
123 // Instance Data //////////////////////////////////////////////////////////////////////
127 int flags = VISIBLE | PACKED | REPACK | REFLOW | RESIZE | FIXED /* ROWS */ | STOP_UPWARD_PROPAGATION | CLIP;
129 private String text = null;
130 private Font font = DEFAULT_FONT;
131 private Picture texture = null;
132 private short strokewidth = 1;
133 public int fillcolor = 0x00000000;
134 private int strokecolor = 0xFF000000;
136 private int aspect = 0;
138 // specified directly by user
139 public LENGTH minwidth = 0;
140 public LENGTH maxwidth = MAX_LENGTH;
141 public LENGTH minheight = 0;
142 public LENGTH maxheight = MAX_LENGTH;
143 private short rows = 1;
144 private short cols = 0;
145 private short rowspan = 1;
146 private short colspan = 1;
148 // computed during reflow
149 private short row = 0;
150 private short col = 0;
153 public LENGTH ax = 0; // FEATURE: roll these into x/y; requires lots of changes
154 public LENGTH ay = 0; // FEATURE: roll these into x/y; requires lots of changes; perhaps y()?
155 public LENGTH width = 0;
156 public LENGTH height = 0;
157 private LENGTH contentwidth = 0; // == max(minwidth, textwidth, sum(child.contentwidth))
158 private LENGTH contentheight = 0;
161 private VectorGraphics.VectorPath path = null;
162 private VectorGraphics.Affine transform = null;
163 private VectorGraphics.RasterPath rpath = null;
164 private VectorGraphics.Affine rtransform = null;
167 // Instance Methods /////////////////////////////////////////////////////////////////////
169 public final int fontSize() { return font == null ? DEFAULT_FONT.pointsize : font.pointsize; }
171 /** invoked when a resource needed to render ourselves finishes loading */
172 public void perform() throws JSExn {
174 // FIXME; we can't assume that just because we were performed the image is loaded.
175 // as external events have occured, check the state of box
176 if (texture != null) {
177 if (texture.isLoaded) { minwidth = min(texture.width, maxwidth); minheight = min(texture.height, maxheight); }
178 else { JS res = texture.stream; texture = null; throw new JSExn("image not found: "+res.unclone()); }
180 Log.warn(Box.class, "perform() called with null texture");
188 // FEATURE: use cx2/cy2 format
189 /** Adds the intersection of (x,y,w,h) and the node's current actual geometry to the Surface's dirty list */
190 public void dirty() { dirty(0, 0, width, height); }
191 public void dirty(int x, int y, int w, int h) {
192 for(Box cur = this; cur != null; cur = cur.parent) {
193 // x and y have a different meaning on the root box
194 if (cur.parent != null && cur.test(CLIP)) {
195 w = min(x + w, cur.width) - max(x, 0);
196 h = min(y + h, cur.height) - max(y, 0);
200 if (w <= 0 || h <= 0) return;
201 if (cur.parent == null && cur.getSurface() != null) cur.getSurface().dirty(x, y, w, h);
208 // Reflow ////////////////////////////////////////////////////////////////////////////////////////
210 // worst case runtime = O(numboxes * numboxes_in_widest_row)
212 private static Box[] frontier = new Box[65535]; // FIXME: GC hazard
214 /** pack the boxes into rows and columns; also computes contentwidth */
216 for(Box child = getChild(0); child != null; child = child.nextSibling()) child.pack();
217 int frontier_size = 0; contentwidth = 0; contentheight = 0;
218 //#repeat COLS/ROWS rows/cols cols/rows col/row row/col colspan/rowspan rowspan/colspan \
219 // contentheight/contentwidth contentwidth/contentheight
220 if (treeSize() > 0 && test(FIXED) == COLS) {
222 for(Box child = getChild(0); child != null; child = child.nextSibling()) {
223 if (!child.test(PACKED) || !child.test(VISIBLE)) continue;
224 child.col = (short)(frontier_size <= 0 ? 0 : (frontier[frontier_size-1].col + frontier[frontier_size-1].colspan));
225 child.row = (short)(frontier_size <= 0 ? 0 : frontier[frontier_size-1].row);
226 if (child.col + min(cols,child.colspan) > cols) { child.col = 0; child.row++; }
227 for(int i=0; i<frontier_size; i++)
228 if (frontier[i].row + frontier[i].rowspan <= child.row) {
229 frontier[i--] = frontier[--frontier_size]; frontier[frontier_size] = null;
230 } else if (frontier[i].col<child.col+min(cols,child.colspan)&&frontier[i].col+frontier[i].colspan>child.col) {
231 child.col = (short)(frontier[i].col + frontier[i].colspan);
232 if (child.col + min(cols,child.colspan) > cols) {
233 child.row = (short)(frontier[i].row + frontier[i].rowspan);
234 for(i--; i>0; i--) child.row = (short)min(row, frontier[i].row + frontier[i].rowspan);
235 child.col = (short)0;
239 frontier[frontier_size++] = child;
241 for(int i=0; i<frontier_size; i++){rows=(short)max(rows, frontier[i].row + frontier[i].rowspan); frontier[i] = null; }
245 //#repeat contentwidth/contentheight contentheight/contentwidth minwidth/minheight row/col col/row \
246 // textwidth/textheight maxwidth/maxheight cols/rows rows/cols colspan/rowspan rowspan/colspan
247 contentwidth = bound(minwidth,
249 font == null || text == null ? 0 : font.textwidth(text)),
254 void resize(LENGTH x, LENGTH y, LENGTH width, LENGTH height) {
255 if (x != this.x || y != this.y || width != this.width || height != this.height) {
256 boolean sizechange = (this.width != width || this.height != height) && getTrap("SizeChange") != null;
258 int thisx = parent == null ? 0 : this.x;
259 int thisy = parent == null ? 0 : this.y;
260 // we can't reenable this until we track surface-relative sizes; imagine clear surface with nonclear children
261 if (false /*texture == null && (text == null || text.equals(""))*/) {
262 if ((fillcolor & 0xff000000) == 0) break;
263 if (this.x == x && this.y == y) {
264 Box who = (parent == null ? this : parent);
265 who.dirty(thisx+min(this.width,width), thisy, Math.abs(width-this.width), max(this.height, height));
266 who.dirty(thisx, thisy+min(this.height,height), min(this.width, width), Math.abs(height-this.height));
270 (parent == null ? this : parent).dirty(thisx, thisy, this.width, this.height);
271 this.width = width; this.height = height; this.x = x; this.y = y;
274 this.width = width; this.height = height; this.x = x; this.y = y;
275 if (sizechange) putAndTriggerTrapsAndCatchExceptions("SizeChange", T);
279 private static float[] coeff = null;
280 private static Simplex lp_h = new Simplex(65535, 65535, 65535);
281 private static Simplex lp = new Simplex(65535, 65535, 65535);
283 private static int[] regions = new int[65535];
284 private static int[] regions_v = new int[65535];
285 private static int numregions = 0;
286 private static int numregions_v = 0;
287 //#repeat col/row colspan/rowspan contentwidth/contentheight width/height HSHRINK/VSHRINK numregions/numregions_v \
288 // maxwidth/maxheight cols/rows minwidth/minheight lp_h/lp lp_h/lp easy_width/easy_height regions/regions_v \
289 // computeRegions/computeRegions_v
290 private void computeRegions() {
292 for(Box c = firstPackedChild(); c != null; c = c.nextPackedSibling()) {
293 regions[numregions++] = c.col;
294 regions[numregions++] = min(cols, c.col+c.colspan);
296 Vec.sortInts(regions, 0, numregions);
298 int newnumregions = numregions;
299 for(int i=1; i<numregions; i++) {
300 if (regions[j] != regions[i]) j++;
301 else newnumregions--;
302 regions[j] = regions[i];
304 numregions = newnumregions;
305 if (regions[numregions-1] == cols) numregions--;
306 else regions[numregions] = cols;
310 void solve(boolean findMinimum) {
311 int numkids = 0; for(Box c = firstPackedChild(); c != null; c = c.nextPackedSibling()) numkids++;
312 //#repeat col/row colspan/rowspan contentwidth/contentheight width/height HSHRINK/VSHRINK numregions/numregions_v \
313 // maxwidth/maxheight cols/rows minwidth/minheight lp_h/lp lp_h/lp easy_width/easy_height regions/regions_v \
314 // computeRegions/computeRegions_v
315 if (numkids > 0 && cols > 1) do {
317 int nc = numregions * 3 + numkids * 2 + 3;
318 if (coeff == null || nc+1>coeff.length) coeff = new float[nc+1];
321 for(int i=0; i<coeff.length; i++) coeff[i] = (float)0.0;
323 coeff[numregions*2+numkids] = (float)10000.0; // priority 1: sum of columns no greater than parent
324 for(int i=numregions*2; i<numregions*2+numkids; i++) coeff[i] = (float)100.0; // priority 2: honor maxwidths
325 for(int i=numregions; i<numregions*2; i++) coeff[i] = (float)(0.1); // priority 3: equalize columns
327 coeff[numregions*2+numkids] = (float)1.0;
329 lp_h.setObjective(coeff, false);
331 // priority 1: sum of columns as close to parent's width as possible
332 for(int i=0; i<coeff.length; i++) coeff[i] = (i<numregions) ? (float)(regions[i+1] - regions[i]) : (float)0.0;
333 coeff[numregions*2+numkids] = (float)-1.0;
334 if (!findMinimum) lp_h.add_constraint(coeff, Simplex.LE, (float)width);
335 else lp_h.add_constraint(coeff, Simplex.LE, (float)0);
338 for(Box child = firstPackedChild(); child != null; child = child.nextPackedSibling()) {
340 // invariant: honor minwidths
341 for(int i=0; i<coeff.length; i++) coeff[i] = (float)0.0;
342 for(int r=0; r<numregions; r++)
343 if (regions[r] >= child.col && regions[r+1] <= min(child.col+child.colspan,cols))
344 coeff[r] = (float)(regions[r+1] - regions[r]);
345 lp_h.add_constraint(coeff, Simplex.GE, (float)child.contentwidth);
347 // priority 2: honor maxwidths
348 int child_maxwidth = child.test(HSHRINK) ? min(child.maxwidth, child.contentwidth) : child.maxwidth;
349 if (child_maxwidth < Integer.MAX_VALUE) {
350 for(int i=0; i<coeff.length; i++) coeff[i] = (float)0.0;
351 for(int r=0; r<numregions; r++)
352 if (regions[r] >= child.col && regions[r+1] <= min(child.col+child.colspan,cols))
353 coeff[r] = (float)(regions[r+1] - regions[r]);
354 coeff[numregions*2+childnum] = (float)-1.0;
355 lp_h.add_constraint(coeff, Simplex.LE, (float)child_maxwidth);
362 // priority 3: equalize columns
363 float avg = ((float)width)/((float)numregions);
364 for(int r=0; r<numregions; r++) {
365 float weight = (float)(regions[r+1] - regions[r]);
366 for(int k=0; k<coeff.length; k++) coeff[k] = (float)(k==r?weight:k==(numregions+r)?-1.0:0.0);
367 lp_h.add_constraint(coeff, Simplex.LE, avg * weight);
368 for(int k=0; k<coeff.length; k++) coeff[k] = (float)(k==r?weight:k==(numregions+r)?1.0:0.0);
369 lp_h.add_constraint(coeff, Simplex.GE, avg * weight);
373 try { switch(lp_h.solve()) {
374 case Simplex.UNBOUNDED: Log.warn(this, "simplex claims unboundedness; this should never happen"); break;
375 case Simplex.INFEASIBLE: Log.debug(this, "simplex claims infeasibility; this should never happen"); break;
376 case Simplex.MILP_FAIL: Log.warn(this, "simplex claims MILP_FAIL; this should never happen"); break;
377 case Simplex.RUNNING: Log.warn(this, "simplex still RUNNING; this should never happen"); break;
378 case Simplex.FAILURE: Log.warn(this, "simplex claims FAILURE; this should never happen"); break;
379 } } catch (Error e) {
380 Log.warn(this, "got an Error in simplex solver; not sure why this happens");
384 if (findMinimum) contentwidth = Math.round(lp_h.solution[lp_h.rows + (2*numregions + numkids + 1)]);
391 for(Box child = getChild(0); child != null; child = child.nextSibling()) {
392 if (!child.test(VISIBLE)) continue;
393 int child_width, child_height, child_x, child_y;
394 if (!child.test(PACKED)) {
395 child_width = child.test(HSHRINK) ? child.contentwidth : min(child.maxwidth, width - Math.abs(child.ax));
396 child_height = child.test(VSHRINK) ? child.contentheight : min(child.maxheight, height - Math.abs(child.ay));
397 child_width = max(child.minwidth, child_width);
398 child_height = max(child.minheight, child_height);
399 int gap_x = width - child_width;
400 int gap_y = height - child_height;
401 child_x = child.ax + (child.test(ALIGN_RIGHT) ? gap_x : !child.test(ALIGN_LEFT) ? gap_x / 2 : 0);
402 child_y = child.ay + (child.test(ALIGN_BOTTOM) ? gap_y : !child.test(ALIGN_TOP) ? gap_y / 2 : 0);
405 //#repeat col/row colspan/rowspan contentwidth/contentheight width/height colMaxWidth/rowMaxHeight \
406 // child_x/child_y x/y HSHRINK/VSHRINK maxwidth/maxheight cols/rows minwidth/minheight x_slack/y_slack \
407 // child_width/child_height ALIGN_RIGHT/ALIGN_BOTTOM ALIGN_LEFT/ALIGN_TOP lp_h/lp \
408 // numregions/numregions_v regions/regions_v
415 for(int r=0; r<numregions; r++)
416 if (regions[r] >= child.col && regions[r+1] <= min(child.col+child.colspan,cols))
417 child_width += Math.round(lp_h.solution[lp_h.rows+r+1] * (regions[r+1] - regions[r]));
418 else if (regions[r+1] <= child.col)
419 child_x += Math.round(lp_h.solution[lp_h.rows+r+1] * (regions[r+1] - regions[r]));
421 diff = (child_width - (child.test(HSHRINK) ? child.contentwidth : min(child_width, child.maxwidth)));
422 child_x += (child.test(ALIGN_RIGHT) ? diff : child.test(ALIGN_LEFT) ? 0 : diff / 2);
426 child.resize(child_x, child_y, child_width, child_height);
429 for(Box child = getChild(0); child != null; child = child.nextSibling())
430 if (child.test(VISIBLE) && child.treeSize() > 0)
436 // Rendering Pipeline /////////////////////////////////////////////////////////////////////
438 /** Renders self and children within the specified region. All rendering operations are clipped to xIn,yIn,wIn,hIn */
439 void render(int parentx, int parenty, int cx1, int cy1, int cx2, int cy2, PixelBuffer buf, VectorGraphics.Affine a) {
440 if (!test(VISIBLE)) return;
441 int globalx = parentx + (parent == null ? 0 : x);
442 int globaly = parenty + (parent == null ? 0 : y);
444 // intersect the x,y,w,h rendering window with ourselves; quit if it's empty
446 cx1 = max(cx1, globalx);
447 cy1 = max(cy1, globaly);
448 cx2 = min(cx2, globalx + width);
449 cy2 = min(cy2, globaly + height);
450 if (cx2 <= cx1 || cy2 <= cy1) return;
453 if ((fillcolor & 0xFF000000) != 0x00000000 || parent == null)
454 buf.fillTrapezoid(cx1, cx2, cy1, cx1, cx2, cy2, (fillcolor & 0xFF000000) == 0 ? 0xffffffff : fillcolor);
456 // FIXME: do aspect in here
457 if (texture != null && texture.isLoaded)
458 for(int x = globalx; x < cx2; x += texture.width)
459 for(int y = globaly; y < cy2; y += texture.height)
460 buf.drawPicture(texture, x, y, cx1, cy1, cx2, cy2);
462 if (text != null && !text.equals("") && font != null) {
463 int gap_x = width - font.textwidth(text);
464 int gap_y = height - font.textheight(text);
465 int text_x = globalx + (test(ALIGN_RIGHT) ? gap_x : !test(ALIGN_LEFT) ? gap_x/2 : 0);
466 int text_y = globaly + (test(ALIGN_BOTTOM) ? gap_y : !test(ALIGN_TOP) ? gap_y/2 : 0);
467 font.rasterizeGlyphs(text, buf, strokecolor, text_x, text_y, cx1, cy1, cx2, cy2);
470 for(Box b = getChild(0); b != null; b = b.nextSibling())
471 b.render(globalx, globaly, cx1, cy1, cx2, cy2, buf, null);
475 // Methods to implement org.ibex.js.JS //////////////////////////////////////
478 public Object callMethod(Object method, Object a0, Object a1, Object a2, Object[] rest, int nargs) throws JSExn {
484 if (b.parent != this)
485 return (redirect == null || redirect == this) ?
487 redirect.callMethod(method, a0, a1, a2, rest, nargs);
488 return N(b.getIndexInParent());
493 ret.put("x", N(b.localToGlobalX(0) - localToGlobalX(0)));
494 ret.put("y", N(b.localToGlobalY(0) - localToGlobalY(0)));
500 return super.callMethod(method, a0, a1, a2, rest, nargs);
503 protected boolean isTrappable(Object key, boolean isRead) {
504 if (key == null) return false;
505 else if (key instanceof String) {
506 // not allowed to trap box properties, and no read traps on events
507 String name = (String)key;
508 for (int i=0; i < props.length; i++) if (name.equals(props[i])) return false;
509 if (isRead) for (int i=0; i < events.length; i++) if (name.equals(events[i])) return false;
515 public Object get(Object name) throws JSExn {
516 if (name instanceof Number)
517 return redirect == null ? null : redirect == this ? getChild(toInt(name)) : redirect.get(name);
520 case "surface": return parent == null ? null : parent.getAndTriggerTraps("surface");
521 case "indexof": return METHOD;
522 case "distanceto": return METHOD;
523 case "text": return text;
524 case "path": throw new JSExn("cannot read from the path property");
525 case "fill": return colorToString(fillcolor);
526 case "strokecolor": return colorToString(strokecolor);
527 case "textcolor": return colorToString(strokecolor);
528 case "font": return font == null ? null : font.stream;
529 case "fontsize": return font == null ? N(10) : N(font.pointsize);
530 case "strokewidth": return N(strokewidth);
531 case "align": return alignToString();
532 case "thisbox": return this;
533 case "shrink": return B(test(HSHRINK) || test(VSHRINK));
534 case "hshrink": return B(test(HSHRINK));
535 case "vshrink": return B(test(VSHRINK));
536 case "aspect": return N(aspect);
537 case "x": return (parent == null || !test(VISIBLE)) ? N(0) : N(x);
538 case "y": return (parent == null || !test(VISIBLE)) ? N(0) : N(y);
539 case "cols": return test(FIXED) == COLS ? N(cols) : N(0);
540 case "rows": return test(FIXED) == ROWS ? N(rows) : N(0);
541 case "colspan": return N(colspan);
542 case "rowspan": return N(rowspan);
543 case "width": return N(width);
544 case "height": return N(height);
545 case "minwidth": return N(minwidth);
546 case "maxwidth": return N(maxwidth);
547 case "minheight": return N(minheight);
548 case "maxheight": return N(maxheight);
549 case "clip": return B(test(CLIP));
550 case "visible": return B(test(VISIBLE) && (parent == null || (parent.get("visible") == T)));
551 case "packed": return B(test(PACKED));
552 case "globalx": return N(localToGlobalX(0));
553 case "globaly": return N(localToGlobalY(0));
554 case "cursor": return test(CURSOR) ? boxToCursor.get(this) : null;
556 if (getSurface() == null) return null;
557 if (getSurface()._mousex == Integer.MAX_VALUE)
558 throw new JSExn("you cannot read from the box.mouse property in background thread context");
560 case "numchildren": return redirect == null ? N(0) : redirect == this ? N(treeSize()) : redirect.get("numchildren");
561 case "redirect": return redirect == null ? null : redirect == this ? T : redirect.get("redirect");
562 case "Minimized": if (parent == null && getSurface() != null) return B(getSurface().minimized);
563 default: return super.get(name);
565 throw new Error("unreachable"); // unreachable
568 private class Mouse extends JS.Cloneable {
569 public Object get(Object key) {
571 case "x": return N(globalToLocalX(getSurface()._mousex));
572 case "y": return N(globalToLocalY(getSurface()._mousey));
574 // this might not get recomputed if we change mousex/mousey...
575 case "inside": return B(test(MOUSEINSIDE));
581 public void setMaxWidth(Object value) {
582 do { CHECKSET_INT(maxwidth); MARK_RESIZE; } while(false);
583 if (parent == null && getSurface() != null) getSurface().pendingWidth = maxwidth;
585 public void setMaxHeight(Object value) {
586 do { CHECKSET_INT(maxheight); MARK_RESIZE; } while(false);
587 if (parent == null && getSurface() != null) getSurface().pendingHeight = maxheight;
590 public void put(Object name, Object value) throws JSExn {
591 if (name instanceof Number) { put(toInt(name), value); return; }
593 case "text": CHECKSET_STRING(text); MARK_RESIZE; dirty();
594 case "strokecolor": value = N(stringToColor((String)value)); CHECKSET_INT(strokecolor); MARK_RESIZE; dirty();
595 case "textcolor": value = N(stringToColor((String)value)); CHECKSET_INT(strokecolor); MARK_RESIZE; dirty();
596 case "text": CHECKSET_STRING(text); MARK_RESIZE; dirty();
597 case "strokewidth": CHECKSET_SHORT(strokewidth); dirty();
598 case "shrink": put("hshrink", value); put("vshrink", value);
599 case "hshrink": CHECKSET_FLAG(HSHRINK); MARK_RESIZE;
600 case "vshrink": CHECKSET_FLAG(VSHRINK); MARK_RESIZE;
601 case "width": put("maxwidth", value); put("minwidth", value); MARK_RESIZE;
602 case "height": put("maxheight", value); put("minheight", value); MARK_RESIZE;
603 case "maxwidth": setMaxWidth(value);
604 case "minwidth": CHECKSET_INT(minwidth); MARK_RESIZE;
605 if (parent == null && getSurface() != null)
606 getSurface().setMinimumSize(minwidth, minheight, minwidth != maxwidth || minheight != maxheight);
607 case "maxheight": setMaxHeight(value);
608 case "minheight": CHECKSET_INT(minheight); MARK_RESIZE;
609 if (parent == null && getSurface() != null)
610 getSurface().setMinimumSize(minwidth, minheight, minwidth != maxwidth || minheight != maxheight);
611 case "colspan": if (toInt(value) <= 0) return; CHECKSET_SHORT(colspan); MARK_REPACK_parent;
612 case "rowspan": if (toInt(value) <= 0) return; CHECKSET_SHORT(rowspan); MARK_REPACK_parent;
613 case "rows": CHECKSET_SHORT(rows); if (rows==0){set(FIXED, COLS);if(cols==0)cols=1;} else set(FIXED, ROWS); MARK_REPACK;
614 case "cols": CHECKSET_SHORT(cols); if (cols==0){set(FIXED, ROWS);if(rows==0)rows=1;} else set(FIXED, COLS); MARK_REPACK;
615 case "clip": CHECKSET_FLAG(CLIP); if (parent == null) dirty(); else parent.dirty();
616 case "visible": CHECKSET_FLAG(VISIBLE); dirty(); MARK_RESIZE; dirty();
617 case "packed": CHECKSET_FLAG(PACKED); MARK_REPACK_parent;
618 case "aspect": CHECKSET_INT(aspect); dirty();
619 case "globalx": put("x", N(globalToLocalX(toInt(value))));
620 case "globaly": put("y", N(globalToLocalY(toInt(value))));
621 case "align": clear(ALIGNS); setAlign(value == null ? "center" : value); MARK_RESIZE;
622 case "cursor": setCursor(value);
623 case "fill": setFill(value);
625 int mousex = toInt(((JS)value).get("x"));
626 int mousey = toInt(((JS)value).get("y"));
627 getSurface()._mousex = localToGlobalX(mousex);
628 getSurface()._mousey = localToGlobalY(mousey);
629 case "Minimized": if (parent == null && getSurface() != null) getSurface().minimized = toBoolean(value); // FEATURE
630 case "Maximized": if (parent == null && getSurface() != null) getSurface().maximized = toBoolean(value); // FEATURE
631 case "Close": if (parent == null && getSurface() != null) getSurface().dispose(true);
633 if (value == null) { redirect = null; return; }
634 for(Box cur = (Box)value; cur != null; cur = cur.parent)
635 if (cur == redirect) {
636 redirect = (Box)value;
639 JS.error("redirect can only be set to a descendant of its current value");
641 if(!(value instanceof Stream)) throw new JSExn("You can only put streams to the font property");
642 font = value == null ? null : Font.getFont((Stream)value, font == null ? 10 : font.pointsize);
645 case "fontsize": font = Font.getFont(font == null ? null : font.stream, toInt(value)); MARK_RESIZE; dirty();
646 case "x": if (parent==null && Surface.fromBox(this)!=null) {
649 if (test(PACKED) && parent != null) return;
650 dirty(); CHECKSET_INT(ax);
651 dirty(); MARK_RESIZE;
654 case "y": if (parent==null && Surface.fromBox(this)!=null) {
657 if (test(PACKED) && parent != null) return;
658 dirty(); CHECKSET_INT(ay);
659 dirty(); MARK_RESIZE;
663 if (getSurface() != null && value != null) getSurface().setTitleBarText(JS.toString(value));
664 super.put(name,value);
666 case "Press1": if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
667 case "Press2": if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
668 case "Press3": if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
669 case "Release1": if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
670 case "Release2": if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
671 case "Release3": if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
672 case "Click1": if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
673 case "Click2": if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
674 case "Click3": if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
675 case "DoubleClick1": if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
676 case "DoubleClick2": if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
677 case "DoubleClick3": if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
678 case "KeyPressed": if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
679 case "KeyReleased": if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
680 case "Move": if (!test(STOP_UPWARD_PROPAGATION) && parent != null) parent.putAndTriggerTraps(name, value);
682 case "HScroll": if (!test(STOP_UPWARD_PROPAGATION) && parent != null)
683 parent.putAndTriggerTraps(name, N(((Number)value).floatValue() * ((float)parent.fontSize()) / ((float)fontSize())));
684 case "VScroll": if (!test(STOP_UPWARD_PROPAGATION) && parent != null)
685 parent.putAndTriggerTraps(name, N(((Number)value).floatValue() * ((float)parent.fontSize()) / ((float)fontSize())));
687 case "_Move": propagateDownward(name, value, false);
688 case "_Press1": propagateDownward(name, value, false);
689 case "_Press2": propagateDownward(name, value, false);
690 case "_Press3": propagateDownward(name, value, false);
691 case "_Release1": propagateDownward(name, value, false);
692 case "_Release2": propagateDownward(name, value, false);
693 case "_Release3": propagateDownward(name, value, false);
694 case "_Click1": propagateDownward(name, value, false);
695 case "_Click2": propagateDownward(name, value, false);
696 case "_Click3": propagateDownward(name, value, false);
697 case "_DoubleClick1": propagateDownward(name, value, false);
698 case "_DoubleClick2": propagateDownward(name, value, false);
699 case "_DoubleClick3": propagateDownward(name, value, false);
700 case "_KeyPressed": propagateDownward(name, value, false);
701 case "_KeyReleased": propagateDownward(name, value, false);
702 case "_HScroll": propagateDownward(name, value, false);
703 case "_VScroll": propagateDownward(name, value, false);
705 case "PosChange": return;
706 case "SizeChange": return;
707 case "childadded": return;
708 case "childremoved": return;
709 case "Enter": return;
710 case "Leave": return;
712 case "thisbox": if (value == null) removeSelf();
714 default: super.put(name, value);
718 private String alignToString() {
719 switch(flags & ALIGNS) {
720 case (ALIGN_TOP | ALIGN_LEFT): return "topleft";
721 case (ALIGN_BOTTOM | ALIGN_LEFT): return "bottomleft";
722 case (ALIGN_TOP | ALIGN_RIGHT): return "topright";
723 case (ALIGN_BOTTOM | ALIGN_RIGHT): return "bottomright";
724 case ALIGN_TOP: return "top";
725 case ALIGN_BOTTOM: return "bottom";
726 case ALIGN_LEFT: return "left";
727 case ALIGN_RIGHT: return "right";
728 case 0: return "center";
729 default: throw new Error("invalid alignment flags: " + (flags & ALIGNS));
733 private void setAlign(Object value) {
735 case "center": clear(ALIGNS);
736 case "topleft": set(ALIGN_TOP | ALIGN_LEFT);
737 case "bottomleft": set(ALIGN_BOTTOM | ALIGN_LEFT);
738 case "topright": set(ALIGN_TOP | ALIGN_RIGHT);
739 case "bottomright": set(ALIGN_BOTTOM | ALIGN_RIGHT);
740 case "top": set(ALIGN_TOP);
741 case "bottom": set(ALIGN_BOTTOM);
742 case "left": set(ALIGN_LEFT);
743 case "right": set(ALIGN_RIGHT);
744 default: JS.log("invalid alignment \"" + value + "\"");
748 private void setCursor(Object value) {
749 if (value == null) { clear(CURSOR); boxToCursor.remove(this); return; }
750 if (value.equals(boxToCursor.get(this))) return;
752 boxToCursor.put(this, value);
753 Surface surface = getSurface();
754 if (surface != null) {
755 String tempcursor = surface.cursor;
756 propagateDownward(null, null, false);
757 if (surface.cursor != tempcursor) surface.syncCursor();
761 private void setFill(Object value) throws JSExn {
763 // FIXME: Check this... does this make it transparent?
766 } else if (value instanceof String) {
767 // FIXME check double set
768 int newfillcolor = stringToColor((String)value);
769 if (newfillcolor == fillcolor) return;
770 fillcolor = newfillcolor;
771 } else if(value instanceof JS) {
772 texture = Picture.load((JS)value, this);
773 if (texture != null && texture.isLoaded) perform();
775 throw new JSExn("fill must be null, a String, or a stream, not a " + value.getClass());
780 // FIXME: mouse move/release still needs to propagate to boxen in which the mouse was pressed and is still held down
782 * Handles events which propagate down the box tree. If obscured
783 * is set, then we merely check for Enter/Leave.
785 private void propagateDownward(Object name_, Object value, boolean obscured) {
787 String name = (String)name_;
788 if (getSurface() == null) return;
789 int x = globalToLocalX(getSurface()._mousex);
790 int y = globalToLocalY(getSurface()._mousey);
791 boolean wasinside = test(MOUSEINSIDE);
792 boolean isinside = test(VISIBLE) && inside(x, y) && !obscured;
793 if (!wasinside && isinside) {
795 putAndTriggerTrapsAndCatchExceptions("Enter", T);
797 if (isinside && test(CURSOR)) getSurface().cursor = (String)boxToCursor.get(this);
798 if (wasinside && !isinside) {
800 putAndTriggerTrapsAndCatchExceptions("Leave", T);
803 boolean found = false;
804 if (wasinside || isinside)
805 for(Box child = getChild(treeSize() - 1); child != null; child = child.prevSibling()) {
806 boolean save_stop = child.test(STOP_UPWARD_PROPAGATION);
807 Object value2 = value;
808 if (name.equals("_HScroll") || name.equals("_VScroll"))
809 value2 = N(((Number)value).floatValue() * ((float)child.fontSize()) / (float)fontSize());
810 if (obscured || !child.inside(x - child.x, y - child.y)) {
811 child.propagateDownward(name, value2, true);
814 child.clear(STOP_UPWARD_PROPAGATION);
815 if (name != null) child.putAndTriggerTrapsAndCatchExceptions(name, value2);
816 else child.propagateDownward(name, value2, obscured);
818 if (save_stop) child.set(STOP_UPWARD_PROPAGATION); else child.clear(STOP_UPWARD_PROPAGATION);
820 if (child.inside(x - child.x, y - child.y))
821 if (name != null && name.equals("_Move")) obscured = true;
825 if (!obscured && !found)
826 if ("_Move".equals(name) || wasinside)
828 putAndTriggerTrapsAndCatchExceptions(name.substring(1), value);
831 private static int stringToColor(String s) {
832 // FIXME support three-char strings by doubling digits
833 if (s == null) return 0x00000000;
834 else if (SVG.colors.get(s) != null) return 0xFF000000 | toInt(SVG.colors.get(s));
835 else if (s.length() == 7 && s.charAt(0) == '#') try {
838 (Integer.parseInt(s.substring(1, 3), 16) << 16) |
839 (Integer.parseInt(s.substring(3, 5), 16) << 8) |
840 Integer.parseInt(s.substring(5, 7), 16);
841 } catch (NumberFormatException e) {
842 Log.info(Box.class, "invalid color " + s);
845 else return 0; // FEATURE: error?
848 private static String colorToString(int argb) {
849 if ((argb & 0xFF000000) == 0) return null;
850 String red = Integer.toHexString((argb & 0x00FF0000) >> 16);
851 String green = Integer.toHexString((argb & 0x0000FF00) >> 8);
852 String blue = Integer.toHexString(argb & 0x000000FF);
853 if (red.length() < 2) red = "0" + red;
854 if (blue.length() < 2) blue = "0" + blue;
855 if (green.length() < 2) green = "0" + green;
856 return "#" + red + green + blue;
859 /** figures out what box in this subtree of the Box owns the pixel at x,y relitave to the Surface */
860 public static Box whoIs(Box cur, int x, int y) {
862 if (cur.parent != null) throw new Error("whoIs may only be invoked on the root box of a surface");
866 // WARNING: this method is called from the event-queueing thread -- it may run concurrently with
867 // ANY part of Ibex, and is UNSYNCHRONIZED for performance reasons. BE CAREFUL HERE.
869 if (!cur.test(VISIBLE)) return null;
870 if (!cur.inside(x - globalx, y - globaly)) return cur.parent == null ? cur : null;
872 for(int i=cur.treeSize() - 1; i>=0; i--) {
873 Box child = cur.getChild(i);
874 if (child == null) continue; // since this method is unsynchronized, we have to double-check
877 if (child.test(VISIBLE) && child.inside(x - globalx, y - globaly)) { cur = child; continue OUTER; }
887 // Trivial Helper Methods (should be inlined) /////////////////////////////////////////
889 void mark_for_repack() { MARK_REPACK; }
890 public Enumeration keys() { throw new Error("you cannot apply for..in to a " + this.getClass().getName()); }
891 public Box getRoot() { return parent == null ? this : parent.getRoot(); }
892 public Surface getSurface() { return Surface.fromBox(getRoot()); }
893 Box nextPackedSibling() { Box b = nextSibling(); return b == null || (b.test(PACKED | VISIBLE)) ? b : b.nextPackedSibling(); }
894 Box firstPackedChild() { Box b = getChild(0); return b == null || (b.test(PACKED | VISIBLE)) ? b : b.nextPackedSibling(); }
895 public int globalToLocalX(int x) { return parent == null ? x : parent.globalToLocalX(x - this.x); }
896 public int globalToLocalY(int y) { return parent == null ? y : parent.globalToLocalY(y - this.y); }
897 public int localToGlobalX(int x) { return parent == null ? x : parent.globalToLocalX(x + this.x); }
898 public int localToGlobalY(int y) { return parent == null ? y : parent.globalToLocalY(y + this.y); }
900 static short min(short a, short b) { if (a<b) return a; else return b; }
901 static int min(int a, int b) { if (a<b) return a; else return b; }
902 static float min(float a, float b) { if (a<b) return a; else return b; }
904 static short max(short a, short b) { if (a>b) return a; else return b; }
905 static int max(int a, int b) { if (a>b) return a; else return b; }
906 static float max(float a, float b) { if (a>b) return a; else return b; }
908 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; }
909 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; }
910 static int bound(int a, int b, int c) { if (c < b) return c; if (a > b) return a; return b; }
911 final boolean inside(int x, int y) { return test(VISIBLE) && x >= 0 && y >= 0 && x < width && y < height; }
913 void set(int mask) { flags |= mask; }
914 void set(int mask, boolean setclear) { if (setclear) set(mask); else clear(mask); }
915 void clear(int mask) { flags &= ~mask; }
916 boolean test(int mask) { return ((flags & mask) == mask); }
919 // Tree Handling //////////////////////////////////////////////////////////////////////
921 public final int getIndexInParent() { return parent == null ? 0 : parent.indexNode(this); }
922 public final Box nextSibling() { return parent == null ? null : parent.getChild(parent.indexNode(this) + 1); }
923 public final Box prevSibling() { return parent == null ? null : parent.getChild(parent.indexNode(this) - 1); }
924 public final Box getChild(int i) {
925 if (i < 0) return null;
926 if (i >= treeSize()) return null;
927 return (Box)getNode(i);
930 // Tree Manipulation /////////////////////////////////////////////////////////////////////
933 if (parent != null) { parent.removeChild(parent.indexNode(this)); return; }
934 Surface surface = Surface.fromBox(this);
935 if (surface != null) surface.dispose(true);
938 /** remove the i^th child */
939 public void removeChild(int i) {
943 b.clear(MOUSEINSIDE);
947 putAndTriggerTrapsAndCatchExceptions("childremoved", b);
950 public void put(int i, Object value) throws JSExn {
953 if (value != null && !(value instanceof Box)) {
954 if (Log.on) JS.warn("attempt to set a numerical property on a box to a non-box");
958 if (redirect == null) {
959 if (value == null) putAndTriggerTrapsAndCatchExceptions("childremoved", getChild(i));
960 else JS.warn("attempt to add/remove children to/from a node with a null redirect");
962 } else if (redirect != this) {
963 if (value != null) putAndTriggerTrapsAndCatchExceptions("childadded", value);
964 redirect.put(i, value);
966 Box b = (Box)redirect.get(new Integer(i));
967 if (b != null) putAndTriggerTrapsAndCatchExceptions("childremoved", b);
970 } else if (value == null) {
971 if (i < 0 || i > treeSize()) return;
974 putAndTriggerTrapsAndCatchExceptions("childremoved", b);
979 // check if box being moved is currently target of a redirect
980 for(Box cur = b.parent; cur != null; cur = cur.parent)
981 if (cur.redirect == b) {
982 if (Log.on) JS.warn("attempt to move a box that is the target of a redirect");
986 // check for recursive ancestor violation
987 for(Box cur = this; cur != null; cur = cur.parent)
989 if (Log.on) JS.warn("attempt to make a node a parent of its own ancestor");
990 if (Log.on) Log.info(this, "box == " + this + " ancestor == " + b);
994 if (b.parent != null) b.parent.removeChild(b.parent.indexNode(b));
998 // need both of these in case child was already uncalc'ed
1003 putAndTriggerTrapsAndCatchExceptions("childadded", b);
1007 void putAndTriggerTrapsAndCatchExceptions(Object name, Object val) {
1009 putAndTriggerTraps(name, val);
1011 JS.log("caught js exception while putting to trap \""+name+"\"");
1013 } catch (Exception e) {
1014 JS.log("caught exception while putting to trap \""+name+"\"");
1029 if (rpath == null) rpath = path.realize(transform == null ? VectorGraphics.Affine.identity() : transform);
1030 if ((flags & HSHRINK) != 0) contentwidth = max(contentwidth, rpath.boundingBoxWidth());
1031 if ((flags & VSHRINK) != 0) contentheight = max(contentheight, rpath.boundingBoxHeight());
1032 // FIXME: separate offset_x needed for the path
1034 // #repeat x1/y1 x2/y2 x3/y3 x4/y4 contentwidth/contentheight left/top right/bottom
1035 int x1 = transform == null ? 0 : (int)transform.multiply_px(0, 0);
1036 int x2 = transform == null ? 0 : (int)transform.multiply_px(contentwidth, 0);
1037 int x3 = transform == null ? contentwidth : (int)transform.multiply_px(contentwidth, contentheight);
1038 int x4 = transform == null ? contentwidth : (int)transform.multiply_px(0, contentheight);
1039 int left = min(min(x1, x2), min(x3, x4));
1040 int right = max(max(x1, x2), max(x3, x4));
1041 contentwidth = max(contentwidth, right - left);
1042 offset_x = -1 * left;
1049 if (rtransform == null) rpath = null;
1050 else if (!rtransform.equalsIgnoringTranslation(a)) rpath = null;
1052 rpath.translate((int)(a.e - rtransform.e), (int)(a.f - rtransform.f));
1053 rtransform = a.copy();
1055 if (rpath == null) rpath = path.realize((rtransform = a) == null ? VectorGraphics.Affine.identity() : a);
1056 if ((strokecolor & 0xff000000) != 0) rpath.stroke(buf, 1, strokecolor);
1057 if ((fillcolor & 0xff000000) != 0) rpath.fill(buf, new VectorGraphics.SingleColorPaint(fillcolor));
1063 VectorGraphics.Affine a2 = VectorGraphics.Affine.translate(b.x, b.y);
1064 if (transform != null) a2.multiply(transform);
1065 a2.multiply(VectorGraphics.Affine.translate(offset_x, offset_y));