dict.h File Reference

#include <stddef.h>
#include <libxml/xmlversion.h>
#include <libxml/xmlstring.h>

Include dependency graph for dict.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct _xmlDict	xmlDict
typedef xmlDict *	xmlDictPtr

Functions
XML_DEPRECATED XMLPUBFUN int	xmlInitializeDict (void)
XMLPUBFUN xmlDictPtr	xmlDictCreate (void)
XMLPUBFUN size_t	xmlDictSetLimit (xmlDictPtr dict, size_t limit)
XMLPUBFUN size_t	xmlDictGetUsage (xmlDictPtr dict)
XMLPUBFUN xmlDictPtr	xmlDictCreateSub (xmlDictPtr sub)
XMLPUBFUN int	xmlDictReference (xmlDictPtr dict)
XMLPUBFUN void	xmlDictFree (xmlDictPtr dict)
XMLPUBFUN const xmlChar *	xmlDictLookup (xmlDictPtr dict, const xmlChar *name, int len)
XMLPUBFUN const xmlChar *	xmlDictExists (xmlDictPtr dict, const xmlChar *name, int len)
XMLPUBFUN const xmlChar *	xmlDictQLookup (xmlDictPtr dict, const xmlChar *prefix, const xmlChar *name)
XMLPUBFUN int	xmlDictOwns (xmlDictPtr dict, const xmlChar *str)
XMLPUBFUN int	xmlDictSize (xmlDictPtr dict)
XML_DEPRECATED XMLPUBFUN void	xmlDictCleanup (void)

Typedef Documentation

xmlDict

typedef struct _xmlDict xmlDict

Definition at line 25 of file dict.h.

xmlDictPtr

typedef xmlDict* xmlDictPtr

Definition at line 26 of file dict.h.

Function Documentation

xmlDictCleanup()

XML_DEPRECATED XMLPUBFUN void xmlDictCleanup

(

void

)

xmlDictCleanup:

DEPRECATED: This function is a no-op. Call xmlCleanupParser to free global state but see the warnings there. xmlCleanupParser should be only called once at program exit. In most cases, you don't have call cleanup functions at all.

Definition at line 112 of file dict.c.

                     {
}

xmlDictCreate()

XMLPUBFUN xmlDictPtr xmlDictCreate

(

void

)

xmlDictCreate:

Create a new dictionary

Returns the newly created dictionary, or NULL if an error occurred.

Definition at line 262 of file dict.c.

                    {
    xmlDictPtr dict;
 
    xmlInitParser();
 
    dict = xmlMalloc(sizeof(xmlDict));
    if (dict == NULL)
        return(NULL);
    dict->ref_counter = 1;
    dict->limit = 0;
 
    dict->size = 0;
    dict->nbElems = 0;
    dict->table = NULL;
    dict->strings = NULL;
    dict->subdict = NULL;
    dict->seed = xmlRandom();
#ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
    dict->seed = 0;
#endif
    return(dict);
}

Referenced by xmlDictCreateSub(), xmlInitSAXParserCtxt(), and xsltNewStylesheetInternal().

xmlDictCreateSub()

XMLPUBFUN xmlDictPtr xmlDictCreateSub

(

xmlDictPtr

sub

)

xmlDictCreateSub: @sub: an existing dictionary

Create a new dictionary, inheriting strings from the read-only dictionary @sub. On lookup, strings are first searched in the new dictionary, then in @sub, and if not found are created in the new dictionary.

Returns the newly created dictionary, or NULL if an error occurred.

Definition at line 297 of file dict.c.

                                 {
    xmlDictPtr dict = xmlDictCreate();
 
    if ((dict != NULL) && (sub != NULL)) {
        dict->seed = sub->seed;
        dict->subdict = sub;
    xmlDictReference(dict->subdict);
    }
    return(dict);
}

Referenced by xsltNewTransformContext().

xmlDictExists()

XMLPUBFUN const xmlChar * xmlDictExists	(	xmlDictPtr	dict,
		const xmlChar *	name,
		int	len
	)

