1 // Copyright 2004 Adam Megacz, see the COPYING file for licensing [GPL]
7 import org.ibex.util.*;
10 * Encapsulates a template node (the <template/> element of a
11 * .ibex file, or any child element thereof).
13 * Note that the Template instance corresponding to the
14 * <template/> node carries all the header information -- hence
15 * some of the instance members are not meaningful on non-root
16 * Template instances. We refer to these non-root instances as
17 * <i>anonymous templates</i>.
19 * See the Ibex reference for information on the order in which
20 * templates are applied, attributes are put, and scripts are run.
22 public class Template {
24 // Instance Members ///////////////////////////////////////////////////////
26 String id = null; ///< the id of this box
27 String redirect = null; ///< the id of the redirect target; only meaningful on a root node
28 private String[] keys; ///< keys to be "put" to instances of this template; elements correspond to those of vals
29 private Object[] vals; ///< values to be "put" to instances of this template; elements correspond to those of keys
30 private String[] urikeys;
31 private String[] urivals;
32 private Vec children = new Vec(); ///< during XML parsing, this holds the list of currently-parsed children; null otherwise
33 private JS script = null; ///< the script on this node
36 JSScope staticScope = null; ///< the scope in which the static block is executed
37 JS staticObject = null;
40 // Only used during parsing /////////////////////////////////////////////////////////////////
42 private StringBuffer content = null; ///< during XML parsing, this holds partially-read character data; null otherwise
43 private int content_start = 0; ///< line number of the first line of <tt>content</tt>
44 private int startLine = -1; ///< the line number that this element starts on
48 // Static data/methods ///////////////////////////////////////////////////////////////////
51 private Template(Template t, int startLine) { prev = t; this.ibex = t.ibex; this.startLine = startLine; }
52 private Template(Ibex ibex) { this.ibex = ibex; }
55 // Methods to apply templates ////////////////////////////////////////////////////////
58 /** Applies the template to Box b
59 * @param pboxes a vector of all box parents on which to put $-references
60 * @param ptemplates a vector of the fileNames to recieve private references on the pboxes
62 public void apply(Box b) throws JSExn {
65 } catch (IOException e) {
69 throw new JSExn(e.toString());
78 private void apply(Box b, PerInstantiationScope parentPis) throws JSExn, IOException {
79 if (prev != null) prev.apply(b, null);
80 if (prev2 != null) prev2.apply(b, null);
82 // FIXME this dollar stuff is all wrong
83 if (id != null) parentPis.putDollar(id, b);
85 PerInstantiationScope pis = new PerInstantiationScope(b, ibex, parentPis, staticObject);
86 for(int i=0; i<urikeys.length; i++) {
87 if (urikeys[i] == null) continue;
88 pis.declare(urikeys[i]);
89 pis.put(urikeys[i], ibex.resolveString(urivals[i], true));
92 // FIXME needs to obey the new application-ordering rules
93 for (int i=0; children != null && i<children.size(); i++) {
95 ((Template)children.elementAt(i)).apply(kid, pis);
96 b.putAndTriggerTraps(b.get("numchildren"), kid);
99 if (script != null) JS.cloneWithNewParentScope(script, pis).call(null, null, null, null, 0);
102 for(int i=0; keys != null && i < keys.length; i++) {
103 if (keys[i] == null) continue;
107 if ("null".equals(val)) val = null;
109 if (val != null && val instanceof String && ((String)val).length() > 0) {
110 switch (((String)val).charAt(0)) {
113 if (val == null) throw new JSExn("unknown box id '"+vals[i]+"' referenced in XML attribute");
116 val = ibex.resolveString(((String)val).substring(1), false);
118 // FIXME: should we be resolving all of these in the XML-parsing code?
121 b.putAndTriggerTraps(key, val);
127 // XML Parsing /////////////////////////////////////////////////////////////////
129 public static Template buildTemplate(String sourceName, Object s, Ibex ibex) {
131 return new TemplateHelper(sourceName, s, ibex).t;
132 } catch (Exception e) {
133 Log.error(Template.class, e);
138 /** handles XML parsing; builds a Template tree as it goes */
139 static final class TemplateHelper extends XML {
142 private int state = STATE_INITIAL;
143 private static final int STATE_INITIAL = 0;
144 private static final int STATE_IN_ROOT_NODE = 1;
145 private static final int STATE_IN_TEMPLATE_NODE = 2;
146 private static final int STATE_IN_META_NODE = 3;
148 StringBuffer static_content = null;
149 int static_content_start = 0;
150 Vec nodeStack = new Vec();
155 String initial_uri = "";
157 public TemplateHelper(String sourceName, Object s, Ibex ibex) throws XML.Exn, IOException, JSExn {
158 this.sourceName = sourceName;
160 InputStream is = Stream.getInputStream(s);
161 Ibex.Blessing b = Ibex.Blessing.getBlessing(s).parent;
163 if(b.parentkey != null) initial_uri = b.parentkey + (initial_uri.equals("") ? "" : "." + initial_uri);
167 parse(new InputStreamReader(is));
168 JS staticScript = parseScript(static_content, static_content_start);
169 t.staticObject = new JS();
170 t.staticScope = new PerInstantiationScope(null, ibex, null, t.staticObject);
171 if (staticScript != null) JS.cloneWithNewParentScope(staticScript, t.staticScope).call(null, null, null, null, 0);
174 private JS parseScript(StringBuffer content, int content_start) throws IOException {
175 if (content == null) return null;
176 String contentString = content.toString();
177 if (contentString.trim().length() > 0) return JS.fromReader(sourceName, content_start, new StringReader(contentString));
181 public void startElement(XML.Element c) throws XML.Exn {
183 case STATE_IN_META_NODE: { meta++; return; }
185 if (!"ibex".equals(c.getLocalName()))
186 throw new XML.Exn("root element was not <ibex>", XML.Exn.SCHEMA, getLine(), getCol());
187 if (c.getAttrLen() != 0)
188 throw new XML.Exn("root element must not have attributes", XML.Exn.SCHEMA, getLine(), getCol());
189 if (c.getUri("ui") == null || "".equals(c.getUri("ui"))) c.addUri("ui", "ibex://ui");
190 if (c.getUri("meta") == null || "".equals(c.getUri("meta"))) c.addUri("meta", "ibex://meta");
191 if (c.getUri("") == null || "".equals(c.getUri(""))) c.addUri("", initial_uri);
192 state = STATE_IN_ROOT_NODE;
194 case STATE_IN_ROOT_NODE:
195 if ("ibex://meta".equals(c.getUri())) { state = STATE_IN_META_NODE; meta = 0; return; }
196 state = STATE_IN_TEMPLATE_NODE;
197 t = (t == null) ? new Template(ibex) : new Template(t, getLine());
199 case STATE_IN_TEMPLATE_NODE:
200 nodeStack.addElement(t);
201 t = new Template(ibex);
205 if (!("ibex://ui".equals(c.getUri()) && "box".equals(c.getLocalName()))) {
206 String tagname = (c.getUri().equals("") ? "" : (c.getUri() + ".")) + c.getLocalName();
210 t.prev2 = (Template)t.ibex.resolveString(tagname, false).call(null, null, null, null, 9999);
211 } catch (Exception e) {
212 Log.error(Template.class, e);
216 Hash urimap = c.getUriMap();
217 t.urikeys = new String[urimap.size()];
218 t.urivals = new String[urimap.size()];
219 Enumeration uriEnumeration = urimap.keys();
221 while(uriEnumeration.hasMoreElements()) {
222 String key = (String)uriEnumeration.nextElement();
223 String val = (String)urimap.get(key);
224 if (val.equals("ibex://ui")) continue;
225 if (val.equals("ibex://meta")) continue;
227 if (val.length() > 0 && val.charAt(0) == '.') val = val.substring(1);
232 Vec keys = new Vec(c.getAttrLen());
233 Vec vals = new Vec(c.getAttrLen());
235 // process attributes into Vecs, dealing with any XML Namespaces in the process
236 ATTR: for (int i=0; i < c.getAttrLen(); i++) {
237 if (c.getAttrKey(i).equals("id")) {
238 t.id = c.getAttrVal(i).toString().intern();
242 // treat value starting with '.' as resource reference
243 String uri = c.getAttrUri(i); if (!uri.equals("")) uri = '.' + uri;
244 keys.addElement(c.getAttrKey(i));
245 vals.addElement((c.getAttrVal(i).startsWith(".") ? uri : "") + c.getAttrVal(i));
248 if (keys.size() == 0) return;
250 // sort the attributes lexicographically
251 Vec.sort(keys, vals, new Vec.CompareFunc() { public int compare(Object a, Object b) {
252 return ((String)a).compareTo((String)b);
255 t.keys = new String[keys.size()];
256 t.vals = new Object[vals.size()];
257 keys.copyInto(t.keys);
258 vals.copyInto(t.vals);
260 // convert attributes to appropriate types and intern strings
261 for(int i=0; i<t.keys.length; i++) {
262 t.keys[i] = t.keys[i].intern();
264 String valString = t.vals[i].toString();
266 if (valString.equals("true")) t.vals[i] = Boolean.TRUE;
267 else if (valString.equals("false")) t.vals[i] = Boolean.FALSE;
268 else if (valString.equals("null")) t.vals[i] = null;
270 boolean hasNonNumeral = false;
271 boolean periodUsed = false;
272 for(int j=0; j<valString.length(); j++)
273 if (j == 0 && valString.charAt(j) == '-') {
274 } else if (valString.charAt(j) == '.' && !periodUsed && j != valString.length() - 1) {
276 } else if (!Character.isDigit(valString.charAt(j))) {
277 hasNonNumeral = true;
280 if (valString.length() > 0 && !hasNonNumeral) t.vals[i] = new Double(valString);
281 else t.vals[i] = valString.intern();
286 public void endElement(XML.Element c) throws XML.Exn, IOException {
288 case STATE_IN_META_NODE: if (--meta < 0) state = STATE_IN_ROOT_NODE; return;
289 case STATE_IN_ROOT_NODE: return;
290 case STATE_IN_TEMPLATE_NODE: {
291 if (t.content != null) { t.script = parseScript(t.content, t.content_start); t.content = null; }
292 if (nodeStack.size() == 0) { state = STATE_IN_ROOT_NODE; return; }
294 t = (Template)nodeStack.lastElement();
295 nodeStack.setSize(nodeStack.size() - 1);
296 t.children.addElement(oldt);
297 int oldt_lines = getLine() - oldt.startLine;
298 if (t.content == null) t.content = new StringBuffer();
299 for (int i=0; oldt_lines > i; i++) t.content.append('\n');
304 public void characters(char[] ch, int start, int length) throws XML.Exn {
305 for (int i=0; length >i; i++) if (ch[start+i] == '\t')
306 Log.error(Template.class, "tabs are not allowed in Ibex files ("+getLine()+":"+getCol()+")");
308 case STATE_IN_TEMPLATE_NODE:
309 if (t.content == null) {
310 t.content_start = getLine();
311 t.content = new StringBuffer();
313 t.content.append(ch, start, length);
315 case STATE_IN_ROOT_NODE:
316 if (static_content == null) {
317 static_content_start = getLine();
318 static_content = new StringBuffer();
320 static_content.append(ch, start, length);
325 public void whitespace(char[] ch, int start, int length) throws XML.Exn { }
328 private static class PerInstantiationScope extends JSScope {
330 PerInstantiationScope parentBoxPis = null;
332 void putDollar(String key, Box target) throws JSExn {
333 if (parentBoxPis != null) parentBoxPis.putDollar(key, target);
335 put("$" + key, target);
337 public PerInstantiationScope(JSScope parentScope, Ibex ibex, PerInstantiationScope parentBoxPis, JS myStatic) {
339 this.parentBoxPis = parentBoxPis;
341 this.myStatic = myStatic;
343 public Object get(Object key) throws JSExn {
344 if (super.has(key)) return super.get(key);
345 if (key.equals("ibex")) return ibex;
346 if (key.equals("")) return ibex.get("");
347 if (key.equals("static")) return myStatic;
348 return super.get(key);