src/org/ibex/Template.java

   1 // Copyright 2004 Adam Megacz, see the COPYING file for licensing [GPL]
   2 package org.ibex;
   3
   4 import java.io.*;
   5 import java.util.*;
   6 import org.ibex.js.*;
   7 import org.ibex.util.*;
   8
   9 /**
  10  *  Encapsulates a template node (the &lt;template/&gt; element of a
  11  *  .ibex file, or any child element thereof).
  12  *
  13  *  Note that the Template instance corresponding to the
  14  *  &lt;template/&gt; 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>.
  18  *
  19  *  See the Ibex reference for information on the order in which
  20  *  templates are applied, attributes are put, and scripts are run.
  21  */
  22 public class Template {
  23
  24     // Instance Members ///////////////////////////////////////////////////////
  25
  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
  34     Template prev;
  35     JSScope staticScope = null;         ///< the scope in which the static block is executed
  36
  37
  38     // Only used during parsing /////////////////////////////////////////////////////////////////
  39
  40     private StringBuffer content = null;   ///< during XML parsing, this holds partially-read character data; null otherwise
  41     private int content_start = 0;         ///< line number of the first line of <tt>content</tt>
  42     private int startLine = -1;            ///< the line number that this element starts on
  43     private Ibex ibex;
  44
  45
  46     // Static data/methods ///////////////////////////////////////////////////////////////////
  47
  48     // for non-root nodes
  49     private Template(Template t, int startLine) { prev = t; this.ibex = t.ibex; this.startLine = startLine; }
  50     private Template(Ibex ibex) { this.ibex = ibex; }
  51
  52
  53     // Methods to apply templates ////////////////////////////////////////////////////////
  54
  55
  56     /** Applies the template to Box b
  57      *  @param pboxes a vector of all box parents on which to put $-references
  58      *  @param ptemplates a vector of the fileNames to recieve private references on the pboxes
  59      */
  60     void apply(Box b) throws JSExn {
  61         try {
  62             apply(b, null);
  63         } catch (IOException e) {
  64             b.clear(Box.VISIBLE);
  65             b.mark_for_repack();
  66             Log.warn(this, e);
  67             throw new JSExn(e.toString());
  68         } catch (JSExn e) {
  69             b.clear(Box.VISIBLE);
  70             b.mark_for_repack();
  71             Log.warn(this, e);
  72             throw e;
  73         }
  74     }
  75
  76     private void apply(Box b, PerInstantiationScope parentPis) throws JSExn, IOException {
  77         if (prev != null) prev.apply(b, null);
  78
  79         // FIXME this dollar stuff is all wrong
  80         if (id != null) parentPis.putDollar(id, b);
  81
  82         PerInstantiationScope pis = new PerInstantiationScope(b, ibex, parentPis, staticScope);
  83         for(int i=0; i<urikeys.length; i++) {
  84             pis.declare(urikeys[i]);
  85             pis.put(urikeys[i], ibex.resolveString(urivals[i], true));
  86         }
  87
  88         // FIXME needs to obey the new application-ordering rules
  89         for (int i=0; children != null && i<children.size(); i++) {
  90             Box kid = new Box();
  91             ((Template)children.elementAt(i)).apply(kid, pis);
  92             b.putAndTriggerTraps(b.get("numchildren"), kid);
  93         }
  94
  95         if (script != null) JS.cloneWithNewParentScope(script, pis).call(null, null, null, null, 0);
  96
  97         Object key, val;
  98         for(int i=0; keys != null && i < keys.length; i++) {
  99             if (keys[i] == null) continue;
 100             key = keys[i];
 101             val = vals[i];
 102
 103             if ("null".equals(val)) val = null;
 104
 105             if (val != null && val instanceof String && ((String)val).length() > 0) {
 106                 switch (((String)val).charAt(0)) {
 107                     case '$':
 108                         val = pis.get(val);
 109                         if (val == null) throw new JSExn("unknown box id '"+vals[i]+"' referenced in XML attribute");
 110                         break;
 111                     case '.':
 112                         val = ibex.resolveString(((String)val).substring(1), false);
 113                     // FIXME: url case
 114                     // FIXME: should we be resolving all of these in the XML-parsing code?
 115                 }
 116             }
 117
 118             b.putAndTriggerTraps(key, val);
 119         }
 120     }
 121
 122
 123
 124     // XML Parsing /////////////////////////////////////////////////////////////////
 125
 126     public static Template buildTemplate(String sourceName, InputStream is, Ibex ibex) {
 127         try {
 128             return new TemplateHelper(sourceName, is, ibex).t;
 129         } catch (Exception e) {
 130             Log.error(Template.class, e);
 131             return null;
 132         }
 133     }
 134
 135     /** handles XML parsing; builds a Template tree as it goes */
 136     static final class TemplateHelper extends XML {
 137
 138         String sourceName;
 139         private int state = STATE_INITIAL;
 140         private static final int STATE_INITIAL = 0;
 141         private static final int STATE_IN_ROOT_NODE = 1;
 142         private static final int STATE_IN_TEMPLATE_NODE = 2;
 143         private static final int STATE_IN_META_NODE = 3;
 144
 145         StringBuffer static_content = null;
 146         int static_content_start = 0;
 147         Vec nodeStack = new Vec();
 148         Template t = null;
 149         int meta = 0;
 150         Ibex ibex;
 151
 152         public TemplateHelper(String sourceName, InputStream is, Ibex ibex) throws XML.Exn, IOException, JSExn {
 153             this.sourceName = sourceName;
 154             this.ibex = ibex;
 155             parse(new InputStreamReader(is));
 156             JS staticScript = parseScript(static_content, static_content_start);
 157             t.staticScope = new PerInstantiationScope(null, ibex, null, null);
 158             if (staticScript != null) JS.cloneWithNewParentScope(staticScript, t.staticScope).call(null, null, null, null, 0);
 159         }
 160
 161         private JS parseScript(StringBuffer content, int content_start) throws IOException {
 162             if (content == null) return null;
 163             String contentString = content.toString();
 164             if (contentString.trim().length() > 0) return JS.fromReader(sourceName, content_start, new StringReader(contentString));
 165             return null;
 166         }
 167
 168         public void startElement(XML.Element c) throws XML.Exn {
 169             switch(state) {
 170                 case STATE_IN_META_NODE: { meta++; return; }
 171                 case STATE_INITIAL:
 172                     if (!"ibex".equals(c.getLocalName()))
 173                         throw new XML.Exn("root element was not <ibex>", XML.Exn.SCHEMA, getLine(), getCol());
 174                     if (c.getAttrLen() != 0)
 175                         throw new XML.Exn("root element must not have attributes", XML.Exn.SCHEMA, getLine(), getCol());
 176                     state = STATE_IN_ROOT_NODE;
 177                     return;
 178                 case STATE_IN_ROOT_NODE:
 179                     if ("meta".equals(c.getPrefix())) { state = STATE_IN_META_NODE; meta = 0; return; }
 180                     state = STATE_IN_TEMPLATE_NODE;
 181                     t = (t == null) ? new Template(ibex) : new Template(t, getLine());
 182                     break;
 183                 case STATE_IN_TEMPLATE_NODE:
 184                     nodeStack.addElement(t);
 185                     t = new Template(ibex);
 186                     break;
 187             }
 188
 189             if (!(/* "ui".equals(c.getPrefix()) && */ "box".equals(c.getLocalName()))) {
 190                 String tagname = (c.getUri().equals("") ? "" : (c.getUri() + ".")) + c.getLocalName();
 191                 // GROSS hack
 192                 try {
 193                     t.prev = (Template)t.ibex.resolveString(tagname, false).call(null, null, null, null, 9999);
 194                     if (t.prev == null) throw new JSExn("template " + tagname + " not found");
 195                 } catch (Exception e) {
 196                     Log.error(Template.class, e);
 197                 }
 198             }
 199
 200             Hash urimap = c.getUriMap();
 201             t.urikeys = new String[urimap.size()];
 202             t.urivals = new String[urimap.size()];
 203             Enumeration uriEnumeration = urimap.keys();
 204             int ii = 0;
 205             while(uriEnumeration.hasMoreElements()) {
 206                 String key = (String)uriEnumeration.nextElement();
 207                 String val = (String)urimap.get(key);
 208                 t.urikeys[ii] = key;
 209                 if (val.charAt(0) == '.') val = val.substring(1);
 210                 t.urivals[ii] = val;
 211                 ii++;
 212             }
 213
 214             Vec keys = new Vec(c.getAttrLen());
 215             Vec vals = new Vec(c.getAttrLen());
 216
 217             // process attributes into Vecs, dealing with any XML Namespaces in the process
 218             ATTR: for (int i=0; i < c.getAttrLen(); i++) {
 219                 //#switch(c.getAttrKey(i))
 220                 case "id":
 221                     t.id = c.getAttrVal(i).toString().intern();
 222                     continue ATTR;
 223                 //#end
 224
 225                 // treat value starting with '.' as resource reference
 226                 String uri = c.getAttrUri(i); if (!uri.equals("")) uri = '.' + uri;
 227                 keys.addElement(c.getAttrKey(i));
 228                 vals.addElement((c.getAttrVal(i).startsWith(".") ? uri : "") + c.getAttrVal(i));
 229             }
 230
 231             if (keys.size() == 0) return;
 232
 233             // sort the attributes lexicographically
 234             Vec.sort(keys, vals, new Vec.CompareFunc() { public int compare(Object a, Object b) {
 235                 return ((String)a).compareTo((String)b);
 236             } });
 237
 238             t.keys = new String[keys.size()];
 239             t.vals = new Object[vals.size()];
 240             keys.copyInto(t.keys);
 241             vals.copyInto(t.vals);
 242
 243             // convert attributes to appropriate types and intern strings
 244             for(int i=0; i<t.keys.length; i++) {
 245                 t.keys[i] = t.keys[i].intern();
 246
 247                 String valString = t.vals[i].toString();
 248
 249                 if (valString.equals("true")) t.vals[i] = Boolean.TRUE;
 250                 else if (valString.equals("false")) t.vals[i] = Boolean.FALSE;
 251                 else if (valString.equals("null")) t.vals[i] = null;
 252                 else {
 253                     boolean hasNonNumeral = false;
 254                     boolean periodUsed = false;
 255                     for(int j=0; j<valString.length(); j++)
 256                         if (j == 0 && valString.charAt(j) == '-') {
 257                         } else if (valString.charAt(j) == '.' && !periodUsed && j != valString.length() - 1) {
 258                             periodUsed = true;
 259                         } else if (!Character.isDigit(valString.charAt(j))) {
 260                             hasNonNumeral = true;
 261                             break;
 262                         }
 263                     if (valString.length() > 0 && !hasNonNumeral) t.vals[i] = new Double(valString);
 264                     else t.vals[i] = valString.intern();
 265                 }
 266             }
 267         }
 268
 269         public void endElement(XML.Element c) throws XML.Exn, IOException {
 270             switch(state) {
 271                 case STATE_IN_META_NODE: if (meta-- < 0) state = STATE_IN_ROOT_NODE; return;
 272                 case STATE_IN_ROOT_NODE: return;
 273                 case STATE_IN_TEMPLATE_NODE: {
 274                     if (t.content != null) { t.script = parseScript(t.content, t.content_start); t.content = null; }
 275                     if (nodeStack.size() == 0) { state = STATE_IN_ROOT_NODE; return; }
 276                     Template oldt = t;
 277                     t = (Template)nodeStack.lastElement();
 278                     nodeStack.setSize(nodeStack.size() - 1);
 279                     t.children.addElement(oldt);
 280                     int oldt_lines = getLine() - oldt.startLine;
 281                     for (int i=0; oldt_lines > i; i++) t.content.append('\n');
 282                 }
 283             }
 284         }
 285
 286         public void characters(char[] ch, int start, int length) throws XML.Exn {
 287             for (int i=0; length >i; i++) if (ch[start+i] == '\t')
 288                 Log.error(Template.class, "tabs are not allowed in Ibex files ("+getLine()+":"+getCol()+")");
 289             switch(state) {
 290                 case STATE_IN_TEMPLATE_NODE:
 291                     if (t.content == null) {
 292                         t.content_start = getLine();
 293                         t.content = new StringBuffer();
 294                     }
 295                     t.content.append(ch, start, length);
 296                     return;
 297                 case STATE_IN_ROOT_NODE:
 298                     if (static_content == null) {
 299                         static_content_start = getLine();
 300                         static_content = new StringBuffer();
 301                     }
 302                     static_content.append(ch, start, length);
 303                     return;
 304             }
 305         }
 306
 307         public void whitespace(char[] ch, int start, int length) throws XML.Exn { }
 308     }
 309
 310     private static class PerInstantiationScope extends JSScope {
 311         Ibex ibex = null;
 312         PerInstantiationScope parentBoxPis = null;
 313         JSScope myStatic = null;
 314         void putDollar(String key, Box target) throws JSExn {
 315             if (parentBoxPis != null) parentBoxPis.putDollar(key, target);
 316             declare("$" + key);
 317             put("$" + key, target);
 318         }
 319         public PerInstantiationScope(JSScope parentScope, Ibex ibex, PerInstantiationScope parentBoxPis, JSScope myStatic) {
 320             super(parentScope);
 321             this.parentBoxPis = parentBoxPis;
 322             this.ibex = ibex;
 323             this.myStatic = myStatic;
 324         }
 325         public Object get(Object key) throws JSExn {
 326             if (super.has(key)) return super.get(key);
 327             if (key.equals("ibex")) return ibex;
 328             if (key.equals("")) return ibex.get("");
 329             if (key.equals("static")) return myStatic;
 330             return super.get(key);
 331         }
 332     }
 333
 334 }
 335
 336