Definition at line 872 of file dict.c.

                                                             {
    const xmlDictEntry *entry;
 
    entry = xmlDictLookupInternal(dict, NULL, name, len, 0);
    if (entry == NULL)
        return(NULL);
    return(entry->name);
}

xmlDictFree()

XMLPUBFUN void xmlDictFree

(

xmlDictPtr

dict

)

xmlDictFree: @dict: the dictionary

Free the hash @dict and its contents. The userdata is deallocated with @f if provided.

Definition at line 333 of file dict.c.

                             {
    xmlDictStringsPtr pool, nextp;
 
    if (dict == NULL)
    return;
 
    /* decrement the counter, it may be shared by a parser and docs */
    xmlMutexLock(&xmlDictMutex);
    dict->ref_counter--;
    if (dict->ref_counter > 0) {
        xmlMutexUnlock(&xmlDictMutex);
        return;
    }
 
    xmlMutexUnlock(&xmlDictMutex);
 
    if (dict->subdict != NULL) {
        xmlDictFree(dict->subdict);
    }
 
    if (dict->table) {
    xmlFree(dict->table);
    }
    pool = dict->strings;
    while (pool != NULL) {
        nextp = pool->next;
    xmlFree(pool);
    pool = nextp;
    }
    xmlFree(dict);
}

Referenced by xmlDictFree(), xmlFreeParserCtxt(), xmlHashFree(), xmlParseBalancedChunkMemoryInternal(), xmlParseExternalEntityPrivate(), xmlParseInNodeContext(), xslt_doc_default_loader(), xsltDocDefaultLoaderFunc(), xsltFreeStylesheet(), xsltFreeTransformContext(), and xsltParseStylesheetUser().

xmlDictGetUsage()

XMLPUBFUN size_t xmlDictGetUsage

(

xmlDictPtr

dict

)

xmlDictGetUsage: @dict: the dictionary

Get how much memory is used by a dictionary for strings Added in 2.9.0

Returns the amount of strings allocated

Definition at line 441 of file dict.c.

                                 {
    xmlDictStringsPtr pool;
    size_t limit = 0;
 
    if (dict == NULL)
    return(0);
    pool = dict->strings;
    while (pool != NULL) {
        limit += pool->size;
    pool = pool->next;
    }
    return(limit);
}

xmlDictLookup()

XMLPUBFUN const xmlChar * xmlDictLookup	(	xmlDictPtr	dict,
		const xmlChar *	name,
		int	len
	)

Definition at line 824 of file dict.c.

                                                             {
    const xmlDictEntry *entry;
 
    entry = xmlDictLookupInternal(dict, NULL, name, len, 1);
    if (entry == NULL)
        return(NULL);
    return(entry->name);
}

Referenced by xmlAddAttributeDecl(), xmlAddID(), xmlCopyDocElementContent(), xmlDetectSAX2(), xmlHashUpdateInternal(), xmlNewDocElementContent(), xmlParseBalancedChunkMemoryInternal(), xmlParseExternalEntityPrivate(), xmlParseName(), xmlParseNameComplex(), xmlParseReference(), xmlSAX2TextNode(), xsltAddTemplate(), xsltApplyAttributeSet(), xsltApplyStylesheetInternal(), xsltAttribute(), xsltAttributeComp(), xsltAttrListTemplateProcess(), xsltAttrTemplateProcess(), xsltElement(), xsltElementComp(), xsltEvalStaticAttrValueTemplate(), xsltGetCNsProp(), xsltGetQNameProperty(), xsltGetQNameURI2(), xsltNumberComp(), xsltParseStylesheetAttributeSet(), xsltParseStylesheetTemplate(), xsltParseTemplateContent(), xsltPreprocessStylesheet(), xsltProcessUserParamInternal(), xsltRegisterGlobalVariable(), xsltShallowCopyAttr(), xsltSortComp(), xsltSplitQName(), xsltStackLookup(), and xsltXPathVariableLookup().

xmlDictOwns()

XMLPUBFUN int xmlDictOwns	(	xmlDictPtr	dict,
		const xmlChar *	str
	)

