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 Function 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 JS.Scope staticScope = null; ///< the scope in which the static block is executed
43 private Function 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 content_lines = 0; ///< number of lines in <tt>content</tt>
51 private int startLine = -1; ///< the line number that this element starts on
52 private final Res r; ///< the resource we came from
55 // Static data/methods ///////////////////////////////////////////////////////////////////
57 public static Template getTemplate(Res r) {
59 r = r.addExtension(".xwt");
60 if (r.t != null) return r.t;
61 r.t = new Template(r);
62 new TemplateHelper().parseit(r.getInputStream(), r.t);
64 } catch (Exception e) {
65 if (Log.on) Log.log(r.t.fileName, e);
70 public static Res resolveStringToResource(String str, XWT xwt, boolean permitAbsolute) {
72 if (str.indexOf("://") != -1) {
73 if (permitAbsolute) return Res.stringToRes(str);
74 Log.log(Template.class, "absolute URL " + str + " not permitted here");
80 while(str.indexOf('.') != -1) {
81 String path = str.substring(0, str.indexOf('.'));
82 str = str.substring(str.indexOf('.') + 1);
83 ret = (Res)ret.get(path);
85 ret = (Res)ret.get(str);
90 // Methods to apply templates ////////////////////////////////////////////////////////
92 private Template(Res r) { this.r = r; }
94 /** called before this template is applied or its static object can be externally referenced */
95 JS.Scope getStatic() {
96 if (staticScope == null) staticScope = new JS.Scope(null);
97 if (staticscript == null) return staticScope;
98 Function temp = staticscript;
100 new JS.Context(temp, staticScope).resume();
104 /** Applies the template to Box b
105 * @param pboxes a vector of all box parents on which to put $-references
106 * @param ptemplates a vector of the fileNames to recieve private references on the pboxes
108 void apply(Box b, JS.Callable c, XWT xwt) { apply(b, c, xwt, null); }
109 void apply(Box b, JS.Callable callback, XWT xwt, PerInstantiationScope parentPis) {
113 if (id != null) parentPis.putDollar(id, b);
114 for(int i=0; i<preapply.size(); i++) {
115 Template t = getTemplate(resolveStringToResource((String)preapply.elementAt(i), xwt, false));
116 if (t == null) throw new RuntimeException("unable to resolve resource " + preapply.elementAt(i));
117 t.apply(b, callback, xwt);
120 PerInstantiationScope pis = new PerInstantiationScope(b, xwt, parentPis, staticScope);
121 for (int i=0; children != null && i<children.size(); i++) {
123 ((Template)children.elementAt(i)).apply(kid, callback, xwt, pis);
126 b.put(b.numChildren(), kid);
129 if (script != null) new JS.Context(script, pis).resume();
131 for(int i=0; keys != null && i<keys.length; i++)
132 if (vals[i] instanceof String && ((String)vals[i]).charAt(0) == '$') b.put(keys[i], pis.get(vals[i]));
133 else if ("image".equals(keys[i])) b.put("image", resolveStringToResource((String)vals[i], xwt, true));
134 else if (keys[i] != null) b.put(keys[i], vals[i]);
139 // XML Parsing /////////////////////////////////////////////////////////////////
141 /** handles XML parsing; builds a Template tree as it goes */
142 static final class TemplateHelper extends XML {
147 private static final int STATE_INITIAL = 0;
148 private static final int STATE_IN_XWT_NODE = 1;
149 private static final int STATE_IN_TEMPLATE_NODE = 2;
150 private static final int STATE_FINISHED_TEMPLATE_NODE = 3;
152 private String nameOfHeaderNodeBeingProcessed;
154 Vec nodeStack = new Vec(); ///< stack of Templates whose XML elements we have seen open-tags for but not close-tags
155 Template t = null; ///< the template we're currently working on
157 /** parse an XML input stream, building a Template tree off of <tt>root</tt> */
158 void parseit(InputStream is, Template root) throws XML.XMLException, IOException {
159 state = STATE_INITIAL;
160 nameOfHeaderNodeBeingProcessed = null;
161 nodeStack.setSize(0);
163 parse(new InputStreamReader(is));
166 public void startElement(XML.Element c) throws XML.SchemaException {
169 if (!"xwt".equals(c.localName)) throw new XML.SchemaException("root element was not <xwt>");
170 if (c.len != 0) throw new XML.SchemaException("root element must not have attributes");
171 state = STATE_IN_XWT_NODE;
174 case STATE_IN_XWT_NODE:
175 if (nameOfHeaderNodeBeingProcessed != null) throw new XML.SchemaException("can't nest header nodes");
176 nameOfHeaderNodeBeingProcessed = c.localName;
177 if (c.localName.equals("doc")) {
179 } else if (c.localName.equals("static")) {
180 if (t.staticscript != null)
181 throw new XML.SchemaException("the <static> header node may not appear more than once");
183 throw new XML.SchemaException("the <static> node may not have attributes");
184 } else if (c.localName.equals("template")) {
185 t.startLine = getLine();
186 state = STATE_IN_TEMPLATE_NODE;
187 processBodyElement(c);
189 throw new XML.SchemaException("unrecognized header node \"" + c.localName + "\"");
193 case STATE_IN_TEMPLATE_NODE:
194 // push the last node we were in onto the stack
195 nodeStack.addElement(t);
196 // instantiate a new node, and set its fileName/importlist/preapply
197 Template t2 = new Template(t.r);
198 t2.startLine = getLine();
199 if (!c.localName.equals("box") && !c.localName.equals("template"))
200 t2.preapply.addElement((c.uri == null ? "" : (c.uri + ".")) + c.localName);
201 // make the new node the current node
203 processBodyElement(c);
206 case STATE_FINISHED_TEMPLATE_NODE:
207 throw new XML.SchemaException("no elements may appear after the <template> node");
211 private void processBodyElement(XML.Element c) {
212 Hash h = new Hash(c.len * 2, 3);
213 for(int i=0; i<c.len; i++) {
214 if (c.keys[i].endsWith(":image")) {
215 String uri = (String)c.urimap.get(c.keys[i].substring(0, c.keys[i].indexOf(':')));
216 c.keys[i] = c.keys[i].substring(c.keys[i].lastIndexOf(':') + 1);
217 c.vals[i] = uri + "." + c.vals[i];
219 if ((c.keys[i].equals("preapply") || c.keys[i].endsWith(":preapply")) && c.localName.equals("template")) {
221 if (c.keys[i].endsWith(":preapply")) {
222 uri = "." + c.urimap.get(c.keys[i].substring(0, c.keys[i].indexOf(':')));
223 c.keys[i] = c.keys[i].substring(c.keys[i].lastIndexOf(':') + 1);
225 StringTokenizer tok = new StringTokenizer(c.vals[i].toString(), " ");
226 while(tok.hasMoreTokens()) t.preapply.addElement(uri + tok.nextToken());
227 c.keys[i] = c.keys[c.keys.length - 1];
228 c.vals[i] = c.vals[c.vals.length - 1];
232 h.put(c.keys[i], c.vals[i]);
234 t.keys = new String[h.size()];
235 t.vals = new Object[h.size()];
237 Vec v = new Vec(h.size(), c.keys);
238 v.sort(new Vec.CompareFunc() { public int compare(Object a, Object b) { return ((String)a).compareTo((String)b); } });
239 for(int i=0; i<h.size(); i++) {
240 if (c.keys[i].equals("thisbox")) {
241 for(int j=i; j>0; j--) { t.keys[j] = t.keys[j - 1]; t.vals[j] = t.vals[j - 1]; }
242 t.keys[0] = (String)v.elementAt(i);
243 t.vals[0] = h.get(t.keys[0]);
245 t.keys[i] = (String)v.elementAt(i);
246 t.vals[i] = h.get(t.keys[i]);
250 for(int i=0; i<t.keys.length; i++) {
251 if (t.keys[i].equals("id")) {
252 t.id = t.vals[i].toString().intern();
257 t.keys[i] = t.keys[i].intern();
259 String valString = t.vals[i].toString();
261 if (valString.equals("true")) t.vals[i] = Boolean.TRUE;
262 else if (valString.equals("false")) t.vals[i] = Boolean.FALSE;
263 else if (valString.equals("null")) t.vals[i] = null;
265 boolean hasNonNumeral = false;
266 boolean periodUsed = false;
267 for(int j=0; j<valString.length(); j++)
268 if (j == 0 && valString.charAt(j) == '-') {
269 } else if (valString.charAt(j) == '.' && !periodUsed && j != valString.length() - 1) {
271 } else if (!Character.isDigit(valString.charAt(j))) {
272 hasNonNumeral = true;
275 if (valString.length() > 0 && !hasNonNumeral) t.vals[i] = new Double(valString);
276 else t.vals[i] = valString.intern();
281 private Function parseScript(boolean isstatic) {
282 Function thisscript = null;
284 thisscript = JS.parse(t.fileName + (isstatic ? "._" : ""), t.content_start, new StringReader(t.content.toString()));
285 } catch (IOException ioe) {
286 if (Log.on) Log.log(this, " ERROR: " + ioe.getMessage());
295 public void endElement(XML.Element c) throws XML.SchemaException {
296 if (state == STATE_IN_XWT_NODE) {
297 if ("static".equals(nameOfHeaderNodeBeingProcessed) && t.content != null) t.staticscript = parseScript(true);
298 nameOfHeaderNodeBeingProcessed = null;
300 } else if (state == STATE_IN_TEMPLATE_NODE) {
301 if (t.content != null) t.script = parseScript(false);
302 if (nodeStack.size() == 0) {
304 state = STATE_FINISHED_TEMPLATE_NODE;
307 // add this template as a child of its parent
309 t = (Template)nodeStack.lastElement();
310 nodeStack.setSize(nodeStack.size() - 1);
311 t.children.addElement(oldt);
316 public void characters(char[] ch, int start, int length) throws XML.SchemaException {
317 // invoke the no-tab crusade
318 for (int i=0; length >i; i++) if (ch[start+i] == '\t') throw new XML.SchemaException(
319 t.fileName+ ":" + getLine() + "," + getCol() + ": tabs are not allowed in XWT files");
321 if ("static".equals(nameOfHeaderNodeBeingProcessed) || state == STATE_IN_TEMPLATE_NODE) {
322 if (t.content == null) {
323 t.content_start = getLine();
325 t.content = new StringBuffer();
328 t.content.append(ch, start, length);
331 } else if (nameOfHeaderNodeBeingProcessed != null && state != STATE_FINISHED_TEMPLATE_NODE) {
332 throw new XML.SchemaException("header node <" + nameOfHeaderNodeBeingProcessed + "> cannot have text content");
336 public void whitespace(char[] ch, int start, int length) throws XML.SchemaException { }
339 private static class PerInstantiationScope extends JS.Scope {
341 PerInstantiationScope parentBoxPis = null;
342 JS.Scope myStatic = null;
343 void putDollar(String key, Box target) {
344 if (parentBoxPis != null) parentBoxPis.putDollar(key, target);
346 put("$" + key, target);
348 public PerInstantiationScope(Scope parentScope, XWT xwt, PerInstantiationScope parentBoxPis, JS.Scope myStatic) {
350 this.parentBoxPis = parentBoxPis;
352 this.myStatic = myStatic;
354 public Object get(Object key) {
355 if (super.has(key)) return super.get(key);
356 if (key.equals("xwt")) return xwt;
357 if (key.equals("static")) return myStatic;
358 return super.get(key);
360 public Object put(Object key, Object val) {
361 if (super.has(key)) return super.put(key, val);
362 return super.put(key, val);