You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by an...@apache.org on 2001/08/28 10:51:48 UTC
cvs commit: xml-xerces/java/src/org/apache/xerces/impl XMLDocumentFragmentScannerImpl.java XMLDocumentScannerImpl.java
andyc 01/08/28 01:51:47
Modified: java/src/org/apache/xerces/impl XMLDocumentScannerImpl.java
Added: java/src/org/apache/xerces/impl
XMLDocumentFragmentScannerImpl.java
Log:
Separated document scanner so that it's possible to build
configurations capable of parsing document fragments as well
as full fledged documents.
Some additional work should be done, however, so that the
user of the document fragment parser can decide if the
fragment should be considered an internal or external
parsed fragment. This is important due to the presence of
the TextDecl in an external parsed entity.
Revision Changes Path
1.5 +100 -1148 xml-xerces/java/src/org/apache/xerces/impl/XMLDocumentScannerImpl.java
Index: XMLDocumentScannerImpl.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xerces/impl/XMLDocumentScannerImpl.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- XMLDocumentScannerImpl.java 2001/08/24 04:14:23 1.4
+++ XMLDocumentScannerImpl.java 2001/08/28 08:51:47 1.5
@@ -108,11 +108,10 @@
* @author Arnaud Le Hors, IBM
* @author Eric Ye, IBM
*
- * @version $Id: XMLDocumentScannerImpl.java,v 1.4 2001/08/24 04:14:23 andyc Exp $
+ * @version $Id: XMLDocumentScannerImpl.java,v 1.5 2001/08/28 08:51:47 andyc Exp $
*/
public class XMLDocumentScannerImpl
- extends XMLScanner
- implements XMLDocumentScanner, XMLComponent, XMLEntityHandler {
+ extends XMLDocumentFragmentScannerImpl {
//
// Constants
@@ -123,45 +122,12 @@
/** Scanner state: XML declaration. */
protected static final int SCANNER_STATE_XML_DECL = 0;
- /** Scanner state: start of markup. */
- protected static final int SCANNER_STATE_START_OF_MARKUP = 1;
-
- /** Scanner state: comment. */
- protected static final int SCANNER_STATE_COMMENT = 2;
-
- /** Scanner state: processing instruction. */
- protected static final int SCANNER_STATE_PI = 3;
-
- /** Scanner state: DOCTYPE. */
- protected static final int SCANNER_STATE_DOCTYPE = 4;
-
/** Scanner state: prolog. */
protected static final int SCANNER_STATE_PROLOG = 5;
- /** Scanner state: root element. */
- protected static final int SCANNER_STATE_ROOT_ELEMENT = 6;
-
- /** Scanner state: content. */
- protected static final int SCANNER_STATE_CONTENT = 7;
-
- /** Scanner state: reference. */
- protected static final int SCANNER_STATE_REFERENCE = 8;
-
/** Scanner state: trailing misc. */
protected static final int SCANNER_STATE_TRAILING_MISC = 12;
- /** Scanner state: end of input. */
- protected static final int SCANNER_STATE_END_OF_INPUT = 13;
-
- /** Scanner state: terminated. */
- protected static final int SCANNER_STATE_TERMINATED = 14;
-
- /** Scanner state: CDATA section. */
- protected static final int SCANNER_STATE_CDATA = 15;
-
- /** Scanner state: Text declaration. */
- protected static final int SCANNER_STATE_TEXT_DECL = 16;
-
/** Scanner state: DTD internal declarations. */
protected static final int SCANNER_STATE_DTD_INTERNAL_DECLS = 17;
@@ -173,18 +139,10 @@
// feature identifiers
- /** Feature identifier: namespaces. */
- protected static final String NAMESPACES =
- Constants.SAX_FEATURE_PREFIX + Constants.NAMESPACES_FEATURE;
-
/** Feature identifier: load external DTD. */
protected static final String LOAD_EXTERNAL_DTD =
Constants.XERCES_FEATURE_PREFIX + Constants.LOAD_EXTERNAL_DTD_FEATURE;
- /** Feature identifier: notify built-in refereces. */
- protected static final String NOTIFY_BUILTIN_REFS =
- Constants.XERCES_FEATURE_PREFIX + Constants.NOTIFY_BUILTIN_REFS_FEATURE;
-
// property identifiers
/** Property identifier: DTD scanner. */
@@ -210,17 +168,6 @@
DTD_SCANNER,
};
- // debugging
-
- /** Debug scanner state. */
- private static final boolean DEBUG_SCANNER_STATE = false;
-
- /** Debug dispatcher. */
- private static final boolean DEBUG_DISPATCHER = false;
-
- /** Debug content dispatcher scanning. */
- private static final boolean DEBUG_CONTENT_SCANNING = false;
-
//
// Data
//
@@ -232,43 +179,11 @@
// protected data
- /** Document handler. */
- protected XMLDocumentHandler fDocumentHandler;
-
- /** Entity stack. */
- protected int[] fEntityStack = new int[4];
-
- /** Markup depth. */
- protected int fMarkupDepth;
-
- /** Scanner state. */
- protected int fScannerState;
-
- /** Seen doctype declaration. */
- protected boolean fSeenDoctypeDecl;
-
- /** has external dtd */
- protected boolean fHasExternalDTD;
-
- /** Standalone. */
- protected boolean fStandalone;
-
/** Scanning DTD. */
protected boolean fScanningDTD;
- // element information
-
- /** Current element. */
- protected QName fCurrentElement;
-
- /** Element stack. */
- protected ElementStack fElementStack = new ElementStack();
-
// other info
- /** Document system identifier. */
- protected String fDocumentSystemId;
-
/** Doctype name. */
protected String fDoctypeName;
@@ -280,19 +195,15 @@
// features
- /** Namespaces. */
- protected boolean fNamespaces;
-
/** Load external DTD. */
protected boolean fLoadExternalDTD = true;
- /** Notify built-in references. */
- protected boolean fNotifyBuiltInRefs = false;
+ // state
- // dispatchers
+ /** Seen doctype declaration. */
+ protected boolean fSeenDoctypeDecl;
- /** Active dispatcher. */
- protected Dispatcher fDispatcher;
+ // dispatchers
/** XML declaration dispatcher. */
protected Dispatcher fXMLDeclDispatcher = new XMLDeclDispatcher();
@@ -303,37 +214,9 @@
/** DTD dispatcher. */
protected Dispatcher fDTDDispatcher = new DTDDispatcher();
- /** Content dispatcher. */
- protected Dispatcher fContentDispatcher = new ContentDispatcher();
-
/** Trailing miscellaneous section dispatcher. */
protected Dispatcher fTrailingMiscDispatcher = new TrailingMiscDispatcher();
- // private data
-
- /** Element QName. */
- private QName fElementQName = new QName();
-
- /** Attribute QName. */
- private QName fAttributeQName = new QName();
-
- /** Another QName. */
- private QName fQName = new QName();
-
- /** Element attributes. */
- private XMLAttributesImpl fAttributes = new XMLAttributesImpl();
-
- /** Single character array. */
- private final char[] fSingleChar = new char[1];
-
- /** External entity. */
- private XMLEntityManager.ExternalEntity fExternalEntity = new XMLEntityManager.ExternalEntity();
-
- // symbols
-
- /** Symbol: "CDATA". */
- private String fCDATASymbol;
-
//
// Constructors
//
@@ -358,35 +241,6 @@
fDocumentSystemId = fEntityManager.expandSystemId(inputSource.getSystemId());
} // setInputSource(XMLInputSource)
- /**
- * Scans a document.
- *
- * @param complete True if the scanner should scan the document
- * completely, pushing all events to the registered
- * document handler. A value of false indicates that
- * that the scanner should only scan the next portion
- * of the document and return. A scanner instance is
- * permitted to completely scan a document if it does
- * not support this "pull" scanning model.
- *
- * @returns True if there is more to scan, false otherwise.
- */
- public boolean scanDocument(boolean complete)
- throws IOException, XNIException {
-
- // keep dispatching "events"
- fEntityManager.setEntityHandler(this);
- do {
- if (!fDispatcher.dispatch(complete)) {
- return false;
- }
- } while (complete);
-
- // return success
- return true;
-
- } // scanDocument(boolean):boolean
-
//
// XMLComponent methods
//
@@ -411,28 +265,13 @@
super.reset(componentManager);
// other settings
- fDocumentSystemId = null;
fDoctypeName = null;
fDoctypePublicId = null;
fDoctypeSystemId = null;
-
- // sax features
- try {
- fNamespaces = componentManager.getFeature(NAMESPACES);
- }
- catch (XMLConfigurationException e) {
- fNamespaces = true;
- }
- fAttributes.setNamespaces(fNamespaces);
+ fSeenDoctypeDecl = false;
// xerces features
try {
- fNotifyBuiltInRefs = componentManager.getFeature(NOTIFY_BUILTIN_REFS);
- }
- catch (XMLConfigurationException e) {
- fNotifyBuiltInRefs = false;
- }
- try {
fLoadExternalDTD = componentManager.getFeature(LOAD_EXTERNAL_DTD);
}
catch (XMLConfigurationException e) {
@@ -443,17 +282,8 @@
fDTDScanner = (XMLDTDScanner)componentManager.getProperty(DTD_SCANNER);
// initialize vars
- fMarkupDepth = 0;
- fCurrentElement = null;
- fElementStack.clear();
- fSeenDoctypeDecl = false;
- fHasExternalDTD = false;
- fStandalone = false;
fScanningDTD = false;
- // create symbols
- fCDATASymbol = fSymbolTable.addSymbol("CDATA");
-
// setup dispatcher
setScannerState(SCANNER_STATE_XML_DECL);
setDispatcher(fXMLDeclDispatcher);
@@ -496,9 +326,6 @@
fLoadExternalDTD = state;
return;
}
- if (feature.equals(Constants.NOTIFY_BUILTIN_REFS_FEATURE)) {
- fNotifyCharRefs = state;
- }
}
} // setFeature(String,boolean)
@@ -538,28 +365,12 @@
if (property.equals(Constants.DTD_SCANNER_PROPERTY)) {
fDTDScanner = (XMLDTDScanner)value;
}
- else if (property.equals(Constants.ENTITY_MANAGER_PROPERTY)) {
- fEntityManager = (XMLEntityManager)value;
- }
return;
}
} // setProperty(String,Object)
//
- // XMLDocumentSource methods
- //
-
- /**
- * setDocumentHandler
- *
- * @param documentHandler
- */
- public void setDocumentHandler(XMLDocumentHandler documentHandler) {
- fDocumentHandler = documentHandler;
- } // setDocumentHandler(XMLDocumentHandler)
-
- //
// XMLEntityHandler methods
//
@@ -588,14 +399,6 @@
String baseSystemId,
String encoding) throws XNIException {
- // keep track of this entity before fEntityDepth is increased
- if (fEntityDepth == fEntityStack.length) {
- int[] entityarray = new int[fEntityStack.length * 2];
- System.arraycopy(fEntityStack, 0, entityarray, 0, fEntityStack.length);
- fEntityStack = entityarray;
- }
- fEntityStack[fEntityDepth] = fMarkupDepth;
-
super.startEntity(name, publicId, systemId, baseSystemId, encoding);
// prepare to look for a TextDecl if external general entity
@@ -608,10 +411,6 @@
if (name.equals("[xml]")) {
fDocumentHandler.startDocument(fEntityScanner, encoding);
}
- else if (!fScanningAttribute) {
- fDocumentHandler.startEntity(name, publicId, systemId,
- baseSystemId, encoding);
- }
}
} // startEntity(String,String,String,String,String)
@@ -629,19 +428,11 @@
super.endEntity(name);
- // make sure markup is properly balanced
- if (fMarkupDepth != fEntityStack[fEntityDepth]) {
- reportFatalError("MarkupEntityMismatch", null);
- }
-
// call handler
if (fDocumentHandler != null) {
if (name.equals("[xml]")) {
fDocumentHandler.endDocument();
}
- else if (!fScanningAttribute) {
- fDocumentHandler.endEntity(name);
- }
}
} // endEntity(String)
@@ -650,101 +441,15 @@
// Protected methods
//
- // scanning methods
+ // dispatcher factory methods
- /**
- * Scans an XML or text declaration.
- * <p>
- * <pre>
- * [23] XMLDecl ::= '<?xml' VersionInfo EncodingDecl? SDDecl? S? '?>'
- * [24] VersionInfo ::= S 'version' Eq (' VersionNum ' | " VersionNum ")
- * [80] EncodingDecl ::= S 'encoding' Eq ('"' EncName '"' | "'" EncName "'" )
- * [81] EncName ::= [A-Za-z] ([A-Za-z0-9._] | '-')*
- * [32] SDDecl ::= S 'standalone' Eq (("'" ('yes' | 'no') "'")
- * | ('"' ('yes' | 'no') '"'))
- *
- * [77] TextDecl ::= '<?xml' VersionInfo? EncodingDecl S? '?>'
- * </pre>
- *
- * @param scanningTextDecl True if a text declaration is to
- * be scanned instead of an XML
- * declaration.
- */
- protected void scanXMLDeclOrTextDecl(boolean scanningTextDecl)
- throws IOException, XNIException {
-
- // scan decl
- super.scanXMLDeclOrTextDecl(scanningTextDecl, fStrings);
- fMarkupDepth--;
-
- // pseudo-attribute values
- String version = fStrings[0];
- String encoding = fStrings[1];
- String standalone = fStrings[2];
-
- // set standalone
- fStandalone = standalone != null && standalone.equals("yes");
- fEntityManager.setStandalone(fStandalone);
+ /** Creates a content dispatcher. */
+ protected Dispatcher createContentDispatcher() {
+ return new ContentDispatcher();
+ } // createContentDispatcher():Dispatcher
- // call handler
- if (fDocumentHandler != null) {
- if (scanningTextDecl) {
- fDocumentHandler.textDecl(version, encoding);
- }
- else {
- fDocumentHandler.xmlDecl(version, encoding, standalone);
- }
- }
-
- // set encoding on reader
- if (encoding != null) {
- fEntityScanner.setEncoding(encoding);
- }
-
- } // scanXMLDeclOrTextDecl(boolean)
-
- /**
- * Scans a processing data. This is needed to handle the situation
- * where a document starts with a processing instruction whose
- * target name <em>starts with</em> "xml". (e.g. xmlfoo)
- *
- * @param target The PI target
- * @param data The string to fill in with the data
- */
- protected void scanPIData(String target, XMLString data)
- throws IOException, XNIException {
-
- super.scanPIData(target, data);
- fMarkupDepth--;
-
- // call handler
- if (fDocumentHandler != null) {
- fDocumentHandler.processingInstruction(target, data);
- }
-
- } // scanPIData(String)
-
- /**
- * Scans a comment.
- * <p>
- * <pre>
- * [15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'
- * </pre>
- * <p>
- * <strong>Note:</strong> Called after scanning past '<!--'
- */
- protected void scanComment() throws IOException, XNIException {
-
- scanComment(fStringBuffer);
- fMarkupDepth--;
-
- // call handler
- if (fDocumentHandler != null) {
- fDocumentHandler.comment(fStringBuffer);
- }
+ // scanning methods
- } // scanComment()
-
/** Scans a doctype declaration. */
protected boolean scanDoctypeDecl() throws IOException, XNIException {
@@ -795,677 +500,30 @@
} // scanDoctypeDecl():boolean
- /**
- * Scans a start element. This method will handle the binding of
- * namespace information and notifying the handler of the start
- * of the element.
- * <p>
- * <pre>
- * [44] EmptyElemTag ::= '<' Name (S Attribute)* S? '/>'
- * [40] STag ::= '<' Name (S Attribute)* S? '>'
- * </pre>
- * <p>
- * <strong>Note:</strong> This method assumes that the leading
- * '<' character has been consumed.
- * <p>
- * <strong>Note:</strong> This method uses the fElementQName and
- * fAttributes variables. The contents of these variables will be
- * destroyed. The caller should copy important information out of
- * these variables before calling this method.
- *
- * @returns True if element is empty. (i.e. It matches
- * production [44].
- */
- protected boolean scanStartElement()
- throws IOException, XNIException {
- if (DEBUG_CONTENT_SCANNING) System.out.println(">>> scanStartElement()");
-
- // name
- if (fNamespaces) {
- fEntityScanner.scanQName(fElementQName);
- }
- else {
- String name = fEntityScanner.scanName();
- fElementQName.setValues(null, name, name, null);
- }
- String rawname = fElementQName.rawname;
-
- // push element stack
- fCurrentElement = fElementStack.pushElement(fElementQName);
-
- // attributes
- boolean empty = false;
- fAttributes.removeAllAttributes();
- do {
- // spaces
- boolean sawSpace = fEntityScanner.skipSpaces();
-
- // end tag?
- int c = fEntityScanner.peekChar();
- if (c == '>') {
- fEntityScanner.scanChar();
- break;
- }
- else if (c == '/') {
- fEntityScanner.scanChar();
- if (!fEntityScanner.skipChar('>')) {
- reportFatalError("ElementUnterminated",
- new Object[]{rawname});
- }
- empty = true;
- break;
- }
- else if (!XMLChar.isNameStart(c) || !sawSpace) {
- reportFatalError("ElementUnterminated", new Object[]{rawname});
- }
-
- // attributes
- scanAttribute(fAttributes);
-
- } while (true);
-
- // call handler
- if (fDocumentHandler != null) {
- if (empty) {
- fDocumentHandler.emptyElement(fElementQName, fAttributes);
- handleEndElement(fElementQName, true);
- }
- else {
- fDocumentHandler.startElement(fElementQName, fAttributes);
- }
- }
-
- if (DEBUG_CONTENT_SCANNING) System.out.println("<<< scanStartElement(): "+empty);
- return empty;
-
- } // scanStartElement():boolean
-
- /**
- * Scans an attribute.
- * <p>
- * <pre>
- * [41] Attribute ::= Name Eq AttValue
- * </pre>
- * <p>
- * <strong>Note:</strong> This method assumes that the next
- * character on the stream is the first character of the attribute
- * name.
- * <p>
- * <strong>Note:</strong> This method uses the fAttributeQName and
- * fQName variables. The contents of these variables will be
- * destroyed.
- *
- * @param attributes The attributes list for the scanned attribute.
- */
- protected void scanAttribute(XMLAttributes attributes)
- throws IOException, XNIException {
- if (DEBUG_CONTENT_SCANNING) System.out.println(">>> scanAttribute()");
-
- // name
- if (fNamespaces) {
- fEntityScanner.scanQName(fAttributeQName);
- }
- else {
- String name = fEntityScanner.scanName();
- fAttributeQName.setValues(null, name, name, null);
- }
-
- // equals
- fEntityScanner.skipSpaces();
- if (!fEntityScanner.skipChar('=')) {
- reportFatalError("EqRequiredInAttribute",
- new Object[]{fCurrentElement.rawname,
- fAttributeQName.rawname});
- }
- fEntityScanner.skipSpaces();
-
- // content
- int oldLen = attributes.getLength();
- attributes.addAttribute(fAttributeQName, fCDATASymbol, null);
-
- // WFC: Unique Att Spec
- if (oldLen == attributes.getLength()) {
- reportFatalError("AttributeNotUnique",
- new Object[]{fCurrentElement.rawname,
- fAttributeQName.rawname});
- }
- //REVISIT: one more case needs to be included: external PE and standalone is no
- boolean isVC = fHasExternalDTD && !fStandalone;
- scanAttributeValue(fString, fAttributeQName.rawname, attributes,
- oldLen, isVC);
- attributes.setValue(oldLen, fString.toString());
- attributes.setSpecified(oldLen, true);
-
- if (DEBUG_CONTENT_SCANNING) System.out.println("<<< scanAttribute()");
- } // scanAttribute(XMLAttributes)
-
- /**
- * Scans element content.
- *
- * @returns Returns the next character on the stream.
- */
- protected int scanContent() throws IOException, XNIException {
-
- XMLString content = fString;
- int c = fEntityScanner.scanContent(content);
- if (c == '\r') {
- // happens when there is the character reference
- fEntityScanner.scanChar();
- fStringBuffer.clear();
- fStringBuffer.append(fString);
- fStringBuffer.append((char)c);
- content = fStringBuffer;
- c = -1;
- }
- if (fDocumentHandler != null && content.length > 0) {
- fDocumentHandler.characters(content);
- }
-
- if (c == ']' && fString.length == 0) {
- fStringBuffer.clear();
- fStringBuffer.append((char)fEntityScanner.scanChar());
- //
- // We work on a single character basis to handle cases such as:
- // ']]]>' which we might otherwise miss.
- //
- if (fEntityScanner.skipChar(']')) {
- fStringBuffer.append(']');
- while (fEntityScanner.skipChar(']')) {
- fStringBuffer.append(']');
- }
- if (fEntityScanner.skipChar('>')) {
- reportFatalError("CDEndInContent", null);
- }
- }
- if (fDocumentHandler != null) {
- fDocumentHandler.characters(fStringBuffer);
- }
- c = -1;
- }
- return c;
-
- } // scanContent():int
-
-
- /**
- * Scans a CDATA section.
- * <p>
- * <strong>Note:</strong> This method uses the fString and
- * fStringBuffer variables.
- *
- * @param complete True if the CDATA section is to be scanned
- * completely.
- *
- * @return True if CDATA is completely scanned.
- */
- protected boolean scanCDATASection(boolean complete)
- throws IOException, XNIException {
-
- // call handler
- if (fDocumentHandler != null) {
- fDocumentHandler.startCDATA();
- }
-
- while (true) {
- if (!fEntityScanner.scanData("]]", fString)) {
- if (fDocumentHandler != null && fString.length > 0) {
- fDocumentHandler.characters(fString);
- }
- int brackets = 2;
- while (fEntityScanner.skipChar(']')) {
- brackets++;
- }
- if (fDocumentHandler != null && brackets > 2) {
- fStringBuffer.clear();
- for (int i = 2; i < brackets; i++) {
- fStringBuffer.append(']');
- }
- fDocumentHandler.characters(fStringBuffer);
- }
- if (fEntityScanner.skipChar('>')) {
- break;
- }
- if (fDocumentHandler != null) {
- fStringBuffer.clear();
- fStringBuffer.append("]]");
- fDocumentHandler.characters(fStringBuffer);
- }
- }
- else {
- if (fDocumentHandler != null) {
- fDocumentHandler.characters(fString);
- }
- int c = fEntityScanner.peekChar();
- if (c != -1 && XMLChar.isInvalid(c)) {
- if (XMLChar.isHighSurrogate(c)) {
- fStringBuffer.clear();
- scanSurrogates(fStringBuffer);
- if (fDocumentHandler != null) {
- fDocumentHandler.characters(fStringBuffer);
- }
- }
- else {
- reportFatalError("InvalidCharInCDSect",
- new Object[]{Integer.toString(c,16)});
- fEntityScanner.scanChar();
- }
- }
- }
- }
- fMarkupDepth--;
-
- // call handler
- if (fDocumentHandler != null) {
- fDocumentHandler.endCDATA();
- }
-
- return true;
-
- } // scanCDATASection(boolean):boolean
-
- /**
- * Scans an end element.
- * <p>
- * <pre>
- * [42] ETag ::= '</' Name S? '>'
- * </pre>
- * <p>
- * <strong>Note:</strong> This method uses the fElementQName variable.
- * The contents of this variable will be destroyed. The caller should
- * copy the needed information out of this variable before calling
- * this method.
- *
- * @returns The element depth.
- */
- protected int scanEndElement() throws IOException, XNIException {
- if (DEBUG_CONTENT_SCANNING) System.out.println(">>> scanEndElement()");
-
- // name
- if (fNamespaces) {
- if (!fEntityScanner.scanQName(fElementQName)) {
- fElementQName.clear();
- }
- }
- else {
- String name = fEntityScanner.scanName();
- fElementQName.setValues(null, name, name, null);
- }
-
- // end
- fEntityScanner.skipSpaces();
- if (!fEntityScanner.skipChar('>')) {
- reportFatalError("ETagUnterminated",
- new Object[]{fElementQName.rawname});
- }
- fMarkupDepth--;
-
- // handle end element
- int depth = handleEndElement(fElementQName, false);
- if (DEBUG_CONTENT_SCANNING) System.out.println("<<< scanEndElement(): "+depth);
- return depth;
-
- } // scanEndElement():int
-
- /**
- * Scans a character reference.
- * <p>
- * <pre>
- * [66] CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';'
- * </pre>
- */
- protected void scanCharReference()
- throws IOException, XNIException {
-
- fStringBuffer2.clear();
- int ch = scanCharReferenceValue(fStringBuffer2);
- fMarkupDepth--;
- if (ch != -1) {
- // call handler
- if (fDocumentHandler != null) {
- if (fNotifyCharRefs) {
- fDocumentHandler.startEntity(fCharRefLiteral, null,
- null, null, null);
- }
- fDocumentHandler.characters(fStringBuffer2);
- if (fNotifyCharRefs) {
- fDocumentHandler.endEntity(fCharRefLiteral);
- }
- }
- }
-
- } // scanCharReference()
-
- /**
- * Scans an entity reference.
- *
- * @throws IOException Thrown if i/o error occurs.
- * @throws XNIException Thrown if handler throws exception upon
- * notification.
- */
- protected void scanEntityReference() throws IOException, XNIException {
-
- // name
- String name = fEntityScanner.scanName();
- if (name == null) {
- reportFatalError("NameRequiredInReference", null);
- }
-
- // end
- if (!fEntityScanner.skipChar(';')) {
- reportFatalError("SemicolonRequiredInReference", null);
- }
- fMarkupDepth--;
-
- // handle built-in entities
- if (name == fAmpSymbol) {
- handleCharacter('&', fAmpSymbol);
- }
- else if (name == fLtSymbol) {
- handleCharacter('<', fLtSymbol);
- }
- else if (name == fGtSymbol) {
- handleCharacter('>', fGtSymbol);
- }
- else if (name == fQuotSymbol) {
- handleCharacter('"', fQuotSymbol);
- }
- else if (name == fAposSymbol) {
- handleCharacter('\'', fAposSymbol);
- }
- // start general entity
- else if (fEntityManager.isUnparsedEntity(name)) {
- reportFatalError("ReferenceToUnparsedEntity", new Object[]{name});
- }
- else {
- if (!fEntityManager.isDeclaredEntity(name)) {
- //REVISIT: one more case needs to be included: external PE and standalone is no
- if ( fHasExternalDTD && !fStandalone) {
- if (fValidation)
- fErrorReporter.reportError( XMLMessageFormatter.XML_DOMAIN,"EntityNotDeclared",
- new Object[]{name}, XMLErrorReporter.SEVERITY_ERROR);
- }
- else
- reportFatalError("EntityNotDeclared", new Object[]{name});
- }
- fEntityManager.startEntity(name, false);
- }
-
- } // scanEntityReference()
-
- // utility methods
-
- /**
- * Calls document handler with a single character resulting from
- * built-in entity resolution.
- *
- * @param c
- * @param entity built-in name
- */
- private void handleCharacter(char c, String entity) throws XNIException {
- if (fDocumentHandler != null) {
- if (fNotifyBuiltInRefs) {
- fDocumentHandler.startEntity(entity, null, null, null, null);
- }
-
- fSingleChar[0] = c;
- fString.setValues(fSingleChar, 0, 1);
- fDocumentHandler.characters(fString);
-
- if (fNotifyBuiltInRefs) {
- fDocumentHandler.endEntity(entity);
- }
- }
- } // handleCharacter(char)
-
- /**
- * Handles the end element. This method will make sure that
- * the end element name matches the current element and notify
- * the handler about the end of the element and the end of any
- * relevent prefix mappings.
- * <p>
- * <strong>Note:</strong> This method uses the fQName variable.
- * The contents of this variable will be destroyed.
- *
- * @param element The element.
- *
- * @returns The element depth.
- *
- * @throws XNIException Thrown if the handler throws a SAX exception
- * upon notification.
- *
- */
- protected int handleEndElement(QName element, boolean isEmpty)
- throws XNIException {
-
- fMarkupDepth--;
- // check that this element was opened in the same entity
- if (fMarkupDepth < fEntityStack[fEntityDepth - 1]) {
- reportFatalError("ElementEntityMismatch",
- new Object[]{fCurrentElement.rawname});
- }
- // make sure the elements match
- QName startElement = fQName;
- fElementStack.popElement(startElement);
- if (element.rawname != startElement.rawname) {
- reportFatalError("ETagRequired",
- new Object[]{startElement.rawname});
- }
-
- // bind namespaces
- if (fNamespaces) {
- element.uri = startElement.uri;
- }
-
- // call handler
- if (fDocumentHandler != null && !isEmpty) {
- fDocumentHandler.endElement(element);
- }
-
- return fMarkupDepth;
-
- } // callEndElement(QName,boolean):int
-
- // helper methods
-
- /**
- * Sets the scanner state.
- *
- * @param state The new scanner state.
- */
- protected final void setScannerState(int state) {
-
- fScannerState = state;
- if (DEBUG_SCANNER_STATE) {
- System.out.print("### setScannerState: ");
- System.out.print(getScannerStateName(state));
- System.out.println();
- }
-
- } // setScannerState(int)
-
- /**
- * Sets the dispatcher.
- *
- * @param dispatcher The new dispatcher.
- */
- protected final void setDispatcher(Dispatcher dispatcher) {
- fDispatcher = dispatcher;
- if (DEBUG_DISPATCHER) {
- System.out.print("%%% setDispatcher: ");
- System.out.print(getDispatcherName(dispatcher));
- System.out.println();
- }
- }
-
//
// Private methods
//
/** Returns the scanner state name. */
- private static String getScannerStateName(int state) {
+ protected String getScannerStateName(int state) {
- if (DEBUG_SCANNER_STATE) {
- switch (state) {
- case SCANNER_STATE_XML_DECL: return "SCANNER_STATE_XML_DECL";
- case SCANNER_STATE_START_OF_MARKUP: return "SCANNER_STATE_START_OF_MARKUP";
- case SCANNER_STATE_COMMENT: return "SCANNER_STATE_COMMENT";
- case SCANNER_STATE_PI: return "SCANNER_STATE_PI";
- case SCANNER_STATE_DOCTYPE: return "SCANNER_STATE_DOCTYPE";
- case SCANNER_STATE_PROLOG: return "SCANNER_STATE_PROLOG";
- case SCANNER_STATE_ROOT_ELEMENT: return "SCANNER_STATE_ROOT_ELEMENT";
- case SCANNER_STATE_CONTENT: return "SCANNER_STATE_CONTENT";
- case SCANNER_STATE_REFERENCE: return "SCANNER_STATE_REFERENCE";
- case SCANNER_STATE_TRAILING_MISC: return "SCANNER_STATE_TRAILING_MISC";
- case SCANNER_STATE_END_OF_INPUT: return "SCANNER_STATE_END_OF_INPUT";
- case SCANNER_STATE_TERMINATED: return "SCANNER_STATE_TERMINATED";
- case SCANNER_STATE_CDATA: return "SCANNER_STATE_CDATA";
- case SCANNER_STATE_TEXT_DECL: return "SCANNER_STATE_TEXT_DECL";
- case SCANNER_STATE_DTD_INTERNAL_DECLS: return "SCANNER_STATE_DTD_INTERNAL_DECLS";
- case SCANNER_STATE_DTD_EXTERNAL: return "SCANNER_STATE_DTD_EXTERNAL";
- case SCANNER_STATE_DTD_EXTERNAL_DECLS: return "SCANNER_STATE_DTD_EXTERNAL_DECLS";
- }
+ switch (state) {
+ case SCANNER_STATE_XML_DECL: return "SCANNER_STATE_XML_DECL";
+ case SCANNER_STATE_PROLOG: return "SCANNER_STATE_PROLOG";
+ case SCANNER_STATE_TRAILING_MISC: return "SCANNER_STATE_TRAILING_MISC";
+ case SCANNER_STATE_DTD_INTERNAL_DECLS: return "SCANNER_STATE_DTD_INTERNAL_DECLS";
+ case SCANNER_STATE_DTD_EXTERNAL: return "SCANNER_STATE_DTD_EXTERNAL";
+ case SCANNER_STATE_DTD_EXTERNAL_DECLS: return "SCANNER_STATE_DTD_EXTERNAL_DECLS";
}
-
- return "??? ("+state+')';
+ return super.getScannerStateName(state);
} // getScannerStateName(int):String
- /** Returns the dispatcher name. */
- public String getDispatcherName(Dispatcher dispatcher) {
-
- if (DEBUG_DISPATCHER) {
- if (dispatcher != null) {
- String name = dispatcher.getClass().getName();
- int index = name.lastIndexOf('.');
- if (index != -1) {
- name = name.substring(index + 1);
- index = name.lastIndexOf('$');
- if (index != -1) {
- name = name.substring(index + 1);
- }
- }
- return name;
- }
- }
- return "null";
-
- } // getDispatcherName():String
-
//
// Classes
//
/**
- * Element stack. This stack operates without synchronization, error
- * checking, and it re-uses objects instead of throwing popped items
- * away.
- *
- * @author Andy Clark, IBM
- */
- protected static class ElementStack {
-
- //
- // Data
- //
-
- /** The stack data. */
- protected QName[] fElements;
-
- /** The size of the stack. */
- protected int fSize;
-
- //
- // Constructors
- //
-
- /** Default constructor. */
- public ElementStack() {
- fElements = new QName[10];
- for (int i = 0; i < fElements.length; i++) {
- fElements[i] = new QName();
- }
- } // <init>()
-
- //
- // Public methods
- //
-
- /**
- * Pushes an element on the stack.
- * <p>
- * <strong>Note:</strong> The QName values are copied into the
- * stack. In other words, the caller does <em>not</em> orphan
- * the element to the stack. Also, the QName object returned
- * is <em>not</em> orphaned to the caller. It should be
- * considered read-only.
- *
- * @param element The element to push onto the stack.
- *
- * @return Returns the actual QName object that stores the
- */
- public QName pushElement(QName element) {
- if (fSize == fElements.length) {
- QName[] array = new QName[fElements.length * 2];
- System.arraycopy(fElements, 0, array, 0, fSize);
- fElements = array;
- for (int i = fSize; i < fElements.length; i++) {
- fElements[i] = new QName();
- }
- }
- fElements[fSize].setValues(element);
- return fElements[fSize++];
- } // pushElement(QName):QName
-
- /**
- * Pops an element off of the stack by setting the values of
- * the specified QName.
- * <p>
- * <strong>Note:</strong> The object returned is <em>not</em>
- * orphaned to the caller. Therefore, the caller should consider
- * the object to be read-only.
- */
- public void popElement(QName element) {
- element.setValues(fElements[--fSize]);
- } // popElement(QName)
-
- /** Clears the stack without throwing away existing QName objects. */
- public void clear() {
- fSize = 0;
- } // clear()
-
- } // class ElementStack
-
- /**
- * This interface defines an XML "event" dispatching model. Classes
- * that implement this interface are responsible for scanning parts
- * of the XML document and dispatching callbacks.
- *
- * @author Glenn Marcy, IBM
- */
- protected interface Dispatcher {
-
- //
- // Dispatcher methods
- //
-
- /**
- * Dispatch an XML "event".
- *
- * @param complete True if this dispatcher is intended to scan
- * and dispatch as much as possible.
- *
- * @returns True if there is more to dispatch either from this
- * or a another dispatcher.
- *
- * @throws IOException Thrown on i/o error.
- * @throws XNIException Thrown on parse error.
- */
- public boolean dispatch(boolean complete)
- throws IOException, XNIException;
-
- } // interface Dispatcher
-
- /**
* Dispatcher to handle XMLDecl scanning.
*
* @author Andy Clark, IBM
@@ -1791,202 +849,96 @@
* @author Eric Ye, IBM
*/
protected final class ContentDispatcher
- implements Dispatcher {
+ extends FragmentContentDispatcher {
//
- // Dispatcher methods
+ // Protected methods
//
+ // hooks
+
+ // NOTE: These hook methods are added so that the full document
+ // scanner can share the majority of code with this class.
+
/**
- * Dispatch an XML "event".
- *
- * @param complete True if this dispatcher is intended to scan
- * and dispatch as much as possible.
- *
- * @returns True if there is more to dispatch either from this
- * or a another dispatcher.
- *
- * @throws IOException Thrown on i/o error.
- * @throws XNIException Thrown on parse error.
+ * Scan for DOCTYPE hook. This method is a hook for subclasses
+ * to add code to handle scanning for a the "DOCTYPE" string
+ * after the string "<!" has been scanned.
+ *
+ * @returns True if the "DOCTYPE" was scanned; false if "DOCTYPE"
+ * was not scanned.
*/
- public boolean dispatch(boolean complete)
+ protected boolean scanForDoctypeHook()
throws IOException, XNIException {
- try {
- boolean again;
- do {
- again = false;
- switch (fScannerState) {
- case SCANNER_STATE_CONTENT: {
- if (fEntityScanner.skipChar('<')) {
- setScannerState(SCANNER_STATE_START_OF_MARKUP);
- again = true;
- }
- else if (fEntityScanner.skipChar('&')) {
- setScannerState(SCANNER_STATE_REFERENCE);
- again = true;
- }
- else {
- do {
- int c = scanContent();
- if (c == '<') {
- fEntityScanner.scanChar();
- setScannerState(SCANNER_STATE_START_OF_MARKUP);
- break;
- }
- else if (c == '&') {
- fEntityScanner.scanChar();
- setScannerState(SCANNER_STATE_REFERENCE);
- break;
- }
- else if (c != -1 && XMLChar.isInvalid(c)) {
- if (XMLChar.isHighSurrogate(c)) {
- // special case: surrogates
- fStringBuffer.clear();
- if (scanSurrogates(fStringBuffer)) {
- // call handler
- if (fDocumentHandler != null) {
- fDocumentHandler.characters(fStringBuffer);
- }
- }
- }
- else {
- reportFatalError("InvalidCharInContent",
- new Object[] {
- Integer.toString(c, 16)});
- fEntityScanner.scanChar();
- }
- }
- } while (complete);
- }
- break;
- }
- case SCANNER_STATE_START_OF_MARKUP: {
- fMarkupDepth++;
- if (fEntityScanner.skipChar('?')) {
- setScannerState(SCANNER_STATE_PI);
- again = true;
- }
- else if (fEntityScanner.skipChar('!')) {
- if (fEntityScanner.skipChar('-')) {
- if (!fEntityScanner.skipChar('-')) {
- reportFatalError("InvalidCommentStart",
- null);
- }
- setScannerState(SCANNER_STATE_COMMENT);
- again = true;
- }
- else if (fEntityScanner.skipString("[CDATA[")) {
- setScannerState(SCANNER_STATE_CDATA);
- again = true;
- }
- else if (fEntityScanner.skipString("DOCTYPE")) {
- setScannerState(SCANNER_STATE_DOCTYPE);
- }
- else {
- reportFatalError("MarkupNotRecognizedInContent",
- null);
- }
- }
- else if (fEntityScanner.skipChar('/')) {
- if (scanEndElement() == 0) {
- setScannerState(SCANNER_STATE_TRAILING_MISC);
- setDispatcher(fTrailingMiscDispatcher);
- return true;
- }
- setScannerState(SCANNER_STATE_CONTENT);
- }
- else if (XMLChar.isNameStart(fEntityScanner.peekChar())) {
- scanStartElement();
- setScannerState(SCANNER_STATE_CONTENT);
- }
- else {
- reportFatalError("MarkupNotRecognizedInContent",
- null);
- }
- break;
- }
- case SCANNER_STATE_COMMENT: {
- scanComment();
- setScannerState(SCANNER_STATE_CONTENT);
- break;
- }
- case SCANNER_STATE_PI: {
- scanPI();
- setScannerState(SCANNER_STATE_CONTENT);
- break;
- }
- case SCANNER_STATE_CDATA: {
- scanCDATASection(complete);
- setScannerState(SCANNER_STATE_CONTENT);
- break;
- }
- case SCANNER_STATE_REFERENCE: {
- fMarkupDepth++;
- // NOTE: We need to set the state beforehand
- // because the XMLEntityHandler#startEntity
- // callback could set the state to
- // SCANNER_STATE_TEXT_DECL and we don't want
- // to override that scanner state.
- setScannerState(SCANNER_STATE_CONTENT);
- if (fEntityScanner.skipChar('#')) {
- scanCharReference();
- }
- else {
- scanEntityReference();
- }
- break;
- }
- case SCANNER_STATE_TEXT_DECL: {
- // scan text decl
- if (fEntityScanner.skipString("<?xml")) {
- fMarkupDepth++;
- // NOTE: special case where entity starts with a PI
- // whose name starts with "xml" (e.g. "xmlfoo")
- if (XMLChar.isName(fEntityScanner.peekChar())) {
- fStringBuffer.clear();
- fStringBuffer.append("xml");
- while (XMLChar.isName(fEntityScanner.peekChar())) {
- fStringBuffer.append((char)fEntityScanner.scanChar());
- }
- String target = fSymbolTable.addSymbol(fStringBuffer.ch, fStringBuffer.offset, fStringBuffer.length);
- scanPIData(target, fString);
- }
-
- // standard text declaration
- else {
- scanXMLDeclOrTextDecl(true);
- }
- }
- setScannerState(SCANNER_STATE_CONTENT);
- break;
- }
- case SCANNER_STATE_ROOT_ELEMENT: {
- if (scanStartElement()) {
- setScannerState(SCANNER_STATE_TRAILING_MISC);
- setDispatcher(fTrailingMiscDispatcher);
- return true;
- }
- setScannerState(SCANNER_STATE_CONTENT);
- break;
- }
- case SCANNER_STATE_DOCTYPE: {
- reportFatalError("DoctypeIllegalInContent",
- null);
- }
- }
- } while (complete || again);
- }
-
- // premature end of file
- catch (EOFException e) {
- reportFatalError("PrematureEOF", null);
- throw e;
+ if (fEntityScanner.skipString("DOCTYPE")) {
+ setScannerState(SCANNER_STATE_DOCTYPE);
+ return true;
}
+ return false;
+ } // scanForDoctypeHook():boolean
+
+ /**
+ * Element depth iz zero. This methos is a hook for subclasses
+ * to add code to handle when the element depth hits zero. When
+ * scanning a document fragment, an element depth of zero is
+ * normal. However, when scanning a full XML document, the
+ * scanner must handle the trailing miscellanous section of
+ * the document after the end of the document's root element.
+ *
+ * @returns True if the caller should stop and return true which
+ * allows the scanner to switch to a new scanning
+ * dispatcher. A return value of false indicates that
+ * the content dispatcher should continue as normal.
+ */
+ protected boolean elementDepthIsZeroHook()
+ throws IOException, XNIException {
+
+ setScannerState(SCANNER_STATE_TRAILING_MISC);
+ setDispatcher(fTrailingMiscDispatcher);
return true;
- } // dispatch(boolean):boolean
+ } // elementDepthIsZeroHook():boolean
+
+ /**
+ * Scan for root element hook. This method is a hook for
+ * subclasses to add code that handles scanning for the root
+ * element. When scanning a document fragment, there is no
+ * "root" element. However, when scanning a full XML document,
+ * the scanner must handle the root element specially.
+ *
+ * @returns True if the caller should stop and return true which
+ * allows the scanner to switch to a new scanning
+ * dispatcher. A return value of false indicates that
+ * the content dispatcher should continue as normal.
+ */
+ protected boolean scanRootElementHook()
+ throws IOException, XNIException {
+
+ if (scanStartElement()) {
+ setScannerState(SCANNER_STATE_TRAILING_MISC);
+ setDispatcher(fTrailingMiscDispatcher);
+ return true;
+ }
+ return false;
+
+ } // scanRootElementHook():boolean
+
+ /**
+ * End of file hook. This method is a hook for subclasses to
+ * add code that handles the end of file. The end of file in
+ * a document fragment is OK if the markup depth is zero.
+ * However, when scanning a full XML document, an end of file
+ * is always premature.
+ */
+ protected void endOfFileHook(EOFException e)
+ throws IOException, XNIException {
+
+ reportFatalError("PrematureEOF", null);
+ throw e;
+
+ } // endOfFileHook()
} // class ContentDispatcher
1.1 xml-xerces/java/src/org/apache/xerces/impl/XMLDocumentFragmentScannerImpl.java
Index: XMLDocumentFragmentScannerImpl.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 1999,2000,2001 The Apache Software Foundation.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 1999, International
* Business Machines, Inc., http://www.apache.org. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.xerces.impl;
import java.io.EOFException;
import java.io.IOException;
import java.util.Stack;
import org.apache.xerces.impl.XMLEntityManager;
import org.apache.xerces.impl.XMLEntityScanner;
import org.apache.xerces.impl.XMLErrorReporter;
import org.apache.xerces.impl.msg.XMLMessageFormatter;
import org.apache.xerces.util.XMLAttributesImpl;
import org.apache.xerces.util.XMLStringBuffer;
import org.apache.xerces.util.SymbolTable;
import org.apache.xerces.util.XMLChar;
import org.apache.xerces.xni.QName;
import org.apache.xerces.xni.XMLAttributes;
import org.apache.xerces.xni.XMLDocumentHandler;
import org.apache.xerces.xni.XMLString;
import org.apache.xerces.xni.XNIException;
import org.apache.xerces.xni.parser.XMLComponent;
import org.apache.xerces.xni.parser.XMLComponentManager;
import org.apache.xerces.xni.parser.XMLConfigurationException;
import org.apache.xerces.xni.parser.XMLDocumentScanner;
import org.apache.xerces.xni.parser.XMLDTDScanner;
import org.apache.xerces.xni.parser.XMLInputSource;
/**
* This class is responsible for scanning the structure and content
* of document fragments. The scanner acts as the source for the
* document information which is communicated to the document handler.
* <p>
* This component requires the following features and properties from the
* component manager that uses it:
* <ul>
* <li>http://xml.org/sax/features/namespaces</li>
* <li>http://xml.org/sax/features/validation</li>
* <li>http://apache.org/xml/features/scanner/notify-char-refs</li>
* <li>http://apache.org/xml/features/scanner/notify-builtin-refs</li>
* <li>http://apache.org/xml/properties/internal/symbol-table</li>
* <li>http://apache.org/xml/properties/internal/error-reporter</li>
* <li>http://apache.org/xml/properties/internal/entity-manager</li>
* </ul>
*
* @author Glenn Marcy, IBM
* @author Stubs generated by DesignDoc on Mon Sep 11 11:10:57 PDT 2000
* @author Andy Clark, IBM
* @author Arnaud Le Hors, IBM
* @author Eric Ye, IBM
*
* @version $Id: XMLDocumentFragmentScannerImpl.java,v 1.1 2001/08/28 08:51:47 andyc Exp $
*/
public class XMLDocumentFragmentScannerImpl
extends XMLScanner
implements XMLDocumentScanner, XMLComponent, XMLEntityHandler {
//
// Constants
//
// scanner states
/** Scanner state: start of markup. */
protected static final int SCANNER_STATE_START_OF_MARKUP = 1;
/** Scanner state: comment. */
protected static final int SCANNER_STATE_COMMENT = 2;
/** Scanner state: processing instruction. */
protected static final int SCANNER_STATE_PI = 3;
/** Scanner state: DOCTYPE. */
protected static final int SCANNER_STATE_DOCTYPE = 4;
/** Scanner state: root element. */
protected static final int SCANNER_STATE_ROOT_ELEMENT = 6;
/** Scanner state: content. */
protected static final int SCANNER_STATE_CONTENT = 7;
/** Scanner state: reference. */
protected static final int SCANNER_STATE_REFERENCE = 8;
/** Scanner state: end of input. */
protected static final int SCANNER_STATE_END_OF_INPUT = 13;
/** Scanner state: terminated. */
protected static final int SCANNER_STATE_TERMINATED = 14;
/** Scanner state: CDATA section. */
protected static final int SCANNER_STATE_CDATA = 15;
/** Scanner state: Text declaration. */
protected static final int SCANNER_STATE_TEXT_DECL = 16;
// feature identifiers
/** Feature identifier: namespaces. */
protected static final String NAMESPACES =
Constants.SAX_FEATURE_PREFIX + Constants.NAMESPACES_FEATURE;
/** Feature identifier: notify built-in refereces. */
protected static final String NOTIFY_BUILTIN_REFS =
Constants.XERCES_FEATURE_PREFIX + Constants.NOTIFY_BUILTIN_REFS_FEATURE;
// recognized features and properties
/** Recognized features. */
private static final String[] RECOGNIZED_FEATURES = {
NAMESPACES,
VALIDATION,
NOTIFY_BUILTIN_REFS,
NOTIFY_CHAR_REFS,
};
/** Recognized properties. */
private static final String[] RECOGNIZED_PROPERTIES = {
SYMBOL_TABLE,
ERROR_REPORTER,
ENTITY_MANAGER,
};
// debugging
/** Debug scanner state. */
private static final boolean DEBUG_SCANNER_STATE = false;
/** Debug dispatcher. */
private static final boolean DEBUG_DISPATCHER = false;
/** Debug content dispatcher scanning. */
private static final boolean DEBUG_CONTENT_SCANNING = false;
//
// Data
//
// protected data
/** Document handler. */
protected XMLDocumentHandler fDocumentHandler;
/** Entity stack. */
protected int[] fEntityStack = new int[4];
/** Markup depth. */
protected int fMarkupDepth;
/** Scanner state. */
protected int fScannerState;
/** has external dtd */
protected boolean fHasExternalDTD;
/** Standalone. */
protected boolean fStandalone;
// element information
/** Current element. */
protected QName fCurrentElement;
/** Element stack. */
protected ElementStack fElementStack = new ElementStack();
// other info
/** Document system identifier. */
protected String fDocumentSystemId;
// features
/** Namespaces. */
protected boolean fNamespaces;
/** Notify built-in references. */
protected boolean fNotifyBuiltInRefs = false;
// dispatchers
/** Active dispatcher. */
protected Dispatcher fDispatcher;
/** Content dispatcher. */
protected Dispatcher fContentDispatcher = createContentDispatcher();
// private data
/** Element QName. */
private QName fElementQName = new QName();
/** Attribute QName. */
private QName fAttributeQName = new QName();
/** Another QName. */
private QName fQName = new QName();
/** Element attributes. */
private XMLAttributesImpl fAttributes = new XMLAttributesImpl();
/** Single character array. */
private final char[] fSingleChar = new char[1];
/** External entity. */
private XMLEntityManager.ExternalEntity fExternalEntity = new XMLEntityManager.ExternalEntity();
// symbols
/** Symbol: "CDATA". */
private String fCDATASymbol;
//
// Constructors
//
/** Default constructor. */
public XMLDocumentFragmentScannerImpl() {} // <init>()
//
// XMLDocumentScanner methods
//
/**
* Sets the input source.
*
* @param inputSource The input source.
*
* @throws IOException Thrown on i/o error.
*/
public void setInputSource(XMLInputSource inputSource) throws IOException {
fEntityManager.setEntityHandler(this);
fEntityManager.startEntity("$fragment$", inputSource, false);
fDocumentSystemId = fEntityManager.expandSystemId(inputSource.getSystemId());
} // setInputSource(XMLInputSource)
/**
* Scans a document.
*
* @param complete True if the scanner should scan the document
* completely, pushing all events to the registered
* document handler. A value of false indicates that
* that the scanner should only scan the next portion
* of the document and return. A scanner instance is
* permitted to completely scan a document if it does
* not support this "pull" scanning model.
*
* @returns True if there is more to scan, false otherwise.
*/
public boolean scanDocument(boolean complete)
throws IOException, XNIException {
// keep dispatching "events"
fEntityManager.setEntityHandler(this);
do {
if (!fDispatcher.dispatch(complete)) {
return false;
}
} while (complete);
// return success
return true;
} // scanDocument(boolean):boolean
//
// XMLComponent methods
//
/**
* Resets the component. The component can query the component manager
* about any features and properties that affect the operation of the
* component.
*
* @param componentManager The component manager.
*
* @throws SAXException Thrown by component on initialization error.
* For example, if a feature or property is
* required for the operation of the component, the
* component manager may throw a
* SAXNotRecognizedException or a
* SAXNotSupportedException.
*/
public void reset(XMLComponentManager componentManager)
throws XMLConfigurationException {
super.reset(componentManager);
// other settings
fDocumentSystemId = null;
// sax features
try {
fNamespaces = componentManager.getFeature(NAMESPACES);
}
catch (XMLConfigurationException e) {
fNamespaces = true;
}
fAttributes.setNamespaces(fNamespaces);
// xerces features
try {
fNotifyBuiltInRefs = componentManager.getFeature(NOTIFY_BUILTIN_REFS);
}
catch (XMLConfigurationException e) {
fNotifyBuiltInRefs = false;
}
// initialize vars
fMarkupDepth = 0;
fCurrentElement = null;
fElementStack.clear();
fHasExternalDTD = false;
fStandalone = false;
// create symbols
fCDATASymbol = fSymbolTable.addSymbol("CDATA");
// setup dispatcher
setScannerState(SCANNER_STATE_CONTENT);
setDispatcher(fContentDispatcher);
} // reset(XMLComponentManager)
/**
* Returns a list of feature identifiers that are recognized by
* this component. This method may return null if no features
* are recognized by this component.
*/
public String[] getRecognizedFeatures() {
return RECOGNIZED_FEATURES;
} // getRecognizedFeatures():String[]
/**
* Sets the state of a feature. This method is called by the component
* manager any time after reset when a feature changes state.
* <p>
* <strong>Note:</strong> Components should silently ignore features
* that do not affect the operation of the component.
*
* @param featureId The feature identifier.
* @param state The state of the feature.
*
* @throws SAXNotRecognizedException The component should not throw
* this exception.
* @throws SAXNotSupportedException The component should not throw
* this exception.
*/
public void setFeature(String featureId, boolean state)
throws XMLConfigurationException {
super.setFeature(featureId, state);
// Xerces properties
if (featureId.startsWith(Constants.XERCES_FEATURE_PREFIX)) {
String feature = featureId.substring(Constants.XERCES_FEATURE_PREFIX.length());
if (feature.equals(Constants.NOTIFY_BUILTIN_REFS_FEATURE)) {
fNotifyCharRefs = state;
}
}
} // setFeature(String,boolean)
/**
* Returns a list of property identifiers that are recognized by
* this component. This method may return null if no properties
* are recognized by this component.
*/
public String[] getRecognizedProperties() {
return RECOGNIZED_PROPERTIES;
} // getRecognizedProperties():String[]
/**
* Sets the value of a property. This method is called by the component
* manager any time after reset when a property changes value.
* <p>
* <strong>Note:</strong> Components should silently ignore properties
* that do not affect the operation of the component.
*
* @param propertyId The property identifier.
* @param value The value of the property.
*
* @throws SAXNotRecognizedException The component should not throw
* this exception.
* @throws SAXNotSupportedException The component should not throw
* this exception.
*/
public void setProperty(String propertyId, Object value)
throws XMLConfigurationException {
super.setProperty(propertyId, value);
// Xerces properties
if (propertyId.startsWith(Constants.XERCES_PROPERTY_PREFIX)) {
String property = propertyId.substring(Constants.XERCES_PROPERTY_PREFIX.length());
if (property.equals(Constants.ENTITY_MANAGER_PROPERTY)) {
fEntityManager = (XMLEntityManager)value;
}
return;
}
} // setProperty(String,Object)
//
// XMLDocumentSource methods
//
/**
* setDocumentHandler
*
* @param documentHandler
*/
public void setDocumentHandler(XMLDocumentHandler documentHandler) {
fDocumentHandler = documentHandler;
} // setDocumentHandler(XMLDocumentHandler)
//
// XMLEntityHandler methods
//
/**
* This method notifies of the start of an entity. The DTD has the
* pseudo-name of "[dtd]; parameter entity names start with '%'; and
* general entities are just specified by their name.
*
* @param name The name of the entity.
* @param publicId The public identifier of the entity if the entity
* is external, null otherwise.
* @param systemId The system identifier of the entity if the entity
* is external, null otherwise.
* @param baseSystemId The base system identifier of the entity if
* the entity is external, null otherwise.
* @param encoding The auto-detected IANA encoding name of the entity
* stream. This value will be null in those situations
* where the entity encoding is not auto-detected (e.g.
* internal entities or a document entity that is
* parsed from a java.io.Reader).
*
* @throws XNIException Thrown by handler to signal an error.
*/
public void startEntity(String name,
String publicId, String systemId,
String baseSystemId,
String encoding) throws XNIException {
// keep track of this entity before fEntityDepth is increased
if (fEntityDepth == fEntityStack.length) {
int[] entityarray = new int[fEntityStack.length * 2];
System.arraycopy(fEntityStack, 0, entityarray, 0, fEntityStack.length);
fEntityStack = entityarray;
}
fEntityStack[fEntityDepth] = fMarkupDepth;
super.startEntity(name, publicId, systemId, baseSystemId, encoding);
// call handler
if (fDocumentHandler != null) {
if (!name.equals("[xml]") && !fScanningAttribute) {
fDocumentHandler.startEntity(name, publicId, systemId,
baseSystemId, encoding);
}
}
} // startEntity(String,String,String,String,String)
/**
* This method notifies the end of an entity. The DTD has the pseudo-name
* of "[dtd]; parameter entity names start with '%'; and general entities
* are just specified by their name.
*
* @param name The name of the entity.
*
* @throws XNIException Thrown by handler to signal an error.
*/
public void endEntity(String name) throws XNIException {
super.endEntity(name);
// make sure markup is properly balanced
if (fMarkupDepth != fEntityStack[fEntityDepth]) {
reportFatalError("MarkupEntityMismatch", null);
}
// call handler
if (fDocumentHandler != null) {
if (!name.equals("[xml]") && !fScanningAttribute) {
fDocumentHandler.endEntity(name);
}
}
} // endEntity(String)
//
// Protected methods
//
// dispatcher factory methods
/** Creates a content dispatcher. */
protected Dispatcher createContentDispatcher() {
return new FragmentContentDispatcher();
} // createContentDispatcher():Dispatcher
// scanning methods
/**
* Scans an XML or text declaration.
* <p>
* <pre>
* [23] XMLDecl ::= '<?xml' VersionInfo EncodingDecl? SDDecl? S? '?>'
* [24] VersionInfo ::= S 'version' Eq (' VersionNum ' | " VersionNum ")
* [80] EncodingDecl ::= S 'encoding' Eq ('"' EncName '"' | "'" EncName "'" )
* [81] EncName ::= [A-Za-z] ([A-Za-z0-9._] | '-')*
* [32] SDDecl ::= S 'standalone' Eq (("'" ('yes' | 'no') "'")
* | ('"' ('yes' | 'no') '"'))
*
* [77] TextDecl ::= '<?xml' VersionInfo? EncodingDecl S? '?>'
* </pre>
*
* @param scanningTextDecl True if a text declaration is to
* be scanned instead of an XML
* declaration.
*/
protected void scanXMLDeclOrTextDecl(boolean scanningTextDecl)
throws IOException, XNIException {
// scan decl
super.scanXMLDeclOrTextDecl(scanningTextDecl, fStrings);
fMarkupDepth--;
// pseudo-attribute values
String version = fStrings[0];
String encoding = fStrings[1];
String standalone = fStrings[2];
// set standalone
fStandalone = standalone != null && standalone.equals("yes");
fEntityManager.setStandalone(fStandalone);
// call handler
if (fDocumentHandler != null) {
if (scanningTextDecl) {
fDocumentHandler.textDecl(version, encoding);
}
else {
fDocumentHandler.xmlDecl(version, encoding, standalone);
}
}
// set encoding on reader
if (encoding != null) {
fEntityScanner.setEncoding(encoding);
}
} // scanXMLDeclOrTextDecl(boolean)
/**
* Scans a processing data. This is needed to handle the situation
* where a document starts with a processing instruction whose
* target name <em>starts with</em> "xml". (e.g. xmlfoo)
*
* @param target The PI target
* @param data The string to fill in with the data
*/
protected void scanPIData(String target, XMLString data)
throws IOException, XNIException {
super.scanPIData(target, data);
fMarkupDepth--;
// call handler
if (fDocumentHandler != null) {
fDocumentHandler.processingInstruction(target, data);
}
} // scanPIData(String)
/**
* Scans a comment.
* <p>
* <pre>
* [15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'
* </pre>
* <p>
* <strong>Note:</strong> Called after scanning past '<!--'
*/
protected void scanComment() throws IOException, XNIException {
scanComment(fStringBuffer);
fMarkupDepth--;
// call handler
if (fDocumentHandler != null) {
fDocumentHandler.comment(fStringBuffer);
}
} // scanComment()
/**
* Scans a start element. This method will handle the binding of
* namespace information and notifying the handler of the start
* of the element.
* <p>
* <pre>
* [44] EmptyElemTag ::= '<' Name (S Attribute)* S? '/>'
* [40] STag ::= '<' Name (S Attribute)* S? '>'
* </pre>
* <p>
* <strong>Note:</strong> This method assumes that the leading
* '<' character has been consumed.
* <p>
* <strong>Note:</strong> This method uses the fElementQName and
* fAttributes variables. The contents of these variables will be
* destroyed. The caller should copy important information out of
* these variables before calling this method.
*
* @returns True if element is empty. (i.e. It matches
* production [44].
*/
protected boolean scanStartElement()
throws IOException, XNIException {
if (DEBUG_CONTENT_SCANNING) System.out.println(">>> scanStartElement()");
// name
if (fNamespaces) {
fEntityScanner.scanQName(fElementQName);
}
else {
String name = fEntityScanner.scanName();
fElementQName.setValues(null, name, name, null);
}
String rawname = fElementQName.rawname;
// push element stack
fCurrentElement = fElementStack.pushElement(fElementQName);
// attributes
boolean empty = false;
fAttributes.removeAllAttributes();
do {
// spaces
boolean sawSpace = fEntityScanner.skipSpaces();
// end tag?
int c = fEntityScanner.peekChar();
if (c == '>') {
fEntityScanner.scanChar();
break;
}
else if (c == '/') {
fEntityScanner.scanChar();
if (!fEntityScanner.skipChar('>')) {
reportFatalError("ElementUnterminated",
new Object[]{rawname});
}
empty = true;
break;
}
else if (!XMLChar.isNameStart(c) || !sawSpace) {
reportFatalError("ElementUnterminated", new Object[]{rawname});
}
// attributes
scanAttribute(fAttributes);
} while (true);
// call handler
if (fDocumentHandler != null) {
if (empty) {
fDocumentHandler.emptyElement(fElementQName, fAttributes);
handleEndElement(fElementQName, true);
}
else {
fDocumentHandler.startElement(fElementQName, fAttributes);
}
}
if (DEBUG_CONTENT_SCANNING) System.out.println("<<< scanStartElement(): "+empty);
return empty;
} // scanStartElement():boolean
/**
* Scans an attribute.
* <p>
* <pre>
* [41] Attribute ::= Name Eq AttValue
* </pre>
* <p>
* <strong>Note:</strong> This method assumes that the next
* character on the stream is the first character of the attribute
* name.
* <p>
* <strong>Note:</strong> This method uses the fAttributeQName and
* fQName variables. The contents of these variables will be
* destroyed.
*
* @param attributes The attributes list for the scanned attribute.
*/
protected void scanAttribute(XMLAttributes attributes)
throws IOException, XNIException {
if (DEBUG_CONTENT_SCANNING) System.out.println(">>> scanAttribute()");
// name
if (fNamespaces) {
fEntityScanner.scanQName(fAttributeQName);
}
else {
String name = fEntityScanner.scanName();
fAttributeQName.setValues(null, name, name, null);
}
// equals
fEntityScanner.skipSpaces();
if (!fEntityScanner.skipChar('=')) {
reportFatalError("EqRequiredInAttribute",
new Object[]{fCurrentElement.rawname,
fAttributeQName.rawname});
}
fEntityScanner.skipSpaces();
// content
int oldLen = attributes.getLength();
attributes.addAttribute(fAttributeQName, fCDATASymbol, null);
// WFC: Unique Att Spec
if (oldLen == attributes.getLength()) {
reportFatalError("AttributeNotUnique",
new Object[]{fCurrentElement.rawname,
fAttributeQName.rawname});
}
//REVISIT: one more case needs to be included: external PE and standalone is no
boolean isVC = fHasExternalDTD && !fStandalone;
scanAttributeValue(fString, fAttributeQName.rawname, attributes,
oldLen, isVC);
attributes.setValue(oldLen, fString.toString());
attributes.setSpecified(oldLen, true);
if (DEBUG_CONTENT_SCANNING) System.out.println("<<< scanAttribute()");
} // scanAttribute(XMLAttributes)
/**
* Scans element content.
*
* @returns Returns the next character on the stream.
*/
protected int scanContent() throws IOException, XNIException {
XMLString content = fString;
int c = fEntityScanner.scanContent(content);
if (c == '\r') {
// happens when there is the character reference
fEntityScanner.scanChar();
fStringBuffer.clear();
fStringBuffer.append(fString);
fStringBuffer.append((char)c);
content = fStringBuffer;
c = -1;
}
if (fDocumentHandler != null && content.length > 0) {
fDocumentHandler.characters(content);
}
if (c == ']' && fString.length == 0) {
fStringBuffer.clear();
fStringBuffer.append((char)fEntityScanner.scanChar());
//
// We work on a single character basis to handle cases such as:
// ']]]>' which we might otherwise miss.
//
if (fEntityScanner.skipChar(']')) {
fStringBuffer.append(']');
while (fEntityScanner.skipChar(']')) {
fStringBuffer.append(']');
}
if (fEntityScanner.skipChar('>')) {
reportFatalError("CDEndInContent", null);
}
}
if (fDocumentHandler != null) {
fDocumentHandler.characters(fStringBuffer);
}
c = -1;
}
return c;
} // scanContent():int
/**
* Scans a CDATA section.
* <p>
* <strong>Note:</strong> This method uses the fString and
* fStringBuffer variables.
*
* @param complete True if the CDATA section is to be scanned
* completely.
*
* @return True if CDATA is completely scanned.
*/
protected boolean scanCDATASection(boolean complete)
throws IOException, XNIException {
// call handler
if (fDocumentHandler != null) {
fDocumentHandler.startCDATA();
}
while (true) {
if (!fEntityScanner.scanData("]]", fString)) {
if (fDocumentHandler != null && fString.length > 0) {
fDocumentHandler.characters(fString);
}
int brackets = 2;
while (fEntityScanner.skipChar(']')) {
brackets++;
}
if (fDocumentHandler != null && brackets > 2) {
fStringBuffer.clear();
for (int i = 2; i < brackets; i++) {
fStringBuffer.append(']');
}
fDocumentHandler.characters(fStringBuffer);
}
if (fEntityScanner.skipChar('>')) {
break;
}
if (fDocumentHandler != null) {
fStringBuffer.clear();
fStringBuffer.append("]]");
fDocumentHandler.characters(fStringBuffer);
}
}
else {
if (fDocumentHandler != null) {
fDocumentHandler.characters(fString);
}
int c = fEntityScanner.peekChar();
if (c != -1 && XMLChar.isInvalid(c)) {
if (XMLChar.isHighSurrogate(c)) {
fStringBuffer.clear();
scanSurrogates(fStringBuffer);
if (fDocumentHandler != null) {
fDocumentHandler.characters(fStringBuffer);
}
}
else {
reportFatalError("InvalidCharInCDSect",
new Object[]{Integer.toString(c,16)});
fEntityScanner.scanChar();
}
}
}
}
fMarkupDepth--;
// call handler
if (fDocumentHandler != null) {
fDocumentHandler.endCDATA();
}
return true;
} // scanCDATASection(boolean):boolean
/**
* Scans an end element.
* <p>
* <pre>
* [42] ETag ::= '</' Name S? '>'
* </pre>
* <p>
* <strong>Note:</strong> This method uses the fElementQName variable.
* The contents of this variable will be destroyed. The caller should
* copy the needed information out of this variable before calling
* this method.
*
* @returns The element depth.
*/
protected int scanEndElement() throws IOException, XNIException {
if (DEBUG_CONTENT_SCANNING) System.out.println(">>> scanEndElement()");
// name
if (fNamespaces) {
if (!fEntityScanner.scanQName(fElementQName)) {
fElementQName.clear();
}
}
else {
String name = fEntityScanner.scanName();
fElementQName.setValues(null, name, name, null);
}
// end
fEntityScanner.skipSpaces();
if (!fEntityScanner.skipChar('>')) {
reportFatalError("ETagUnterminated",
new Object[]{fElementQName.rawname});
}
fMarkupDepth--;
// handle end element
int depth = handleEndElement(fElementQName, false);
if (DEBUG_CONTENT_SCANNING) System.out.println("<<< scanEndElement(): "+depth);
return depth;
} // scanEndElement():int
/**
* Scans a character reference.
* <p>
* <pre>
* [66] CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';'
* </pre>
*/
protected void scanCharReference()
throws IOException, XNIException {
fStringBuffer2.clear();
int ch = scanCharReferenceValue(fStringBuffer2);
fMarkupDepth--;
if (ch != -1) {
// call handler
if (fDocumentHandler != null) {
if (fNotifyCharRefs) {
fDocumentHandler.startEntity(fCharRefLiteral, null,
null, null, null);
}
fDocumentHandler.characters(fStringBuffer2);
if (fNotifyCharRefs) {
fDocumentHandler.endEntity(fCharRefLiteral);
}
}
}
} // scanCharReference()
/**
* Scans an entity reference.
*
* @throws IOException Thrown if i/o error occurs.
* @throws XNIException Thrown if handler throws exception upon
* notification.
*/
protected void scanEntityReference() throws IOException, XNIException {
// name
String name = fEntityScanner.scanName();
if (name == null) {
reportFatalError("NameRequiredInReference", null);
}
// end
if (!fEntityScanner.skipChar(';')) {
reportFatalError("SemicolonRequiredInReference", null);
}
fMarkupDepth--;
// handle built-in entities
if (name == fAmpSymbol) {
handleCharacter('&', fAmpSymbol);
}
else if (name == fLtSymbol) {
handleCharacter('<', fLtSymbol);
}
else if (name == fGtSymbol) {
handleCharacter('>', fGtSymbol);
}
else if (name == fQuotSymbol) {
handleCharacter('"', fQuotSymbol);
}
else if (name == fAposSymbol) {
handleCharacter('\'', fAposSymbol);
}
// start general entity
else if (fEntityManager.isUnparsedEntity(name)) {
reportFatalError("ReferenceToUnparsedEntity", new Object[]{name});
}
else {
if (!fEntityManager.isDeclaredEntity(name)) {
//REVISIT: one more case needs to be included: external PE and standalone is no
if ( fHasExternalDTD && !fStandalone) {
if (fValidation)
fErrorReporter.reportError( XMLMessageFormatter.XML_DOMAIN,"EntityNotDeclared",
new Object[]{name}, XMLErrorReporter.SEVERITY_ERROR);
}
else
reportFatalError("EntityNotDeclared", new Object[]{name});
}
fEntityManager.startEntity(name, false);
}
} // scanEntityReference()
// utility methods
/**
* Calls document handler with a single character resulting from
* built-in entity resolution.
*
* @param c
* @param entity built-in name
*/
private void handleCharacter(char c, String entity) throws XNIException {
if (fDocumentHandler != null) {
if (fNotifyBuiltInRefs) {
fDocumentHandler.startEntity(entity, null, null, null, null);
}
fSingleChar[0] = c;
fString.setValues(fSingleChar, 0, 1);
fDocumentHandler.characters(fString);
if (fNotifyBuiltInRefs) {
fDocumentHandler.endEntity(entity);
}
}
} // handleCharacter(char)
/**
* Handles the end element. This method will make sure that
* the end element name matches the current element and notify
* the handler about the end of the element and the end of any
* relevent prefix mappings.
* <p>
* <strong>Note:</strong> This method uses the fQName variable.
* The contents of this variable will be destroyed.
*
* @param element The element.
*
* @returns The element depth.
*
* @throws XNIException Thrown if the handler throws a SAX exception
* upon notification.
*
*/
protected int handleEndElement(QName element, boolean isEmpty)
throws XNIException {
fMarkupDepth--;
// check that this element was opened in the same entity
if (fMarkupDepth < fEntityStack[fEntityDepth - 1]) {
reportFatalError("ElementEntityMismatch",
new Object[]{fCurrentElement.rawname});
}
// make sure the elements match
QName startElement = fQName;
fElementStack.popElement(startElement);
if (element.rawname != startElement.rawname) {
reportFatalError("ETagRequired",
new Object[]{startElement.rawname});
}
// bind namespaces
if (fNamespaces) {
element.uri = startElement.uri;
}
// call handler
if (fDocumentHandler != null && !isEmpty) {
fDocumentHandler.endElement(element);
}
return fMarkupDepth;
} // callEndElement(QName,boolean):int
// helper methods
/**
* Sets the scanner state.
*
* @param state The new scanner state.
*/
protected final void setScannerState(int state) {
fScannerState = state;
if (DEBUG_SCANNER_STATE) {
System.out.print("### setScannerState: ");
System.out.print(getScannerStateName(state));
System.out.println();
}
} // setScannerState(int)
/**
* Sets the dispatcher.
*
* @param dispatcher The new dispatcher.
*/
protected final void setDispatcher(Dispatcher dispatcher) {
fDispatcher = dispatcher;
if (DEBUG_DISPATCHER) {
System.out.print("%%% setDispatcher: ");
System.out.print(getDispatcherName(dispatcher));
System.out.println();
}
}
//
// Private methods
//
/** Returns the scanner state name. */
protected String getScannerStateName(int state) {
switch (state) {
case SCANNER_STATE_DOCTYPE: return "SCANNER_STATE_DOCTYPE";
case SCANNER_STATE_ROOT_ELEMENT: return "SCANNER_STATE_ROOT_ELEMENT";
case SCANNER_STATE_START_OF_MARKUP: return "SCANNER_STATE_START_OF_MARKUP";
case SCANNER_STATE_COMMENT: return "SCANNER_STATE_COMMENT";
case SCANNER_STATE_PI: return "SCANNER_STATE_PI";
case SCANNER_STATE_CONTENT: return "SCANNER_STATE_CONTENT";
case SCANNER_STATE_REFERENCE: return "SCANNER_STATE_REFERENCE";
case SCANNER_STATE_END_OF_INPUT: return "SCANNER_STATE_END_OF_INPUT";
case SCANNER_STATE_TERMINATED: return "SCANNER_STATE_TERMINATED";
case SCANNER_STATE_CDATA: return "SCANNER_STATE_CDATA";
case SCANNER_STATE_TEXT_DECL: return "SCANNER_STATE_TEXT_DECL";
}
return "??? ("+state+')';
} // getScannerStateName(int):String
/** Returns the dispatcher name. */
public String getDispatcherName(Dispatcher dispatcher) {
if (DEBUG_DISPATCHER) {
if (dispatcher != null) {
String name = dispatcher.getClass().getName();
int index = name.lastIndexOf('.');
if (index != -1) {
name = name.substring(index + 1);
index = name.lastIndexOf('$');
if (index != -1) {
name = name.substring(index + 1);
}
}
return name;
}
}
return "null";
} // getDispatcherName():String
//
// Classes
//
/**
* Element stack. This stack operates without synchronization, error
* checking, and it re-uses objects instead of throwing popped items
* away.
*
* @author Andy Clark, IBM
*/
protected static class ElementStack {
//
// Data
//
/** The stack data. */
protected QName[] fElements;
/** The size of the stack. */
protected int fSize;
//
// Constructors
//
/** Default constructor. */
public ElementStack() {
fElements = new QName[10];
for (int i = 0; i < fElements.length; i++) {
fElements[i] = new QName();
}
} // <init>()
//
// Public methods
//
/**
* Pushes an element on the stack.
* <p>
* <strong>Note:</strong> The QName values are copied into the
* stack. In other words, the caller does <em>not</em> orphan
* the element to the stack. Also, the QName object returned
* is <em>not</em> orphaned to the caller. It should be
* considered read-only.
*
* @param element The element to push onto the stack.
*
* @return Returns the actual QName object that stores the
*/
public QName pushElement(QName element) {
if (fSize == fElements.length) {
QName[] array = new QName[fElements.length * 2];
System.arraycopy(fElements, 0, array, 0, fSize);
fElements = array;
for (int i = fSize; i < fElements.length; i++) {
fElements[i] = new QName();
}
}
fElements[fSize].setValues(element);
return fElements[fSize++];
} // pushElement(QName):QName
/**
* Pops an element off of the stack by setting the values of
* the specified QName.
* <p>
* <strong>Note:</strong> The object returned is <em>not</em>
* orphaned to the caller. Therefore, the caller should consider
* the object to be read-only.
*/
public void popElement(QName element) {
element.setValues(fElements[--fSize]);
} // popElement(QName)
/** Clears the stack without throwing away existing QName objects. */
public void clear() {
fSize = 0;
} // clear()
} // class ElementStack
/**
* This interface defines an XML "event" dispatching model. Classes
* that implement this interface are responsible for scanning parts
* of the XML document and dispatching callbacks.
*
* @author Glenn Marcy, IBM
*/
protected interface Dispatcher {
//
// Dispatcher methods
//
/**
* Dispatch an XML "event".
*
* @param complete True if this dispatcher is intended to scan
* and dispatch as much as possible.
*
* @returns True if there is more to dispatch either from this
* or a another dispatcher.
*
* @throws IOException Thrown on i/o error.
* @throws XNIException Thrown on parse error.
*/
public boolean dispatch(boolean complete)
throws IOException, XNIException;
} // interface Dispatcher
/**
* Dispatcher to handle content scanning.
*
* @author Andy Clark, IBM
* @author Eric Ye, IBM
*/
protected class FragmentContentDispatcher
implements Dispatcher {
//
// Dispatcher methods
//
/**
* Dispatch an XML "event".
*
* @param complete True if this dispatcher is intended to scan
* and dispatch as much as possible.
*
* @returns True if there is more to dispatch either from this
* or a another dispatcher.
*
* @throws IOException Thrown on i/o error.
* @throws XNIException Thrown on parse error.
*/
public boolean dispatch(boolean complete)
throws IOException, XNIException {
try {
boolean again;
do {
again = false;
switch (fScannerState) {
case SCANNER_STATE_CONTENT: {
if (fEntityScanner.skipChar('<')) {
setScannerState(SCANNER_STATE_START_OF_MARKUP);
again = true;
}
else if (fEntityScanner.skipChar('&')) {
setScannerState(SCANNER_STATE_REFERENCE);
again = true;
}
else {
do {
int c = scanContent();
if (c == '<') {
fEntityScanner.scanChar();
setScannerState(SCANNER_STATE_START_OF_MARKUP);
break;
}
else if (c == '&') {
fEntityScanner.scanChar();
setScannerState(SCANNER_STATE_REFERENCE);
break;
}
else if (c != -1 && XMLChar.isInvalid(c)) {
if (XMLChar.isHighSurrogate(c)) {
// special case: surrogates
fStringBuffer.clear();
if (scanSurrogates(fStringBuffer)) {
// call handler
if (fDocumentHandler != null) {
fDocumentHandler.characters(fStringBuffer);
}
}
}
else {
reportFatalError("InvalidCharInContent",
new Object[] {
Integer.toString(c, 16)});
fEntityScanner.scanChar();
}
}
} while (complete);
}
break;
}
case SCANNER_STATE_START_OF_MARKUP: {
fMarkupDepth++;
if (fEntityScanner.skipChar('?')) {
setScannerState(SCANNER_STATE_PI);
again = true;
}
else if (fEntityScanner.skipChar('!')) {
if (fEntityScanner.skipChar('-')) {
if (!fEntityScanner.skipChar('-')) {
reportFatalError("InvalidCommentStart",
null);
}
setScannerState(SCANNER_STATE_COMMENT);
again = true;
}
else if (fEntityScanner.skipString("[CDATA[")) {
setScannerState(SCANNER_STATE_CDATA);
again = true;
}
else if (!scanForDoctypeHook()) {
reportFatalError("MarkupNotRecognizedInContent",
null);
}
}
else if (fEntityScanner.skipChar('/')) {
if (scanEndElement() == 0) {
if (elementDepthIsZeroHook()) {
return true;
}
}
setScannerState(SCANNER_STATE_CONTENT);
}
else if (XMLChar.isNameStart(fEntityScanner.peekChar())) {
scanStartElement();
setScannerState(SCANNER_STATE_CONTENT);
}
else {
reportFatalError("MarkupNotRecognizedInContent",
null);
}
break;
}
case SCANNER_STATE_COMMENT: {
scanComment();
setScannerState(SCANNER_STATE_CONTENT);
break;
}
case SCANNER_STATE_PI: {
scanPI();
setScannerState(SCANNER_STATE_CONTENT);
break;
}
case SCANNER_STATE_CDATA: {
scanCDATASection(complete);
setScannerState(SCANNER_STATE_CONTENT);
break;
}
case SCANNER_STATE_REFERENCE: {
fMarkupDepth++;
// NOTE: We need to set the state beforehand
// because the XMLEntityHandler#startEntity
// callback could set the state to
// SCANNER_STATE_TEXT_DECL and we don't want
// to override that scanner state.
setScannerState(SCANNER_STATE_CONTENT);
if (fEntityScanner.skipChar('#')) {
scanCharReference();
}
else {
scanEntityReference();
}
break;
}
case SCANNER_STATE_TEXT_DECL: {
// scan text decl
if (fEntityScanner.skipString("<?xml")) {
fMarkupDepth++;
// NOTE: special case where entity starts with a PI
// whose name starts with "xml" (e.g. "xmlfoo")
if (XMLChar.isName(fEntityScanner.peekChar())) {
fStringBuffer.clear();
fStringBuffer.append("xml");
while (XMLChar.isName(fEntityScanner.peekChar())) {
fStringBuffer.append((char)fEntityScanner.scanChar());
}
String target = fSymbolTable.addSymbol(fStringBuffer.ch, fStringBuffer.offset, fStringBuffer.length);
scanPIData(target, fString);
}
// standard text declaration
else {
scanXMLDeclOrTextDecl(true);
}
}
setScannerState(SCANNER_STATE_CONTENT);
break;
}
case SCANNER_STATE_ROOT_ELEMENT: {
if (scanRootElementHook()) {
return true;
}
setScannerState(SCANNER_STATE_CONTENT);
break;
}
case SCANNER_STATE_DOCTYPE: {
reportFatalError("DoctypeIllegalInContent",
null);
}
}
} while (complete || again);
}
// premature end of file
catch (EOFException e) {
endOfFileHook(e);
return false;
}
return true;
} // dispatch(boolean):boolean
//
// Protected methods
//
// hooks
// NOTE: These hook methods are added so that the full document
// scanner can share the majority of code with this class.
/**
* Scan for DOCTYPE hook. This method is a hook for subclasses
* to add code to handle scanning for a the "DOCTYPE" string
* after the string "<!" has been scanned.
*
* @returns True if the "DOCTYPE" was scanned; false if "DOCTYPE"
* was not scanned.
*/
protected boolean scanForDoctypeHook()
throws IOException, XNIException {
return false;
} // scanForDoctypeHook():boolean
/**
* Element depth iz zero. This methos is a hook for subclasses
* to add code to handle when the element depth hits zero. When
* scanning a document fragment, an element depth of zero is
* normal. However, when scanning a full XML document, the
* scanner must handle the trailing miscellanous section of
* the document after the end of the document's root element.
*
* @returns True if the caller should stop and return true which
* allows the scanner to switch to a new scanning
* dispatcher. A return value of false indicates that
* the content dispatcher should continue as normal.
*/
protected boolean elementDepthIsZeroHook()
throws IOException, XNIException {
return false;
} // elementDepthIsZeroHook():boolean
/**
* Scan for root element hook. This method is a hook for
* subclasses to add code that handles scanning for the root
* element. When scanning a document fragment, there is no
* "root" element. However, when scanning a full XML document,
* the scanner must handle the root element specially.
*
* @returns True if the caller should stop and return true which
* allows the scanner to switch to a new scanning
* dispatcher. A return value of false indicates that
* the content dispatcher should continue as normal.
*/
protected boolean scanRootElementHook()
throws IOException, XNIException {
return false;
} // scanRootElementHook():boolean
/**
* End of file hook. This method is a hook for subclasses to
* add code that handles the end of file. The end of file in
* a document fragment is OK if the markup depth is zero.
* However, when scanning a full XML document, an end of file
* is always premature.
*/
protected void endOfFileHook(EOFException e)
throws IOException, XNIException {
// NOTE: An end of file is only only an error if we were
// in the middle of scanning some markup. -Ac
if (fMarkupDepth != 0) {
reportFatalError("PrematureEOF", null);
throw e;
}
} // endOfFileHook()
} // class FragmentContentDispatcher
} // class XMLDocumentFragmentScannerImpl
---------------------------------------------------------------------
To unsubscribe, e-mail: xerces-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: xerces-cvs-help@xml.apache.org