ohair@286: /*
mkos@397:  * Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.dtdparser;
ohair@286: 
ohair@286: import org.xml.sax.EntityResolver;
ohair@286: import org.xml.sax.InputSource;
ohair@286: import org.xml.sax.Locator;
ohair@286: import org.xml.sax.SAXException;
ohair@286: import org.xml.sax.SAXParseException;
ohair@286: 
ohair@286: import java.io.IOException;
ohair@286: import java.util.ArrayList;
ohair@286: import java.util.Enumeration;
ohair@286: import java.util.Hashtable;
ohair@286: import java.util.Locale;
ohair@286: import java.util.Set;
ohair@286: import java.util.Vector;
ohair@286: 
ohair@286: /**
ohair@286:  * This implements parsing of XML 1.0 DTDs.
ohair@286:  * <p/>
ohair@286:  * This conforms to the portion of the XML 1.0 specification related
ohair@286:  * to the external DTD subset.
ohair@286:  * <p/>
ohair@286:  * For multi-language applications (such as web servers using XML
ohair@286:  * processing to create dynamic content), a method supports choosing
ohair@286:  * a locale for parser diagnostics which is both understood by the
ohair@286:  * message recipient and supported by the parser.
ohair@286:  * <p/>
ohair@286:  * This parser produces a stream of parse events.  It supports some
ohair@286:  * features (exposing comments, CDATA sections, and entity references)
ohair@286:  * which are not required to be reported by conformant XML processors.
ohair@286:  *
ohair@286:  * @author David Brownell
ohair@286:  * @author Janet Koenig
ohair@286:  * @author Kohsuke KAWAGUCHI
mkos@397:  * @version $Id: DTDParser.java,v 1.2 2009/04/16 15:25:49 snajper Exp $
ohair@286:  */
ohair@286: public class DTDParser {
ohair@286:     public final static String TYPE_CDATA = "CDATA";
ohair@286:     public final static String TYPE_ID = "ID";
ohair@286:     public final static String TYPE_IDREF = "IDREF";
ohair@286:     public final static String TYPE_IDREFS = "IDREFS";
ohair@286:     public final static String TYPE_ENTITY = "ENTITY";
ohair@286:     public final static String TYPE_ENTITIES = "ENTITIES";
ohair@286:     public final static String TYPE_NMTOKEN = "NMTOKEN";
ohair@286:     public final static String TYPE_NMTOKENS = "NMTOKENS";
ohair@286:     public final static String TYPE_NOTATION = "NOTATION";
ohair@286:     public final static String TYPE_ENUMERATION = "ENUMERATION";
ohair@286: 
ohair@286: 
ohair@286:     // stack of input entities being merged
ohair@286:     private InputEntity in;
ohair@286: 
ohair@286:     // temporaries reused during parsing
ohair@286:     private StringBuffer strTmp;
ohair@286:     private char nameTmp [];
ohair@286:     private NameCache nameCache;
ohair@286:     private char charTmp [] = new char[2];
ohair@286: 
ohair@286:     // temporary DTD parsing state
ohair@286:     private boolean doLexicalPE;
ohair@286: 
ohair@286:     // DTD state, used during parsing
ohair@286: //    private SimpleHashtable    elements = new SimpleHashtable (47);
ohair@286:     protected final Set declaredElements = new java.util.HashSet();
ohair@286:     private SimpleHashtable params = new SimpleHashtable(7);
ohair@286: 
ohair@286:     // exposed to package-private subclass
ohair@286:     Hashtable notations = new Hashtable(7);
ohair@286:     SimpleHashtable entities = new SimpleHashtable(17);
ohair@286: 
ohair@286:     private SimpleHashtable ids = new SimpleHashtable();
ohair@286: 
ohair@286:     // listeners for DTD parsing events
ohair@286:     private DTDEventListener dtdHandler;
ohair@286: 
ohair@286:     private EntityResolver resolver;
ohair@286:     private Locale locale;
ohair@286: 
ohair@286:     // string constants -- use these copies so "==" works
ohair@286:     // package private
ohair@286:     static final String strANY = "ANY";
ohair@286:     static final String strEMPTY = "EMPTY";
ohair@286: 
ohair@286:     /**
ohair@286:      * Used by applications to request locale for diagnostics.
ohair@286:      *
ohair@286:      * @param l The locale to use, or null to use system defaults
ohair@286:      *          (which may include only message IDs).
ohair@286:      */
ohair@286:     public void setLocale(Locale l) throws SAXException {
ohair@286: 
ohair@286:         if (l != null && !messages.isLocaleSupported(l.toString())) {
ohair@286:             throw new SAXException(messages.getMessage(locale,
ohair@286:                     "P-078", new Object[]{l}));
ohair@286:         }
ohair@286:         locale = l;
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Returns the diagnostic locale.
ohair@286:      */
ohair@286:     public Locale getLocale() {
ohair@286:         return locale;
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Chooses a client locale to use for diagnostics, using the first
ohair@286:      * language specified in the list that is supported by this parser.
ohair@286:      * That locale is then set using <a href="#setLocale(java.util.Locale)">
ohair@286:      * setLocale()</a>.  Such a list could be provided by a variety of user
ohair@286:      * preference mechanisms, including the HTTP <em>Accept-Language</em>
ohair@286:      * header field.
ohair@286:      *
ohair@286:      * @param languages Array of language specifiers, ordered with the most
ohair@286:      *                  preferable one at the front.  For example, "en-ca" then "fr-ca",
ohair@286:      *                  followed by "zh_CN".  Both RFC 1766 and Java styles are supported.
ohair@286:      * @return The chosen locale, or null.
ohair@286:      * @see MessageCatalog
ohair@286:      */
ohair@286:     public Locale chooseLocale(String languages [])
ohair@286:             throws SAXException {
ohair@286: 
ohair@286:         Locale l = messages.chooseLocale(languages);
ohair@286: 
ohair@286:         if (l != null) {
ohair@286:             setLocale(l);
ohair@286:         }
ohair@286:         return l;
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Lets applications control entity resolution.
ohair@286:      */
ohair@286:     public void setEntityResolver(EntityResolver r) {
ohair@286: 
ohair@286:         resolver = r;
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Returns the object used to resolve entities
ohair@286:      */
ohair@286:     public EntityResolver getEntityResolver() {
ohair@286: 
ohair@286:         return resolver;
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Used by applications to set handling of DTD parsing events.
ohair@286:      */
ohair@286:     public void setDtdHandler(DTDEventListener handler) {
ohair@286:         dtdHandler = handler;
ohair@286:         if (handler != null)
ohair@286:             handler.setDocumentLocator(new Locator() {
ohair@286:                 public String getPublicId() {
ohair@286:                     return DTDParser.this.getPublicId();
ohair@286:                 }
ohair@286: 
ohair@286:                 public String getSystemId() {
ohair@286:                     return DTDParser.this.getSystemId();
ohair@286:                 }
ohair@286: 
ohair@286:                 public int getLineNumber() {
ohair@286:                     return DTDParser.this.getLineNumber();
ohair@286:                 }
ohair@286: 
ohair@286:                 public int getColumnNumber() {
ohair@286:                     return DTDParser.this.getColumnNumber();
ohair@286:                 }
ohair@286:             });
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Returns the handler used to for DTD parsing events.
ohair@286:      */
ohair@286:     public DTDEventListener getDtdHandler() {
ohair@286:         return dtdHandler;
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Parse a DTD.
ohair@286:      */
ohair@286:     public void parse(InputSource in)
ohair@286:             throws IOException, SAXException {
ohair@286:         init();
ohair@286:         parseInternal(in);
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Parse a DTD.
ohair@286:      */
ohair@286:     public void parse(String uri)
ohair@286:             throws IOException, SAXException {
mkos@397:         InputSource in;
ohair@286: 
ohair@286:         init();
ohair@286:         // System.out.println ("parse (\"" + uri + "\")");
mkos@397:         in = resolver.resolveEntity(null, uri);
ohair@286: 
ohair@286:         // If custom resolver punts resolution to parser, handle it ...
mkos@397:         if (in == null) {
mkos@397:             in = Resolver.createInputSource(new java.net.URL(uri), false);
ohair@286: 
ohair@286:             // ... or if custom resolver doesn't correctly construct the
ohair@286:             // input entity, patch it up enough so relative URIs work, and
ohair@286:             // issue a warning to minimize later confusion.
mkos@397:         } else if (in.getSystemId() == null) {
ohair@286:             warning("P-065", null);
mkos@397:             in.setSystemId(uri);
ohair@286:         }
ohair@286: 
mkos@397:         parseInternal(in);
ohair@286:     }
ohair@286: 
ohair@286:     // makes sure the parser is reset to "before a document"
ohair@286:     private void init() {
ohair@286:         in = null;
ohair@286: 
ohair@286:         // alloc temporary data used in parsing
ohair@286:         strTmp = new StringBuffer();
ohair@286:         nameTmp = new char[20];
ohair@286:         nameCache = new NameCache();
ohair@286: 
ohair@286:         // reset doc info
ohair@286: //        isInAttribute = false;
ohair@286: 
ohair@286:         doLexicalPE = false;
ohair@286: 
ohair@286:         entities.clear();
ohair@286:         notations.clear();
ohair@286:         params.clear();
ohair@286:         //    elements.clear ();
ohair@286:         declaredElements.clear();
ohair@286: 
ohair@286:         // initialize predefined references ... re-interpreted later
ohair@286:         builtin("amp", "&#38;");
ohair@286:         builtin("lt", "&#60;");
ohair@286:         builtin("gt", ">");
ohair@286:         builtin("quot", "\"");
ohair@286:         builtin("apos", "'");
ohair@286: 
ohair@286:         if (locale == null)
ohair@286:             locale = Locale.getDefault();
ohair@286:         if (resolver == null)
ohair@286:             resolver = new Resolver();
ohair@286:         if (dtdHandler == null)
ohair@286:             dtdHandler = new DTDHandlerBase();
ohair@286:     }
ohair@286: 
ohair@286:     private void builtin(String entityName, String entityValue) {
ohair@286:         InternalEntity entity;
ohair@286:         entity = new InternalEntity(entityName, entityValue.toCharArray());
ohair@286:         entities.put(entityName, entity);
ohair@286:     }
ohair@286: 
ohair@286: 
ohair@286:     ////////////////////////////////////////////////////////////////
ohair@286:     //
ohair@286:     // parsing is by recursive descent, code roughly
ohair@286:     // following the BNF rules except tweaked for simple
ohair@286:     // lookahead.  rules are more or less in numeric order,
ohair@286:     // except where code sharing suggests other structures.
ohair@286:     //
ohair@286:     // a classic benefit of recursive descent parsers:  it's
ohair@286:     // relatively easy to get diagnostics that make sense.
ohair@286:     //
ohair@286:     ////////////////////////////////////////////////////////////////
ohair@286: 
ohair@286: 
ohair@286:     private void parseInternal(InputSource input)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         if (input == null)
ohair@286:             fatal("P-000");
ohair@286: 
ohair@286:         try {
ohair@286:             in = InputEntity.getInputEntity(dtdHandler, locale);
ohair@286:             in.init(input, null, null, false);
ohair@286: 
ohair@286:             dtdHandler.startDTD(in);
ohair@286: 
ohair@286:             // [30] extSubset ::= TextDecl? extSubsetDecl
ohair@286:             // [31] extSubsetDecl ::= ( markupdecl | conditionalSect
ohair@286:             //        | PEReference | S )*
ohair@286:             //    ... same as [79] extPE, which is where the code is
ohair@286: 
ohair@286:             ExternalEntity externalSubset = new ExternalEntity(in);
ohair@286:             externalParameterEntity(externalSubset);
ohair@286: 
ohair@286:             if (!in.isEOF()) {
ohair@286:                 fatal("P-001", new Object[]
ohair@286:                 {Integer.toHexString(((int) getc()))});
ohair@286:             }
ohair@286:             afterRoot();
ohair@286:             dtdHandler.endDTD();
ohair@286: 
ohair@286:         } catch (EndOfInputException e) {
ohair@286:             if (!in.isDocument()) {
ohair@286:                 String name = in.getName();
ohair@286:                 do {    // force a relevant URI and line number
ohair@286:                     in = in.pop();
ohair@286:                 } while (in.isInternal());
ohair@286:                 fatal("P-002", new Object[]{name});
ohair@286:             } else {
ohair@286:                 fatal("P-003", null);
ohair@286:             }
ohair@286:         } catch (RuntimeException e) {
ohair@286:             // Don't discard location that triggered the exception
ohair@286:             // ## Should properly wrap exception
ohair@286:             System.err.print("Internal DTD parser error: "); // ##
ohair@286:             e.printStackTrace();
ohair@286:             throw new SAXParseException(e.getMessage() != null
ohair@286:                     ? e.getMessage() : e.getClass().getName(),
ohair@286:                     getPublicId(), getSystemId(),
ohair@286:                     getLineNumber(), getColumnNumber());
ohair@286: 
ohair@286:         } finally {
ohair@286:             // recycle temporary data used during parsing
ohair@286:             strTmp = null;
ohair@286:             nameTmp = null;
ohair@286:             nameCache = null;
ohair@286: 
ohair@286:             // ditto input sources etc
ohair@286:             if (in != null) {
ohair@286:                 in.close();
ohair@286:                 in = null;
ohair@286:             }
ohair@286: 
ohair@286:             // get rid of all DTD info ... some of it would be
ohair@286:             // useful for editors etc, investigate later.
ohair@286: 
ohair@286:             params.clear();
ohair@286:             entities.clear();
ohair@286:             notations.clear();
ohair@286:             declaredElements.clear();
ohair@286: //        elements.clear();
ohair@286:             ids.clear();
ohair@286:         }
ohair@286:     }
ohair@286: 
ohair@286:     void afterRoot() throws SAXException {
ohair@286:         // Make sure all IDREFs match declared ID attributes.  We scan
ohair@286:         // after the document element is parsed, since XML allows forward
ohair@286:         // references, and only now can we know if they're all resolved.
ohair@286: 
ohair@286:         for (Enumeration e = ids.keys();
ohair@286:              e.hasMoreElements();
ohair@286:                 ) {
ohair@286:             String id = (String) e.nextElement();
ohair@286:             Boolean value = (Boolean) ids.get(id);
ohair@286:             if (Boolean.FALSE == value)
ohair@286:                 error("V-024", new Object[]{id});
ohair@286:         }
ohair@286:     }
ohair@286: 
ohair@286: 
ohair@286:     // role is for diagnostics
ohair@286:     private void whitespace(String roleId)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [3] S ::= (#x20 | #x9 | #xd | #xa)+
ohair@286:         if (!maybeWhitespace()) {
ohair@286:             fatal("P-004", new Object[]
ohair@286:             {messages.getMessage(locale, roleId)});
ohair@286:         }
ohair@286:     }
ohair@286: 
ohair@286:     // S?
ohair@286:     private boolean maybeWhitespace()
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         if (!doLexicalPE)
ohair@286:             return in.maybeWhitespace();
ohair@286: 
ohair@286:         // see getc() for the PE logic -- this lets us splice
ohair@286:         // expansions of PEs in "anywhere".  getc() has smarts,
ohair@286:         // so for external PEs we don't bypass it.
ohair@286: 
ohair@286:         // XXX we can marginally speed PE handling, and certainly
ohair@286:         // be cleaner (hence potentially more correct), by using
ohair@286:         // the observations that expanded PEs only start and stop
ohair@286:         // where whitespace is allowed.  getc wouldn't need any
ohair@286:         // "lexical" PE expansion logic, and no other method needs
ohair@286:         // to handle termination of PEs.  (parsing of literals would
ohair@286:         // still need to pop entities, but not parsing of references
ohair@286:         // in content.)
ohair@286: 
ohair@286:         char c = getc();
ohair@286:         boolean saw = false;
ohair@286: 
ohair@286:         while (c == ' ' || c == '\t' || c == '\n' || c == '\r') {
ohair@286:             saw = true;
ohair@286: 
ohair@286:             // this gracefully ends things when we stop playing
ohair@286:             // with internal parameters.  caller should have a
ohair@286:             // grammar rule allowing whitespace at end of entity.
ohair@286:             if (in.isEOF() && !in.isInternal())
ohair@286:                 return saw;
ohair@286:             c = getc();
ohair@286:         }
ohair@286:         ungetc();
ohair@286:         return saw;
ohair@286:     }
ohair@286: 
ohair@286:     private String maybeGetName()
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         NameCacheEntry entry = maybeGetNameCacheEntry();
ohair@286:         return (entry == null) ? null : entry.name;
ohair@286:     }
ohair@286: 
ohair@286:     private NameCacheEntry maybeGetNameCacheEntry()
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [5] Name ::= (Letter|'_'|':') (Namechar)*
ohair@286:         char c = getc();
ohair@286: 
ohair@286:         if (!XmlChars.isLetter(c) && c != ':' && c != '_') {
ohair@286:             ungetc();
ohair@286:             return null;
ohair@286:         }
ohair@286:         return nameCharString(c);
ohair@286:     }
ohair@286: 
ohair@286:     // Used when parsing enumerations
ohair@286:     private String getNmtoken()
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [7] Nmtoken ::= (Namechar)+
ohair@286:         char c = getc();
ohair@286:         if (!XmlChars.isNameChar(c))
ohair@286:             fatal("P-006", new Object[]{new Character(c)});
ohair@286:         return nameCharString(c).name;
ohair@286:     }
ohair@286: 
ohair@286:     // n.b. this gets used when parsing attribute values (for
ohair@286:     // internal references) so we can't use strTmp; it's also
ohair@286:     // a hotspot for CPU and memory in the parser (called at least
ohair@286:     // once for each element) so this has been optimized a bit.
ohair@286: 
ohair@286:     private NameCacheEntry nameCharString(char c)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         int i = 1;
ohair@286: 
ohair@286:         nameTmp[0] = c;
ohair@286:         for (; ;) {
ohair@286:             if ((c = in.getNameChar()) == 0)
ohair@286:                 break;
ohair@286:             if (i >= nameTmp.length) {
ohair@286:                 char tmp [] = new char[nameTmp.length + 10];
ohair@286:                 System.arraycopy(nameTmp, 0, tmp, 0, nameTmp.length);
ohair@286:                 nameTmp = tmp;
ohair@286:             }
ohair@286:             nameTmp[i++] = c;
ohair@286:         }
ohair@286:         return nameCache.lookupEntry(nameTmp, i);
ohair@286:     }
ohair@286: 
ohair@286:     //
ohair@286:     // much similarity between parsing entity values in DTD
ohair@286:     // and attribute values (in DTD or content) ... both follow
ohair@286:     // literal parsing rules, newline canonicalization, etc
ohair@286:     //
ohair@286:     // leaves value in 'strTmp' ... either a "replacement text" (4.5),
ohair@286:     // or else partially normalized attribute value (the first bit
ohair@286:     // of 3.3.3's spec, without the "if not CDATA" bits).
ohair@286:     //
ohair@286:     private void parseLiteral(boolean isEntityValue)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [9] EntityValue ::=
ohair@286:         //    '"' ([^"&%] | Reference | PEReference)* '"'
ohair@286:         //    |    "'" ([^'&%] | Reference | PEReference)* "'"
ohair@286:         // [10] AttValue ::=
ohair@286:         //    '"' ([^"&]  | Reference             )* '"'
ohair@286:         //    |    "'" ([^'&]  | Reference             )* "'"
ohair@286:         char quote = getc();
ohair@286:         char c;
ohair@286:         InputEntity source = in;
ohair@286: 
ohair@286:         if (quote != '\'' && quote != '"') {
ohair@286:             fatal("P-007");
ohair@286:         }
ohair@286: 
ohair@286:         // don't report entity expansions within attributes,
ohair@286:         // they're reported "fully expanded" via SAX
ohair@286: //    isInAttribute = !isEntityValue;
ohair@286: 
ohair@286:         // get value into strTmp
ohair@286:         strTmp = new StringBuffer();
ohair@286: 
ohair@286:         // scan, allowing entity push/pop wherever ...
ohair@286:         // expanded entities can't terminate the literal!
ohair@286:         for (; ;) {
ohair@286:             if (in != source && in.isEOF()) {
ohair@286:                 // we don't report end of parsed entities
ohair@286:                 // within attributes (no SAX hooks)
ohair@286:                 in = in.pop();
ohair@286:                 continue;
ohair@286:             }
ohair@286:             if ((c = getc()) == quote && in == source) {
ohair@286:                 break;
ohair@286:             }
ohair@286: 
ohair@286:             //
ohair@286:             // Basically the "reference in attribute value"
ohair@286:             // row of the chart in section 4.4 of the spec
ohair@286:             //
ohair@286:             if (c == '&') {
ohair@286:                 String entityName = maybeGetName();
ohair@286: 
ohair@286:                 if (entityName != null) {
ohair@286:                     nextChar(';', "F-020", entityName);
ohair@286: 
ohair@286:                     // 4.4 says:  bypass these here ... we'll catch
ohair@286:                     // forbidden refs to unparsed entities on use
ohair@286:                     if (isEntityValue) {
ohair@286:                         strTmp.append('&');
ohair@286:                         strTmp.append(entityName);
ohair@286:                         strTmp.append(';');
ohair@286:                         continue;
ohair@286:                     }
ohair@286:                     expandEntityInLiteral(entityName, entities, isEntityValue);
ohair@286: 
ohair@286: 
ohair@286:                     // character references are always included immediately
ohair@286:                 } else if ((c = getc()) == '#') {
ohair@286:                     int tmp = parseCharNumber();
ohair@286: 
ohair@286:                     if (tmp > 0xffff) {
ohair@286:                         tmp = surrogatesToCharTmp(tmp);
ohair@286:                         strTmp.append(charTmp[0]);
ohair@286:                         if (tmp == 2)
ohair@286:                             strTmp.append(charTmp[1]);
ohair@286:                     } else
ohair@286:                         strTmp.append((char) tmp);
ohair@286:                 } else
ohair@286:                     fatal("P-009");
ohair@286:                 continue;
ohair@286: 
ohair@286:             }
ohair@286: 
ohair@286:             // expand parameter entities only within entity value literals
ohair@286:             if (c == '%' && isEntityValue) {
ohair@286:                 String entityName = maybeGetName();
ohair@286: 
ohair@286:                 if (entityName != null) {
ohair@286:                     nextChar(';', "F-021", entityName);
ohair@286:                     expandEntityInLiteral(entityName, params, isEntityValue);
ohair@286:                     continue;
ohair@286:                 } else
ohair@286:                     fatal("P-011");
ohair@286:             }
ohair@286: 
ohair@286:             // For attribute values ...
ohair@286:             if (!isEntityValue) {
ohair@286:                 // 3.3.3 says whitespace normalizes to space...
ohair@286:                 if (c == ' ' || c == '\t' || c == '\n' || c == '\r') {
ohair@286:                     strTmp.append(' ');
ohair@286:                     continue;
ohair@286:                 }
ohair@286: 
ohair@286:                 // "<" not legal in parsed literals ...
ohair@286:                 if (c == '<')
ohair@286:                     fatal("P-012");
ohair@286:             }
ohair@286: 
ohair@286:             strTmp.append(c);
ohair@286:         }
ohair@286: //    isInAttribute = false;
ohair@286:     }
ohair@286: 
ohair@286:     // does a SINGLE expansion of the entity (often reparsed later)
ohair@286:     private void expandEntityInLiteral(String name, SimpleHashtable table,
ohair@286:                                        boolean isEntityValue)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         Object entity = table.get(name);
ohair@286: 
ohair@286:         if (entity instanceof InternalEntity) {
ohair@286:             InternalEntity value = (InternalEntity) entity;
ohair@286:             pushReader(value.buf, name, !value.isPE);
ohair@286: 
ohair@286:         } else if (entity instanceof ExternalEntity) {
ohair@286:             if (!isEntityValue)    // must be a PE ...
ohair@286:                 fatal("P-013", new Object[]{name});
ohair@286:             // XXX if this returns false ...
ohair@286:             pushReader((ExternalEntity) entity);
ohair@286: 
ohair@286:         } else if (entity == null) {
ohair@286:             //
ohair@286:             // Note:  much confusion about whether spec requires such
ohair@286:             // errors to be fatal in many cases, but none about whether
ohair@286:             // it allows "normal" errors to be unrecoverable!
ohair@286:             //
ohair@286:             fatal((table == params) ? "V-022" : "P-014",
ohair@286:                     new Object[]{name});
ohair@286:         }
ohair@286:     }
ohair@286: 
ohair@286:     // [11] SystemLiteral ::= ('"' [^"]* '"') | ("'" [^']* "'")
ohair@286:     // for PUBLIC and SYSTEM literals, also "<?xml ...type='literal'?>'
ohair@286: 
ohair@286:     // NOTE:  XML spec should explicitly say that PE ref syntax is
ohair@286:     // ignored in PIs, comments, SystemLiterals, and Pubid Literal
ohair@286:     // values ... can't process the XML spec's own DTD without doing
ohair@286:     // that for comments.
ohair@286: 
ohair@286:     private String getQuotedString(String type, String extra)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // use in.getc to bypass PE processing
ohair@286:         char quote = in.getc();
ohair@286: 
ohair@286:         if (quote != '\'' && quote != '"')
ohair@286:             fatal("P-015", new Object[]{
ohair@286:                 messages.getMessage(locale, type, new Object[]{extra})
ohair@286:             });
ohair@286: 
ohair@286:         char c;
ohair@286: 
ohair@286:         strTmp = new StringBuffer();
ohair@286:         while ((c = in.getc()) != quote)
ohair@286:             strTmp.append((char) c);
ohair@286:         return strTmp.toString();
ohair@286:     }
ohair@286: 
ohair@286: 
ohair@286:     private String parsePublicId() throws IOException, SAXException {
ohair@286: 
ohair@286:         // [12] PubidLiteral ::= ('"' PubidChar* '"') | ("'" PubidChar* "'")
ohair@286:         // [13] PubidChar ::= #x20|#xd|#xa|[a-zA-Z0-9]|[-'()+,./:=?;!*#@$_%]
ohair@286:         String retval = getQuotedString("F-033", null);
ohair@286:         for (int i = 0; i < retval.length(); i++) {
ohair@286:             char c = retval.charAt(i);
ohair@286:             if (" \r\n-'()+,./:=?;!*#@$_%0123456789".indexOf(c) == -1
ohair@286:                     && !(c >= 'A' && c <= 'Z')
ohair@286:                     && !(c >= 'a' && c <= 'z'))
ohair@286:                 fatal("P-016", new Object[]{new Character(c)});
ohair@286:         }
ohair@286:         strTmp = new StringBuffer();
ohair@286:         strTmp.append(retval);
ohair@286:         return normalize(false);
ohair@286:     }
ohair@286: 
ohair@286:     // [14] CharData ::= [^<&]* - ([^<&]* ']]>' [^<&]*)
ohair@286:     // handled by:  InputEntity.parsedContent()
ohair@286: 
ohair@286:     private boolean maybeComment(boolean skipStart)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [15] Comment ::= '<!--'
ohair@286:         //        ( (Char - '-') | ('-' (Char - '-'))*
ohair@286:         //        '-->'
ohair@286:         if (!in.peek(skipStart ? "!--" : "<!--", null))
ohair@286:             return false;
ohair@286: 
ohair@286:         boolean savedLexicalPE = doLexicalPE;
ohair@286:         boolean saveCommentText;
ohair@286: 
ohair@286:         doLexicalPE = false;
ohair@286:         saveCommentText = false;
ohair@286:         if (saveCommentText)
ohair@286:             strTmp = new StringBuffer();
ohair@286: 
ohair@286:         oneComment:
ohair@286:         for (; ;) {
ohair@286:             try {
ohair@286:                 // bypass PE expansion, but permit PEs
ohair@286:                 // to complete ... valid docs won't care.
ohair@286:                 for (; ;) {
ohair@286:                     int c = getc();
ohair@286:                     if (c == '-') {
ohair@286:                         c = getc();
ohair@286:                         if (c != '-') {
ohair@286:                             if (saveCommentText)
ohair@286:                                 strTmp.append('-');
ohair@286:                             ungetc();
ohair@286:                             continue;
ohair@286:                         }
ohair@286:                         nextChar('>', "F-022", null);
ohair@286:                         break oneComment;
ohair@286:                     }
ohair@286:                     if (saveCommentText)
ohair@286:                         strTmp.append((char) c);
ohair@286:                 }
ohair@286:             } catch (EndOfInputException e) {
ohair@286:                 //
ohair@286:                 // This is fatal EXCEPT when we're processing a PE...
ohair@286:                 // in which case a validating processor reports an error.
ohair@286:                 // External PEs are easy to detect; internal ones we
ohair@286:                 // infer by being an internal entity outside an element.
ohair@286:                 //
ohair@286:                 if (in.isInternal()) {
ohair@286:                     error("V-021", null);
ohair@286:                 }
ohair@286:                 fatal("P-017");
ohair@286:             }
ohair@286:         }
ohair@286:         doLexicalPE = savedLexicalPE;
ohair@286:         if (saveCommentText)
ohair@286:             dtdHandler.comment(strTmp.toString());
ohair@286:         return true;
ohair@286:     }
ohair@286: 
ohair@286:     private boolean maybePI(boolean skipStart)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [16] PI ::= '<?' PITarget
ohair@286:         //        (S (Char* - (Char* '?>' Char*)))?
ohair@286:         //        '?>'
ohair@286:         // [17] PITarget ::= Name - (('X'|'x')('M'|'m')('L'|'l')
ohair@286:         boolean savedLexicalPE = doLexicalPE;
ohair@286: 
ohair@286:         if (!in.peek(skipStart ? "?" : "<?", null))
ohair@286:             return false;
ohair@286:         doLexicalPE = false;
ohair@286: 
ohair@286:         String target = maybeGetName();
ohair@286: 
ohair@286:         if (target == null) {
ohair@286:             fatal("P-018");
ohair@286:         }
ohair@286:         if ("xml".equals(target)) {
ohair@286:             fatal("P-019");
ohair@286:         }
ohair@286:         if ("xml".equalsIgnoreCase(target)) {
ohair@286:             fatal("P-020", new Object[]{target});
ohair@286:         }
ohair@286: 
ohair@286:         if (maybeWhitespace()) {
ohair@286:             strTmp = new StringBuffer();
ohair@286:             try {
ohair@286:                 for (; ;) {
ohair@286:                     // use in.getc to bypass PE processing
ohair@286:                     char c = in.getc();
ohair@286:                     //Reached the end of PI.
ohair@286:                     if (c == '?' && in.peekc('>'))
ohair@286:                         break;
ohair@286:                     strTmp.append(c);
ohair@286:                 }
ohair@286:             } catch (EndOfInputException e) {
ohair@286:                 fatal("P-021");
ohair@286:             }
ohair@286:             dtdHandler.processingInstruction(target, strTmp.toString());
ohair@286:         } else {
ohair@286:             if (!in.peek("?>", null)) {
ohair@286:                 fatal("P-022");
ohair@286:             }
ohair@286:             dtdHandler.processingInstruction(target, "");
ohair@286:         }
ohair@286: 
ohair@286:         doLexicalPE = savedLexicalPE;
ohair@286:         return true;
ohair@286:     }
ohair@286: 
ohair@286:     // [18] CDSect ::= CDStart CData CDEnd
ohair@286:     // [19] CDStart ::= '<![CDATA['
ohair@286:     // [20] CData ::= (Char* - (Char* ']]>' Char*))
ohair@286:     // [21] CDEnd ::= ']]>'
ohair@286:     //
ohair@286:     //    ... handled by InputEntity.unparsedContent()
ohair@286: 
ohair@286:     // collapsing several rules together ...
ohair@286:     // simpler than attribute literals -- no reference parsing!
ohair@286:     private String maybeReadAttribute(String name, boolean must)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [24] VersionInfo ::= S 'version' Eq \'|\" versionNum \'|\"
ohair@286:         // [80] EncodingDecl ::= S 'encoding' Eq \'|\" EncName \'|\"
ohair@286:         // [32] SDDecl ::=  S 'standalone' Eq \'|\" ... \'|\"
ohair@286:         if (!maybeWhitespace()) {
ohair@286:             if (!must) {
ohair@286:                 return null;
ohair@286:             }
ohair@286:             fatal("P-024", new Object[]{name});
ohair@286:             // NOTREACHED
ohair@286:         }
ohair@286: 
ohair@286:         if (!peek(name)) {
ohair@286:             if (must) {
ohair@286:                 fatal("P-024", new Object[]{name});
ohair@286:             } else {
ohair@286:                 // To ensure that the whitespace is there so that when we
ohair@286:                 // check for the next attribute we assure that the
ohair@286:                 // whitespace still exists.
ohair@286:                 ungetc();
ohair@286:                 return null;
ohair@286:             }
ohair@286:         }
ohair@286: 
ohair@286:         // [25] Eq ::= S? '=' S?
ohair@286:         maybeWhitespace();
ohair@286:         nextChar('=', "F-023", null);
ohair@286:         maybeWhitespace();
ohair@286: 
ohair@286:         return getQuotedString("F-035", name);
ohair@286:     }
ohair@286: 
ohair@286:     private void readVersion(boolean must, String versionNum)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         String value = maybeReadAttribute("version", must);
ohair@286: 
ohair@286:         // [26] versionNum ::= ([a-zA-Z0-9_.:]| '-')+
ohair@286: 
ohair@286:         if (must && value == null)
ohair@286:             fatal("P-025", new Object[]{versionNum});
ohair@286:         if (value != null) {
ohair@286:             int length = value.length();
ohair@286:             for (int i = 0; i < length; i++) {
ohair@286:                 char c = value.charAt(i);
ohair@286:                 if (!((c >= '0' && c <= '9')
ohair@286:                         || c == '_' || c == '.'
ohair@286:                         || (c >= 'a' && c <= 'z')
ohair@286:                         || (c >= 'A' && c <= 'Z')
ohair@286:                         || c == ':' || c == '-')
ohair@286:                 )
ohair@286:                     fatal("P-026", new Object[]{value});
ohair@286:             }
ohair@286:         }
ohair@286:         if (value != null && !value.equals(versionNum))
ohair@286:             error("P-027", new Object[]{versionNum, value});
ohair@286:     }
ohair@286: 
ohair@286:     // common code used by most markup declarations
ohair@286:     // ... S (Q)Name ...
ohair@286:     private String getMarkupDeclname(String roleId, boolean qname)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         String name;
ohair@286: 
ohair@286:         whitespace(roleId);
ohair@286:         name = maybeGetName();
ohair@286:         if (name == null)
ohair@286:             fatal("P-005", new Object[]
ohair@286:             {messages.getMessage(locale, roleId)});
ohair@286:         return name;
ohair@286:     }
ohair@286: 
ohair@286:     private boolean maybeMarkupDecl()
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [29] markupdecl ::= elementdecl | Attlistdecl
ohair@286:         //           | EntityDecl | NotationDecl | PI | Comment
ohair@286:         return maybeElementDecl()
ohair@286:                 || maybeAttlistDecl()
ohair@286:                 || maybeEntityDecl()
ohair@286:                 || maybeNotationDecl()
ohair@286:                 || maybePI(false)
ohair@286:                 || maybeComment(false);
ohair@286:     }
ohair@286: 
ohair@286:     private static final String XmlLang = "xml:lang";
ohair@286: 
ohair@286:     private boolean isXmlLang(String value) {
ohair@286: 
ohair@286:         // [33] LanguageId ::= Langcode ('-' Subcode)*
ohair@286:         // [34] Langcode ::= ISO639Code | IanaCode | UserCode
ohair@286:         // [35] ISO639Code ::= [a-zA-Z] [a-zA-Z]
ohair@286:         // [36] IanaCode ::= [iI] '-' SubCode
ohair@286:         // [37] UserCode ::= [xX] '-' SubCode
ohair@286:         // [38] SubCode ::= [a-zA-Z]+
ohair@286: 
ohair@286:         // the ISO and IANA codes (and subcodes) are registered,
ohair@286:         // but that's neither a WF nor a validity constraint.
ohair@286: 
ohair@286:         int nextSuffix;
ohair@286:         char c;
ohair@286: 
ohair@286:         if (value.length() < 2)
ohair@286:             return false;
ohair@286:         c = value.charAt(1);
ohair@286:         if (c == '-') {        // IANA, or user, code
ohair@286:             c = value.charAt(0);
ohair@286:             if (!(c == 'i' || c == 'I' || c == 'x' || c == 'X'))
ohair@286:                 return false;
ohair@286:             nextSuffix = 1;
ohair@286:         } else if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')) {
ohair@286:             // 2 letter ISO code, or error
ohair@286:             c = value.charAt(0);
ohair@286:             if (!((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')))
ohair@286:                 return false;
ohair@286:             nextSuffix = 2;
ohair@286:         } else
ohair@286:             return false;
ohair@286: 
ohair@286:         // here "suffix" ::= '-' [a-zA-Z]+ suffix*
ohair@286:         while (nextSuffix < value.length()) {
ohair@286:             c = value.charAt(nextSuffix);
ohair@286:             if (c != '-')
ohair@286:                 break;
ohair@286:             while (++nextSuffix < value.length()) {
ohair@286:                 c = value.charAt(nextSuffix);
ohair@286:                 if (!((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')))
ohair@286:                     break;
ohair@286:             }
ohair@286:         }
ohair@286:         return value.length() == nextSuffix && c != '-';
ohair@286:     }
ohair@286: 
ohair@286: 
ohair@286:     //
ohair@286:     // CHAPTER 3:  Logical Structures
ohair@286:     //
ohair@286: 
ohair@286:     /**
ohair@286:      * To validate, subclassers should at this time make sure that
ohair@286:      * values are of the declared types:<UL>
ohair@286:      * <LI> ID and IDREF(S) values are Names
ohair@286:      * <LI> NMTOKEN(S) are Nmtokens
ohair@286:      * <LI> ENUMERATION values match one of the tokens
ohair@286:      * <LI> NOTATION values match a notation name
ohair@286:      * <LI> ENTITIY(IES) values match an unparsed external entity
ohair@286:      * </UL>
ohair@286:      * <p/>
ohair@286:      * <P> Separately, make sure IDREF values match some ID
ohair@286:      * provided in the document (in the afterRoot method).
ohair@286:      */
ohair@286: /*    void validateAttributeSyntax (Attribute attr, String value)
ohair@286:          throws DTDParseException {
ohair@286:         // ID, IDREF(S) ... values are Names
ohair@286:         if (Attribute.ID == attr.type()) {
ohair@286:             if (!XmlNames.isName (value))
ohair@286:                 error ("V-025", new Object [] { value });
ohair@286: 
ohair@286:             Boolean             b = (Boolean) ids.getNonInterned (value);
ohair@286:             if (b == null || b.equals (Boolean.FALSE))
ohair@286:                 ids.put (value.intern (), Boolean.TRUE);
ohair@286:             else
ohair@286:                 error ("V-026", new Object [] { value });
ohair@286: 
ohair@286:         } else if (Attribute.IDREF == attr.type()) {
ohair@286:             if (!XmlNames.isName (value))
ohair@286:                 error ("V-027", new Object [] { value });
ohair@286: 
ohair@286:             Boolean             b = (Boolean) ids.getNonInterned (value);
ohair@286:             if (b == null)
ohair@286:                 ids.put (value.intern (), Boolean.FALSE);
ohair@286: 
ohair@286:         } else if (Attribute.IDREFS == attr.type()) {
ohair@286:             StringTokenizer     tokenizer = new StringTokenizer (value);
ohair@286:             Boolean             b;
ohair@286:             boolean             sawValue = false;
ohair@286: 
ohair@286:             while (tokenizer.hasMoreTokens ()) {
ohair@286:                 value = tokenizer.nextToken ();
ohair@286:                 if (!XmlNames.isName (value))
ohair@286:                     error ("V-027", new Object [] { value });
ohair@286:                 b = (Boolean) ids.getNonInterned (value);
ohair@286:                 if (b == null)
ohair@286:                     ids.put (value.intern (), Boolean.FALSE);
ohair@286:                 sawValue = true;
ohair@286:             }
ohair@286:             if (!sawValue)
ohair@286:                 error ("V-039", null);
ohair@286: 
ohair@286: 
ohair@286:         // NMTOKEN(S) ... values are Nmtoken(s)
ohair@286:         } else if (Attribute.NMTOKEN == attr.type()) {
ohair@286:             if (!XmlNames.isNmtoken (value))
ohair@286:                 error ("V-028", new Object [] { value });
ohair@286: 
ohair@286:         } else if (Attribute.NMTOKENS == attr.type()) {
ohair@286:             StringTokenizer     tokenizer = new StringTokenizer (value);
ohair@286:             boolean             sawValue = false;
ohair@286: 
ohair@286:             while (tokenizer.hasMoreTokens ()) {
ohair@286:                 value = tokenizer.nextToken ();
ohair@286:                 if (!XmlNames.isNmtoken (value))
ohair@286:                     error ("V-028", new Object [] { value });
ohair@286:                 sawValue = true;
ohair@286:             }
ohair@286:             if (!sawValue)
ohair@286:                 error ("V-032", null);
ohair@286: 
ohair@286:         // ENUMERATION ... values match one of the tokens
ohair@286:         } else if (Attribute.ENUMERATION == attr.type()) {
ohair@286:             for (int i = 0; i < attr.values().length; i++)
ohair@286:                 if (value.equals (attr.values()[i]))
ohair@286:                     return;
ohair@286:             error ("V-029", new Object [] { value });
ohair@286: 
ohair@286:         // NOTATION values match a notation name
ohair@286:         } else if (Attribute.NOTATION == attr.type()) {
ohair@286:             //
ohair@286:             // XXX XML 1.0 spec should probably list references to
ohair@286:             // externally defined notations in standalone docs as
ohair@286:             // validity errors.  Ditto externally defined unparsed
ohair@286:             // entities; neither should show up in attributes, else
ohair@286:             // one needs to read the external declarations in order
ohair@286:             // to make sense of the document (exactly what tagging
ohair@286:             // a doc as "standalone" intends you won't need to do).
ohair@286:             //
ohair@286:             for (int i = 0; i < attr.values().length; i++)
ohair@286:                 if (value.equals (attr.values()[i]))
ohair@286:                     return;
ohair@286:             error ("V-030", new Object [] { value });
ohair@286: 
ohair@286:         // ENTITY(IES) values match an unparsed entity(ies)
ohair@286:         } else if (Attribute.ENTITY == attr.type()) {
ohair@286:             // see note above re standalone
ohair@286:             if (!isUnparsedEntity (value))
ohair@286:                 error ("V-031", new Object [] { value });
ohair@286: 
ohair@286:         } else if (Attribute.ENTITIES == attr.type()) {
ohair@286:             StringTokenizer     tokenizer = new StringTokenizer (value);
ohair@286:             boolean             sawValue = false;
ohair@286: 
ohair@286:             while (tokenizer.hasMoreTokens ()) {
ohair@286:                 value = tokenizer.nextToken ();
ohair@286:                 // see note above re standalone
ohair@286:                 if (!isUnparsedEntity (value))
ohair@286:                     error ("V-031", new Object [] { value });
ohair@286:                 sawValue = true;
ohair@286:             }
ohair@286:             if (!sawValue)
ohair@286:                 error ("V-040", null);
ohair@286: 
ohair@286:         } else if (Attribute.CDATA != attr.type())
ohair@286:             throw new InternalError (attr.type());
ohair@286:     }
ohair@286: */
ohair@286: /*
ohair@286:     private boolean isUnparsedEntity (String name)
ohair@286:     {
ohair@286:         Object e = entities.getNonInterned (name);
ohair@286:         if (e == null || !(e instanceof ExternalEntity))
ohair@286:             return false;
ohair@286:         return ((ExternalEntity)e).notation != null;
ohair@286:     }
ohair@286: */
ohair@286:     private boolean maybeElementDecl()
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [45] elementDecl ::= '<!ELEMENT' S Name S contentspec S? '>'
ohair@286:         // [46] contentspec ::= 'EMPTY' | 'ANY' | Mixed | children
ohair@286:         InputEntity start = peekDeclaration("!ELEMENT");
ohair@286: 
ohair@286:         if (start == null)
ohair@286:             return false;
ohair@286: 
ohair@286:         // n.b. for content models where inter-element whitespace is
ohair@286:         // ignorable, we mark that fact here.
ohair@286:         String name = getMarkupDeclname("F-015", true);
ohair@286: //    Element        element = (Element) elements.get (name);
ohair@286: //    boolean        declEffective = false;
ohair@286: 
ohair@286: /*
ohair@286:     if (element != null) {
ohair@286:         if (element.contentModel() != null) {
ohair@286:             error ("V-012", new Object [] { name });
ohair@286:         } // else <!ATTLIST name ...> came first
ohair@286:     } else {
ohair@286:         element = new Element(name);
ohair@286:         elements.put (element.name(), element);
ohair@286:         declEffective = true;
ohair@286:     }
ohair@286: */
ohair@286:         if (declaredElements.contains(name))
ohair@286:             error("V-012", new Object[]{name});
ohair@286:         else {
ohair@286:             declaredElements.add(name);
ohair@286: //        declEffective = true;
ohair@286:         }
ohair@286: 
ohair@286:         short modelType;
ohair@286:         whitespace("F-000");
ohair@286:         if (peek(strEMPTY)) {
ohair@286: ///        // leave element.contentModel as null for this case.
ohair@286:             dtdHandler.startContentModel(name, modelType = DTDEventListener.CONTENT_MODEL_EMPTY);
ohair@286:         } else if (peek(strANY)) {
ohair@286: ///        element.setContentModel(new StringModel(StringModelType.ANY));
ohair@286:             dtdHandler.startContentModel(name, modelType = DTDEventListener.CONTENT_MODEL_ANY);
ohair@286:         } else {
ohair@286:             modelType = getMixedOrChildren(name);
ohair@286:         }
ohair@286: 
ohair@286:         dtdHandler.endContentModel(name, modelType);
ohair@286: 
ohair@286:         maybeWhitespace();
ohair@286:         char c = getc();
ohair@286:         if (c != '>')
ohair@286:             fatal("P-036", new Object[]{name, new Character(c)});
ohair@286:         if (start != in)
ohair@286:             error("V-013", null);
ohair@286: 
ohair@286: ///        dtdHandler.elementDecl(element);
ohair@286: 
ohair@286:         return true;
ohair@286:     }
ohair@286: 
ohair@286:     // We're leaving the content model as a regular expression;
ohair@286:     // it's an efficient natural way to express such things, and
ohair@286:     // libraries often interpret them.  No whitespace in the
ohair@286:     // model we store, though!
ohair@286: 
ohair@286:     /**
ohair@286:      * returns content model type.
ohair@286:      */
ohair@286:     private short getMixedOrChildren(String elementName/*Element element*/)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         InputEntity start;
ohair@286: 
ohair@286:         // [47] children ::= (choice|seq) ('?'|'*'|'+')?
ohair@286:         strTmp = new StringBuffer();
ohair@286: 
ohair@286:         nextChar('(', "F-028", elementName);
ohair@286:         start = in;
ohair@286:         maybeWhitespace();
ohair@286:         strTmp.append('(');
ohair@286: 
ohair@286:         short modelType;
ohair@286:         if (peek("#PCDATA")) {
ohair@286:             strTmp.append("#PCDATA");
ohair@286:             dtdHandler.startContentModel(elementName, modelType = DTDEventListener.CONTENT_MODEL_MIXED);
ohair@286:             getMixed(elementName, start);
ohair@286:         } else {
ohair@286:             dtdHandler.startContentModel(elementName, modelType = DTDEventListener.CONTENT_MODEL_CHILDREN);
ohair@286:             getcps(elementName, start);
ohair@286:         }
ohair@286: 
ohair@286:         return modelType;
ohair@286:     }
ohair@286: 
ohair@286:     // '(' S? already consumed
ohair@286:     // matching ')' must be in "start" entity if validating
ohair@286:     private void getcps(/*Element element,*/String elementName, InputEntity start)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [48] cp ::= (Name|choice|seq) ('?'|'*'|'+')?
ohair@286:         // [49] choice ::= '(' S? cp (S? '|' S? cp)* S? ')'
ohair@286:         // [50] seq    ::= '(' S? cp (S? ',' S? cp)* S? ')'
ohair@286:         boolean decided = false;
ohair@286:         char type = 0;
ohair@286: //        ContentModel       retval, temp, current;
ohair@286: 
ohair@286: //        retval = temp = current = null;
ohair@286: 
ohair@286:         dtdHandler.startModelGroup();
ohair@286: 
ohair@286:         do {
ohair@286:             String tag;
ohair@286: 
ohair@286:             tag = maybeGetName();
ohair@286:             if (tag != null) {
ohair@286:                 strTmp.append(tag);
ohair@286: //                temp = new ElementModel(tag);
ohair@286: //                getFrequency((RepeatableContent)temp);
ohair@286: ///->
ohair@286:                 dtdHandler.childElement(tag, getFrequency());
ohair@286: ///<-
ohair@286:             } else if (peek("(")) {
ohair@286:                 InputEntity next = in;
ohair@286:                 strTmp.append('(');
ohair@286:                 maybeWhitespace();
ohair@286: //                temp = getcps(element, next);
ohair@286: //                getFrequency(temp);
ohair@286: ///->
ohair@286:                 getcps(elementName, next);
ohair@286: ///                getFrequency();        <- this looks like a bug
ohair@286: ///<-
ohair@286:             } else
ohair@286:                 fatal((type == 0) ? "P-039" :
ohair@286:                         ((type == ',') ? "P-037" : "P-038"),
ohair@286:                         new Object[]{new Character(getc())});
ohair@286: 
ohair@286:             maybeWhitespace();
ohair@286:             if (decided) {
ohair@286:                 char c = getc();
ohair@286: 
ohair@286: //                if (current != null) {
ohair@286: //                    current.addChild(temp);
ohair@286: //                }
ohair@286:                 if (c == type) {
ohair@286:                     strTmp.append(type);
ohair@286:                     maybeWhitespace();
ohair@286:                     reportConnector(type);
ohair@286:                     continue;
ohair@286:                 } else if (c == '\u0029') {    // rparen
ohair@286:                     ungetc();
ohair@286:                     continue;
ohair@286:                 } else {
ohair@286:                     fatal((type == 0) ? "P-041" : "P-040",
ohair@286:                             new Object[]{
ohair@286:                                 new Character(c),
ohair@286:                                 new Character(type)
ohair@286:                             });
ohair@286:                 }
ohair@286:             } else {
ohair@286:                 type = getc();
ohair@286:                 switch (type) {
ohair@286:                 case '|':
ohair@286:                 case ',':
ohair@286:                     reportConnector(type);
ohair@286:                     break;
ohair@286:                 default:
ohair@286: //                        retval = temp;
ohair@286:                     ungetc();
ohair@286:                     continue;
ohair@286:                 }
ohair@286: //                retval = (ContentModel)current;
ohair@286:                 decided = true;
ohair@286: //                current.addChild(temp);
ohair@286:                 strTmp.append(type);
ohair@286:             }
ohair@286:             maybeWhitespace();
ohair@286:         } while (!peek(")"));
ohair@286: 
ohair@286:         if (in != start)
ohair@286:             error("V-014", new Object[]{elementName});
ohair@286:         strTmp.append(')');
ohair@286: 
ohair@286:         dtdHandler.endModelGroup(getFrequency());
ohair@286: //        return retval;
ohair@286:     }
ohair@286: 
ohair@286:     private void reportConnector(char type) throws SAXException {
ohair@286:         switch (type) {
ohair@286:         case '|':
ohair@286:             dtdHandler.connector(DTDEventListener.CHOICE);    ///<-
ohair@286:             return;
ohair@286:         case ',':
ohair@286:             dtdHandler.connector(DTDEventListener.SEQUENCE); ///<-
ohair@286:             return;
ohair@286:         default:
ohair@286:             throw new Error();    //assertion failed.
ohair@286:         }
ohair@286:     }
ohair@286: 
ohair@286:     private short getFrequency()
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         final char c = getc();
ohair@286: 
ohair@286:         if (c == '?') {
ohair@286:             strTmp.append(c);
ohair@286:             return DTDEventListener.OCCURENCE_ZERO_OR_ONE;
ohair@286:             //        original.setRepeat(Repeat.ZERO_OR_ONE);
ohair@286:         } else if (c == '+') {
ohair@286:             strTmp.append(c);
ohair@286:             return DTDEventListener.OCCURENCE_ONE_OR_MORE;
ohair@286:             //        original.setRepeat(Repeat.ONE_OR_MORE);
ohair@286:         } else if (c == '*') {
ohair@286:             strTmp.append(c);
ohair@286:             return DTDEventListener.OCCURENCE_ZERO_OR_MORE;
ohair@286:             //        original.setRepeat(Repeat.ZERO_OR_MORE);
ohair@286:         } else {
ohair@286:             ungetc();
ohair@286:             return DTDEventListener.OCCURENCE_ONCE;
ohair@286:         }
ohair@286:     }
ohair@286: 
ohair@286:     // '(' S? '#PCDATA' already consumed
ohair@286:     // matching ')' must be in "start" entity if validating
ohair@286:     private void getMixed(String elementName, /*Element element,*/ InputEntity start)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [51] Mixed ::= '(' S? '#PCDATA' (S? '|' S? Name)* S? ')*'
ohair@286:         //        | '(' S? '#PCDATA'                   S? ')'
ohair@286:         maybeWhitespace();
ohair@286:         if (peek("\u0029*") || peek("\u0029")) {
ohair@286:             if (in != start)
ohair@286:                 error("V-014", new Object[]{elementName});
ohair@286:             strTmp.append(')');
ohair@286: //            element.setContentModel(new StringModel(StringModelType.PCDATA));
ohair@286:             return;
ohair@286:         }
ohair@286: 
ohair@286:         ArrayList l = new ArrayList();
ohair@286: //    l.add(new StringModel(StringModelType.PCDATA));
ohair@286: 
ohair@286: 
ohair@286:         while (peek("|")) {
ohair@286:             String name;
ohair@286: 
ohair@286:             strTmp.append('|');
ohair@286:             maybeWhitespace();
ohair@286: 
ohair@286:             doLexicalPE = true;
ohair@286:             name = maybeGetName();
ohair@286:             if (name == null)
ohair@286:                 fatal("P-042", new Object[]
ohair@286:                 {elementName, Integer.toHexString(getc())});
ohair@286:             if (l.contains(name)) {
ohair@286:                 error("V-015", new Object[]{name});
ohair@286:             } else {
ohair@286:                 l.add(name);
ohair@286:                 dtdHandler.mixedElement(name);
ohair@286:             }
ohair@286:             strTmp.append(name);
ohair@286:             maybeWhitespace();
ohair@286:         }
ohair@286: 
ohair@286:         if (!peek("\u0029*"))    // right paren
ohair@286:             fatal("P-043", new Object[]
ohair@286:             {elementName, new Character(getc())});
ohair@286:         if (in != start)
ohair@286:             error("V-014", new Object[]{elementName});
ohair@286:         strTmp.append(')');
ohair@286: //        ChoiceModel cm = new ChoiceModel((Collection)l);
ohair@286: //    cm.setRepeat(Repeat.ZERO_OR_MORE);
ohair@286: //       element.setContentModel(cm);
ohair@286:     }
ohair@286: 
ohair@286:     private boolean maybeAttlistDecl()
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [52] AttlistDecl ::= '<!ATTLIST' S Name AttDef* S? '>'
ohair@286:         InputEntity start = peekDeclaration("!ATTLIST");
ohair@286: 
ohair@286:         if (start == null)
ohair@286:             return false;
ohair@286: 
ohair@286:         String elementName = getMarkupDeclname("F-016", true);
ohair@286: //    Element    element = (Element) elements.get (name);
ohair@286: 
ohair@286: //    if (element == null) {
ohair@286: //        // not yet declared -- no problem.
ohair@286: //        element = new Element(name);
ohair@286: //        elements.put(name, element);
ohair@286: //    }
ohair@286: 
ohair@286:         while (!peek(">")) {
ohair@286: 
ohair@286:             // [53] AttDef ::= S Name S AttType S DefaultDecl
ohair@286:             // [54] AttType ::= StringType | TokenizedType | EnumeratedType
ohair@286: 
ohair@286:             // look for global attribute definitions, don't expand for now...
ohair@286:             maybeWhitespace();
ohair@286:             char c = getc();
ohair@286:             if (c == '%') {
ohair@286:                 String entityName = maybeGetName();
ohair@286:                 if (entityName != null) {
ohair@286:                     nextChar(';', "F-021", entityName);
ohair@286:                     whitespace("F-021");
ohair@286:                     continue;
ohair@286:                 } else
ohair@286:                     fatal("P-011");
ohair@286:             }
ohair@286: 
ohair@286:             ungetc();
ohair@286:             // look for attribute name otherwise
ohair@286:             String attName = maybeGetName();
ohair@286:             if (attName == null) {
ohair@286:                 fatal("P-044", new Object[]{new Character(getc())});
ohair@286:             }
ohair@286:             whitespace("F-001");
ohair@286: 
ohair@286: ///        Attribute    a = new Attribute (name);
ohair@286: 
ohair@286:             String typeName;
ohair@286:             Vector values = null;    // notation/enumeration values
ohair@286: 
ohair@286:             // Note:  use the type constants from Attribute
ohair@286:             // so that "==" may be used (faster)
ohair@286: 
ohair@286:             // [55] StringType ::= 'CDATA'
ohair@286:             if (peek(TYPE_CDATA))
ohair@286: ///            a.setType(Attribute.CDATA);
ohair@286:                 typeName = TYPE_CDATA;
ohair@286: 
ohair@286:             // [56] TokenizedType ::= 'ID' | 'IDREF' | 'IDREFS'
ohair@286:             //        | 'ENTITY' | 'ENTITIES'
ohair@286:             //        | 'NMTOKEN' | 'NMTOKENS'
ohair@286:             // n.b. if "IDREFS" is there, both "ID" and "IDREF"
ohair@286:             // match peekahead ... so this order matters!
ohair@286:             else if (peek(TYPE_IDREFS))
ohair@286:                 typeName = TYPE_IDREFS;
ohair@286:             else if (peek(TYPE_IDREF))
ohair@286:                 typeName = TYPE_IDREF;
ohair@286:             else if (peek(TYPE_ID)) {
ohair@286:                 typeName = TYPE_ID;
ohair@286: // TODO: should implement this error check?
ohair@286: ///        if (element.id() != null) {
ohair@286: ///                    error ("V-016", new Object [] { element.id() });
ohair@286: ///        } else
ohair@286: ///            element.setId(name);
ohair@286:             } else if (peek(TYPE_ENTITY))
ohair@286:                 typeName = TYPE_ENTITY;
ohair@286:             else if (peek(TYPE_ENTITIES))
ohair@286:                 typeName = TYPE_ENTITIES;
ohair@286:             else if (peek(TYPE_NMTOKENS))
ohair@286:                 typeName = TYPE_NMTOKENS;
ohair@286:             else if (peek(TYPE_NMTOKEN))
ohair@286:                 typeName = TYPE_NMTOKEN;
ohair@286: 
ohair@286:             // [57] EnumeratedType ::= NotationType | Enumeration
ohair@286:             // [58] NotationType ::= 'NOTATION' S '(' S? Name
ohair@286:             //        (S? '|' S? Name)* S? ')'
ohair@286:             else if (peek(TYPE_NOTATION)) {
ohair@286:                 typeName = TYPE_NOTATION;
ohair@286:                 whitespace("F-002");
ohair@286:                 nextChar('(', "F-029", null);
ohair@286:                 maybeWhitespace();
ohair@286: 
ohair@286:                 values = new Vector();
ohair@286:                 do {
ohair@286:                     String name;
ohair@286:                     if ((name = maybeGetName()) == null)
ohair@286:                         fatal("P-068");
ohair@286:                     // permit deferred declarations
ohair@286:                     if (notations.get(name) == null)
ohair@286:                         notations.put(name, name);
ohair@286:                     values.addElement(name);
ohair@286:                     maybeWhitespace();
ohair@286:                     if (peek("|"))
ohair@286:                         maybeWhitespace();
ohair@286:                 } while (!peek(")"));
ohair@286: ///            a.setValues(new String [v.size ()]);
ohair@286: ///            for (int i = 0; i < v.size (); i++)
ohair@286: ///                a.setValue(i, (String)v.elementAt(i));
ohair@286: 
ohair@286:                 // [59] Enumeration ::= '(' S? Nmtoken (S? '|' Nmtoken)* S? ')'
ohair@286:             } else if (peek("(")) {
ohair@286: ///            a.setType(Attribute.ENUMERATION);
ohair@286:                 typeName = TYPE_ENUMERATION;
ohair@286: 
ohair@286:                 maybeWhitespace();
ohair@286: 
ohair@286: ///            Vector v = new Vector ();
ohair@286:                 values = new Vector();
ohair@286:                 do {
ohair@286:                     String name = getNmtoken();
ohair@286: ///                v.addElement (name);
ohair@286:                     values.addElement(name);
ohair@286:                     maybeWhitespace();
ohair@286:                     if (peek("|"))
ohair@286:                         maybeWhitespace();
ohair@286:                 } while (!peek(")"));
ohair@286: ///            a.setValues(new String [v.size ()]);
ohair@286: ///            for (int i = 0; i < v.size (); i++)
ohair@286: ///                a.setValue(i, (String)v.elementAt(i));
ohair@286:             } else {
ohair@286:                 fatal("P-045",
ohair@286:                         new Object[]{attName, new Character(getc())});
ohair@286:                 typeName = null;
ohair@286:             }
ohair@286: 
ohair@286:             short attributeUse;
ohair@286:             String defaultValue = null;
ohair@286: 
ohair@286:             // [60] DefaultDecl ::= '#REQUIRED' | '#IMPLIED'
ohair@286:             //        | (('#FIXED' S)? AttValue)
ohair@286:             whitespace("F-003");
ohair@286:             if (peek("#REQUIRED"))
ohair@286:                 attributeUse = DTDEventListener.USE_REQUIRED;
ohair@286: ///            a.setIsRequired(true);
ohair@286:             else if (peek("#FIXED")) {
ohair@286: ///            if (a.type() == Attribute.ID)
ohair@286:                 if (typeName == TYPE_ID)
ohair@286:                     error("V-017", new Object[]{attName});
ohair@286: ///            a.setIsFixed(true);
ohair@286:                 attributeUse = DTDEventListener.USE_FIXED;
ohair@286:                 whitespace("F-004");
ohair@286:                 parseLiteral(false);
ohair@286: ///            if (a.type() != Attribute.CDATA)
ohair@286: ///                a.setDefaultValue(normalize(false));
ohair@286: ///            else
ohair@286: ///                a.setDefaultValue(strTmp.toString());
ohair@286: 
ohair@286:                 if (typeName == TYPE_CDATA)
ohair@286:                     defaultValue = normalize(false);
ohair@286:                 else
ohair@286:                     defaultValue = strTmp.toString();
ohair@286: 
ohair@286: // TODO: implement this check
ohair@286: ///            if (a.type() != Attribute.CDATA)
ohair@286: ///                validateAttributeSyntax (a, a.defaultValue());
ohair@286:             } else if (!peek("#IMPLIED")) {
ohair@286:                 attributeUse = DTDEventListener.USE_IMPLIED;
ohair@286: 
ohair@286: ///            if (a.type() == Attribute.ID)
ohair@286:                 if (typeName == TYPE_ID)
ohair@286:                     error("V-018", new Object[]{attName});
ohair@286:                 parseLiteral(false);
ohair@286: ///            if (a.type() != Attribute.CDATA)
ohair@286: ///                a.setDefaultValue(normalize(false));
ohair@286: ///            else
ohair@286: ///                a.setDefaultValue(strTmp.toString());
ohair@286:                 if (typeName == TYPE_CDATA)
ohair@286:                     defaultValue = normalize(false);
ohair@286:                 else
ohair@286:                     defaultValue = strTmp.toString();
ohair@286: 
ohair@286: // TODO: implement this check
ohair@286: ///            if (a.type() != Attribute.CDATA)
ohair@286: ///                validateAttributeSyntax (a, a.defaultValue());
ohair@286:             } else {
ohair@286:                 // TODO: this looks like an fatal error.
ohair@286:                 attributeUse = DTDEventListener.USE_NORMAL;
ohair@286:             }
ohair@286: 
ohair@286:             if (XmlLang.equals(attName)
ohair@286:                     && defaultValue/* a.defaultValue()*/ != null
ohair@286:                     && !isXmlLang(defaultValue/*a.defaultValue()*/))
ohair@286:                 error("P-033", new Object[]{defaultValue /*a.defaultValue()*/});
ohair@286: 
ohair@286: // TODO: isn't it an error to specify the same attribute twice?
ohair@286: ///        if (!element.attributes().contains(a)) {
ohair@286: ///            element.addAttribute(a);
ohair@286: ///            dtdHandler.attributeDecl(a);
ohair@286: ///        }
ohair@286: 
ohair@286:             String[] v = (values != null) ? (String[]) values.toArray(new String[0]) : null;
ohair@286:             dtdHandler.attributeDecl(elementName, attName, typeName, v, attributeUse, defaultValue);
ohair@286:             maybeWhitespace();
ohair@286:         }
ohair@286:         if (start != in)
ohair@286:             error("V-013", null);
ohair@286:         return true;
ohair@286:     }
ohair@286: 
ohair@286:     // used when parsing literal attribute values,
ohair@286:     // or public identifiers.
ohair@286:     //
ohair@286:     // input in strTmp
ohair@286:     private String normalize(boolean invalidIfNeeded) {
ohair@286: 
ohair@286:         // this can allocate an extra string...
ohair@286: 
ohair@286:         String s = strTmp.toString();
ohair@286:         String s2 = s.trim();
ohair@286:         boolean didStrip = false;
ohair@286: 
ohair@286:         if (s != s2) {
ohair@286:             s = s2;
ohair@286:             s2 = null;
ohair@286:             didStrip = true;
ohair@286:         }
ohair@286:         strTmp = new StringBuffer();
ohair@286:         for (int i = 0; i < s.length(); i++) {
ohair@286:             char c = s.charAt(i);
ohair@286:             if (!XmlChars.isSpace(c)) {
ohair@286:                 strTmp.append(c);
ohair@286:                 continue;
ohair@286:             }
ohair@286:             strTmp.append(' ');
ohair@286:             while (++i < s.length() && XmlChars.isSpace(s.charAt(i)))
ohair@286:                 didStrip = true;
ohair@286:             i--;
ohair@286:         }
ohair@286:         if (didStrip)
ohair@286:             return strTmp.toString();
ohair@286:         else
ohair@286:             return s;
ohair@286:     }
ohair@286: 
ohair@286:     private boolean maybeConditionalSect()
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [61] conditionalSect ::= includeSect | ignoreSect
ohair@286: 
ohair@286:         if (!peek("<!["))
ohair@286:             return false;
ohair@286: 
ohair@286:         String keyword;
ohair@286:         InputEntity start = in;
ohair@286: 
ohair@286:         maybeWhitespace();
ohair@286: 
ohair@286:         if ((keyword = maybeGetName()) == null)
ohair@286:             fatal("P-046");
ohair@286:         maybeWhitespace();
ohair@286:         nextChar('[', "F-030", null);
ohair@286: 
ohair@286:         // [62] includeSect ::= '<![' S? 'INCLUDE' S? '['
ohair@286:         //                extSubsetDecl ']]>'
ohair@286:         if ("INCLUDE".equals(keyword)) {
ohair@286:             for (; ;) {
ohair@286:                 while (in.isEOF() && in != start)
ohair@286:                     in = in.pop();
ohair@286:                 if (in.isEOF()) {
ohair@286:                     error("V-020", null);
ohair@286:                 }
ohair@286:                 if (peek("]]>"))
ohair@286:                     break;
ohair@286: 
ohair@286:                 doLexicalPE = false;
ohair@286:                 if (maybeWhitespace())
ohair@286:                     continue;
ohair@286:                 if (maybePEReference())
ohair@286:                     continue;
ohair@286:                 doLexicalPE = true;
ohair@286:                 if (maybeMarkupDecl() || maybeConditionalSect())
ohair@286:                     continue;
ohair@286: 
ohair@286:                 fatal("P-047");
ohair@286:             }
ohair@286: 
ohair@286:             // [63] ignoreSect ::= '<![' S? 'IGNORE' S? '['
ohair@286:             //            ignoreSectcontents ']]>'
ohair@286:             // [64] ignoreSectcontents ::= Ignore ('<!['
ohair@286:             //            ignoreSectcontents ']]>' Ignore)*
ohair@286:             // [65] Ignore ::= Char* - (Char* ('<![' | ']]>') Char*)
ohair@286:         } else if ("IGNORE".equals(keyword)) {
ohair@286:             int nestlevel = 1;
ohair@286:             // ignoreSectcontents
ohair@286:             doLexicalPE = false;
ohair@286:             while (nestlevel > 0) {
ohair@286:                 char c = getc();    // will pop input entities
ohair@286:                 if (c == '<') {
ohair@286:                     if (peek("!["))
ohair@286:                         nestlevel++;
ohair@286:                 } else if (c == ']') {
ohair@286:                     if (peek("]>"))
ohair@286:                         nestlevel--;
ohair@286:                 } else
ohair@286:                     continue;
ohair@286:             }
ohair@286:         } else
ohair@286:             fatal("P-048", new Object[]{keyword});
ohair@286:         return true;
ohair@286:     }
ohair@286: 
ohair@286: 
ohair@286:     //
ohair@286:     // CHAPTER 4:  Physical Structures
ohair@286:     //
ohair@286: 
ohair@286:     // parse decimal or hex numeric character reference
ohair@286:     private int parseCharNumber()
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         char c;
ohair@286:         int retval = 0;
ohair@286: 
ohair@286:         // n.b. we ignore overflow ...
ohair@286:         if (getc() != 'x') {
ohair@286:             ungetc();
ohair@286:             for (; ;) {
ohair@286:                 c = getc();
ohair@286:                 if (c >= '0' && c <= '9') {
ohair@286:                     retval *= 10;
ohair@286:                     retval += (c - '0');
ohair@286:                     continue;
ohair@286:                 }
ohair@286:                 if (c == ';')
ohair@286:                     return retval;
ohair@286:                 fatal("P-049");
ohair@286:             }
ohair@286:         } else
ohair@286:             for (; ;) {
ohair@286:                 c = getc();
ohair@286:                 if (c >= '0' && c <= '9') {
ohair@286:                     retval <<= 4;
ohair@286:                     retval += (c - '0');
ohair@286:                     continue;
ohair@286:                 }
ohair@286:                 if (c >= 'a' && c <= 'f') {
ohair@286:                     retval <<= 4;
ohair@286:                     retval += 10 + (c - 'a');
ohair@286:                     continue;
ohair@286:                 }
ohair@286:                 if (c >= 'A' && c <= 'F') {
ohair@286:                     retval <<= 4;
ohair@286:                     retval += 10 + (c - 'A');
ohair@286:                     continue;
ohair@286:                 }
ohair@286:                 if (c == ';')
ohair@286:                     return retval;
ohair@286:                 fatal("P-050");
ohair@286:             }
ohair@286:     }
ohair@286: 
ohair@286:     // parameter is a UCS-4 character ... i.e. not just 16 bit UNICODE,
ohair@286:     // though still subject to the 'Char' construct in XML
ohair@286:     private int surrogatesToCharTmp(int ucs4)
ohair@286:             throws SAXException {
ohair@286: 
ohair@286:         if (ucs4 <= 0xffff) {
ohair@286:             if (XmlChars.isChar(ucs4)) {
ohair@286:                 charTmp[0] = (char) ucs4;
ohair@286:                 return 1;
ohair@286:             }
ohair@286:         } else if (ucs4 <= 0x0010ffff) {
ohair@286:             // we represent these as UNICODE surrogate pairs
ohair@286:             ucs4 -= 0x10000;
ohair@286:             charTmp[0] = (char) (0xd800 | ((ucs4 >> 10) & 0x03ff));
ohair@286:             charTmp[1] = (char) (0xdc00 | (ucs4 & 0x03ff));
ohair@286:             return 2;
ohair@286:         }
ohair@286:         fatal("P-051", new Object[]{Integer.toHexString(ucs4)});
ohair@286:         // NOTREACHED
ohair@286:         return -1;
ohair@286:     }
ohair@286: 
ohair@286:     private boolean maybePEReference()
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // This is the SYNTACTIC version of this construct.
ohair@286:         // When processing external entities, there is also
ohair@286:         // a LEXICAL version; see getc() and doLexicalPE.
ohair@286: 
ohair@286:         // [69] PEReference ::= '%' Name ';'
ohair@286:         if (!in.peekc('%'))
ohair@286:             return false;
ohair@286: 
ohair@286:         String name = maybeGetName();
ohair@286:         Object entity;
ohair@286: 
ohair@286:         if (name == null)
ohair@286:             fatal("P-011");
ohair@286:         nextChar(';', "F-021", name);
ohair@286:         entity = params.get(name);
ohair@286: 
ohair@286:         if (entity instanceof InternalEntity) {
ohair@286:             InternalEntity value = (InternalEntity) entity;
ohair@286:             pushReader(value.buf, name, false);
ohair@286: 
ohair@286:         } else if (entity instanceof ExternalEntity) {
ohair@286:             pushReader((ExternalEntity) entity);
ohair@286:             externalParameterEntity((ExternalEntity) entity);
ohair@286: 
ohair@286:         } else if (entity == null) {
ohair@286:             error("V-022", new Object[]{name});
ohair@286:         }
ohair@286:         return true;
ohair@286:     }
ohair@286: 
ohair@286:     private boolean maybeEntityDecl()
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [70] EntityDecl ::= GEDecl | PEDecl
ohair@286:         // [71] GEDecl ::= '<!ENTITY' S       Name S EntityDef S? '>'
ohair@286:         // [72] PEDecl ::= '<!ENTITY' S '%' S Name S PEDEF     S? '>'
ohair@286:         // [73] EntityDef ::= EntityValue | (ExternalID NDataDecl?)
ohair@286:         // [74] PEDef     ::= EntityValue |  ExternalID
ohair@286:         //
ohair@286:         InputEntity start = peekDeclaration("!ENTITY");
ohair@286: 
ohair@286:         if (start == null)
ohair@286:             return false;
ohair@286: 
ohair@286:         String entityName;
ohair@286:         SimpleHashtable defns;
ohair@286:         ExternalEntity externalId;
ohair@286:         boolean doStore;
ohair@286: 
ohair@286:         // PE expansion gets selectively turned off several places:
ohair@286:         // in ENTITY declarations (here), in comments, in PIs.
ohair@286: 
ohair@286:         // Here, we allow PE entities to be declared, and allows
ohair@286:         // literals to include PE refs without the added spaces
ohair@286:         // required with their expansion in markup decls.
ohair@286: 
ohair@286:         doLexicalPE = false;
ohair@286:         whitespace("F-005");
ohair@286:         if (in.peekc('%')) {
ohair@286:             whitespace("F-006");
ohair@286:             defns = params;
ohair@286:         } else
ohair@286:             defns = entities;
ohair@286: 
ohair@286:         ungetc();    // leave some whitespace
ohair@286:         doLexicalPE = true;
ohair@286:         entityName = getMarkupDeclname("F-017", false);
ohair@286:         whitespace("F-007");
ohair@286:         externalId = maybeExternalID();
ohair@286: 
ohair@286:         //
ohair@286:         // first definition sticks ... e.g. internal subset PEs are used
ohair@286:         // to override DTD defaults.  It's also an "error" to incorrectly
ohair@286:         // redefine builtin internal entities, but since reporting such
ohair@286:         // errors is optional we only give warnings ("just in case") for
ohair@286:         // non-parameter entities.
ohair@286:         //
ohair@286:         doStore = (defns.get(entityName) == null);
ohair@286:         if (!doStore && defns == entities)
ohair@286:             warning("P-054", new Object[]{entityName});
ohair@286: 
ohair@286:         // internal entities
ohair@286:         if (externalId == null) {
ohair@286:             char value [];
ohair@286:             InternalEntity entity;
ohair@286: 
ohair@286:             doLexicalPE = false;        // "ab%bar;cd" -maybe-> "abcd"
ohair@286:             parseLiteral(true);
ohair@286:             doLexicalPE = true;
ohair@286:             if (doStore) {
ohair@286:                 value = new char[strTmp.length()];
ohair@286:                 if (value.length != 0)
ohair@286:                     strTmp.getChars(0, value.length, value, 0);
ohair@286:                 entity = new InternalEntity(entityName, value);
ohair@286:                 entity.isPE = (defns == params);
ohair@286:                 entity.isFromInternalSubset = false;
ohair@286:                 defns.put(entityName, entity);
ohair@286:                 if (defns == entities)
ohair@286:                     dtdHandler.internalGeneralEntityDecl(entityName,
ohair@286:                             new String(value));
ohair@286:             }
ohair@286: 
ohair@286:             // external entities (including unparsed)
ohair@286:         } else {
ohair@286:             // [76] NDataDecl ::= S 'NDATA' S Name
ohair@286:             if (defns == entities && maybeWhitespace()
ohair@286:                     && peek("NDATA")) {
ohair@286:                 externalId.notation = getMarkupDeclname("F-018", false);
ohair@286: 
ohair@286:                 // flag undeclared notation for checking after
ohair@286:                 // the DTD is fully processed
ohair@286:                 if (notations.get(externalId.notation) == null)
ohair@286:                     notations.put(externalId.notation, Boolean.TRUE);
ohair@286:             }
ohair@286:             externalId.name = entityName;
ohair@286:             externalId.isPE = (defns == params);
ohair@286:             externalId.isFromInternalSubset = false;
ohair@286:             if (doStore) {
ohair@286:                 defns.put(entityName, externalId);
ohair@286:                 if (externalId.notation != null)
ohair@286:                     dtdHandler.unparsedEntityDecl(entityName,
ohair@286:                             externalId.publicId, externalId.systemId,
ohair@286:                             externalId.notation);
ohair@286:                 else if (defns == entities)
ohair@286:                     dtdHandler.externalGeneralEntityDecl(entityName,
ohair@286:                             externalId.publicId, externalId.systemId);
ohair@286:             }
ohair@286:         }
ohair@286:         maybeWhitespace();
ohair@286:         nextChar('>', "F-031", entityName);
ohair@286:         if (start != in)
ohair@286:             error("V-013", null);
ohair@286:         return true;
ohair@286:     }
ohair@286: 
ohair@286:     private ExternalEntity maybeExternalID()
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [75] ExternalID ::= 'SYSTEM' S SystemLiteral
ohair@286:         //        | 'PUBLIC' S' PubidLiteral S Systemliteral
ohair@286:         String temp = null;
ohair@286:         ExternalEntity retval;
ohair@286: 
ohair@286:         if (peek("PUBLIC")) {
ohair@286:             whitespace("F-009");
ohair@286:             temp = parsePublicId();
ohair@286:         } else if (!peek("SYSTEM"))
ohair@286:             return null;
ohair@286: 
ohair@286:         retval = new ExternalEntity(in);
ohair@286:         retval.publicId = temp;
ohair@286:         whitespace("F-008");
ohair@286:         retval.systemId = parseSystemId();
ohair@286:         return retval;
ohair@286:     }
ohair@286: 
ohair@286:     private String parseSystemId()
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         String uri = getQuotedString("F-034", null);
ohair@286:         int temp = uri.indexOf(':');
ohair@286: 
ohair@286:         // resolve relative URIs ... must do it here since
ohair@286:         // it's relative to the source file holding the URI!
ohair@286: 
ohair@286:         // "new java.net.URL (URL, string)" conforms to RFC 1630,
ohair@286:         // but we can't use that except when the URI is a URL.
ohair@286:         // The entity resolver is allowed to handle URIs that are
ohair@286:         // not URLs, so we pass URIs through with scheme intact
ohair@286:         if (temp == -1 || uri.indexOf('/') < temp) {
ohair@286:             String baseURI;
ohair@286: 
ohair@286:             baseURI = in.getSystemId();
ohair@286:             if (baseURI == null)
ohair@286:                 fatal("P-055", new Object[]{uri});
ohair@286:             if (uri.length() == 0)
ohair@286:                 uri = ".";
ohair@286:             baseURI = baseURI.substring(0, baseURI.lastIndexOf('/') + 1);
ohair@286:             if (uri.charAt(0) != '/')
ohair@286:                 uri = baseURI + uri;
ohair@286:             else {
ohair@286:                 // XXX slashes at the beginning of a relative URI are
ohair@286:                 // a special case we don't handle.
ohair@286:                 throw new InternalError();
ohair@286:             }
ohair@286: 
ohair@286:             // letting other code map any "/xxx/../" or "/./" to "/",
ohair@286:             // since all URIs must handle it the same.
ohair@286:         }
ohair@286:         // check for fragment ID in URI
ohair@286:         if (uri.indexOf('#') != -1)
ohair@286:             error("P-056", new Object[]{uri});
ohair@286:         return uri;
ohair@286:     }
ohair@286: 
ohair@286:     private void maybeTextDecl()
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [77] TextDecl ::= '<?xml' VersionInfo? EncodingDecl S? '?>'
ohair@286:         if (peek("<?xml")) {
ohair@286:             readVersion(false, "1.0");
ohair@286:             readEncoding(true);
ohair@286:             maybeWhitespace();
ohair@286:             if (!peek("?>"))
ohair@286:                 fatal("P-057");
ohair@286:         }
ohair@286:     }
ohair@286: 
ohair@286:     private void externalParameterEntity(ExternalEntity next)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         //
ohair@286:         // Reap the intended benefits of standalone declarations:
ohair@286:         // don't deal with external parameter entities, except to
ohair@286:         // validate the standalone declaration.
ohair@286:         //
ohair@286: 
ohair@286:         // n.b. "in external parameter entities" (and external
ohair@286:         // DTD subset, same grammar) parameter references can
ohair@286:         // occur "within" markup declarations ... expansions can
ohair@286:         // cross syntax rules.  Flagged here; affects getc().
ohair@286: 
ohair@286:         // [79] ExtPE ::= TextDecl? extSubsetDecl
ohair@286:         // [31] extSubsetDecl ::= ( markupdecl | conditionalSect
ohair@286:         //        | PEReference | S )*
ohair@286:         InputEntity pe;
ohair@286: 
ohair@286:         // XXX if this returns false ...
ohair@286: 
ohair@286:         pe = in;
ohair@286:         maybeTextDecl();
ohair@286:         while (!pe.isEOF()) {
ohair@286:             // pop internal PEs (and whitespace before/after)
ohair@286:             if (in.isEOF()) {
ohair@286:                 in = in.pop();
ohair@286:                 continue;
ohair@286:             }
ohair@286:             doLexicalPE = false;
ohair@286:             if (maybeWhitespace())
ohair@286:                 continue;
ohair@286:             if (maybePEReference())
ohair@286:                 continue;
ohair@286:             doLexicalPE = true;
ohair@286:             if (maybeMarkupDecl() || maybeConditionalSect())
ohair@286:                 continue;
ohair@286:             break;
ohair@286:         }
ohair@286:         // if (in != pe) throw new InternalError("who popped my PE?");
ohair@286:         if (!pe.isEOF())
ohair@286:             fatal("P-059", new Object[]{in.getName()});
ohair@286:     }
ohair@286: 
ohair@286:     private void readEncoding(boolean must)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [81] EncName ::= [A-Za-z] ([A-Za-z0-9._] | '-')*
ohair@286:         String name = maybeReadAttribute("encoding", must);
ohair@286: 
ohair@286:         if (name == null)
ohair@286:             return;
ohair@286:         for (int i = 0; i < name.length(); i++) {
ohair@286:             char c = name.charAt(i);
ohair@286:             if ((c >= 'A' && c <= 'Z')
ohair@286:                     || (c >= 'a' && c <= 'z'))
ohair@286:                 continue;
ohair@286:             if (i != 0
ohair@286:                     && ((c >= '0' && c <= '9')
ohair@286:                     || c == '-'
ohair@286:                     || c == '_'
ohair@286:                     || c == '.'
ohair@286:                     ))
ohair@286:                 continue;
ohair@286:             fatal("P-060", new Object[]{new Character(c)});
ohair@286:         }
ohair@286: 
ohair@286:         //
ohair@286:         // This should be the encoding in use, and it's even an error for
ohair@286:         // it to be anything else (in certain cases that are impractical to
ohair@286:         // to test, and may even be insufficient).  So, we do the best we
ohair@286:         // can, and warn if things look suspicious.  Note that Java doesn't
ohair@286:         // uniformly expose the encodings, and that the names it uses
ohair@286:         // internally are nonstandard.  Also, that the XML spec allows
ohair@286:         // such "errors" not to be reported at all.
ohair@286:         //
ohair@286:         String currentEncoding = in.getEncoding();
ohair@286: 
ohair@286:         if (currentEncoding != null
ohair@286:                 && !name.equalsIgnoreCase(currentEncoding))
ohair@286:             warning("P-061", new Object[]{name, currentEncoding});
ohair@286:     }
ohair@286: 
ohair@286:     private boolean maybeNotationDecl()
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         // [82] NotationDecl ::= '<!NOTATION' S Name S
ohair@286:         //        (ExternalID | PublicID) S? '>'
ohair@286:         // [83] PublicID ::= 'PUBLIC' S PubidLiteral
ohair@286:         InputEntity start = peekDeclaration("!NOTATION");
ohair@286: 
ohair@286:         if (start == null)
ohair@286:             return false;
ohair@286: 
ohair@286:         String name = getMarkupDeclname("F-019", false);
ohair@286:         ExternalEntity entity = new ExternalEntity(in);
ohair@286: 
ohair@286:         whitespace("F-011");
ohair@286:         if (peek("PUBLIC")) {
ohair@286:             whitespace("F-009");
ohair@286:             entity.publicId = parsePublicId();
ohair@286:             if (maybeWhitespace()) {
ohair@286:                 if (!peek(">"))
ohair@286:                     entity.systemId = parseSystemId();
ohair@286:                 else
ohair@286:                     ungetc();
ohair@286:             }
ohair@286:         } else if (peek("SYSTEM")) {
ohair@286:             whitespace("F-008");
ohair@286:             entity.systemId = parseSystemId();
ohair@286:         } else
ohair@286:             fatal("P-062");
ohair@286:         maybeWhitespace();
ohair@286:         nextChar('>', "F-032", name);
ohair@286:         if (start != in)
ohair@286:             error("V-013", null);
ohair@286:         if (entity.systemId != null && entity.systemId.indexOf('#') != -1)
ohair@286:             error("P-056", new Object[]{entity.systemId});
ohair@286: 
ohair@286:         Object value = notations.get(name);
ohair@286:         if (value != null && value instanceof ExternalEntity)
ohair@286:             warning("P-063", new Object[]{name});
ohair@286: 
ohair@286:         else {
ohair@286:             notations.put(name, entity);
ohair@286:             dtdHandler.notationDecl(name, entity.publicId,
ohair@286:                     entity.systemId);
ohair@286:         }
ohair@286:         return true;
ohair@286:     }
ohair@286: 
ohair@286: 
ohair@286:     ////////////////////////////////////////////////////////////////
ohair@286:     //
ohair@286:     //    UTILITIES
ohair@286:     //
ohair@286:     ////////////////////////////////////////////////////////////////
ohair@286: 
ohair@286:     private char getc() throws IOException, SAXException {
ohair@286: 
ohair@286:         if (!doLexicalPE) {
ohair@286:             char c = in.getc();
ohair@286:             return c;
ohair@286:         }
ohair@286: 
ohair@286:         //
ohair@286:         // External parameter entities get funky processing of '%param;'
ohair@286:         // references.  It's not clearly defined in the XML spec; but it
ohair@286:         // boils down to having those refs be _lexical_ in most cases to
ohair@286:         // include partial syntax productions.  It also needs selective
ohair@286:         // enabling; "<!ENTITY % foo ...>" must work, for example, and
ohair@286:         // if "bar" is an empty string PE, "ab%bar;cd" becomes "abcd"
ohair@286:         // if it's expanded in a literal, else "ab  cd".  PEs also do
ohair@286:         // not expand within comments or PIs, and external PEs are only
ohair@286:         // allowed to have markup decls (and so aren't handled lexically).
ohair@286:         //
ohair@286:         // This PE handling should be merged into maybeWhitespace, where
ohair@286:         // it can be dealt with more consistently.
ohair@286:         //
ohair@286:         // Also, there are some validity constraints in this area.
ohair@286:         //
ohair@286:         char c;
ohair@286: 
ohair@286:         while (in.isEOF()) {
ohair@286:             if (in.isInternal() || (doLexicalPE && !in.isDocument()))
ohair@286:                 in = in.pop();
ohair@286:             else {
ohair@286:                 fatal("P-064", new Object[]{in.getName()});
ohair@286:             }
ohair@286:         }
ohair@286:         if ((c = in.getc()) == '%' && doLexicalPE) {
ohair@286:             // PE ref ::= '%' name ';'
ohair@286:             String name = maybeGetName();
ohair@286:             Object entity;
ohair@286: 
ohair@286:             if (name == null)
ohair@286:                 fatal("P-011");
ohair@286:             nextChar(';', "F-021", name);
ohair@286:             entity = params.get(name);
ohair@286: 
ohair@286:             // push a magic "entity" before and after the
ohair@286:             // real one, so ungetc() behaves uniformly
ohair@286:             pushReader(" ".toCharArray(), null, false);
ohair@286:             if (entity instanceof InternalEntity)
ohair@286:                 pushReader(((InternalEntity) entity).buf, name, false);
ohair@286:             else if (entity instanceof ExternalEntity)
ohair@286:             // PEs can't be unparsed!
ohair@286:             // XXX if this returns false ...
ohair@286:                 pushReader((ExternalEntity) entity);
ohair@286:             else if (entity == null)
ohair@286:             // see note in maybePEReference re making this be nonfatal.
ohair@286:                 fatal("V-022");
ohair@286:             else
ohair@286:                 throw new InternalError();
ohair@286:             pushReader(" ".toCharArray(), null, false);
ohair@286:             return in.getc();
ohair@286:         }
ohair@286:         return c;
ohair@286:     }
ohair@286: 
ohair@286:     private void ungetc() {
ohair@286: 
ohair@286:         in.ungetc();
ohair@286:     }
ohair@286: 
ohair@286:     private boolean peek(String s)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         return in.peek(s, null);
ohair@286:     }
ohair@286: 
ohair@286:     // Return the entity starting the specified declaration
ohair@286:     // (for validating declaration nesting) else null.
ohair@286: 
ohair@286:     private InputEntity peekDeclaration(String s)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         InputEntity start;
ohair@286: 
ohair@286:         if (!in.peekc('<'))
ohair@286:             return null;
ohair@286:         start = in;
ohair@286:         if (in.peek(s, null))
ohair@286:             return start;
ohair@286:         in.ungetc();
ohair@286:         return null;
ohair@286:     }
ohair@286: 
ohair@286:     private void nextChar(char c, String location, String near)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         while (in.isEOF() && !in.isDocument())
ohair@286:             in = in.pop();
ohair@286:         if (!in.peekc(c))
ohair@286:             fatal("P-008", new Object[]
ohair@286:             {new Character(c),
ohair@286:              messages.getMessage(locale, location),
ohair@286:              (near == null ? "" : ('"' + near + '"'))});
ohair@286:     }
ohair@286: 
ohair@286: 
ohair@286:     private void pushReader(char buf [], String name, boolean isGeneral)
ohair@286:             throws SAXException {
ohair@286: 
ohair@286:         InputEntity r = InputEntity.getInputEntity(dtdHandler, locale);
ohair@286:         r.init(buf, name, in, !isGeneral);
ohair@286:         in = r;
ohair@286:     }
ohair@286: 
ohair@286:     private boolean pushReader(ExternalEntity next)
ohair@286:             throws IOException, SAXException {
ohair@286: 
ohair@286:         InputEntity r = InputEntity.getInputEntity(dtdHandler, locale);
ohair@286:         InputSource s;
ohair@286:         try {
ohair@286:             s = next.getInputSource(resolver);
ohair@286:         } catch (IOException e) {
ohair@286:             String msg =
ohair@286:                     "unable to open the external entity from :" + next.systemId;
ohair@286:             if (next.publicId != null)
ohair@286:                 msg += " (public id:" + next.publicId + ")";
ohair@286: 
ohair@286:             SAXParseException spe = new SAXParseException(msg,
ohair@286:                     getPublicId(), getSystemId(), getLineNumber(), getColumnNumber(), e);
ohair@286:             dtdHandler.fatalError(spe);
ohair@286:             throw e;
ohair@286:         }
ohair@286: 
ohair@286:         r.init(s, next.name, in, next.isPE);
ohair@286:         in = r;
ohair@286:         return true;
ohair@286:     }
ohair@286: 
ohair@286:     public String getPublicId() {
ohair@286: 
ohair@286:         return (in == null) ? null : in.getPublicId();
ohair@286:     }
ohair@286: 
ohair@286:     public String getSystemId() {
ohair@286: 
ohair@286:         return (in == null) ? null : in.getSystemId();
ohair@286:     }
ohair@286: 
ohair@286:     public int getLineNumber() {
ohair@286: 
ohair@286:         return (in == null) ? -1 : in.getLineNumber();
ohair@286:     }
ohair@286: 
ohair@286:     public int getColumnNumber() {
ohair@286: 
ohair@286:         return (in == null) ? -1 : in.getColumnNumber();
ohair@286:     }
ohair@286: 
ohair@286:     // error handling convenience routines
ohair@286: 
ohair@286:     private void warning(String messageId, Object parameters [])
ohair@286:             throws SAXException {
ohair@286: 
ohair@286:         SAXParseException e = new SAXParseException(messages.getMessage(locale, messageId, parameters),
ohair@286:                 getPublicId(), getSystemId(), getLineNumber(), getColumnNumber());
ohair@286: 
ohair@286:         dtdHandler.warning(e);
ohair@286:     }
ohair@286: 
ohair@286:     void error(String messageId, Object parameters [])
ohair@286:             throws SAXException {
ohair@286: 
ohair@286:         SAXParseException e = new SAXParseException(messages.getMessage(locale, messageId, parameters),
ohair@286:                 getPublicId(), getSystemId(), getLineNumber(), getColumnNumber());
ohair@286: 
ohair@286:         dtdHandler.error(e);
ohair@286:     }
ohair@286: 
ohair@286:     private void fatal(String messageId) throws SAXException {
ohair@286: 
ohair@286:         fatal(messageId, null);
ohair@286:     }
ohair@286: 
ohair@286:     private void fatal(String messageId, Object parameters [])
ohair@286:             throws SAXException {
ohair@286: 
ohair@286:         SAXParseException e = new SAXParseException(messages.getMessage(locale, messageId, parameters),
ohair@286:                 getPublicId(), getSystemId(), getLineNumber(), getColumnNumber());
ohair@286: 
ohair@286:         dtdHandler.fatalError(e);
ohair@286: 
ohair@286:         throw e;
ohair@286:     }
ohair@286: 
ohair@286:     //
ohair@286:     // Map char arrays to strings ... cuts down both on memory and
ohair@286:     // CPU usage for element/attribute/other names that are reused.
ohair@286:     //
ohair@286:     // Documents typically repeat names a lot, so we more or less
ohair@286:     // intern all the strings within the document; since some strings
ohair@286:     // are repeated in multiple documents (e.g. stylesheets) we go
ohair@286:     // a bit further, and intern globally.
ohair@286:     //
ohair@286:     static class NameCache {
ohair@286:         //
ohair@286:         // Unless we auto-grow this, the default size should be a
ohair@286:         // reasonable bit larger than needed for most XML files
ohair@286:         // we've yet seen (and be prime).  If it's too small, the
ohair@286:         // penalty is just excess cache collisions.
ohair@286:         //
ohair@286:         NameCacheEntry hashtable [] = new NameCacheEntry[541];
ohair@286: 
ohair@286:         //
ohair@286:         // Usually we just want to get the 'symbol' for these chars
ohair@286:         //
ohair@286:         String lookup(char value [], int len) {
ohair@286: 
ohair@286:             return lookupEntry(value, len).name;
ohair@286:         }
ohair@286: 
ohair@286:         //
ohair@286:         // Sometimes we need to scan the chars in the resulting
ohair@286:         // string, so there's an accessor which exposes them.
ohair@286:         // (Mostly for element end tags.)
ohair@286:         //
ohair@286:         NameCacheEntry lookupEntry(char value [], int len) {
ohair@286: 
ohair@286:             int index = 0;
ohair@286:             NameCacheEntry entry;
ohair@286: 
ohair@286:             // hashing to get index
ohair@286:             for (int i = 0; i < len; i++)
ohair@286:                 index = index * 31 + value[i];
ohair@286:             index &= 0x7fffffff;
ohair@286:             index %= hashtable.length;
ohair@286: 
ohair@286:             // return entry if one's there ...
ohair@286:             for (entry = hashtable[index];
ohair@286:                  entry != null;
ohair@286:                  entry = entry.next) {
ohair@286:                 if (entry.matches(value, len))
ohair@286:                     return entry;
ohair@286:             }
ohair@286: 
ohair@286:             // else create new one
ohair@286:             entry = new NameCacheEntry();
ohair@286:             entry.chars = new char[len];
ohair@286:             System.arraycopy(value, 0, entry.chars, 0, len);
ohair@286:             entry.name = new String(entry.chars);
ohair@286:             //
ohair@286:             // NOTE:  JDK 1.1 has a fixed size string intern table,
ohair@286:             // with non-GC'd entries.  It can panic here; that's a
ohair@286:             // JDK problem, use 1.2 or later with many identifiers.
ohair@286:             //
ohair@286:             entry.name = entry.name.intern();        // "global" intern
ohair@286:             entry.next = hashtable[index];
ohair@286:             hashtable[index] = entry;
ohair@286:             return entry;
ohair@286:         }
ohair@286:     }
ohair@286: 
ohair@286:     static class NameCacheEntry {
ohair@286: 
ohair@286:         String name;
ohair@286:         char chars [];
ohair@286:         NameCacheEntry next;
ohair@286: 
ohair@286:         boolean matches(char value [], int len) {
ohair@286: 
ohair@286:             if (chars.length != len)
ohair@286:                 return false;
ohair@286:             for (int i = 0; i < len; i++)
ohair@286:                 if (value[i] != chars[i])
ohair@286:                     return false;
ohair@286:             return true;
ohair@286:         }
ohair@286:     }
ohair@286: 
ohair@286:     //
ohair@286:     // Message catalog for diagnostics.
ohair@286:     //
ohair@286:     static final Catalog messages = new Catalog();
ohair@286: 
ohair@286:     static final class Catalog extends MessageCatalog {
ohair@286: 
ohair@286:         Catalog() {
ohair@286:             super(DTDParser.class);
ohair@286:         }
ohair@286:     }
ohair@286: 
ohair@286: }