1 // Copyright 2003 Adam Megacz, see the COPYING file for licensing [GPL]
5 import java.util.zip.*;
12 * Encapsulates a template node (the <template/> element of a
13 * .xwt file, or any child element thereof).
15 * Note that the Template instance corresponding to the
16 * <template/> node carries all the header information -- hence
17 * some of the instance members are not meaningful on non-root
18 * Template instances. We refer to these non-root instances as
19 * <i>anonymous templates</i>.
21 * See the XWT reference for information on the order in which
22 * templates are applied, attributes are put, and scripts are run.
24 public class Template {
26 // Instance Members ///////////////////////////////////////////////////////
28 String id = null; ///< the id of this box
29 String redirect = null; ///< the id of the redirect target; only meaningful on a root node
30 private String[] keys; ///< keys to be "put" to instances of this template; elements correspond to those of vals
31 private Object[] vals; ///< values to be "put" to instances of this template; elements correspond to those of keys
32 private Vec children = new Vec(); ///< during XML parsing, this holds the list of currently-parsed children; null otherwise
33 private int numunits = -1; ///< see numUnits(); -1 means that this value has not yet been computed
35 private JSFunction script = null; ///< the script on this node
36 private String fileName = "unknown"; ///< the filename this node came from; used only for debugging
37 private Vec preapply = new Vec(); ///< templates that should be preapplied (in the order of application)
40 // Instance Members that are only meaningful on root Template //////////////////////////////////////
42 private JSScope staticJSScope = null; ///< the scope in which the static block is executed
43 private JSFunction staticscript = null; ///< the script on the static node of this template, null already performed
46 // Only used during parsing /////////////////////////////////////////////////////////////////
48 private StringBuffer content = null; ///< during XML parsing, this holds partially-read character data; null otherwise
49 private int content_start = 0; ///< line number of the first line of <tt>content</tt>
50 private int startLine = -1; ///< the line number that this element starts on
51 private final Res r; ///< the resource we came from
54 // Static data/methods ///////////////////////////////////////////////////////////////////
56 public static Template getTemplate(Res r) {
58 r = r.addExtension(".xwt");
59 if (r.t != null) return r.t;
60 r.t = new Template(r);
61 new TemplateHelper().parseit(r.getInputStream(), r.t);
63 } catch (Exception e) {
64 if (Log.on) Log.log(r.t == null ? "null" : r.t.fileName, e);
69 public static Res resolveStringToResource(String str, XWT xwt, boolean permitAbsolute) {
71 if (str.indexOf("://") != -1) {
72 if (permitAbsolute) return (Res)xwt.callMethod("res.url", str, null, null, null, 1);
73 Log.log(Template.class, "absolute URL " + str + " not permitted here");
79 while(str.indexOf('.') != -1) {
80 String path = str.substring(0, str.indexOf('.'));
81 str = str.substring(str.indexOf('.') + 1);
82 ret = (Res)ret.get(path);
84 ret = (Res)ret.get(str);
89 // Methods to apply templates ////////////////////////////////////////////////////////
91 private Template(Res r) {
93 String f = r.toString();
94 if (f != null && !f.equals(""))
95 fileName = f.substring(f.lastIndexOf('/')+1, f.endsWith(".xwt") ? f.length() - 4 : f.length());
98 /** called before this template is applied or its static object can be externally referenced */
100 if (staticJSScope == null) staticJSScope = new JSScope(null);
101 if (staticscript == null) return staticJSScope;
102 JSFunction temp = staticscript;
104 temp.cloneWithNewParentScope(staticJSScope).call(null, null, null, null, 0);
105 return staticJSScope;
108 /** Applies the template to Box b
109 * @param pboxes a vector of all box parents on which to put $-references
110 * @param ptemplates a vector of the fileNames to recieve private references on the pboxes
112 void apply(Box b, XWT xwt) { apply(b, xwt, null); }
113 void apply(Box b, XWT xwt, PerInstantiationJSScope parentPis) {
117 if (id != null) parentPis.putDollar(id, b);
118 for(int i=0; i<preapply.size(); i++) {
119 Template t = getTemplate(resolveStringToResource((String)preapply.elementAt(i), xwt, false));
120 if (t == null) throw new RuntimeException("unable to resolve resource " + preapply.elementAt(i));
124 PerInstantiationJSScope pis = new PerInstantiationJSScope(b, xwt, parentPis, staticJSScope);
125 for (int i=0; children != null && i<children.size(); i++) {
127 ((Template)children.elementAt(i)).apply(kid, xwt, pis);
128 b.putAndTriggerTraps(JS.N(b.numchildren), kid);
131 if (script != null) script.cloneWithNewParentScope(pis).call(null, null, null, null, 0);
133 for(int i=0; keys != null && i<keys.length; i++)
134 if (vals[i] instanceof String && ((String)vals[i]).charAt(0) == '$') b.putAndTriggerTraps(keys[i], pis.get(vals[i]));
135 else if ("image".equals(keys[i])) b.putAndTriggerTraps("image", resolveStringToResource((String)vals[i], xwt, true));
136 else if (keys[i] != null) b.putAndTriggerTraps(keys[i], vals[i]);
141 // XML Parsing /////////////////////////////////////////////////////////////////
143 /** handles XML parsing; builds a Template tree as it goes */
144 static final class TemplateHelper extends XML {
149 private static final int STATE_INITIAL = 0;
150 private static final int STATE_IN_XWT_NODE = 1;
151 private static final int STATE_IN_TEMPLATE_NODE = 2;
152 private static final int STATE_FINISHED_TEMPLATE_NODE = 3;
154 private String nameOfHeaderNodeBeingProcessed;
156 Vec nodeStack = new Vec(); ///< stack of Templates whose XML elements we have seen open-tags for but not close-tags
157 Template t = null; ///< the template we're currently working on
159 /** parse an XML input stream, building a Template tree off of <tt>root</tt> */
160 void parseit(InputStream is, Template root) throws XML.XMLException, IOException {
161 state = STATE_INITIAL;
162 nameOfHeaderNodeBeingProcessed = null;
163 nodeStack.setSize(0);
165 parse(new InputStreamReader(is));
168 public void startElement(XML.Element c) throws XML.SchemaException {
171 if (!"xwt".equals(c.localName)) throw new XML.SchemaException("root element was not <xwt>");
172 if (c.len != 0) throw new XML.SchemaException("root element must not have attributes");
173 state = STATE_IN_XWT_NODE;
176 case STATE_IN_XWT_NODE:
177 if (nameOfHeaderNodeBeingProcessed != null) throw new XML.SchemaException("can't nest header nodes");
178 nameOfHeaderNodeBeingProcessed = c.localName;
179 if (c.localName.equals("doc")) {
181 } else if (c.localName.equals("static")) {
182 if (t.staticscript != null)
183 throw new XML.SchemaException("the <static> header node may not appear more than once");
185 throw new XML.SchemaException("the <static> node may not have attributes");
186 } else if (c.localName.equals("template")) {
187 t.startLine = getLine();
188 state = STATE_IN_TEMPLATE_NODE;
189 processBodyElement(c);
191 throw new XML.SchemaException("unrecognized header node \"" + c.localName + "\"");
195 case STATE_IN_TEMPLATE_NODE:
196 // push the last node we were in onto the stack
197 nodeStack.addElement(t);
198 // instantiate a new node, and set its fileName/importlist/preapply
199 Template t2 = new Template(t.r);
200 t2.startLine = getLine();
201 if (!c.localName.equals("box") && !c.localName.equals("template"))
202 t2.preapply.addElement((c.uri == null ? "" : (c.uri + ".")) + c.localName);
203 // make the new node the current node
205 processBodyElement(c);
208 case STATE_FINISHED_TEMPLATE_NODE:
209 throw new XML.SchemaException("no elements may appear after the <template> node");
213 private void processBodyElement(XML.Element c) {
214 Hash h = new Hash(c.len * 2, 3);
215 for(int i=0; i<c.len; i++) {
216 if (c.keys[i] == null) continue;
217 if (c.keys[i].equals("font")) c.vals[i] = c.uris[i] + "." + c.vals[i];
218 if (c.keys[i].equals("preapply")) {
219 String uri = c.uris[i];
220 StringTokenizer tok = new StringTokenizer(c.vals[i].toString(), " ");
221 while(tok.hasMoreTokens()) t.preapply.addElement(uri + tok.nextToken());
222 c.keys[i] = c.keys[c.keys.length - 1];
223 c.vals[i] = c.vals[c.vals.length - 1];
227 h.put(c.keys[i], c.vals[i]);
229 t.keys = new String[h.size()];
230 t.vals = new Object[h.size()];
232 Vec v = new Vec(h.size(), c.keys);
233 v.sort(new Vec.CompareFunc() { public int compare(Object a, Object b) { return ((String)a).compareTo((String)b); } });
234 for(int i=0; i<h.size(); i++) {
235 if (c.keys[i].equals("thisbox")) {
236 for(int j=i; j>0; j--) { t.keys[j] = t.keys[j - 1]; t.vals[j] = t.vals[j - 1]; }
237 t.keys[0] = (String)v.elementAt(i);
238 t.vals[0] = h.get(t.keys[0]);
240 t.keys[i] = (String)v.elementAt(i);
241 t.vals[i] = h.get(t.keys[i]);
245 for(int i=0; i<t.keys.length; i++) {
246 if (t.keys[i].equals("id")) {
247 t.id = t.vals[i].toString().intern();
252 t.keys[i] = t.keys[i].intern();
254 String valString = t.vals[i].toString();
256 if (valString.equals("true")) t.vals[i] = Boolean.TRUE;
257 else if (valString.equals("false")) t.vals[i] = Boolean.FALSE;
258 else if (valString.equals("null")) t.vals[i] = null;
260 boolean hasNonNumeral = false;
261 boolean periodUsed = false;
262 for(int j=0; j<valString.length(); j++)
263 if (j == 0 && valString.charAt(j) == '-') {
264 } else if (valString.charAt(j) == '.' && !periodUsed && j != valString.length() - 1) {
266 } else if (!Character.isDigit(valString.charAt(j))) {
267 hasNonNumeral = true;
270 if (valString.length() > 0 && !hasNonNumeral) t.vals[i] = new Double(valString);
271 else t.vals[i] = valString.intern();
276 private JSFunction parseScript(boolean isstatic) {
277 JSFunction thisscript = null;
279 String contentString = t.content.toString();
280 if (contentString.trim().length() > 0)
281 thisscript = JSFunction.fromReader(t.fileName + (isstatic ? "._" : ""),
283 new StringReader(contentString));
284 } catch (IOException ioe) {
285 if (Log.on) Log.log(this, " ERROR: " + ioe.getMessage());
293 public void endElement(XML.Element c) throws XML.SchemaException {
294 if (state == STATE_IN_XWT_NODE) {
295 if ("static".equals(nameOfHeaderNodeBeingProcessed) && t.content != null) t.staticscript = parseScript(true);
296 nameOfHeaderNodeBeingProcessed = null;
298 } else if (state == STATE_IN_TEMPLATE_NODE) {
299 if (t.content != null) t.script = parseScript(false);
300 if (nodeStack.size() == 0) {
302 state = STATE_FINISHED_TEMPLATE_NODE;
305 // add this template as a child of its parent
307 t = (Template)nodeStack.lastElement();
308 nodeStack.setSize(nodeStack.size() - 1);
309 t.children.addElement(oldt);
311 int oldt_lines = getLine() - oldt.startLine;
312 for (int i=0; oldt_lines > i; i++) t.content.append('\n');
317 public void characters(char[] ch, int start, int length) throws XML.SchemaException {
318 // invoke the no-tab crusade
319 for (int i=0; length >i; i++) if (ch[start+i] == '\t') throw new XML.SchemaException(
320 t.fileName+ ":" + getLine() + "," + getCol() + ": tabs are not allowed in XWT files");
322 if ("static".equals(nameOfHeaderNodeBeingProcessed) || state == STATE_IN_TEMPLATE_NODE) {
323 if (t.content == null) {
324 t.content_start = getLine();
325 t.content = new StringBuffer();
328 t.content.append(ch, start, length);
330 } else if (nameOfHeaderNodeBeingProcessed != null && state != STATE_FINISHED_TEMPLATE_NODE) {
331 throw new XML.SchemaException("header node <" + nameOfHeaderNodeBeingProcessed + "> cannot have text content");
335 public void whitespace(char[] ch, int start, int length) throws XML.SchemaException { }
338 private static class PerInstantiationJSScope extends JSScope {
340 PerInstantiationJSScope parentBoxPis = null;
341 JSScope myStatic = null;
342 void putDollar(String key, Box target) {
343 if (parentBoxPis != null) parentBoxPis.putDollar(key, target);
345 put("$" + key, target);
347 public PerInstantiationJSScope(JSScope parentScope, XWT xwt, PerInstantiationJSScope parentBoxPis, JSScope myStatic) {
349 this.parentBoxPis = parentBoxPis;
351 this.myStatic = myStatic;
353 public Object get(Object key) {
354 if (super.has(key)) return super.get(key);
355 if (key.equals("xwt")) return xwt;
356 if (key.equals("static")) return myStatic;
357 return super.get(key);
359 public void put(Object key, Object val) {
360 if (super.has(key)) super.put(key, val);
361 else super.put(key, val);