/*
* legacy.c: set of deprecated routines, not to be used anymore but
* kept purely for ABI compatibility
*
* See Copyright for the status of this software.
*
* daniel@veillard.com
*/
#define IN_LIBXML
#include "libxml.h"
#ifdef LIBXML_LEGACY_ENABLED
#include <string.h>
#include <libxml/entities.h>
#include <libxml/parserInternals.h>
#include <libxml/HTMLparser.h>
/************************************************************************
* *
* Deprecated functions kept for compatibility *
* *
************************************************************************/
#ifdef LIBXML_HTML_ENABLED
/**
* htmlDecodeEntities:
* @ctxt: the parser context
* @len: the len to decode (in bytes !), -1 for no size limit
* @end: an end marker xmlChar, 0 if none
* @end2: an end marker xmlChar, 0 if none
* @end3: an end marker xmlChar, 0 if none
*
* Substitute the HTML entities by their value
*
* DEPRECATED !!!!
*
* Returns A newly allocated string with the substitution done. The caller
* must deallocate it !
*/
xmlChar *
{
static int deprecated = 0;
if (!deprecated) {
"htmlDecodeEntities() deprecated function reached\n");
deprecated = 1;
}
return (NULL);
}
#endif
/**
* xmlInitializePredefinedEntities:
*
* Set up the predefined entities.
* Deprecated call
*/
void
{
}
/**
* xmlCleanupPredefinedEntities:
*
* Cleanup up the predefined entities table.
* Deprecated call
*/
void
{
}
static const char *xmlFeaturesList[] = {
"validate",
"load subset",
"keep blanks",
"disable SAX",
"fetch external entities",
"substitute entities",
"gather line info",
"user data",
"is html",
"is standalone",
"stop parser",
"document",
"is well formed",
"is valid",
"SAX block",
"SAX function internalSubset",
"SAX function isStandalone",
"SAX function hasInternalSubset",
"SAX function hasExternalSubset",
"SAX function resolveEntity",
"SAX function getEntity",
"SAX function entityDecl",
"SAX function notationDecl",
"SAX function attributeDecl",
"SAX function elementDecl",
"SAX function unparsedEntityDecl",
"SAX function setDocumentLocator",
"SAX function startDocument",
"SAX function endDocument",
"SAX function startElement",
"SAX function endElement",
"SAX function reference",
"SAX function characters",
"SAX function ignorableWhitespace",
"SAX function processingInstruction",
"SAX function comment",
"SAX function warning",
"SAX function error",
"SAX function fatalError",
"SAX function getParameterEntity",
"SAX function cdataBlock",
"SAX function externalSubset",
};
/**
* xmlGetFeaturesList:
* @result: an array of string to be filled with the features name.
*
* Copy at most *@len feature names into the @result array
*
* Returns -1 in case or error, or the total number of features,
* len is updated with the number of strings copied,
* strings must not be deallocated
*/
int
{
int ret, i;
return (ret);
return (-1);
for (i = 0; i < *len; i++)
result[i] = xmlFeaturesList[i];
return (ret);
}
/**
* xmlGetFeature:
* @name: the feature name
* @result: location to store the result
*
* Read the current value of one feature of this parser instance
*
* Returns -1 in case or error, 0 otherwise
*/
int
{
return (-1);
*((hasInternalSubsetSAXFunc *) result) =
*((hasExternalSubsetSAXFunc *) result) =
*((unparsedEntityDeclSAXFunc *) result) =
*((setDocumentLocatorSAXFunc *) result) =
*((ignorableWhitespaceSAXFunc *) result) =
*((processingInstructionSAXFunc *) result) =
*((getParameterEntitySAXFunc *) result) =
} else {
return (-1);
}
return (0);
}
/**
* xmlSetFeature:
* @name: the feature name
* @value: pointer to the location of the new value
*
* Change the current value of one feature of this parser instance
*
* Returns -1 in case or error, 0 otherwise
*/
int
{
return (-1);
}
*((hasInternalSubsetSAXFunc *) value);
*((hasExternalSubsetSAXFunc *) value);
*((unparsedEntityDeclSAXFunc *) value);
*((setDocumentLocatorSAXFunc *) value);
*((ignorableWhitespaceSAXFunc *) value);
*((processingInstructionSAXFunc *) value);
*((getParameterEntitySAXFunc *) value);
} else {
return (-1);
}
return (0);
}
/**
* xmlDecodeEntities:
* @ctxt: the parser context
* @len: the len to decode (in bytes !), -1 for no size limit
* @what: combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF
* @end: an end marker xmlChar, 0 if none
* @end2: an end marker xmlChar, 0 if none
* @end3: an end marker xmlChar, 0 if none
*
* This function is deprecated, we now always process entities content
* through xmlStringDecodeEntities
*
* TODO: remove it in next major release.
*
* [67] Reference ::= EntityRef | CharRef
*
* [69] PEReference ::= '%' Name ';'
*
* Returns A newly allocated string with the substitution done. The caller
* must deallocate it !
*/
xmlChar *
{
static int deprecated = 0;
if (!deprecated) {
"xmlDecodeEntities() deprecated function reached\n");
deprecated = 1;
}
return (NULL);
}
/**
* xmlNamespaceParseNCName:
* @ctxt: an XML parser context
*
* parse an XML namespace name.
*
* TODO: this seems not in use anymore, the namespace handling is done on
* top of the SAX interfaces, i.e. not on raw input.
*
* [NS 3] NCName ::= (Letter | '_') (NCNameChar)*
*
* [NS 4] NCNameChar ::= Letter | Digit | '.' | '-' | '_' |
* CombiningChar | Extender
*
* Returns the namespace name or NULL
*/
xmlChar *
{
static int deprecated = 0;
if (!deprecated) {
"xmlNamespaceParseNCName() deprecated function reached\n");
deprecated = 1;
}
return (NULL);
}
/**
* xmlNamespaceParseQName:
* @ctxt: an XML parser context
* @prefix: a xmlChar **
*
* TODO: this seems not in use anymore, the namespace handling is done on
* top of the SAX interfaces, i.e. not on raw input.
*
* parse an XML qualified name
*
* [NS 5] QName ::= (Prefix ':')? LocalPart
*
* [NS 6] Prefix ::= NCName
*
* [NS 7] LocalPart ::= NCName
*
* Returns the local part, and prefix is updated
* to get the Prefix if any.
*/
xmlChar *
{
static int deprecated = 0;
if (!deprecated) {
"xmlNamespaceParseQName() deprecated function reached\n");
deprecated = 1;
}
return (NULL);
}
/**
* xmlNamespaceParseNSDef:
* @ctxt: an XML parser context
*
* parse a namespace prefix declaration
*
* TODO: this seems not in use anymore, the namespace handling is done on
* top of the SAX interfaces, i.e. not on raw input.
*
* [NS 1] NSDef ::= PrefixDef Eq SystemLiteral
*
* [NS 2] PrefixDef ::= 'xmlns' (':' NCName)?
*
* Returns the namespace name
*/
xmlChar *
{
static int deprecated = 0;
if (!deprecated) {
"xmlNamespaceParseNSDef() deprecated function reached\n");
deprecated = 1;
}
return (NULL);
}
/**
* xmlParseQuotedString:
* @ctxt: an XML parser context
*
* Parse and return a string between quotes or doublequotes
*
* TODO: Deprecated, to be removed at next drop of binary compatibility
*
* Returns the string parser or NULL.
*/
xmlChar *
{
static int deprecated = 0;
if (!deprecated) {
"xmlParseQuotedString() deprecated function reached\n");
deprecated = 1;
}
return (NULL);
}
/**
* xmlParseNamespace:
* @ctxt: an XML parser context
*
* xmlParseNamespace: parse specific PI '<?namespace ...' constructs.
*
* This is what the older xml-name Working Draft specified, a bunch of
* other stuff may still rely on it, so support is still here as
* if it was declared on the root of the Tree:-(
*
* TODO: remove from library
*
* To be removed at next drop of binary compatibility
*/
void
{
static int deprecated = 0;
if (!deprecated) {
"xmlParseNamespace() deprecated function reached\n");
deprecated = 1;
}
}
/**
* xmlScanName:
* @ctxt: an XML parser context
*
* Trickery: parse an XML name but without consuming the input flow
* Needed for rollback cases. Used only when parsing entities references.
*
* TODO: seems deprecated now, only used in the default part of
* xmlParserHandleReference
*
* [4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' |
* CombiningChar | Extender
*
* [5] Name ::= (Letter | '_' | ':') (NameChar)*
*
* [6] Names ::= Name (S Name)*
*
* Returns the Name parsed or NULL
*/
xmlChar *
{
static int deprecated = 0;
if (!deprecated) {
"xmlScanName() deprecated function reached\n");
deprecated = 1;
}
return (NULL);
}
/**
* xmlParserHandleReference:
* @ctxt: the parser context
*
* TODO: Remove, now deprecated ... the test is done directly in the
* content parsing
* routines.
*
* [67] Reference ::= EntityRef | CharRef
*
* [68] EntityRef ::= '&' Name ';'
*
* [ WFC: Entity Declared ]
* the Name given in the entity reference must match that in an entity
* declaration, except that well-formed documents need not declare any
* of the following entities: amp, lt, gt, apos, quot.
*
* [ WFC: Parsed Entity ]
* An entity reference must not contain the name of an unparsed entity
*
* [66] CharRef ::= '&#' [0-9]+ ';' |
* '&#x' [0-9a-fA-F]+ ';'
*
* A PEReference may have been detected in the current input stream
* the handling is done accordingly to
* http://www.w3.org/TR/REC-xml#entproc
*/
void
{
static int deprecated = 0;
if (!deprecated) {
"xmlParserHandleReference() deprecated function reached\n");
deprecated = 1;
}
return;
}
/**
* xmlHandleEntity:
* @ctxt: an XML parser context
* @entity: an XML entity pointer.
*
* Default handling of defined entities, when should we define a new input
* stream ? When do we just handle that as a set of chars ?
*
* OBSOLETE: to be removed at some point.
*/
void
{
static int deprecated = 0;
if (!deprecated) {
"xmlHandleEntity() deprecated function reached\n");
deprecated = 1;
}
}
/**
* xmlNewGlobalNs:
* @doc: the document carrying the namespace
* @href: the URI associated
* @prefix: the prefix for the namespace
*
* Creation of a Namespace, the old way using PI and without scoping
* DEPRECATED !!!
* Returns NULL this functionality had been removed
*/
{
static int deprecated = 0;
if (!deprecated) {
"xmlNewGlobalNs() deprecated function reached\n");
deprecated = 1;
}
return (NULL);
}
/**
* xmlUpgradeOldNs:
* @doc: a document pointer
*
* Upgrade old style Namespaces (PI) and move them to the root of the document.
* DEPRECATED
*/
void
{
static int deprecated = 0;
if (!deprecated) {
"xmlUpgradeOldNs() deprecated function reached\n");
deprecated = 1;
}
}
/**
* xmlEncodeEntities:
* @doc: the document containing the string
* @input: A string to convert to XML.
*
* TODO: remove xmlEncodeEntities, once we are not afraid of breaking binary
* compatibility
*
* People must migrate their code to xmlEncodeEntitiesReentrant !
* This routine will issue a warning when encountered.
*
* Returns NULL
*/
const xmlChar *
{
if (warning) {
"Deprecated API xmlEncodeEntities() used\n");
" change code to use xmlEncodeEntitiesReentrant()\n");
warning = 0;
}
return (NULL);
}
/************************************************************************
* *
* Old set of SAXv1 functions *
* *
************************************************************************/
static int deprecated_v1_msg = 0;
#define DEPRECATED(n) \
if (deprecated_v1_msg == 0) \
"Use of deprecated SAXv1 function %s\n", n); \
/**
* getPublicId:
* @ctx: the user data (XML parser context)
*
* Provides the public ID e.g. "-//SGMLSOURCE//DTD DEMO//EN"
* DEPRECATED: use xmlSAX2GetPublicId()
*
* Returns a xmlChar *
*/
const xmlChar *
{
DEPRECATED("getPublicId")
return (xmlSAX2GetPublicId(ctx));
}
/**
* getSystemId:
* @ctx: the user data (XML parser context)
*
* Provides the system ID, basically URL or filename e.g.
* DEPRECATED: use xmlSAX2GetSystemId()
*
* Returns a xmlChar *
*/
const xmlChar *
{
DEPRECATED("getSystemId")
return (xmlSAX2GetSystemId(ctx));
}
/**
* getLineNumber:
* @ctx: the user data (XML parser context)
*
* Provide the line number of the current parsing point.
* DEPRECATED: use xmlSAX2GetLineNumber()
*
* Returns an int
*/
int
{
DEPRECATED("getLineNumber")
return (xmlSAX2GetLineNumber(ctx));
}
/**
* getColumnNumber:
* @ctx: the user data (XML parser context)
*
* Provide the column number of the current parsing point.
* DEPRECATED: use xmlSAX2GetColumnNumber()
*
* Returns an int
*/
int
{
DEPRECATED("getColumnNumber")
return (xmlSAX2GetColumnNumber(ctx));
}
/**
* isStandalone:
* @ctx: the user data (XML parser context)
*
* Is this document tagged standalone ?
* DEPRECATED: use xmlSAX2IsStandalone()
*
* Returns 1 if true
*/
int
{
DEPRECATED("isStandalone")
return (xmlSAX2IsStandalone(ctx));
}
/**
* hasInternalSubset:
* @ctx: the user data (XML parser context)
*
* Does this document has an internal subset
* DEPRECATED: use xmlSAX2HasInternalSubset()
*
* Returns 1 if true
*/
int
{
DEPRECATED("hasInternalSubset")
return (xmlSAX2HasInternalSubset(ctx));
}
/**
* hasExternalSubset:
* @ctx: the user data (XML parser context)
*
* Does this document has an external subset
* DEPRECATED: use xmlSAX2HasExternalSubset()
*
* Returns 1 if true
*/
int
{
DEPRECATED("hasExternalSubset")
return (xmlSAX2HasExternalSubset(ctx));
}
/**
* internalSubset:
* @ctx: the user data (XML parser context)
* @name: the root element name
* @ExternalID: the external ID
* @SystemID: the SYSTEM ID (e.g. filename or URL)
*
* Callback on internal subset declaration.
* DEPRECATED: use xmlSAX2InternalSubset()
*/
void
{
DEPRECATED("internalSubset")
}
/**
* externalSubset:
* @ctx: the user data (XML parser context)
* @name: the root element name
* @ExternalID: the external ID
* @SystemID: the SYSTEM ID (e.g. filename or URL)
*
* Callback on external subset declaration.
* DEPRECATED: use xmlSAX2ExternalSubset()
*/
void
{
DEPRECATED("externalSubset")
}
/**
* resolveEntity:
* @ctx: the user data (XML parser context)
* @publicId: The public ID of the entity
* @systemId: The system ID of the entity
*
* The entity loader, to control the loading of external entities,
* the application can either:
* - override this resolveEntity() callback in the SAX block
* - or better use the xmlSetExternalEntityLoader() function to
* set up it's own entity resolution routine
* DEPRECATED: use xmlSAX2ResolveEntity()
*
* Returns the xmlParserInputPtr if inlined or NULL for DOM behaviour.
*/
{
DEPRECATED("resolveEntity")
}
/**
* getEntity:
* @ctx: the user data (XML parser context)
* @name: The entity name
*
* Get an entity by name
* DEPRECATED: use xmlSAX2GetEntity()
*
* Returns the xmlEntityPtr if found.
*/
{
DEPRECATED("getEntity")
}
/**
* getParameterEntity:
* @ctx: the user data (XML parser context)
* @name: The entity name
*
* Get a parameter entity by name
* DEPRECATED: use xmlSAX2GetParameterEntity()
*
* Returns the xmlEntityPtr if found.
*/
{
DEPRECATED("getParameterEntity")
}
/**
* entityDecl:
* @ctx: the user data (XML parser context)
* @name: the entity name
* @type: the entity type
* @publicId: The public ID of the entity
* @systemId: The system ID of the entity
* @content: the entity value (without processing).
*
* An entity definition has been parsed
* DEPRECATED: use xmlSAX2EntityDecl()
*/
void
{
DEPRECATED("entityDecl")
}
/**
* attributeDecl:
* @ctx: the user data (XML parser context)
* @elem: the name of the element
* @fullname: the attribute name
* @type: the attribute type
* @def: the type of default value
* @defaultValue: the attribute default value
* @tree: the tree of enumerated value set
*
* An attribute definition has been parsed
* DEPRECATED: use xmlSAX2AttributeDecl()
*/
void
{
DEPRECATED("attributeDecl")
tree);
}
/**
* elementDecl:
* @ctx: the user data (XML parser context)
* @name: the element name
* @type: the element type
* @content: the element value tree
*
* An element definition has been parsed
* DEPRECATED: use xmlSAX2ElementDecl()
*/
void
{
DEPRECATED("elementDecl")
}
/**
* notationDecl:
* @ctx: the user data (XML parser context)
* @name: The name of the notation
* @publicId: The public ID of the entity
* @systemId: The system ID of the entity
*
* What to do when a notation declaration has been parsed.
* DEPRECATED: use xmlSAX2NotationDecl()
*/
void
{
DEPRECATED("notationDecl")
}
/**
* unparsedEntityDecl:
* @ctx: the user data (XML parser context)
* @name: The name of the entity
* @publicId: The public ID of the entity
* @systemId: The system ID of the entity
* @notationName: the name of the notation
*
* What to do when an unparsed entity declaration is parsed
* DEPRECATED: use xmlSAX2UnparsedEntityDecl()
*/
void
const xmlChar * notationName)
{
DEPRECATED("unparsedEntityDecl")
}
/**
* setDocumentLocator:
* @ctx: the user data (XML parser context)
* @loc: A SAX Locator
*
* Receive the document locator at startup, actually xmlDefaultSAXLocator
* Everything is available on the context, so this is useless in our case.
* DEPRECATED
*/
void
{
DEPRECATED("setDocumentLocator")
}
/**
* startDocument:
* @ctx: the user data (XML parser context)
*
* called when the document start being processed.
* DEPRECATED: use xmlSAX2StartDocument()
*/
void
{
/* don't be too painful for glade users */
/* DEPRECATED("startDocument") */
}
/**
* endDocument:
* @ctx: the user data (XML parser context)
*
* called when the document end has been detected.
* DEPRECATED: use xmlSAX2EndDocument()
*/
void
{
DEPRECATED("endDocument")
}
/**
* attribute:
* @ctx: the user data (XML parser context)
* @fullname: The attribute name, including namespace prefix
* @value: The attribute value
*
* Handle an attribute that has been read by the parser.
* The default handling is to convert the attribute into an
* DOM subtree and past it in a new xmlAttr element added to
* the element.
* DEPRECATED: use xmlSAX2Attribute()
*/
void
{
DEPRECATED("attribute")
}
/**
* startElement:
* @ctx: the user data (XML parser context)
* @fullname: The element name, including namespace prefix
*
* called when an opening tag has been processed.
* DEPRECATED: use xmlSAX2StartElement()
*/
void
{
}
/**
* endElement:
* @ctx: the user data (XML parser context)
* @name: The element name
*
* called when the end of an element has been detected.
* DEPRECATED: use xmlSAX2EndElement()
*/
void
{
DEPRECATED("endElement")
}
/**
* reference:
* @ctx: the user data (XML parser context)
* @name: The entity name
*
* called when an entity reference is detected.
* DEPRECATED: use xmlSAX2Reference()
*/
void
{
DEPRECATED("reference")
}
/**
* characters:
* @ctx: the user data (XML parser context)
* @ch: a xmlChar string
* @len: the number of xmlChar
*
* receiving some chars from the parser.
* DEPRECATED: use xmlSAX2Characters()
*/
void
{
DEPRECATED("characters")
}
/**
* ignorableWhitespace:
* @ctx: the user data (XML parser context)
* @ch: a xmlChar string
* @len: the number of xmlChar
*
* receiving some ignorable whitespaces from the parser.
* UNUSED: by default the DOM building will use characters
* DEPRECATED: use xmlSAX2IgnorableWhitespace()
*/
void
int len ATTRIBUTE_UNUSED)
{
DEPRECATED("ignorableWhitespace")
}
/**
* processingInstruction:
* @ctx: the user data (XML parser context)
* @target: the target name
* @data: the PI data's
*
* A processing instruction has been parsed.
* DEPRECATED: use xmlSAX2ProcessingInstruction()
*/
void
{
DEPRECATED("processingInstruction")
}
/**
* globalNamespace:
* @ctx: the user data (XML parser context)
* @href: the namespace associated URN
* @prefix: the namespace prefix
*
* An old global namespace has been parsed.
* DEPRECATED
*/
void
{
DEPRECATED("globalNamespace")
}
/**
* setNamespace:
* @ctx: the user data (XML parser context)
* @name: the namespace prefix
*
* Set the current element namespace.
* DEPRECATED
*/
void
{
DEPRECATED("setNamespace")
}
/**
* getNamespace:
* @ctx: the user data (XML parser context)
*
* Get the current element namespace.
* DEPRECATED
*
* Returns the xmlNsPtr or NULL if none
*/
{
DEPRECATED("getNamespace")
return (NULL);
}
/**
* checkNamespace:
* @ctx: the user data (XML parser context)
* @namespace: the namespace to check against
*
* Check that the current element namespace is the same as the
* one read upon parsing.
* DEPRECATED
*
* Returns 1 if true 0 otherwise
*/
int
{
DEPRECATED("checkNamespace")
return (0);
}
/**
* namespaceDecl:
* @ctx: the user data (XML parser context)
* @href: the namespace associated URN
* @prefix: the namespace prefix
*
* A namespace has been parsed.
* DEPRECATED
*/
void
{
DEPRECATED("namespaceDecl")
}
/**
* comment:
* @ctx: the user data (XML parser context)
* @value: the comment content
*
* A comment has been parsed.
* DEPRECATED: use xmlSAX2Comment()
*/
void
{
DEPRECATED("comment")
}
/**
* cdataBlock:
* @ctx: the user data (XML parser context)
* @value: The pcdata content
* @len: the block length
*
* called when a pcdata block has been parsed
* DEPRECATED: use xmlSAX2CDataBlock()
*/
void
{
DEPRECATED("cdataBlock")
}
#define bottom_legacy
#include "elfgcchack.h"
#endif /* LIBXML_LEGACY_ENABLED */