2003/06/29 21:20:38
[org.ibex.core.git] / 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.xwt.js.*;
9 import org.xwt.util.*;
10
11 /**
12  *  Encapsulates a template node (the <template/> 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 JS.CompiledFunction staticscript = null;
77
78     /** the script on this node */
79     private JS.CompiledFunction 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     /** the line number that this element starts on */
94     private int startLine = -1;
95
96     // Static data/methods ///////////////////////////////////////////////////////////////////
97
98     /** a template cache so that only one Template object is created for each xwt */
99     private static Hashtable cache = new Hashtable(1000);
100
101     /** The default importlist; in future revisions this will contain "xwt.*" */
102     public static final String[] defaultImportList = new String[] { };
103
104     /** returns the appropriate template, resolving and theming as needed */
105     public static Template getTemplate(String name, String[] importlist) {
106         String resolved = Resources.resolve(name + ".xwt", importlist);
107         Template t = resolved == null ? null : (Template)cache.get(resolved.substring(0, resolved.length() - 4));
108         if (t != null) return t;
109         if (resolved == null) return null;
110
111         // note that Templates in xwar's are instantiated as read in via loadStream() --
112         // the following code only runs when XWT is reading templates from a filesystem.
113         ByteArrayInputStream bais = new ByteArrayInputStream(Resources.getResource(resolved));
114         return buildTemplate(bais, resolved.substring(0, resolved.length() - 4));
115     }
116
117     public static Template buildTemplate(InputStream is, String nodeName) {
118         return buildTemplate(is, nodeName, new TemplateHelper());
119     }
120
121     public static Template buildTemplate(InputStream is, String nodeName, TemplateHelper t) {
122         try {
123             return new Template(is, nodeName, t);
124         } catch (XML.SchemaException e) {
125             if (Log.on) Log.log(Template.class, "error parsing template " + nodeName);
126             if (Log.on) Log.log(Template.class, e.getMessage());
127             return null;
128         } catch (XML.XMLException e) {
129             if (Log.on) Log.log(Template.class, "error parsing template at " + nodeName + ":" + e.getLine() + "," + e.getCol());
130             if (Log.on) Log.log(Template.class, e.getMessage());
131             return null;
132         } catch (IOException e) {
133             if (Log.on) Log.log(Template.class, "IOException while parsing template " + nodeName + " -- this should never happen");
134             if (Log.on) Log.log(Template.class, e);
135             return null;
136         }
137     }
138
139
140     // Methods to apply templates ////////////////////////////////////////////////////////
141
142     private Template(String nodeName) {
143         this.nodeName = nodeName;
144         cache.put(nodeName, this);
145     }
146     private Template(InputStream is, String nodeName, TemplateHelper th) throws XML.XMLException, IOException {
147         this(nodeName);
148         th.parseit(is, this);
149     }
150
151     /** calculates, caches, and returns an integer approximation of how long it will take to apply this template, including pre/post and children */
152     int numUnits() {
153         link();
154         if (numunits != -1) return numunits;
155         numunits = 1;
156         for(int i=0; _preapply != null && i<_preapply.length; i++) if (_preapply[i] != null) numunits += _preapply[i].numUnits();
157         for(int i=0; _postapply != null && i<_postapply.length; i++) if (_postapply[i] != null) numunits += _postapply[i].numUnits();
158         if (script != null) numunits += 10;
159         numunits += keys == null ? 0 : keys.length;
160         for(int i=0; children != null && i<children.length; i++) numunits += children[i].numUnits();
161         return numunits;
162     }
163     
164     /** Applies the template to Box b
165      *  @param pboxes a vector of all box parents on which to put $-references
166      *  @param ptemplates a vector of the nodeNames to recieve private references on the pboxes
167      */
168     void apply(Box b, Vec pboxes, Vec ptemplates, JS.Callable callback, int numerator, int denominator) {
169
170         int original_numerator = numerator;
171
172         if (pboxes == null) {
173             pboxes = new Vec();
174             ptemplates = new Vec();
175         }
176
177         if (id != null && !id.equals(""))
178             for(int i=0; i<pboxes.size(); i++) {
179                 Box parent = (Box)pboxes.elementAt(i);
180                 String parentNodeName = (String)ptemplates.elementAt(i);
181                 parent.put("$" + id, b);
182             }
183
184         if (script != null || (redirect != null && !"self".equals(redirect))) {
185             pboxes.addElement(b);
186             ptemplates.addElement(nodeName);
187         }
188
189         int numids = pboxes.size();
190         
191         link();
192
193         for(int i=0; _preapply != null && i<_preapply.length; i++)
194             if (_preapply[i] != null) {
195                 _preapply[i].apply(b, null, null, callback, numerator, denominator);
196                 numerator += _preapply[i].numUnits();
197             }
198
199         for (int i=0; children != null && i<children.length; i++) {
200             b.put(Integer.MAX_VALUE, new Box(children[i], pboxes, ptemplates, callback, numerator, denominator));
201             numerator += children[i].numUnits();
202         }
203
204         // whom to redirect to; doesn't take effect until after script runs
205         Box redir = null;
206         if (redirect != null && !"self".equals(redirect)) redir = (Box)b.get("$" + redirect);
207
208         if (script != null) try {
209             script.call(new JS.Array(), b);
210         } catch (JS.Exn e) {
211             if (Log.on) Log.log(this, "WARNING: uncaught ecmascript exception: " + e.getMessage());
212         }
213
214         for(int i=0; keys != null && i<keys.length; i++) {
215             try {
216                 if (keys[i] == null) { }
217                 else if (keys[i].equals("border") || keys[i].equals("image") &&
218                         !vals[i].toString().startsWith("http://") && !vals[i].toString().startsWith("https://")) {
219                     String s = Resources.resolve(vals[i].toString() + ".png", importlist);
220                     if (s != null) b.put(keys[i], s.substring(0, s.length() - 4));
221                     else if (Log.on) Log.log(this, "unable to resolve image " + vals[i].toString() + " referenced in attributes of " + nodeName); 
222                 }
223                 else b.put(keys[i], vals[i]);
224             } catch(JS.Exn e) {
225                 if(Log.on) Log.log(this,"WARNING: uncaught ecmascript exception while putting attr \"" + keys[i] + 
226                     "\" of " + nodeName + " : " + e.getMessage());
227             }
228         }
229
230         if (redirect != null && !"self".equals(redirect)) b.redirect = redir;
231
232         for(int i=0; _postapply != null && i<_postapply.length; i++)
233             if (_postapply[i] != null) {
234                 _postapply[i].apply(b, null, null, callback, numerator, denominator);
235                 numerator += _postapply[i].numUnits();
236             }
237
238         pboxes.setSize(numids);
239         ptemplates.setSize(numids);
240
241         numerator = original_numerator + numUnits();
242
243         if (callback != null)
244             try {
245                 JS.Array args = new JS.Array();
246                 args.addElement(new Double(numerator));
247                 args.addElement(new Double(denominator));
248                 callback.call(args);
249             } catch (JS.Exn e) {
250                 if (Log.on) Log.log(this, "WARNING: uncaught ecmascript exception: " + e);
251             }
252
253         if (Thread.currentThread() instanceof ThreadMessage) try {
254             XWT.sleep(0);
255         } catch (JS.Exn e) {
256             if (Log.on) Log.log(this, "WARNING: uncaught ecmascript exception: " + e);
257         }
258     }
259
260
261     // Theming Logic ////////////////////////////////////////////////////////////
262
263     /** helper method to recursively gather up the list of keys to be preserved */
264     private void gatherPreserves(Vec v) {
265         for(int i=0; preserve != null && i<preserve.length; i++) v.addElement(preserve[i]);
266         for(int i=0; _preapply != null && i<_preapply.length; i++) if (_preapply[i] != null) _preapply[i].gatherPreserves(v);
267         for(int i=0; _postapply != null && i<_postapply.length; i++) if (_postapply[i] != null) _postapply[i].gatherPreserves(v);
268     }
269
270     /** adds a theme mapping, retemplatizing as needed */
271     public static void retheme(JS.Callable callback) {
272         XWF.flushXWFs();
273
274         // clear changed marker and relink
275         Template[] t = new Template[cache.size()];
276         Enumeration e = cache.elements();
277         for(int i=0; e.hasMoreElements(); i++) t[i] = (Template)e.nextElement();
278         for(int i=0; i<t.length; i++) {
279             t[i].changed = false;
280             t[i].numunits = -1;
281             t[i].link(true);
282         }
283
284         for(int i=0; i<Surface.allSurfaces.size(); i++) {
285             Box b = ((Surface)Surface.allSurfaces.elementAt(i)).root;
286             if (b != null) reapply(b);
287         }
288
289         if (callback != null)
290             try {
291                 JS.Array args = new JS.Array();
292                 args.addElement(new Double(1.0));
293                 args.addElement(new Double(1.0));
294                 callback.call(args);
295             } catch (JS.Exn ex) {
296                 if (Log.on) Log.log(Template.class, "WARNING: uncaught ecmascript exception: " + ex.getMessage());
297             }
298     }
299
300     /** template reapplication procedure */
301     private static void reapply(Box b) {
302
303         Log.log(Template.class, "Template.reapply() not implemented");
304         /*
305         // Ref 7.5.1: check if we need to retemplatize
306         boolean retemplatize = false;
307         if (b.templatename != null) {
308             Template t = getTemplate(b.templatename, b.importlist);
309             if (t != b.template) retemplatize = true;
310             b.template = t;
311         }
312         if (b.template != null && b.template.changed) retemplatize = true;
313
314         if (retemplatize) {
315
316             // Ref 7.5.2: "Preserve all properties on the box mentioned in the <preserve> elements of any
317             //             of the templates which would be applied in step 7."
318             Vec keys = new Vec();
319             b.template.gatherPreserves(keys);
320             Object[] vals = new Object[keys.size()];
321             for(int i=0; i<keys.size(); i++) vals[i] = b.get(((String)keys.elementAt(i)), null);
322             
323             // Ref 7.5.3: "Remove and save all children of the box, or its redirect target, if it has one"
324             Box[] kids = null;
325             if (b.redirect != null) {
326                 kids = new Box[b.redirect.numChildren()];
327                 for(int i=b.redirect.numChildren() - 1; i >= 0; i--) {
328                     kids[i] = b.redirect.getChild(i);
329                     kids[i].remove();
330                 }
331             }
332             
333             // Ref 7.5.4: "Set the box's redirect target to self"
334             b.redirect = b;
335             
336             // Ref 7.5.5: "Remove all of the box's immediate children"
337             for(Box cur = b.getChild(b.numChildren() - 1); cur != null;) {
338                 Box oldcur = cur;
339                 cur = cur.prevSibling();
340                 oldcur.remove();
341             }
342             
343             // Ref 7.5.6: "Remove all traps set by scripts run during the application of any template to this box"
344             Trap.removeAllTrapsByBox(b);
345             
346             // Ref 7.5.7: "Apply the template to the box according to the usual application procedure"
347             b.template.apply(b, null, null, null, 0, 1);
348             
349             // Ref 7.5.8: "Re-add the saved children which were removed in step 3"
350             for(int i=0; kids != null && i<kids.length; i++) b.put(Integer.MAX_VALUE, null, kids[i]);
351             
352             // Ref 7.5.9: "Re-put any property values which were preserved in step 2"
353             for(int i=0; i<keys.size(); i++) b.put((String)keys.elementAt(i), null, vals[i]);
354         }        
355
356         // Recurse
357         for(Box j = b.getChild(0); j != null; j = j.nextSibling()) reapply(j);
358         */
359     }
360
361     /** runs statics, resolves string references to other templates into actual Template instance references, and sets <tt>change</tt> as needed */
362     void link() { link(false); }
363
364     /** same as link(), except that with a true value, it will force a re-link */
365     private void link(boolean force) {
366
367         if (staticscript != null) try { 
368             JS.Scope s = Static.createStatic(nodeName, false);
369             if (staticscript != null) {
370                 JS.CompiledFunction temp = staticscript;
371                 staticscript = null;
372
373                 // we layer a transparent scope over the Static so that we can catch requests for the xwt object
374                 // yet not screw up paths that include a package called xwt (ie xwt.static.org.xwt.foo)
375                 JS.Scope varScope = new JS.Scope(s) {
376                         public boolean isTransparent() { return true; }
377                         public Object get(Object key) {
378                             if ("xwt".equals(key)) return XWT.singleton; else return super.get(key);
379                         } };
380
381                 temp.call(new JS.Array(), varScope);
382             }
383         } catch (JS.Exn e) {
384             if (Log.on) Log.log(this, "WARNING: uncaught ecmascript exception: " + e.getMessage());
385         }
386
387         if (!(force || (preapply != null && _preapply == null) || (postapply != null && _postapply == null))) return;
388         
389         if (preapply != null) {
390             if (_preapply == null) _preapply = new Template[preapply.length];
391             for(int i=0; i<_preapply.length; i++) {
392                 Template t = getTemplate(preapply[i], importlist);
393                 if (t != _preapply[i]) changed = true;
394                 _preapply[i] = t;
395             }
396         }
397         if (postapply != null) {
398             if (_postapply == null) _postapply = new Template[postapply.length];
399             for(int i=0; i<_postapply.length; i++) {
400                 Template t = getTemplate(postapply[i], importlist);
401                 if (t != _postapply[i]) changed = true;
402                 _postapply[i] = t;
403             }
404         }
405
406         for(int i=0; children != null && i<children.length; i++) children[i].link(force);
407     }
408
409
410     // XML Parsing /////////////////////////////////////////////////////////////////
411
412     /** handles XML parsing; builds a Template tree as it goes */
413     static final class TemplateHelper extends XML {
414
415         TemplateHelper() { }
416
417         /** parse an XML input stream, building a Template tree off of <tt>root</tt> */
418         void parseit(InputStream is, Template root) throws XML.XMLException, IOException {
419             rootNodeHasBeenEncountered = false;
420             templateNodeHasBeenEncountered = false;
421             staticNodeHasBeenEncountered = false;
422             templateNodeHasBeenFinished = false;
423             nameOfHeaderNodeBeingProcessed = null;
424
425             nodeStack.setSize(0);
426             importlist.setSize(0);
427             preapply.setSize(0);
428             postapply.setSize(0);
429
430             importlist.fromArray(defaultImportList);
431
432             t = root;
433             parse(new InputStreamReader(is)); 
434         }
435
436         /** parsing state: true iff we have already encountered the <xwt> open-tag */
437         boolean rootNodeHasBeenEncountered = false;
438
439         /** parsing state: true iff we have already encountered the <template> open-tag */
440         boolean templateNodeHasBeenEncountered = false;
441
442         /** parsing state: true iff we have already encountered the <static> open-tag */
443         boolean staticNodeHasBeenEncountered = false;
444
445         /** parsing state: true iff we have already encountered the <template> close-tag */
446         boolean templateNodeHasBeenFinished = false;
447
448         /** parsing state: If we have encountered the open tag of a header node, but not the close tag, this is the name of
449          *  that tag; otherwise, it is null. */
450         String nameOfHeaderNodeBeingProcessed = null;
451
452         /** stack of Templates whose XML elements we have seen open-tags for but not close-tags */
453         Vec nodeStack = new Vec();
454
455         /** builds up the list of imports */
456         Vec importlist = new Vec();
457
458         /** builds up the list of preapplies */
459         Vec preapply = new Vec();
460
461         /** builds up the list of postapplies */
462         Vec postapply = new Vec();
463
464         /** the template we're currently working on */
465         Template t = null;
466
467         public void startElement(XML.Element c) throws XML.SchemaException {
468             if (templateNodeHasBeenFinished) {
469                 throw new XML.SchemaException("no elements may appear after the <template> node");
470
471             } else if (!rootNodeHasBeenEncountered) {
472                 if (!"xwt".equals(c.localName)) throw new XML.SchemaException("root element was not <xwt>");
473                 if (c.len != 0) throw new XML.SchemaException("root element must not have attributes");
474                 rootNodeHasBeenEncountered = true;
475                 return;
476         
477             } else if (!templateNodeHasBeenEncountered) {
478                 if (nameOfHeaderNodeBeingProcessed != null) throw new XML.SchemaException("can't nest header nodes");
479                 nameOfHeaderNodeBeingProcessed = c.localName;
480
481                 if (c.localName.equals("import")) {
482                     if (c.len != 1 || !c.keys[0].equals("name"))
483                         throw new XML.SchemaException("<import> node must have exactly one attribute, which must be called 'name'");
484                     String importpackage = c.vals[0].toString();
485                     if (importpackage.endsWith(".*")) importpackage = importpackage.substring(0, importpackage.length() - 2);
486                     importlist.addElement(importpackage);
487                     return;
488
489                 } else if (c.localName.equals("redirect")) {
490                     if (c.len != 1 || !c.keys[0].equals("target"))
491                         throw new XML.SchemaException("<redirect> node must have exactly one attribute, which must be called 'target'");
492                     if (t.redirect != null)
493                         throw new XML.SchemaException("the <redirect> header element may not appear more than once");
494                     t.redirect = c.vals[0].toString();
495                     if(t.redirect.equals("null")) t.redirect = null;
496                     return;
497
498                 } else if (c.localName.equals("preapply")) {
499                     if (c.len != 1 || !c.keys[0].equals("name"))
500                         throw new XML.SchemaException("<preapply> node must have exactly one attribute, which must be called 'name'");
501                     preapply.addElement(c.vals[0]);
502                     return;
503
504                 } else if (c.localName.equals("postapply")) {
505                     if (c.len != 1 || !c.keys[0].equals("name"))
506                         throw new XML.SchemaException("<postapply> node must have exactly one attribute, which must be called 'name'");
507                     postapply.addElement(c.vals[0]);
508                     return;
509
510                 } else if (c.localName.equals("static")) {
511                     if (staticNodeHasBeenEncountered)
512                         throw new XML.SchemaException("the <static> header node may not appear more than once");
513                     if (c.len > 0)
514                         throw new XML.SchemaException("the <static> node may not have attributes");
515                     staticNodeHasBeenEncountered = true;
516                     return;
517
518                 } else if (c.localName.equals("preserve")) {
519                     if (c.len != 1 || !c.keys[0].equals("attributes"))
520                         throw new XML.SchemaException("<preserve> node must have exactly one attribute, which must be called 'attributes'");
521                     if (t.preserve != null)
522                         throw new XML.SchemaException("<preserve> header element may not appear more than once");
523
524                     StringTokenizer tok = new StringTokenizer(c.vals[0].toString(), ",", false);
525                     t.preserve = new String[tok.countTokens()];
526                     for(int i=0; i<t.preserve.length; i++) t.preserve[i] = tok.nextToken();
527                     return;
528
529                 } else if (c.localName.equals("template")) {
530                     // finalize importlist/preapply/postapply, since they can't change from here on
531                     t.startLine = getLine();
532                     importlist.toArray(t.importlist = new String[importlist.size()]);
533                     if (preapply.size() > 0) preapply.copyInto(t.preapply = new String[preapply.size()]);
534                     if (postapply.size() > 0) postapply.copyInto(t.postapply = new String[postapply.size()]);
535                     importlist.setSize(0); preapply.setSize(0); postapply.setSize(0);
536                     templateNodeHasBeenEncountered = true;
537
538                 } else {
539                     throw new XML.SchemaException("unrecognized header node \"" + c.localName + "\"");
540
541                 }
542
543             } else {
544
545                 // push the last node we were in onto the stack
546                 nodeStack.addElement(t);
547
548                 // instantiate a new node, and set its nodeName/importlist/preapply
549                 Template t2 = new Template(t.nodeName + "." + t.childvect.size());
550                 t2.importlist = t.importlist;
551                 t2.startLine = getLine();
552                 if (!c.localName.equals("box")) t2.preapply = new String[] { c.localName };
553
554                 // make the new node the current node
555                 t = t2;
556
557             }
558
559             // TODO: Sort contents straight from one array to another
560             t.keys = new String[c.len];
561             t.vals = new Object[c.len];
562             System.arraycopy(c.keys, 0, t.keys, 0, c.len);
563             System.arraycopy(c.vals, 0, t.vals, 0, c.len);
564             quickSortAttributes(0, t.keys.length - 1);
565
566             for(int i=0; i<t.keys.length; i++) {
567                 if (t.keys[i].equals("id")) {
568                     t.id = t.vals[i].toString().intern();
569                     t.keys[i] = null;
570                     continue;
571                 }
572
573                 t.keys[i] = t.keys[i].intern();
574
575                 String valString = t.vals[i].toString();
576                 
577                 if (valString.equals("true")) t.vals[i] = Boolean.TRUE;
578                 else if (valString.equals("false")) t.vals[i] = Boolean.FALSE;
579                 else if (valString.equals("null")) t.vals[i] = null;
580                 else {
581                     boolean hasNonNumeral = false;
582                     boolean periodUsed = false;
583                     for(int j=0; j<valString.length(); j++)
584                         if (j == 0 && valString.charAt(j) == '-') {
585                         } else if (valString.charAt(j) == '.' && !periodUsed && j != valString.length() - 1) {
586                             periodUsed = true;
587                         } else if (!Character.isDigit(valString.charAt(j))) {
588                             hasNonNumeral = true;
589                             break;
590                         }
591                     if (valString.length() > 0 && !hasNonNumeral) t.vals[i] = new Double(valString);
592                     else t.vals[i] = valString.intern();
593                 }
594
595                 // bump thisbox to the front of the pack
596                 if (t.keys[i].equals("thisbox")) {
597                     t.keys[i] = t.keys[0];
598                     t.keys[0] = "thisbox";
599                     Object o = t.vals[0];
600                     t.vals[0] = t.vals[i];
601                     t.vals[i] = o;
602                 }
603             }
604         }
605
606         /** simple quicksort, from http://sourceforge.net/snippet/detail.php?type=snippet&id=100240 */
607         private int partitionAttributes(int left, int right) {
608             int i, j, middle;
609             middle = (left + right) / 2;
610             String s = t.keys[right]; t.keys[right] = t.keys[middle]; t.keys[middle] = s;
611             Object o = t.vals[right]; t.vals[right] = t.vals[middle]; t.vals[middle] = o;
612             for (i = left - 1, j = right; ; ) {
613                 while (t.keys[++i].compareTo(t.keys[right]) < 0);
614                 while (j > left && t.keys[--j].compareTo(t.keys[right]) > 0);
615                 if (i >= j) break;
616                 s = t.keys[i]; t.keys[i] = t.keys[j]; t.keys[j] = s;
617                 o = t.vals[i]; t.vals[i] = t.vals[j]; t.vals[j] = o;
618             }
619             s = t.keys[right]; t.keys[right] = t.keys[i]; t.keys[i] = s;
620             o = t.vals[right]; t.vals[right] = t.vals[i]; t.vals[i] = o;
621             return i;
622         }
623
624         /** simple quicksort, from http://sourceforge.net/snippet/detail.php?type=snippet&id=100240 */
625         private void quickSortAttributes(int left, int right) {
626             if (left >= right) return;
627             int p = partitionAttributes(left, right);
628             quickSortAttributes(left, p - 1);
629             quickSortAttributes(p + 1, right);
630         }
631
632         public void endElement(XML.Element c) throws XML.SchemaException {
633             if (rootNodeHasBeenEncountered && !templateNodeHasBeenEncountered) {
634                 if ("static".equals(nameOfHeaderNodeBeingProcessed) && t.content != null) t.staticscript = genscript(true);
635                 nameOfHeaderNodeBeingProcessed = null;
636
637             } else if (templateNodeHasBeenEncountered && !templateNodeHasBeenFinished) {
638                 // turn our childvect into a Template[]
639                 t.childvect.copyInto(t.children = new Template[t.childvect.size()]);
640                 t.childvect = null;
641                 if (t.content != null) t.script = genscript(false);
642                 
643                 if (nodeStack.size() == 0) {
644                     // </template>
645                     templateNodeHasBeenFinished = true;
646
647                 } else {
648                     // add this template as a child of its parent
649                     Template oldt = t;
650                     t = (Template)nodeStack.lastElement();
651                     nodeStack.setSize(nodeStack.size() - 1);
652                     t.childvect.addElement(oldt);
653                 }
654
655             }
656         }
657
658         private JS.CompiledFunction genscript(boolean isstatic) {
659             JS.CompiledFunction thisscript = null;
660             try {
661                 thisscript = JS.parse(t.nodeName + (isstatic ? "._" : ""), t.content_start, new StringReader(t.content.toString()));
662             } catch (JS.Exn ee) {
663                 if (Log.on) Log.log(this, "  ERROR: " + ee.getMessage());
664                 thisscript = null;
665             } catch (IOException ioe) {
666                 if (Log.on) Log.log(this, "  ERROR: " + ioe.getMessage());
667                 thisscript = null;
668             }
669
670             t.content = null;
671             t.content_start = 0;
672             t.content_lines = 0;
673             return thisscript;
674         }
675
676         public void characters(char[] ch, int start, int length) throws XML.SchemaException {
677             // invoke the no-tab crusade
678             for (int i=0; length >i; i++) if (ch[start+i] == '\t') throw new XML.SchemaException(
679                 t.nodeName+ ":" + getLine() + "," + getCol() + ": tabs are not allowed in XWT files");
680
681             if ("static".equals(nameOfHeaderNodeBeingProcessed) || templateNodeHasBeenEncountered) {
682                 if (t.content == null) {
683                     t.content_start = getLine();
684                     t.content_lines = 0;
685                     t.content = new StringBuffer();
686                 }
687
688                 t.content.append(ch, start, length);
689                 t.content_lines++;
690
691             } else if (nameOfHeaderNodeBeingProcessed != null) {
692                 throw new XML.SchemaException("header node <" + nameOfHeaderNodeBeingProcessed + "> cannot have text content");
693             }
694         }
695
696         public void whitespace(char[] ch, int start, int length) throws XML.SchemaException {
697         }
698     }
699
700 }
701
702