xmlDictOwns: @dict: the dictionary @str: the string

check if a string is owned by the dictionary

Returns 1 if true, 0 if false and -1 in case of error -1 in case of error

Definition at line 376 of file dict.c.

                                                 {
    xmlDictStringsPtr pool;
 
    if ((dict == NULL) || (str == NULL))
    return(-1);
    pool = dict->strings;
    while (pool != NULL) {
        if ((str >= &pool->array[0]) && (str <= pool->free))
        return(1);
    pool = pool->next;
    }
    if (dict->subdict)
        return(xmlDictOwns(dict->subdict, str));
    return(0);
}

Referenced by xmlDictOwns(), xmlFreeAttribute(), xmlFreeDocElementContent(), xmlHashUpdateInternal(), xmlParseEnumerationType(), xmlParseNotationType(), xmlSAX2ExternalSubset(), xmlSAX2Text(), xsltAttrListTemplateProcess(), xsltAttrTemplateProcess(), xsltCopyText(), xsltParseTemplateContent(), and xsltPreprocessStylesheet().

xmlDictQLookup()

XMLPUBFUN const xmlChar * xmlDictQLookup	(	xmlDictPtr	dict,
		const xmlChar *	prefix,
		const xmlChar *	name
	)

Definition at line 894 of file dict.c.

                                                                            {
    const xmlDictEntry *entry;
 
    entry = xmlDictLookupInternal(dict, prefix, name, -1, 1);
    if (entry == NULL)
        return(NULL);
    return(entry->name);
}

Referenced by xmlSAX2StartElementNs(), xsltApplyStylesheetInternal(), and xsltDocumentElem().

xmlDictReference()

XMLPUBFUN int xmlDictReference

(

xmlDictPtr

dict

)

xmlDictReference: @dict: the dictionary

Increment the reference counter of a dictionary

Returns 0 in case of success and -1 in case of error

Definition at line 317 of file dict.c.

                                  {
    if (dict == NULL) return -1;
    xmlMutexLock(&xmlDictMutex);
    dict->ref_counter++;
    xmlMutexUnlock(&xmlDictMutex);
    return(0);
}

Referenced by xmlDictCreateSub(), xmlHashCreateDict(), xmlParseBalancedChunkMemoryInternal(), xmlParseExternalEntityPrivate(), xmlSAX2StartDocument(), xslt_doc_default_loader(), xsltApplyStylesheetInternal(), xsltCreateRVT(), xsltDocDefaultLoaderFunc(), xsltDocumentElem(), xsltLoadStylesheetPI(), and xsltParseStylesheetUser().

xmlDictSetLimit()

XMLPUBFUN size_t xmlDictSetLimit	(	xmlDictPtr	dict,
		size_t	limit
	)

xmlDictSetLimit: @dict: the dictionary @limit: the limit in bytes

Set a size limit for the dictionary Added in 2.9.0

Returns the previous limit of the dictionary or 0

Definition at line 421 of file dict.c.

                                               {
    size_t ret;
 
    if (dict == NULL)
    return(0);
    ret = dict->limit;
    dict->limit = limit;
    return(ret);
}

Referenced by xmlCtxtUseOptionsInternal(), and xmlInitSAXParserCtxt().

xmlDictSize()

XMLPUBFUN int xmlDictSize

(

xmlDictPtr

dict

)

xmlDictSize: @dict: the dictionary

Query the number of elements installed in the hash @dict.

Returns the number of elements in the dictionary or -1 in case of error

Definition at line 402 of file dict.c.

                             {
    if (dict == NULL)
    return(-1);
    if (dict->subdict)
        return(dict->nbElems + dict->subdict->nbElems);
    return(dict->nbElems);
}

xmlInitializeDict()

XML_DEPRECATED XMLPUBFUN int xmlInitializeDict

(

void

)

xmlInitializeDict:

DEPRECATED: Alias for xmlInitParser.

Returns 0.

Definition at line 88 of file dict.c.

                        {
    xmlInitParser();
    return(0);
}