1
0
mirror of https://gitlab.gnome.org/GNOME/libxml2.git synced 2025-10-20 03:52:25 +03:00

catalog: Deprecate low-level internal functions

This commit is contained in:
Nick Wellnhofer
2025-08-17 14:35:08 +02:00
parent 5bd6b44d13
commit 591f19ebe7
4 changed files with 57 additions and 1 deletions

View File

@@ -407,6 +407,8 @@ xmlCreateNewCatalog(xmlCatalogType type, xmlCatalogPrefer prefer) {
/** /**
* Free the memory allocated to a Catalog * Free the memory allocated to a Catalog
* *
* @deprecated Internal function, don't use
*
* @param catal a Catalog * @param catal a Catalog
*/ */
void void
@@ -761,6 +763,8 @@ xmlCatalogConvertEntry(void *payload, void *data,
/** /**
* Convert all the SGML catalog entries as XML ones * Convert all the SGML catalog entries as XML ones
* *
* @deprecated Internal function, don't use
*
* @param catal the catalog * @param catal the catalog
* @returns the number of entries converted if successful, -1 otherwise * @returns the number of entries converted if successful, -1 otherwise
*/ */
@@ -851,7 +855,7 @@ xmlCatalogUnWrapURN(const xmlChar *urn) {
* parse an XML file and build a tree. It's like #xmlParseFile * parse an XML file and build a tree. It's like #xmlParseFile
* except it bypass all catalog lookups. * except it bypass all catalog lookups.
* *
* @deprecated Use XML_PARSE_NO_SYS_CATALOG. * @deprecated Internal function, don't use
* *
* @param filename the filename * @param filename the filename
* @returns the resulting document tree or NULL in case of error * @returns the resulting document tree or NULL in case of error
@@ -2541,6 +2545,8 @@ xmlCatalogSGMLResolve(xmlCatalogPtr catal, const xmlChar *pubID,
* references. This is only needed for manipulating SGML Super Catalogs * references. This is only needed for manipulating SGML Super Catalogs
* like adding and removing CATALOG or DELEGATE entries. * like adding and removing CATALOG or DELEGATE entries.
* *
* @deprecated Internal function, don't use
*
* @param filename a file path * @param filename a file path
* @returns the catalog parsed or NULL in case of error * @returns the catalog parsed or NULL in case of error
*/ */
@@ -2576,6 +2582,8 @@ xmlLoadSGMLSuperCatalog(const char *filename)
* It will recurse in SGML CATALOG entries. On the other hand XML * It will recurse in SGML CATALOG entries. On the other hand XML
* Catalogs are not handled recursively. * Catalogs are not handled recursively.
* *
* @deprecated Internal function, don't use
*
* @param filename a file path * @param filename a file path
* @returns the catalog parsed or NULL in case of error * @returns the catalog parsed or NULL in case of error
*/ */
@@ -2673,6 +2681,8 @@ xmlExpandCatalog(xmlCatalogPtr catal, const char *filename)
/** /**
* Try to lookup the catalog resource for a system ID * Try to lookup the catalog resource for a system ID
* *
* @deprecated Internal function, don't use
*
* @param catal a Catalog * @param catal a Catalog
* @param sysID the system ID string * @param sysID the system ID string
* @returns the resource if found or NULL otherwise, the value returned * @returns the resource if found or NULL otherwise, the value returned
@@ -2706,6 +2716,8 @@ xmlACatalogResolveSystem(xmlCatalog *catal, const xmlChar *sysID) {
/** /**
* Try to lookup the catalog local reference associated to a public ID in that catalog * Try to lookup the catalog local reference associated to a public ID in that catalog
* *
* @deprecated Internal function, don't use
*
* @param catal a Catalog * @param catal a Catalog
* @param pubID the public ID string * @param pubID the public ID string
* @returns the local resource if found or NULL otherwise, the value returned * @returns the local resource if found or NULL otherwise, the value returned
@@ -2739,6 +2751,8 @@ xmlACatalogResolvePublic(xmlCatalog *catal, const xmlChar *pubID) {
/** /**
* Do a complete resolution lookup of an External Identifier * Do a complete resolution lookup of an External Identifier
* *
* @deprecated Internal function, don't use
*
* @param catal a Catalog * @param catal a Catalog
* @param pubID the public ID string * @param pubID the public ID string
* @param sysID the system ID string * @param sysID the system ID string
@@ -2784,6 +2798,8 @@ xmlACatalogResolve(xmlCatalog *catal, const xmlChar * pubID,
/** /**
* Do a complete resolution lookup of an URI * Do a complete resolution lookup of an URI
* *
* @deprecated Internal function, don't use
*
* @param catal a Catalog * @param catal a Catalog
* @param URI the URI * @param URI the URI
* @returns the URI of the resource or NULL if not found, it must be freed * @returns the URI of the resource or NULL if not found, it must be freed
@@ -2818,6 +2834,8 @@ xmlACatalogResolveURI(xmlCatalog *catal, const xmlChar *URI) {
/** /**
* Dump the given catalog to the given file. * Dump the given catalog to the given file.
* *
* @deprecated Internal function, don't use
*
* @param catal a Catalog * @param catal a Catalog
* @param out the file. * @param out the file.
*/ */
@@ -2838,6 +2856,8 @@ xmlACatalogDump(xmlCatalog *catal, FILE *out) {
* Add an entry in the catalog, it may overwrite existing but * Add an entry in the catalog, it may overwrite existing but
* different entries. * different entries.
* *
* @deprecated Internal function, don't use
*
* @param catal a Catalog * @param catal a Catalog
* @param type the type of record to add to the catalog * @param type the type of record to add to the catalog
* @param orig the system, public or prefix to match * @param orig the system, public or prefix to match
@@ -2877,6 +2897,8 @@ xmlACatalogAdd(xmlCatalog *catal, const xmlChar * type,
/** /**
* Remove an entry from the catalog * Remove an entry from the catalog
* *
* @deprecated Internal function, don't use
*
* @param catal a Catalog * @param catal a Catalog
* @param value the value to remove * @param value the value to remove
* @returns the number of entries removed if successful, -1 otherwise * @returns the number of entries removed if successful, -1 otherwise
@@ -2901,6 +2923,8 @@ xmlACatalogRemove(xmlCatalog *catal, const xmlChar *value) {
/** /**
* create a new Catalog. * create a new Catalog.
* *
* @deprecated Internal function, don't use
*
* @param sgml should this create an SGML catalog * @param sgml should this create an SGML catalog
* @returns the xmlCatalog or NULL in case of error * @returns the xmlCatalog or NULL in case of error
*/ */
@@ -2922,6 +2946,8 @@ xmlNewCatalog(int sgml) {
/** /**
* Check is a catalog is empty * Check is a catalog is empty
* *
* @deprecated Internal function, don't use
*
* @param catal should this create an SGML catalog * @param catal should this create an SGML catalog
* @returns 1 if the catalog is empty, 0 if not, amd -1 in case of error. * @returns 1 if the catalog is empty, 0 if not, amd -1 in case of error.
*/ */

View File

@@ -70,42 +70,55 @@ typedef xmlCatalog *xmlCatalogPtr;
/* /*
* Operations on a given catalog. * Operations on a given catalog.
*/ */
XML_DEPRECATED
XMLPUBFUN xmlCatalog * XMLPUBFUN xmlCatalog *
xmlNewCatalog (int sgml); xmlNewCatalog (int sgml);
XML_DEPRECATED
XMLPUBFUN xmlCatalog * XMLPUBFUN xmlCatalog *
xmlLoadACatalog (const char *filename); xmlLoadACatalog (const char *filename);
XML_DEPRECATED
XMLPUBFUN xmlCatalog * XMLPUBFUN xmlCatalog *
xmlLoadSGMLSuperCatalog (const char *filename); xmlLoadSGMLSuperCatalog (const char *filename);
XML_DEPRECATED
XMLPUBFUN int XMLPUBFUN int
xmlConvertSGMLCatalog (xmlCatalog *catal); xmlConvertSGMLCatalog (xmlCatalog *catal);
XML_DEPRECATED
XMLPUBFUN int XMLPUBFUN int
xmlACatalogAdd (xmlCatalog *catal, xmlACatalogAdd (xmlCatalog *catal,
const xmlChar *type, const xmlChar *type,
const xmlChar *orig, const xmlChar *orig,
const xmlChar *replace); const xmlChar *replace);
XML_DEPRECATED
XMLPUBFUN int XMLPUBFUN int
xmlACatalogRemove (xmlCatalog *catal, xmlACatalogRemove (xmlCatalog *catal,
const xmlChar *value); const xmlChar *value);
XML_DEPRECATED
XMLPUBFUN xmlChar * XMLPUBFUN xmlChar *
xmlACatalogResolve (xmlCatalog *catal, xmlACatalogResolve (xmlCatalog *catal,
const xmlChar *pubID, const xmlChar *pubID,
const xmlChar *sysID); const xmlChar *sysID);
XML_DEPRECATED
XMLPUBFUN xmlChar * XMLPUBFUN xmlChar *
xmlACatalogResolveSystem(xmlCatalog *catal, xmlACatalogResolveSystem(xmlCatalog *catal,
const xmlChar *sysID); const xmlChar *sysID);
XML_DEPRECATED
XMLPUBFUN xmlChar * XMLPUBFUN xmlChar *
xmlACatalogResolvePublic(xmlCatalog *catal, xmlACatalogResolvePublic(xmlCatalog *catal,
const xmlChar *pubID); const xmlChar *pubID);
XML_DEPRECATED
XMLPUBFUN xmlChar * XMLPUBFUN xmlChar *
xmlACatalogResolveURI (xmlCatalog *catal, xmlACatalogResolveURI (xmlCatalog *catal,
const xmlChar *URI); const xmlChar *URI);
#ifdef LIBXML_OUTPUT_ENABLED #ifdef LIBXML_OUTPUT_ENABLED
XML_DEPRECATED
XMLPUBFUN void XMLPUBFUN void
xmlACatalogDump (xmlCatalog *catal, xmlACatalogDump (xmlCatalog *catal,
FILE *out); FILE *out);
#endif /* LIBXML_OUTPUT_ENABLED */ #endif /* LIBXML_OUTPUT_ENABLED */
XML_DEPRECATED
XMLPUBFUN void XMLPUBFUN void
xmlFreeCatalog (xmlCatalog *catal); xmlFreeCatalog (xmlCatalog *catal);
XML_DEPRECATED
XMLPUBFUN int XMLPUBFUN int
xmlCatalogIsEmpty (xmlCatalog *catal); xmlCatalogIsEmpty (xmlCatalog *catal);
@@ -142,6 +155,7 @@ XMLPUBFUN int
XML_DEPRECATED XML_DEPRECATED
XMLPUBFUN xmlDoc * XMLPUBFUN xmlDoc *
xmlParseCatalogFile (const char *filename); xmlParseCatalogFile (const char *filename);
XML_DEPRECATED
XMLPUBFUN int XMLPUBFUN int
xmlCatalogConvert (void); xmlCatalogConvert (void);

View File

@@ -573,16 +573,26 @@ deprecated_funcs = {
'htmlIsScriptAttribute': True, 'htmlIsScriptAttribute': True,
'htmlParseCharRef': True, 'htmlParseCharRef': True,
'htmlParseElement': True, 'htmlParseElement': True,
'xmlACatalogAdd': True,
'xmlACatalogDump': True,
'xmlACatalogRemove': True,
'xmlACatalogResolve': True,
'xmlACatalogResolvePublic': True,
'xmlACatalogResolveSystem': True,
'xmlACatalogResolveURI': True,
'xmlAddEncodingAlias': True, 'xmlAddEncodingAlias': True,
'xmlByteConsumed': True, 'xmlByteConsumed': True,
'xmlCatalogConvert': True,
'xmlCatalogGetPublic': True, 'xmlCatalogGetPublic': True,
'xmlCatalogGetSystem': True, 'xmlCatalogGetSystem': True,
'xmlCatalogIsEmpty': True,
'xmlCheckFilename': True, 'xmlCheckFilename': True,
'xmlCheckLanguageID': True, 'xmlCheckLanguageID': True,
'xmlCleanupCharEncodingHandlers': True, 'xmlCleanupCharEncodingHandlers': True,
'xmlCleanupEncodingAliases': True, 'xmlCleanupEncodingAliases': True,
'xmlCleanupGlobals': True, 'xmlCleanupGlobals': True,
'xmlClearParserCtxt': True, 'xmlClearParserCtxt': True,
'xmlConvertSGMLCatalog': True,
'xmlCopyChar': True, 'xmlCopyChar': True,
'xmlCopyCharMultiByte': True, 'xmlCopyCharMultiByte': True,
'xmlCreateEntityParserCtxt': True, 'xmlCreateEntityParserCtxt': True,
@@ -590,6 +600,7 @@ deprecated_funcs = {
'xmlDelEncodingAlias': True, 'xmlDelEncodingAlias': True,
'xmlDictCleanup': True, 'xmlDictCleanup': True,
'xmlFileMatch': True, 'xmlFileMatch': True,
'xmlFreeCatalog': True,
'xmlGetCompressMode': True, 'xmlGetCompressMode': True,
'xmlGetEncodingAlias': True, 'xmlGetEncodingAlias': True,
'xmlInitCharEncodingHandlers': True, 'xmlInitCharEncodingHandlers': True,
@@ -610,9 +621,12 @@ deprecated_funcs = {
'xmlIsRef': True, 'xmlIsRef': True,
'xmlKeepBlanksDefault': True, 'xmlKeepBlanksDefault': True,
'xmlLineNumbersDefault': True, 'xmlLineNumbersDefault': True,
'xmlLoadACatalog': True,
'xmlLoadSGMLSuperCatalog': True,
'xmlNanoHTTPCleanup': True, 'xmlNanoHTTPCleanup': True,
'xmlNanoHTTPInit': True, 'xmlNanoHTTPInit': True,
'xmlNanoHTTPScanProxy': True, 'xmlNanoHTTPScanProxy': True,
'xmlNewCatalog': True,
'xmlNextChar': True, 'xmlNextChar': True,
'xmlNormalizeWindowsPath': True, 'xmlNormalizeWindowsPath': True,
'xmlParseAttValue': True, 'xmlParseAttValue': True,

View File

@@ -6,6 +6,8 @@
* Author: Daniel Veillard * Author: Daniel Veillard
*/ */
#define XML_DEPRECATED
#include "libxml.h" #include "libxml.h"
#include <string.h> #include <string.h>