Interface Summary : IBufferedDeclHandler

SAX2 extension handler for DTD declaration events.
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

This is an optional extension handler for SAX2 to provide more complete information about DTD declarations in an XML document. XML readers are not required to recognize this handler, and it is not part of core-only SAX2 distributions.

Note that data-related DTD declarations (unparsed entities and notations) are already reported through the IBufferedDTDHandler interface.

If you are using the declaration handler together with a lexical handler, all of the events will occur between the startDTD and the endDTD events.

To set the DeclHandler for an XML reader, use the getProperty method with the property name http://xml.org/sax/properties/declaration-handler and an object implementing this interface (or nil) as the value. If the reader does not report declaration events, it will throw a ESAXNotRecognizedException when you attempt to register the handler.

For reasons of generality and efficiency, strings that are returned from the interface are declared as pointers (PSAXChar) and lengths. This requires that the model use procedural out parameters rather than functions as in the original interfaces.


Since : SAX 2.0 (extensions 1.0)
See : IBufferedXMLReader

Methods

procedure elementDecl(PSAXChar, Integer, PSAXChar, Integer)
procedure attributeDecl(PSAXChar, Integer, PSAXChar, Integer, PSAXChar, Integer, PSAXChar, Integer, PSAXChar, Integer)
procedure internalEntityDecl(PSAXChar, Integer, PSAXChar, Integer)
procedure externalEntityDecl(PSAXChar, Integer, PSAXChar, Integer, PSAXChar, Integer)


procedure elementDecl( name : PSAXChar; nameLength : Integer; model : PSAXChar; modelLength : Integer);

Report an element type declaration.

The content model will consist of the string "EMPTY", the string "ANY", or a parenthesised group, optionally followed by an occurrence indicator. The model will be normalized so that all parameter entities are fully resolved and all whitespace is removed,and will include the enclosing parentheses. Other normalization (such as removing redundant parentheses or simplifying occurrence indicators) is at the discretion of the parser.


Parameter : name The element type name.
Parameter : nameLength The length of the name buffer The value may be -1 which indicates that the buffer is null-terminated. If the value is 0 then the buffer may be nil.
Parameter : model The content model as a normalized string.
Parameter : modelLength The length of the model buffer The value may be -1 which indicates that the buffer is null-terminated. If the value is 0 then the buffer may be nil.
Exception : ESAXException The application may raise an exception. /

Top


procedure attributeDecl( eName : PSAXChar; eNameLength : Integer; aName : PSAXChar; aNameLength : Integer; attrType : PSAXChar; attrTypeLength : Integer; mode : PSAXChar; modeLength : Integer; value : PSAXChar; valueLength : Integer);

Report an attribute type declaration.

Only the effective (first) declaration for an attribute will be reported. The type will be one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", a parenthesized token group with the separator "|" and all whitespace removed, or the word "NOTATION" followed by a space followed by a parenthesized token group with all whitespace removed.

The value will be the value as reported to applications, appropriately normalized and with entity and character references expanded.


Parameter : eName The name of the associated element.
Parameter : eNameLength The length of the eName buffer The value may be -1 which indicates that the buffer is null-terminated. If the value is 0 then the buffer may be nil.
Parameter : aName The name of the attribute.
Parameter : aNameLength The length of the aName buffer The value may be -1 which indicates that the buffer is null-terminated. If the value is 0 then the buffer may be nil.
Parameter : attrType A string representing the attribute type.
Parameter : attrTypeLength The length of the attrType buffer The value may be -1 which indicates that the buffer is null-terminated. If the value is 0 then the buffer may be nil.
Parameter : mode A string representing the attribute defaulting mode ("#IMPLIED", "#REQUIRED", or "#FIXED") or '' if none of these applies.
Parameter : modeLength The length of the mode buffer The value may be -1 which indicates that the buffer is null-terminated. If the value is 0 then the buffer may be nil.
Parameter : value A string representing the attribute's default value, or an empty string if there is none.
Parameter : valueLength The length of the value buffer The value may be -1 which indicates that the buffer is null-terminated. If the value is 0 then the buffer may be nil.
Exception : ESAXException The application may raise an exception.

Top


procedure internalEntityDecl( name : PSAXChar; nameLength : Integer; value : PSAXChar; valueLength : Integer);

Report an internal entity declaration.

Only the effective (first) declaration for each entity will be reported. All parameter entities in the value will be expanded, but general entities will not.


Parameter : name The name of the entity. If it is a parameter entity, the name will begin with '%'.
Parameter : nameLength The length of the name buffer The value may be -1 which indicates that the buffer is null-terminated. If the value is 0 then the buffer may be nil.
Parameter : value The replacement text of the entity.
Parameter : valueLength The length of the value buffer The value may be -1 which indicates that the buffer is null-terminated. If the value is 0 then the buffer may be nil.
Exception : ESAXException The application may raise an exception.
See : IBufferedDeclHandler.externalEntityDecl
See : IBufferedDTDHandler.unparsedEntityDecl

Top


procedure externalEntityDecl( name : PSAXChar; nameLength : Integer; publicId : PSAXChar; publicIdLength : Integer; systemId : PSAXChar; systemIdLength : Integer);

Report a parsed external entity declaration.

Only the effective (first) declaration for each entity will be reported.


Parameter : name The name of the entity. If it is a parameter entity, the name will begin with '%'.
Parameter : nameLength The length of the name buffer The value may be -1 which indicates that the buffer is null-terminated. If the value is 0 then the buffer may be nil.
Parameter : publicId The declared public identifier of the entity, or the empty string if none was declared.
Parameter : publicIdLength The length of the publicId buffer The value may be -1 which indicates that the buffer is null-terminated. If the value is 0 then the buffer may be nil.
Parameter : systemId The declared system identifier of the entity.
Parameter : systemIdLength The length of the systemId buffer The value may be -1 which indicates that the buffer is null-terminated. If the value is 0 then the buffer may be nil.
Exception : ESAXException The application may raise an exception.
See : IBufferedDeclHandler.internalEntityDecl
See : IBufferedDTDHandler.unparsedEntityDecl

Top