View Javadoc

    1   package groovy.xml.streamingmarkupsupport;
    2   /*
    3
    4   Copyright 2004 (C) John Wilson. All Rights Reserved.
    5
    6   Redistribution and use of this software and associated documentation
    7   ("Software"), with or without modification, are permitted provided
    8   that the following conditions are met:
    9
    10  1. Redistributions of source code must retain copyright
    11     statements and notices.  Redistributions must also contain a
    12     copy of this document.
    13
    14  2. Redistributions in binary form must reproduce the
    15     above copyright notice, this list of conditions and the
    16     following disclaimer in the documentation and/or other
    17     materials provided with the distribution.
    18
    19  3. The name "groovy" must not be used to endorse or promote
    20     products derived from this Software without prior written
    21     permission of The Codehaus.  For written permission,
    22     please contact info@codehaus.org.
    23
    24  4. Products derived from this Software may not be called "groovy"
    25     nor may "groovy" appear in their names without prior written
    26     permission of The Codehaus. "groovy" is a registered
    27     trademark of The Codehaus.
    28
    29  5. Due credit should be given to The Codehaus -
    30     http://groovy.codehaus.org/
    31
    32  THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
    33  ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
    34  NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
    35  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
    36  THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
    37  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    38  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
    39  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    40  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
    41  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    42  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    43  OF THE POSSIBILITY OF SUCH DAMAGE.
    44
    45  */
    46
    47  import groovy.lang.Closure;
    48  import groovy.lang.GroovyInterceptable;
    49  import groovy.lang.GroovyObjectSupport;
    50
    51  import java.util.Collections;
    52  import java.util.HashMap;
    53  import java.util.Map;
    54
    55  public class BaseMarkupBuilder extends Builder {
    56  	public BaseMarkupBuilder(final Map namespaceMethodMap) {
    57  		super(namespaceMethodMap);
    58  	}
    59
    60  	public Object bind(final Closure root) {
    61  		return new Document(root, this.namespaceMethodMap);
    62  	}
    63
    64  	private static class Document extends Built implements GroovyInterceptable {
    65  		private Object out;
    66  		private final Map pendingNamespaces = new HashMap();
    67  		private final Map namespaces = new HashMap();
    68           private final Map specialProperties = new HashMap();
    69  		private String prefix = "";
    70
    71          {
    72
    73              namespaces.put("xml", "http://www.w3.org/XML/1998/namespace");             // built in namespace
    74              namespaces.put("mkp", "http://www.codehaus.org/Groovy/markup/keywords");   // pseudo namespace for markup keywords
    75
    76              specialProperties.put("out", new OutputSink("out") {
    77                  public Object leftShift(final Object value) {
    78                      return leftShift("yield", value);
    79                  }
    80              });
    81              specialProperties.put("unescaped", new OutputSink("unescaped") {
    82                  public Object leftShift(final Object value) {
    83                      return leftShift("yieldUnescaped", value);
    84                  }
    85              });
    86              specialProperties.put("namespaces", new OutputSink("namespaces") {
    87                  public Object leftShift(final Object value) {
    88                      return leftShift("declareNamespace", value);
    89                  }
    90              });
    91              specialProperties.put("pi", new OutputSink("pi") {
    92                  public Object leftShift(final Object value) {
    93                      return leftShift("pi", value);
    94                  }
    95              });
    96              specialProperties.put("comment", new OutputSink("comment") {
    97                  public Object leftShift(final Object value) {
    98                      return leftShift("comment", value);
    99                  }
    100             });
    101         }
    102
    103         private abstract class OutputSink extends GroovyObjectSupport {
    104             private final String name;
    105
    106             public OutputSink(final String name) {
    107                 this.name = name;
    108             }
    109
    110             public Object invokeMethod(final String name, final Object args) {
    111                 Document.this.prefix = this.name;
    112                 return Document.this.invokeMethod(name, args);
    113             }
    114
    115             public abstract Object leftShift(Object item);
    116
    117             protected Object leftShift(final String command, final Object value) {
    118                 Document.this.getProperty("mkp");
    119                 Document.this.invokeMethod(command, new Object[]{value});
    120                 return this;
    121             }
    122         }
    123
    124 		public Document(final Closure root, final Map namespaceMethodMap) {
    125 			super(root, namespaceMethodMap);
    126 		}
    127
    128 		/* (non-Javadoc)
    129 		 * @see groovy.lang.GroovyObject#invokeMethod(java.lang.String, java.lang.Object)
    130 		 */
    131 		public Object invokeMethod(final String name, final Object args) {
    132 			final Object[] arguments = (Object[]) args;
    133 			Map attrs = Collections.EMPTY_MAP;
    134 			Object body = null;
    135
    136
    137 			//
    138 			// Sort the parameters out
    139 			//
    140 			for (int i = 0; i != arguments.length; i++) {
    141 				final Object arg = arguments[i];
    142
    143 				if (arg instanceof Map) {
    144 					attrs = (Map)arg;
    145 				} else if (arg instanceof Closure) {
    146 					final Closure c = ((Closure) arg);
    147
    148 					c.setDelegate(this);
    149 					body = c.asWritable();
    150 				} else {
    151 					body = arg;
    152 				}
    153 			}
    154
    155 			//
    156 			// call the closure corresponding to the tag
    157 			//
    158 			final Object uri;
    159
    160 			if (this.pendingNamespaces.containsKey(this.prefix)) {
    161 				uri = this.pendingNamespaces.get(this.prefix);
    162 			} else if (this.namespaces.containsKey(this.prefix)) {
    163 				uri = this.namespaces.get(this.prefix);
    164 			} else {
    165 				uri = ":";
    166 			}
    167
    168 			final Object[] info  = (Object[])this.namespaceSpecificTags.get(uri);
    169 			final Map tagMap = (Map)info[2];
    170 			final Closure defaultTagClosure = (Closure)info[0];
    171
    172 			final String prefix = this.prefix;
    173 			this.prefix = "";
    174
    175 			if (tagMap.containsKey(name)) {
    176 				return ((Closure)tagMap.get(name)).call(new Object[]{this, this.pendingNamespaces, this.namespaces, this.namespaceSpecificTags, prefix, attrs, body, this.out});
    177 			} else {
    178 				return defaultTagClosure.call(new Object[]{name, this, this.pendingNamespaces, this.namespaces, this.namespaceSpecificTags, prefix, attrs, body, this.out});
    179 			}
    180 		}
    181
    182 		/* (non-Javadoc)
    183 		 * @see groovy.lang.GroovyObject#getProperty(java.lang.String)
    184 		 */
    185 		public Object getProperty(final String property) {
    186         final Object special = this.specialProperties.get(property);
    187
    188             if (special == null) {
    189         			this.prefix = property;
    190         			return this;
    191             } else {
    192                 return special;
    193             }
    194 		}
    195
    196 		/* (non-Javadoc)
    197 		 * @see groovy.lang.GroovyObject#setProperty(java.lang.String, java.lang.Object)
    198 		 */
    199 		public void setProperty(String property, Object newValue) {
    200 			if ("trigger".equals(property)) {
    201 				this.out = newValue;
    202 				this.root.call(this);
    203 			} else {
    204 				super.setProperty(property, newValue);
    205 			}
    206 		}
    207 	}
    208 }