src/org/xwt/Template.java

   1 // Copyright 2002 Adam Megacz, see the COPYING file for licensing [GPL]
   2 package org.xwt;
   3
   4 import java.io.*;
   5 import java.util.zip.*;
   6 import java.util.*;
   7 import java.lang.*;
   8 import org.mozilla.javascript.*;
   9 import org.xwt.util.*;
  10
  11 /**
  12  *  Encapsulates a template node (the &lt;template/&gt; element of a
  13  *  .xwt file, or any child element thereof). Each instance of
  14  *  Template has a <tt>nodeName</tt> -- this is the resource name of
  15  *  the file that the template node occurs in, concatenated with the
  16  *  path from the root element to this node, each step of which is in
  17  *  the form .n for some integer n. Static nodes use the string "._"
  18  *  as a path.
  19  *
  20  *  Note that the Template instance corresponding to the
  21  *  &lt;template/&gt; node carries all the header information -- hence
  22  *  some of the instance members are not meaningful on non-root
  23  *  Template instances. We refer to these non-root instances as
  24  *  <i>anonymous templates</i>.
  25  *
  26  *  See the XWT reference for information on the order in which
  27  *  templates are applied, attributes are put, and scripts are run.
  28  */
  29 public class Template {
  30
  31     // Instance Members ///////////////////////////////////////////////////////
  32
  33     /** this instance's nodeName */
  34     String nodeName;
  35
  36     /** the id of the redirect target; only meaningful on a root node */
  37     String redirect = null;
  38
  39     /** templates that should be preapplied (in the order of application); only meaningful on a root node */
  40     private String[] preapply;
  41
  42     /** 'linked' form of preapply -- the String references have been resolved into instance references */
  43     private Template[] _preapply = null;
  44
  45     /** templates that should be postapplied (in the order of application); only meaningful on a root node */
  46     private String[] postapply;
  47
  48     /** 'linked' form of postapply -- the String references have been resolved into instance references */
  49     private Template[] _postapply = null;
  50
  51     /** keys to be "put" to instances of this template; elements correspond to those of vals */
  52     private String[] keys;
  53
  54     /** values to be "put" to instances of this template; elements correspond to those of keys */
  55     private Object[] vals;
  56
  57     /** array of strings representing the importlist for this template */
  58     private String[] importlist;
  59
  60     /** child template objects */
  61     private Template[] children;
  62
  63     /** an array of the names of properties to be preserved when retheming; only meaningful on a root node */
  64     private String[] preserve = null;
  65
  66     /** the <tt>id</tt> attribute on this node */
  67     private String id = "";
  68
  69     /** see numUnits(); -1 means that this value has not yet been computed */
  70     private int numunits = -1;
  71
  72     /** true iff the resolution of this template's preapply/postapply sets changed as a result of the most recent call to retheme() */
  73     private boolean changed = false;
  74
  75     /** the script on the static node of this template, null if it has already been executed */
  76     private Script staticscript = null;
  77
  78     /** the script on this node */
  79     private Script script = null;
  80
  81     /** during XML parsing, this holds the list of currently-parsed children; null otherwise */
  82     private Vec childvect = new Vec();
  83
  84     /** during XML parsing, this holds partially-read character data; null otherwise */
  85     private StringBuffer content = null;
  86
  87     /** line number of the first line of <tt>content</tt> */
  88     private int content_start = 0;
  89
  90     /** number of lines in <tt>content</tt> */
  91     private int content_lines = 0;
  92
  93
  94     // Static data/methods ///////////////////////////////////////////////////////////////////
  95
  96     /** a template cache so that only one Template object is created for each xwt */
  97     private static Hashtable cache = new Hashtable(1000);
  98
  99     /** The default importlist; in future revisions this will contain "xwt.*" */
 100     public static final String[] defaultImportList = new String[] { };
 101
 102     /** returns the appropriate template, resolving and theming as needed */
 103     public static Template getTemplate(String name, String[] importlist) {
 104         String resolved = Resources.resolve(name + ".xwt", importlist);
 105         Template t = resolved == null ? null : (Template)cache.get(resolved.substring(0, resolved.length() - 4));
 106         if (t != null) return t;
 107         if (resolved == null) return null;
 108
 109         // note that Templates in xwar's are instantiated as read in via loadStream() --
 110         // the following code only runs when XWT is reading templates from a filesystem.
 111         ByteArrayInputStream bais = new ByteArrayInputStream(Resources.getResource(resolved));
 112         return buildTemplate(bais, resolved.substring(0, resolved.length() - 4));
 113     }
 114
 115     public static Template buildTemplate(InputStream is, String nodeName) {
 116         try {
 117             return new Template(is, nodeName);
 118         } catch (XML.SAXParseException e) {
 119             if (Log.on) Log.log(Template.class, "error parsing template at " + nodeName + ":" + e.getLineNumber() + "," + e.getColumnNumber());
 120             if (Log.on) Log.log(Template.class, e);
 121             return null;
 122         } catch (XML.SAXException e) {
 123             if (Log.on) Log.log(Template.class, "error parsing template " + nodeName);
 124             if (Log.on) Log.log(Template.class, e);
 125             return null;
 126         } catch (TemplateException te) {
 127             if (Log.on) Log.log(Template.class, "error parsing template " + nodeName);
 128             if (Log.on) Log.log(Template.class, te);
 129             return null;
 130         } catch (IOException e) {
 131             if (Log.on) Log.log(Template.class, "IOException while parsing template " + nodeName + " -- this should never happen");
 132             if (Log.on) Log.log(Template.class, e);
 133             return null;
 134         }
 135     }
 136
 137
 138     // Methods to apply templates ////////////////////////////////////////////////////////
 139
 140     private Template() { }
 141     private Template(InputStream is, String nodeName) throws XML.SAXException, IOException {
 142         this.nodeName = nodeName;
 143         cache.put(nodeName, this);
 144         new TemplateHelper().parseit(is, this);
 145     }
 146
 147     /** calculates, caches, and returns an integer approximation of how long it will take to apply this template, including pre/post and children */
 148     int numUnits() {
 149         link();
 150         if (numunits != -1) return numunits;
 151         numunits = 1;
 152         for(int i=0; _preapply != null && i<_preapply.length; i++) if (_preapply[i] != null) numunits += _preapply[i].numUnits();
 153         for(int i=0; _postapply != null && i<_postapply.length; i++) if (_postapply[i] != null) numunits += _postapply[i].numUnits();
 154         if (script != null) numunits += 10;
 155         numunits += keys == null ? 0 : keys.length;
 156         for(int i=0; children != null && i<children.length; i++) numunits += children[i].numUnits();
 157         return numunits;
 158     }
 159
 160     /** Applies the template to Box b
 161      *  @param pboxes a vector of all box parents on which to put $-references
 162      *  @param ptemplates a vector of the nodeNames to recieve private references on the pboxes
 163      */
 164     void apply(Box b, Vec pboxes, Vec ptemplates) {
 165
 166         if (pboxes == null) {
 167             pboxes = new Vec();
 168             ptemplates = new Vec();
 169         }
 170
 171         if (id != null && !id.equals(""))
 172             for(int i=0; i<pboxes.size(); i++) {
 173                 Box parent = (Box)pboxes.elementAt(i);
 174                 String parentNodeName = (String)ptemplates.elementAt(i);
 175                 parent.putPrivately("$" + id, b, parentNodeName);
 176             }
 177
 178         if (script != null) {
 179             pboxes.addElement(b);
 180             ptemplates.addElement(nodeName);
 181         }
 182
 183         int numids = pboxes.size();
 184
 185         link();
 186
 187         for(int i=0; _preapply != null && i<_preapply.length; i++)
 188             if (_preapply[i] != null) _preapply[i].apply(b, null, null);
 189
 190         for (int i=0; children != null && i<children.length; i++)
 191             b.put(Integer.MAX_VALUE, null, new Box(children[i], pboxes, ptemplates));
 192
 193         // whom to redirect to; doesn't take effect until after script runs
 194         Box redir = null;
 195         if (redirect != null && !"self".equals(redirect))
 196             redir = (Box)b.getPrivately("$" + redirect, nodeName);
 197
 198         if (script != null) try {
 199             Context cx = Context.enter();
 200             script.exec(cx, b);
 201         } catch (EcmaError e) {
 202             if (Log.on) Log.log(this, "WARNING: uncaught interpreter exception: " + e.getMessage());
 203             if (Log.on) Log.log(this, "         thrown while instantiating " + nodeName + " at " + e.getSourceName() + ":" + e.getLineNumber());
 204         } catch (JavaScriptException e) {
 205             if (Log.on) Log.log(this, "WARNING: uncaught ecmascript exception: " + e.getMessage());
 206             if (Log.on) Log.log(this, "         thrown while instantiating " + nodeName + " at " + e.sourceFile + ":" + e.line);
 207         }
 208
 209         for(int i=0; keys != null && i<keys.length; i++)
 210             if (keys[i] == null) { }
 211             else if (keys[i].equals("border") || keys[i].equals("image")) {
 212                 String s = Resources.resolve(vals[i].toString() + ".png", importlist);
 213                 if (s != null) b.put(keys[i], null, s.substring(0, s.length() - 4));
 214                 else if (Log.on) Log.log(this, "unable to resolve image " + vals[i].toString() + " referenced in attributes of " + nodeName);
 215             }
 216             else b.put(keys[i], null, vals[i]);
 217
 218         if (redirect != null && !"self".equals(redirect)) b.redirect = redir;
 219
 220         for(int i=0; _postapply != null && i<_postapply.length; i++)
 221             if (_postapply[i] != null) _postapply[i].apply(b, null, null);
 222
 223         pboxes.setSize(numids);
 224         ptemplates.setSize(numids);
 225
 226         Main.instantiatedUnits += 1 + (script == null ? 0 : 10) + (keys == null ? 0 : keys.length);
 227         Main.updateSplashScreen();
 228     }
 229
 230
 231     // Theming Logic ////////////////////////////////////////////////////////////
 232
 233     /** helper method to recursively gather up the list of keys to be preserved */
 234     private void gatherPreserves(Vec v) {
 235         for(int i=0; preserve != null && i<preserve.length; i++) v.addElement(preserve[i]);
 236         for(int i=0; _preapply != null && i<_preapply.length; i++) if (_preapply[i] != null) _preapply[i].gatherPreserves(v);
 237         for(int i=0; _postapply != null && i<_postapply.length; i++) if (_postapply[i] != null) _postapply[i].gatherPreserves(v);
 238     }
 239
 240     /** adds a theme mapping, retemplatizing as needed */
 241     public static void retheme(String from, String to) {
 242         if (Log.on) Log.log(Template.class, "retheming from " + from + " to " + to);
 243         XWF.flushXWFs();
 244         Resources.mapFrom.addElement(from);
 245         Resources.mapTo.addElement(to);
 246
 247         // clear changed marker and relink
 248         Template[] t = new Template[cache.size()];
 249         Enumeration e = cache.elements();
 250         for(int i=0; e.hasMoreElements(); i++) t[i] = (Template)e.nextElement();
 251         for(int i=0; i<t.length; i++) {
 252             t[i].changed = false;
 253             t[i].numunits = -1;
 254             t[i].link(true);
 255         }
 256
 257         for(int i=0; i<Surface.allSurfaces.size(); i++) {
 258             Box b = ((Surface)Surface.allSurfaces.elementAt(i)).root;
 259             if (b != null) reapply(b);
 260         }
 261     }
 262
 263     /** template reapplication procedure */
 264     private static void reapply(Box b) {
 265
 266         // Ref 7.5.1: check if we need to retemplatize
 267         boolean retemplatize = false;
 268         if (b.templatename != null) {
 269             Template t = getTemplate(b.templatename, b.importlist);
 270             if (t != b.template) retemplatize = true;
 271             b.template = t;
 272         }
 273         if (b.template != null && b.template.changed)
 274             retemplatize = true;
 275
 276         if (retemplatize) {
 277
 278             // Ref 7.5.2: "Preserve all properties on the box mentioned in the <preserve> elements of any
 279             //             of the templates which would be applied in step 7."
 280             Vec keys = new Vec();
 281             b.template.gatherPreserves(keys);
 282             Object[] vals = new Object[keys.size()];
 283             for(int i=0; i<keys.size(); i++) vals[i] = b.get(((String)keys.elementAt(i)), null);
 284
 285             // Ref 7.5.3: "Remove and save all children of the box, or its redirect target, if it has one"
 286             Box[] kids = null;
 287             if (b.redirect != null) {
 288                 kids = new Box[b.redirect.numChildren()];
 289                 for(int i=b.redirect.numChildren() - 1; i >= 0; i--) {
 290                     kids[i] = b.redirect.getChild(i);
 291                     kids[i].remove();
 292                 }
 293             }
 294
 295             // Ref 7.5.4: "Set the box's redirect target to self"
 296             b.redirect = b;
 297
 298             // Ref 7.5.5: "Remove all of the box's immediate children"
 299             for(Box cur = b.getChild(b.numChildren() - 1); cur != null;) {
 300                 Box oldcur = cur;
 301                 cur = cur.prevSibling();
 302                 oldcur.remove();
 303             }
 304
 305             // Ref 7.5.6: "Remove all traps set by scripts run during the application of any template to this box"
 306             Trap.removeAllTrapsByBox(b);
 307
 308             // Ref 7.5.7: "Apply the template to the box according to the usual application procedure"
 309             b.template.apply(b, null, null);
 310
 311             // Ref 7.5.8: "Re-add the saved children which were removed in step 3"
 312             for(int i=0; kids != null && i<kids.length; i++) b.put(Integer.MAX_VALUE, null, kids[i]);
 313
 314             // Ref 7.5.9: "Re-put any property values which were preserved in step 2"
 315             for(int i=0; i<keys.size(); i++) b.put((String)keys.elementAt(i), null, vals[i]);
 316         }
 317
 318         // Recurse
 319         for(Box j = b.getChild(0); j != null; j = j.nextSibling()) reapply(j);
 320     }
 321
 322     /** runs statics, resolves string references to other templates into actual Template instance references, and sets <tt>change</tt> as needed */
 323     void link() { link(false); }
 324
 325     /** same as link(), except that with a true value, it will force a re-link */
 326     private void link(boolean force) {
 327
 328         if (staticscript != null) try {
 329             Scriptable s = Static.getStatic(nodeName);
 330             if (staticscript != null) {
 331                 Script temp = staticscript;
 332                 staticscript = null;
 333                 temp.exec(Context.enter(), s);
 334             }
 335         } catch (EcmaError e) {
 336             if (Log.on) Log.log(this, "WARNING: uncaught interpreter exception: " + e.getMessage());
 337             if (Log.on) Log.log(this, "         thrown while executing <static/> block for " + nodeName +
 338                                       " at " + e.getSourceName() + ":" + e.getLineNumber());
 339         } catch (JavaScriptException e) {
 340             if (Log.on) Log.log(this, "WARNING: uncaught ecmascript exception: " + e.getMessage());
 341             if (Log.on) Log.log(this, "         thrown while executing <static/> block for " + nodeName + " at " + e.sourceFile + ":" + e.line);
 342         }
 343
 344         if (!(force || (preapply != null && _preapply == null) || (postapply != null && _postapply == null))) return;
 345
 346         if (preapply != null) {
 347             if (_preapply == null) _preapply = new Template[preapply.length];
 348             for(int i=0; i<_preapply.length; i++) {
 349                 Template t = getTemplate(preapply[i], importlist);
 350                 if (t != _preapply[i]) changed = true;
 351                 _preapply[i] = t;
 352             }
 353         }
 354         if (postapply != null) {
 355             if (_postapply == null) _postapply = new Template[postapply.length];
 356             for(int i=0; i<_postapply.length; i++) {
 357                 Template t = getTemplate(postapply[i], importlist);
 358                 if (t != _postapply[i]) changed = true;
 359                 _postapply[i] = t;
 360             }
 361         }
 362
 363         for(int i=0; children != null && i<children.length; i++) children[i].link(force);
 364     }
 365
 366
 367     // XML Parsing /////////////////////////////////////////////////////////////////
 368
 369     /** handles XML parsing; builds a Template tree as it goes */
 370     private static class TemplateHelper extends XML {
 371
 372         TemplateHelper() {
 373             for(int i=0; i<defaultImportList.length; i++) importlist.addElement(defaultImportList[i]);
 374         }
 375
 376         /** parse an XML input stream, building a Template tree off of <tt>root</tt> */
 377         void parseit(InputStream is, Template root) throws XML.SAXException, IOException {
 378             t = root;
 379             parse(new TabAndMaxColumnEnforcingReader(new InputStreamReader(is), root.nodeName));
 380         }
 381
 382         /** parsing state: true iff we have already encountered the <xwt> open-tag */
 383         boolean rootNodeHasBeenEncountered = false;
 384
 385         /** parsing state: true iff we have already encountered the <template> open-tag */
 386         boolean templateNodeHasBeenEncountered = false;
 387
 388         /** parsing state: true iff we have already encountered the <static> open-tag */
 389         boolean staticNodeHasBeenEncountered = false;
 390
 391         /** parsing state: true iff we have already encountered the <template> close-tag */
 392         boolean templateNodeHasBeenFinished = false;
 393
 394         /** parsing state: If we have encountered the open tag of a header node, but not the close tag, this is the name of
 395          *  that tag; otherwise, it is null. */
 396         String nameOfHeaderNodeBeingProcessed = null;
 397
 398         /** stack of Templates whose XML elements we have seen open-tags for but not close-tags */
 399         Vec nodeStack = new Vec();
 400
 401         /** builds up the list of imports */
 402         Vec importlist = new Vec();
 403
 404         /** builds up the list of preapplies */
 405         Vec preapply = new Vec();
 406
 407         /** builds up the list of postapplies */
 408         Vec postapply = new Vec();
 409
 410         /** the template we're currently working on */
 411         Template t = null;
 412
 413         public void startElement(String name, String[] keys, Object[] vals, int line, int col) throws XML.SAXException {
 414
 415             if (templateNodeHasBeenFinished) {
 416                 throw new XML.SAXException("no elements may appear after the <template> node");
 417
 418             } else if (!rootNodeHasBeenEncountered) {
 419                 if (!"xwt".equals(name)) throw new XML.SAXException("root element was not <xwt>");
 420                 if (keys.length != 0) throw new XML.SAXException("root element must not have attributes");
 421                 rootNodeHasBeenEncountered = true;
 422                 return;
 423
 424             } else if (!templateNodeHasBeenEncountered) {
 425                 if (nameOfHeaderNodeBeingProcessed != null) throw new XML.SAXException("can't nest header nodes");
 426                 nameOfHeaderNodeBeingProcessed = name;
 427
 428                 if (name.equals("import")) {
 429                     if (keys.length != 1 || !keys[0].equals("name"))
 430                         throw new XML.SAXException("<import> node must have exactly one attribute, which must be called 'name'");
 431                     String importpackage = vals[0].toString();
 432                     if (importpackage.endsWith(".*")) importpackage = importpackage.substring(0, importpackage.length() - 2);
 433                     importlist.addElement(importpackage);
 434                     return;
 435
 436                 } else if (name.equals("redirect")) {
 437                     if (keys.length != 1 || !keys[0].equals("target"))
 438                         throw new XML.SAXException("<redirect> node must have exactly one attribute, which must be called 'target'");
 439                     if (t.redirect != null)
 440                         throw new XML.SAXException("the <redirect> header element may not appear more than once");
 441                     t.redirect = vals[0].toString();
 442                     return;
 443
 444                 } else if (name.equals("preapply")) {
 445                     if (keys.length != 1 || !keys[0].equals("name"))
 446                         throw new XML.SAXException("<preapply> node must have exactly one attribute, which must be called 'name'");
 447                     preapply.addElement(vals[0]);
 448                     return;
 449
 450                 } else if (name.equals("postapply")) {
 451                     if (keys.length != 1 || !keys[0].equals("name"))
 452                         throw new XML.SAXException("<postapply> node must have exactly one attribute, which must be called 'name'");
 453                     postapply.addElement(vals[0]);
 454                     return;
 455
 456                 } else if (name.equals("static")) {
 457                     if (staticNodeHasBeenEncountered)
 458                         throw new XML.SAXException("the <static> header node may not appear more than once");
 459                     if (keys.length > 0)
 460                         throw new XML.SAXException("the <static> node may not have attributes");
 461                     staticNodeHasBeenEncountered = true;
 462                     return;
 463
 464                 } else if (name.equals("preserve")) {
 465                     if (keys.length != 1 || !keys[0].equals("attributes"))
 466                         throw new XML.SAXException("<preserve> node must have exactly one attribute, which must be called 'attributes'");
 467                     if (t.preserve != null)
 468                         throw new XML.SAXException("<preserve> header element may not appear more than once");
 469
 470                     StringTokenizer tok = new StringTokenizer(vals[0].toString(), ",", false);
 471                     t.preserve = new String[tok.countTokens()];
 472                     for(int i=0; i<t.preserve.length; i++) t.preserve[i] = tok.nextToken();
 473                     return;
 474
 475                 } else if (name.equals("template")) {
 476                     // finalize importlist/preapply/postapply, since they can't change from here on
 477                     importlist.toArray(t.importlist = new String[importlist.size()]);
 478                     if (preapply.size() > 0) preapply.copyInto(t.preapply = new String[preapply.size()]);
 479                     if (postapply.size() > 0) postapply.copyInto(t.postapply = new String[postapply.size()]);
 480                     importlist = preapply = postapply = null;
 481                     templateNodeHasBeenEncountered = true;
 482
 483                 } else {
 484                     throw new XML.SAXException("unrecognized header node \"" + name + "\"");
 485
 486                 }
 487
 488             } else {
 489
 490                 // push the last node we were in onto the stack
 491                 nodeStack.addElement(t);
 492
 493                 // instantiate a new node, and set its nodeName/importlist/preapply
 494                 Template t2 = new Template();
 495                 t2.nodeName = t.nodeName + "." + t.childvect.size();
 496                 t2.importlist = t.importlist;
 497                 if (!name.equals("box")) t2.preapply = new String[] { name };
 498
 499                 // make the new node the current node
 500                 t = t2;
 501
 502             }
 503
 504             t.keys = keys;
 505             t.vals = vals;
 506
 507             quickSortAttributes(0, t.keys.length - 1);
 508
 509             for(int i=0; i<t.keys.length; i++) {
 510                 if (t.keys[i].equals("id")) {
 511                     t.id = vals[i].toString().intern();
 512                     t.keys[i] = null;
 513                     continue;
 514                 }
 515
 516                 t.keys[i] = t.keys[i].intern();
 517
 518                 String valString = vals[i].toString();
 519
 520                 if (valString.equals("true")) t.vals[i] = Boolean.TRUE;
 521                 else if (valString.equals("false")) t.vals[i] = Boolean.FALSE;
 522                 else if (valString.equals("null")) t.vals[i] = null;
 523                 else {
 524                     boolean hasNonNumeral = false;
 525                     boolean periodUsed = false;
 526                     for(int j=0; j<valString.length(); j++)
 527                         if (j == 0 && valString.charAt(j) == '-') {
 528                         } else if (valString.charAt(j) == '.' && !periodUsed && j != valString.length() - 1)
 529                             periodUsed = true;
 530                         else if (valString.charAt(j) == '0' && (j == 0 || (j == 1 && valString.charAt(0) == '-'))) {
 531                             hasNonNumeral = true;
 532                             break;
 533                         } else if (!Character.isDigit(valString.charAt(j))) {
 534                             hasNonNumeral = true;
 535                             break;
 536                         }
 537                     if (valString.length() > 0 && !hasNonNumeral) vals[i] = new Double(valString);
 538                     else vals[i] = valString.intern();
 539                 }
 540
 541                 // bump thisbox to the front of the pack
 542                 if (t.keys[i].equals("thisbox")) {
 543                     t.keys[i] = t.keys[0];
 544                     t.keys[0] = "thisbox";
 545                     Object o = t.vals[0];
 546                     t.vals[0] = t.vals[i];
 547                     t.vals[i] = o;
 548                 }
 549             }
 550         }
 551
 552         /** simple quicksort, from http://sourceforge.net/snippet/detail.php?type=snippet&id=100240 */
 553         private int partitionAttributes(int left, int right) {
 554             int i, j, middle;
 555             middle = (left + right) / 2;
 556             String s = t.keys[right]; t.keys[right] = t.keys[middle]; t.keys[middle] = s;
 557             Object o = t.vals[right]; t.vals[right] = t.vals[middle]; t.vals[middle] = o;
 558             for (i = left - 1, j = right; ; ) {
 559                 while (t.keys[++i].compareTo(t.keys[right]) < 0);
 560                 while (j > left && t.keys[--j].compareTo(t.keys[right]) > 0);
 561                 if (i >= j) break;
 562                 s = t.keys[i]; t.keys[i] = t.keys[j]; t.keys[j] = s;
 563                 o = t.vals[i]; t.vals[i] = t.vals[j]; t.vals[j] = o;
 564             }
 565             s = t.keys[right]; t.keys[right] = t.keys[i]; t.keys[i] = s;
 566             o = t.vals[right]; t.vals[right] = t.vals[i]; t.vals[i] = o;
 567             return i;
 568         }
 569
 570         /** simple quicksort, from http://sourceforge.net/snippet/detail.php?type=snippet&id=100240 */
 571         private void quickSortAttributes(int left, int right) {
 572             if (left >= right) return;
 573             int p = partitionAttributes(left, right);
 574             quickSortAttributes(left, p - 1);
 575             quickSortAttributes(p + 1, right);
 576         }
 577
 578         public void endElement(String name, int line, int col) throws XML.SAXException {
 579
 580             boolean hasNonWhitespace = false;
 581
 582             int len = t == null || t.content == null ? 0 : t.content.length();
 583             for(int i=0; t.content != null && i<len; i++)
 584
 585                 // ignore double-slash comment blocks
 586                 if (t.content.charAt(i) == '/' && t.content.charAt(i + 1) == '/') {
 587                     while(t.content.charAt(i) != '\n' && i<len) i++;
 588                     i--;
 589
 590                 // ignore /* .. */ comment blocks
 591                 } else if (i<len - 1 && t.content.charAt(i) == '/' && t.content.charAt(i + 1) == '*') {
 592                     i += 2;
 593                     while(i<len - 1 && !(t.content.charAt(i) == '*' && t.content.charAt(i + 1) == '/')) i++;
 594                     if (i<len - 1 && t.content.charAt(i) == '*' && t.content.charAt(i + 1) == '/') i += 2;
 595                     i--;
 596
 597                 // check for named functions
 598                 } else if (i + 8 <= len && t.content.charAt(i) == 'f' && t.content.charAt(i+1) == 'u' &&
 599                            t.content.charAt(i+2) == 'n' && t.content.charAt(i+3) == 'c' && t.content.charAt(i+4) == 't' &&
 600                            t.content.charAt(i+5) == 'i' && t.content.charAt(i+6) == 'o' && t.content.charAt(i+7) == 'n') {
 601                     int j = i + 8;
 602                     while(j<len && Character.isWhitespace(t.content.charAt(j))) j++;
 603                     if (j<len && t.content.charAt(j) != '(')
 604                         throw new XML.SAXException("named functions are not permitted in XWT -- instead of \"function foo() { ... }\"," +
 605                                         " use \"foo = function() { ... }\"");
 606
 607                 // replace " and " with " && "
 608                 } else if (i + 5 < len && Character.isWhitespace(t.content.charAt(i)) &&
 609                            t.content.charAt(i+1) == 'a' && t.content.charAt(i+2) == 'n' && t.content.charAt(i+3) == 'd' &&
 610                            Character.isWhitespace(t.content.charAt(i + 4))) {
 611                     t.content.setCharAt(i+1, '&');
 612                     t.content.setCharAt(i+2, '&');
 613                     t.content.setCharAt(i+3, ' ');
 614                     hasNonWhitespace = true;
 615
 616                 // generic check for nonwhitespace
 617                 } else if (!Character.isWhitespace(t.content.charAt(i))) {
 618                     hasNonWhitespace = true;
 619
 620                 }
 621
 622             if (rootNodeHasBeenEncountered && !templateNodeHasBeenEncountered) {
 623                 if ("static".equals(nameOfHeaderNodeBeingProcessed) && hasNonWhitespace) t.staticscript = genscript(true);
 624                 nameOfHeaderNodeBeingProcessed = null;
 625
 626             } else if (templateNodeHasBeenEncountered && !templateNodeHasBeenFinished) {
 627
 628                 // turn our childvect into a Template[]
 629                 t.childvect.copyInto(t.children = new Template[t.childvect.size()]);
 630                 t.childvect = null;
 631                 if (hasNonWhitespace) t.script = genscript(false);
 632
 633                 if (nodeStack.size() == 0) {
 634                     // </template>
 635                     templateNodeHasBeenFinished = true;
 636
 637                 } else {
 638                     // add this template as a child of its parent
 639                     Template oldt = t;
 640                     t = (Template)nodeStack.lastElement();
 641                     nodeStack.setSize(nodeStack.size() - 1);
 642                     t.childvect.addElement(oldt);
 643                 }
 644
 645             }
 646         }
 647
 648         private Script genscript(boolean isstatic) {
 649             Script thisscript = null;
 650             Context cx = Context.enter();
 651             cx.setOptimizationLevel(-1);
 652
 653             try {
 654                 thisscript = cx.compileReader(null, new StringReader(t.content.toString()), t.nodeName + (isstatic ? "._" : ""), t.content_start, null);
 655             } catch (EcmaError ee) {
 656                 if (Log.on) Log.log(this, ee.getMessage() + " at " + ee.getSourceName() + ":" + ee.getLineNumber());
 657                 thisscript = null;
 658             } catch (EvaluatorException ee) {
 659                 if (Log.on) Log.log(this, "  ERROR: " + ee.getMessage());
 660                 thisscript = null;
 661             } catch (IOException ioe) {
 662                 if (Log.on) Log.log(this, "IOException while compiling script; this should never happen");
 663                 if (Log.on) Log.log(this, ioe);
 664                 thisscript = null;
 665             }
 666
 667             t.content = null;
 668             t.content_start = 0;
 669             t.content_lines = 0;
 670             return thisscript;
 671         }
 672
 673         public void content(char[] ch, int start, int length, int line, int col) throws XML.SAXException {
 674             if ("static".equals(nameOfHeaderNodeBeingProcessed) || templateNodeHasBeenEncountered) {
 675                 int contentlines = 0;
 676                 for(int i=start; i<start + length; i++) if (ch[i] == '\n') contentlines++;
 677                 line -= contentlines;
 678
 679                 if (t.content == null) {
 680                     t.content_start = line;
 681                     t.content_lines = 0;
 682                     t.content = new StringBuffer();
 683                 }
 684
 685                 for(int i=t.content_start + t.content_lines; i<line; i++) {
 686                     t.content.append('\n');
 687                     t.content_lines++;
 688                 }
 689
 690                 t.content.append(ch, start, length);
 691                 t.content_lines += contentlines;
 692
 693             } else if (nameOfHeaderNodeBeingProcessed != null) {
 694                 throw new XML.SAXException("header node <" + nameOfHeaderNodeBeingProcessed + "> cannot have text content");
 695
 696             }
 697
 698         }
 699
 700     }
 701
 702     /** a filtering reader that watches for tabs and long lines */
 703     private static class TabAndMaxColumnEnforcingReader extends FilterReader {
 704         private int MAX_COLUMN = 150;
 705         private int column = 0;
 706         private int line = 1;
 707         private boolean lastCharWasCR = false;
 708         private String filename;
 709         public TabAndMaxColumnEnforcingReader(Reader r, String filename) { super(r); this.filename = filename; }
 710         public int read() {
 711             if (Log.on) Log.log(this, this.getClass().getName() + ".read() not supported, this should never happen");
 712             return -1;
 713         }
 714         public long skip(long numskip) {
 715             if (Log.on) Log.log(this, this.getClass().getName() + ".skip() not supported; this should never happen");
 716             return numskip;
 717         }
 718         public int read(char[] buf, int off, int len) throws IOException {
 719             int ret = super.read(buf, off, len);
 720             for(int i=off; i<off + ret; i++)
 721                 if (buf[i] == '\t') {
 722                     throw new TemplateException(filename + ":" + line + "," + column + ": tabs are not allowed in XWT files");
 723                 } else if (buf[i] == '\r') {
 724                     column = 0;
 725                     line++;
 726                     lastCharWasCR = true;
 727                 } else if (buf[i] == '\n') {
 728                     column = 0;
 729                     if (!lastCharWasCR) line++;
 730                 } else if (++column > MAX_COLUMN) {
 731                     throw new TemplateException(filename + ":" + line + ": lines longer than " + MAX_COLUMN + " characters not allowed");
 732                 } else {
 733                     lastCharWasCR = false;
 734                 }
 735             return ret;
 736         }
 737     }
 738
 739     private static class TemplateException extends IOException {
 740         TemplateException(String s) { super(s); }
 741     }
 742
 743 }
 744
 745