Merge from mainline (gomp-merge-2005-02-26).
[official-gcc.git] / libjava / external / sax / org / xml / sax / helpers / NamespaceSupport.java
blob17d803626644c9bfc3c78a0508587667e4b264b8
1 // NamespaceSupport.java - generic Namespace support for SAX.
2 // http://www.saxproject.org
3 // Written by David Megginson
4 // This class is in the Public Domain. NO WARRANTY!
5 // $Id: NamespaceSupport.java,v 1.1 2005/02/02 00:41:54 tromey Exp $
7 package org.xml.sax.helpers;
9 import java.util.EmptyStackException;
10 import java.util.Enumeration;
11 import java.util.Hashtable;
12 import java.util.Vector;
15 /**
16 * Encapsulate Namespace logic for use by applications using SAX,
17 * or internally by SAX drivers.
19 * <blockquote>
20 * <em>This module, both source code and documentation, is in the
21 * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em>
22 * See <a href='http://www.saxproject.org'>http://www.saxproject.org</a>
23 * for further information.
24 * </blockquote>
26 * <p>This class encapsulates the logic of Namespace processing: it
27 * tracks the declarations currently in force for each context and
28 * automatically processes qualified XML names into their Namespace
29 * parts; it can also be used in reverse for generating XML qnames
30 * from Namespaces.</p>
32 * <p>Namespace support objects are reusable, but the reset method
33 * must be invoked between each session.</p>
35 * <p>Here is a simple session:</p>
37 * <pre>
38 * String parts[] = new String[3];
39 * NamespaceSupport support = new NamespaceSupport();
41 * support.pushContext();
42 * support.declarePrefix("", "http://www.w3.org/1999/xhtml");
43 * support.declarePrefix("dc", "http://www.purl.org/dc#");
45 * parts = support.processName("p", parts, false);
46 * System.out.println("Namespace URI: " + parts[0]);
47 * System.out.println("Local name: " + parts[1]);
48 * System.out.println("Raw name: " + parts[2]);
50 * parts = support.processName("dc:title", parts, false);
51 * System.out.println("Namespace URI: " + parts[0]);
52 * System.out.println("Local name: " + parts[1]);
53 * System.out.println("Raw name: " + parts[2]);
55 * support.popContext();
56 * </pre>
58 * <p>Note that this class is optimized for the use case where most
59 * elements do not contain Namespace declarations: if the same
60 * prefix/URI mapping is repeated for each context (for example), this
61 * class will be somewhat less efficient.</p>
63 * <p>Although SAX drivers (parsers) may choose to use this class to
64 * implement namespace handling, they are not required to do so.
65 * Applications must track namespace information themselves if they
66 * want to use namespace information.
68 * @since SAX 2.0
69 * @author David Megginson
70 * @version 2.0.1 (sax2r2)
72 public class NamespaceSupport
76 ////////////////////////////////////////////////////////////////////
77 // Constants.
78 ////////////////////////////////////////////////////////////////////
81 /**
82 * The XML Namespace URI as a constant.
83 * The value is <code>http://www.w3.org/XML/1998/namespace</code>
84 * as defined in the "Namespaces in XML" * recommendation.
86 * <p>This is the Namespace URI that is automatically mapped
87 * to the "xml" prefix.</p>
89 public final static String XMLNS =
90 "http://www.w3.org/XML/1998/namespace";
93 /**
94 * The namespace declaration URI as a constant.
95 * The value is <code>http://www.w3.org/xmlns/2000/</code>, as defined
96 * in a backwards-incompatible erratum to the "Namespaces in XML"
97 * recommendation. Because that erratum postdated SAX2, SAX2 defaults
98 * to the original recommendation, and does not normally use this URI.
101 * <p>This is the Namespace URI that is optionally applied to
102 * <em>xmlns</em> and <em>xmlns:*</em> attributes, which are used to
103 * declare namespaces. </p>
105 * @since SAX 2.1alpha
106 * @see #setNamespaceDeclUris
107 * @see #isNamespaceDeclUris
109 public final static String NSDECL =
110 "http://www.w3.org/xmlns/2000/";
114 * An empty enumeration.
116 private final static Enumeration EMPTY_ENUMERATION =
117 new Vector().elements();
120 ////////////////////////////////////////////////////////////////////
121 // Constructor.
122 ////////////////////////////////////////////////////////////////////
126 * Create a new Namespace support object.
128 public NamespaceSupport ()
130 reset();
135 ////////////////////////////////////////////////////////////////////
136 // Context management.
137 ////////////////////////////////////////////////////////////////////
141 * Reset this Namespace support object for reuse.
143 * <p>It is necessary to invoke this method before reusing the
144 * Namespace support object for a new session. If namespace
145 * declaration URIs are to be supported, that flag must also
146 * be set to a non-default value.
147 * </p>
149 * @see #setNamespaceDeclUris
151 public void reset ()
153 contexts = new Context[32];
154 namespaceDeclUris = false;
155 contextPos = 0;
156 contexts[contextPos] = currentContext = new Context();
157 currentContext.declarePrefix("xml", XMLNS);
162 * Start a new Namespace context.
163 * The new context will automatically inherit
164 * the declarations of its parent context, but it will also keep
165 * track of which declarations were made within this context.
167 * <p>Event callback code should start a new context once per element.
168 * This means being ready to call this in either of two places.
169 * For elements that don't include namespace declarations, the
170 * <em>ContentHandler.startElement()</em> callback is the right place.
171 * For elements with such a declaration, it'd done in the first
172 * <em>ContentHandler.startPrefixMapping()</em> callback.
173 * A boolean flag can be used to
174 * track whether a context has been started yet. When either of
175 * those methods is called, it checks the flag to see if a new context
176 * needs to be started. If so, it starts the context and sets the
177 * flag. After <em>ContentHandler.startElement()</em>
178 * does that, it always clears the flag.
180 * <p>Normally, SAX drivers would push a new context at the beginning
181 * of each XML element. Then they perform a first pass over the
182 * attributes to process all namespace declarations, making
183 * <em>ContentHandler.startPrefixMapping()</em> callbacks.
184 * Then a second pass is made, to determine the namespace-qualified
185 * names for all attributes and for the element name.
186 * Finally all the information for the
187 * <em>ContentHandler.startElement()</em> callback is available,
188 * so it can then be made.
190 * <p>The Namespace support object always starts with a base context
191 * already in force: in this context, only the "xml" prefix is
192 * declared.</p>
194 * @see org.xml.sax.ContentHandler
195 * @see #popContext
197 public void pushContext ()
199 int max = contexts.length;
201 contexts [contextPos].declsOK = false;
202 contextPos++;
204 // Extend the array if necessary
205 if (contextPos >= max) {
206 Context newContexts[] = new Context[max*2];
207 System.arraycopy(contexts, 0, newContexts, 0, max);
208 max *= 2;
209 contexts = newContexts;
212 // Allocate the context if necessary.
213 currentContext = contexts[contextPos];
214 if (currentContext == null) {
215 contexts[contextPos] = currentContext = new Context();
218 // Set the parent, if any.
219 if (contextPos > 0) {
220 currentContext.setParent(contexts[contextPos - 1]);
226 * Revert to the previous Namespace context.
228 * <p>Normally, you should pop the context at the end of each
229 * XML element. After popping the context, all Namespace prefix
230 * mappings that were previously in force are restored.</p>
232 * <p>You must not attempt to declare additional Namespace
233 * prefixes after popping a context, unless you push another
234 * context first.</p>
236 * @see #pushContext
238 public void popContext ()
240 contexts[contextPos].clear();
241 contextPos--;
242 if (contextPos < 0) {
243 throw new EmptyStackException();
245 currentContext = contexts[contextPos];
250 ////////////////////////////////////////////////////////////////////
251 // Operations within a context.
252 ////////////////////////////////////////////////////////////////////
256 * Declare a Namespace prefix. All prefixes must be declared
257 * before they are referenced. For example, a SAX driver (parser)
258 * would scan an element's attributes
259 * in two passes: first for namespace declarations,
260 * then a second pass using {@link #processName processName()} to
261 * interpret prefixes against (potentially redefined) prefixes.
263 * <p>This method declares a prefix in the current Namespace
264 * context; the prefix will remain in force until this context
265 * is popped, unless it is shadowed in a descendant context.</p>
267 * <p>To declare the default element Namespace, use the empty string as
268 * the prefix.</p>
270 * <p>Note that you must <em>not</em> declare a prefix after
271 * you've pushed and popped another Namespace context, or
272 * treated the declarations phase as complete by processing
273 * a prefixed name.</p>
275 * <p>Note that there is an asymmetry in this library: {@link
276 * #getPrefix getPrefix} will not return the "" prefix,
277 * even if you have declared a default element namespace.
278 * To check for a default namespace,
279 * you have to look it up explicitly using {@link #getURI getURI}.
280 * This asymmetry exists to make it easier to look up prefixes
281 * for attribute names, where the default prefix is not allowed.</p>
283 * @param prefix The prefix to declare, or the empty string to
284 * indicate the default element namespace. This may never have
285 * the value "xml" or "xmlns".
286 * @param uri The Namespace URI to associate with the prefix.
287 * @return true if the prefix was legal, false otherwise
289 * @see #processName
290 * @see #getURI
291 * @see #getPrefix
293 public boolean declarePrefix (String prefix, String uri)
295 if (prefix.equals("xml") || prefix.equals("xmlns")) {
296 return false;
297 } else {
298 currentContext.declarePrefix(prefix, uri);
299 return true;
305 * Process a raw XML qualified name, after all declarations in the
306 * current context have been handled by {@link #declarePrefix
307 * declarePrefix()}.
309 * <p>This method processes a raw XML qualified name in the
310 * current context by removing the prefix and looking it up among
311 * the prefixes currently declared. The return value will be the
312 * array supplied by the caller, filled in as follows:</p>
314 * <dl>
315 * <dt>parts[0]</dt>
316 * <dd>The Namespace URI, or an empty string if none is
317 * in use.</dd>
318 * <dt>parts[1]</dt>
319 * <dd>The local name (without prefix).</dd>
320 * <dt>parts[2]</dt>
321 * <dd>The original raw name.</dd>
322 * </dl>
324 * <p>All of the strings in the array will be internalized. If
325 * the raw name has a prefix that has not been declared, then
326 * the return value will be null.</p>
328 * <p>Note that attribute names are processed differently than
329 * element names: an unprefixed element name will receive the
330 * default Namespace (if any), while an unprefixed attribute name
331 * will not.</p>
333 * @param qName The XML qualified name to be processed.
334 * @param parts An array supplied by the caller, capable of
335 * holding at least three members.
336 * @param isAttribute A flag indicating whether this is an
337 * attribute name (true) or an element name (false).
338 * @return The supplied array holding three internalized strings
339 * representing the Namespace URI (or empty string), the
340 * local name, and the XML qualified name; or null if there
341 * is an undeclared prefix.
342 * @see #declarePrefix
343 * @see java.lang.String#intern */
344 public String [] processName (String qName, String parts[],
345 boolean isAttribute)
347 String myParts[] = currentContext.processName(qName, isAttribute);
348 if (myParts == null) {
349 return null;
350 } else {
351 parts[0] = myParts[0];
352 parts[1] = myParts[1];
353 parts[2] = myParts[2];
354 return parts;
360 * Look up a prefix and get the currently-mapped Namespace URI.
362 * <p>This method looks up the prefix in the current context.
363 * Use the empty string ("") for the default Namespace.</p>
365 * @param prefix The prefix to look up.
366 * @return The associated Namespace URI, or null if the prefix
367 * is undeclared in this context.
368 * @see #getPrefix
369 * @see #getPrefixes
371 public String getURI (String prefix)
373 return currentContext.getURI(prefix);
378 * Return an enumeration of all prefixes whose declarations are
379 * active in the current context.
380 * This includes declarations from parent contexts that have
381 * not been overridden.
383 * <p><strong>Note:</strong> if there is a default prefix, it will not be
384 * returned in this enumeration; check for the default prefix
385 * using the {@link #getURI getURI} with an argument of "".</p>
387 * @return An enumeration of prefixes (never empty).
388 * @see #getDeclaredPrefixes
389 * @see #getURI
391 public Enumeration getPrefixes ()
393 return currentContext.getPrefixes();
398 * Return one of the prefixes mapped to a Namespace URI.
400 * <p>If more than one prefix is currently mapped to the same
401 * URI, this method will make an arbitrary selection; if you
402 * want all of the prefixes, use the {@link #getPrefixes}
403 * method instead.</p>
405 * <p><strong>Note:</strong> this will never return the empty (default) prefix;
406 * to check for a default prefix, use the {@link #getURI getURI}
407 * method with an argument of "".</p>
409 * @param uri the namespace URI
410 * @return one of the prefixes currently mapped to the URI supplied,
411 * or null if none is mapped or if the URI is assigned to
412 * the default namespace
413 * @see #getPrefixes(java.lang.String)
414 * @see #getURI
416 public String getPrefix (String uri)
418 return currentContext.getPrefix(uri);
423 * Return an enumeration of all prefixes for a given URI whose
424 * declarations are active in the current context.
425 * This includes declarations from parent contexts that have
426 * not been overridden.
428 * <p>This method returns prefixes mapped to a specific Namespace
429 * URI. The xml: prefix will be included. If you want only one
430 * prefix that's mapped to the Namespace URI, and you don't care
431 * which one you get, use the {@link #getPrefix getPrefix}
432 * method instead.</p>
434 * <p><strong>Note:</strong> the empty (default) prefix is <em>never</em> included
435 * in this enumeration; to check for the presence of a default
436 * Namespace, use the {@link #getURI getURI} method with an
437 * argument of "".</p>
439 * @param uri The Namespace URI.
440 * @return An enumeration of prefixes (never empty).
441 * @see #getPrefix
442 * @see #getDeclaredPrefixes
443 * @see #getURI
445 public Enumeration getPrefixes (String uri)
447 Vector prefixes = new Vector();
448 Enumeration allPrefixes = getPrefixes();
449 while (allPrefixes.hasMoreElements()) {
450 String prefix = (String)allPrefixes.nextElement();
451 if (uri.equals(getURI(prefix))) {
452 prefixes.addElement(prefix);
455 return prefixes.elements();
460 * Return an enumeration of all prefixes declared in this context.
462 * <p>The empty (default) prefix will be included in this
463 * enumeration; note that this behaviour differs from that of
464 * {@link #getPrefix} and {@link #getPrefixes}.</p>
466 * @return An enumeration of all prefixes declared in this
467 * context.
468 * @see #getPrefixes
469 * @see #getURI
471 public Enumeration getDeclaredPrefixes ()
473 return currentContext.getDeclaredPrefixes();
477 * Controls whether namespace declaration attributes are placed
478 * into the {@link #NSDECL NSDECL} namespace
479 * by {@link #processName processName()}. This may only be
480 * changed before any contexts have been pushed.
482 * @since SAX 2.1alpha
484 * @exception IllegalStateException when attempting to set this
485 * after any context has been pushed.
487 public void setNamespaceDeclUris (boolean value)
489 if (contextPos != 0)
490 throw new IllegalStateException ();
491 if (value == namespaceDeclUris)
492 return;
493 namespaceDeclUris = value;
494 if (value)
495 currentContext.declarePrefix ("xmlns", NSDECL);
496 else {
497 contexts[contextPos] = currentContext = new Context();
498 currentContext.declarePrefix("xml", XMLNS);
503 * Returns true if namespace declaration attributes are placed into
504 * a namespace. This behavior is not the default.
506 * @since SAX 2.1alpha
508 public boolean isNamespaceDeclUris ()
509 { return namespaceDeclUris; }
513 ////////////////////////////////////////////////////////////////////
514 // Internal state.
515 ////////////////////////////////////////////////////////////////////
517 private Context contexts[];
518 private Context currentContext;
519 private int contextPos;
520 private boolean namespaceDeclUris;
523 ////////////////////////////////////////////////////////////////////
524 // Internal classes.
525 ////////////////////////////////////////////////////////////////////
528 * Internal class for a single Namespace context.
530 * <p>This module caches and reuses Namespace contexts,
531 * so the number allocated
532 * will be equal to the element depth of the document, not to the total
533 * number of elements (i.e. 5-10 rather than tens of thousands).
534 * Also, data structures used to represent contexts are shared when
535 * possible (child contexts without declarations) to further reduce
536 * the amount of memory that's consumed.
537 * </p>
539 final class Context {
542 * Create the root-level Namespace context.
544 Context ()
546 copyTables();
551 * (Re)set the parent of this Namespace context.
552 * The context must either have been freshly constructed,
553 * or must have been cleared.
555 * @param context The parent Namespace context object.
557 void setParent (Context parent)
559 this.parent = parent;
560 declarations = null;
561 prefixTable = parent.prefixTable;
562 uriTable = parent.uriTable;
563 elementNameTable = parent.elementNameTable;
564 attributeNameTable = parent.attributeNameTable;
565 defaultNS = parent.defaultNS;
566 declSeen = false;
567 declsOK = true;
571 * Makes associated state become collectible,
572 * invalidating this context.
573 * {@link #setParent} must be called before
574 * this context may be used again.
576 void clear ()
578 parent = null;
579 prefixTable = null;
580 uriTable = null;
581 elementNameTable = null;
582 attributeNameTable = null;
583 defaultNS = null;
588 * Declare a Namespace prefix for this context.
590 * @param prefix The prefix to declare.
591 * @param uri The associated Namespace URI.
592 * @see org.xml.sax.helpers.NamespaceSupport#declarePrefix
594 void declarePrefix (String prefix, String uri)
596 // Lazy processing...
597 if (!declsOK)
598 throw new IllegalStateException (
599 "can't declare any more prefixes in this context");
600 if (!declSeen) {
601 copyTables();
603 if (declarations == null) {
604 declarations = new Vector();
607 prefix = prefix.intern();
608 uri = uri.intern();
609 if ("".equals(prefix)) {
610 if ("".equals(uri)) {
611 defaultNS = null;
612 } else {
613 defaultNS = uri;
615 } else {
616 prefixTable.put(prefix, uri);
617 uriTable.put(uri, prefix); // may wipe out another prefix
619 declarations.addElement(prefix);
624 * Process an XML qualified name in this context.
626 * @param qName The XML qualified name.
627 * @param isAttribute true if this is an attribute name.
628 * @return An array of three strings containing the
629 * URI part (or empty string), the local part,
630 * and the raw name, all internalized, or null
631 * if there is an undeclared prefix.
632 * @see org.xml.sax.helpers.NamespaceSupport#processName
634 String [] processName (String qName, boolean isAttribute)
636 String name[];
637 Hashtable table;
639 // detect errors in call sequence
640 declsOK = false;
642 // Select the appropriate table.
643 if (isAttribute) {
644 table = attributeNameTable;
645 } else {
646 table = elementNameTable;
649 // Start by looking in the cache, and
650 // return immediately if the name
651 // is already known in this content
652 name = (String[])table.get(qName);
653 if (name != null) {
654 return name;
657 // We haven't seen this name in this
658 // context before. Maybe in the parent
659 // context, but we can't assume prefix
660 // bindings are the same.
661 name = new String[3];
662 name[2] = qName.intern();
663 int index = qName.indexOf(':');
666 // No prefix.
667 if (index == -1) {
668 if (isAttribute) {
669 if (qName == "xmlns" && namespaceDeclUris)
670 name[0] = NSDECL;
671 else
672 name[0] = "";
673 } else if (defaultNS == null) {
674 name[0] = "";
675 } else {
676 name[0] = defaultNS;
678 name[1] = name[2];
681 // Prefix
682 else {
683 String prefix = qName.substring(0, index);
684 String local = qName.substring(index+1);
685 String uri;
686 if ("".equals(prefix)) {
687 uri = defaultNS;
688 } else {
689 uri = (String)prefixTable.get(prefix);
691 if (uri == null
692 || (!isAttribute && "xmlns".equals (prefix))) {
693 return null;
695 name[0] = uri;
696 name[1] = local.intern();
699 // Save in the cache for future use.
700 // (Could be shared with parent context...)
701 table.put(name[2], name);
702 return name;
707 * Look up the URI associated with a prefix in this context.
709 * @param prefix The prefix to look up.
710 * @return The associated Namespace URI, or null if none is
711 * declared.
712 * @see org.xml.sax.helpers.NamespaceSupport#getURI
714 String getURI (String prefix)
716 if ("".equals(prefix)) {
717 return defaultNS;
718 } else if (prefixTable == null) {
719 return null;
720 } else {
721 return (String)prefixTable.get(prefix);
727 * Look up one of the prefixes associated with a URI in this context.
729 * <p>Since many prefixes may be mapped to the same URI,
730 * the return value may be unreliable.</p>
732 * @param uri The URI to look up.
733 * @return The associated prefix, or null if none is declared.
734 * @see org.xml.sax.helpers.NamespaceSupport#getPrefix
736 String getPrefix (String uri)
738 if (uriTable == null) {
739 return null;
740 } else {
741 return (String)uriTable.get(uri);
747 * Return an enumeration of prefixes declared in this context.
749 * @return An enumeration of prefixes (possibly empty).
750 * @see org.xml.sax.helpers.NamespaceSupport#getDeclaredPrefixes
752 Enumeration getDeclaredPrefixes ()
754 if (declarations == null) {
755 return EMPTY_ENUMERATION;
756 } else {
757 return declarations.elements();
763 * Return an enumeration of all prefixes currently in force.
765 * <p>The default prefix, if in force, is <em>not</em>
766 * returned, and will have to be checked for separately.</p>
768 * @return An enumeration of prefixes (never empty).
769 * @see org.xml.sax.helpers.NamespaceSupport#getPrefixes
771 Enumeration getPrefixes ()
773 if (prefixTable == null) {
774 return EMPTY_ENUMERATION;
775 } else {
776 return prefixTable.keys();
782 ////////////////////////////////////////////////////////////////
783 // Internal methods.
784 ////////////////////////////////////////////////////////////////
788 * Copy on write for the internal tables in this context.
790 * <p>This class is optimized for the normal case where most
791 * elements do not contain Namespace declarations.</p>
793 private void copyTables ()
795 if (prefixTable != null) {
796 prefixTable = (Hashtable)prefixTable.clone();
797 } else {
798 prefixTable = new Hashtable();
800 if (uriTable != null) {
801 uriTable = (Hashtable)uriTable.clone();
802 } else {
803 uriTable = new Hashtable();
805 elementNameTable = new Hashtable();
806 attributeNameTable = new Hashtable();
807 declSeen = true;
812 ////////////////////////////////////////////////////////////////
813 // Protected state.
814 ////////////////////////////////////////////////////////////////
816 Hashtable prefixTable;
817 Hashtable uriTable;
818 Hashtable elementNameTable;
819 Hashtable attributeNameTable;
820 String defaultNS = null;
821 boolean declsOK = true;
825 ////////////////////////////////////////////////////////////////
826 // Internal state.
827 ////////////////////////////////////////////////////////////////
829 private Vector declarations = null;
830 private boolean declSeen = false;
831 private Context parent = null;
835 // end of NamespaceSupport.java