Blame doc/devhelp/libxml2-globals.html

Packit 423ecb
Packit 423ecb
<html>
Packit 423ecb
  <head>
Packit 423ecb
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
Packit 423ecb
    <title>globals: interface for all global variables of the library</title>
Packit 423ecb
    <meta name="generator" content="Libxml2 devhelp stylesheet"/>
Packit 423ecb
    <link rel="start" href="index.html" title="libxml2 Reference Manual"/>
Packit 423ecb
    <link rel="up" href="general.html" title="API"/>
Packit 423ecb
    <link rel="stylesheet" href="style.css" type="text/css"/>
Packit 423ecb
    <link rel="chapter" href="general.html" title="API"/>
Packit 423ecb
  </head>
Packit 423ecb
  <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 423ecb
    
Packit 423ecb
      
Packit 423ecb
        
Packit 423ecb
          
Packit 423ecb
            Prev
Packit 423ecb
          
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb
          
Packit 423ecb
            Up
Packit 423ecb
          
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb
          
Packit 423ecb
            Home
Packit 423ecb
          
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb
          
Packit 423ecb
            Next
Packit 423ecb
          
Packit 423ecb
        
Packit 423ecb
        libxml2 Reference Manual
Packit 423ecb
      
Packit 423ecb
    
Packit 423ecb
    

Packit 423ecb
      globals
Packit 423ecb
    
Packit 423ecb
    

globals - interface for all global variables of the library

Packit 423ecb
    

all the global variables and thread handling for those variables is handled by this module. The bottom of this file is automatically generated by build_glob.py based on the description file global.data

Packit 423ecb
    

Author(s): Gary Pennington <Gary.Pennington@uk.sun.com>, Daniel Veillard

Packit 423ecb
    
Packit 423ecb
      

Synopsis

Packit 423ecb
      
typedef xmlGlobalState * xmlGlobalStatePtr;
Packit 423ecb
typedef struct _xmlGlobalState xmlGlobalState;
Packit 423ecb
void	xmlThrDefSetStructuredErrorFunc	(void * ctx, 
xmlStructuredErrorFunc handler);
Packit 423ecb
void	xmlInitializeGlobalState	(xmlGlobalStatePtr gs);
Packit 423ecb
xmlBufferAllocationScheme	xmlThrDefBufferAllocScheme	(xmlBufferAllocationScheme v);
Packit 423ecb
int	xmlThrDefPedanticParserDefaultValue	(int v);
Packit 423ecb
xmlRegisterNodeFunc	xmlRegisterNodeDefault	(xmlRegisterNodeFunc func);
Packit 423ecb
typedef xmlParserInputBufferPtr xmlParserInputBufferCreateFilenameFunc	(const char * URI, 
xmlCharEncoding enc);
Packit 423ecb
xmlOutputBufferCreateFilenameFunc	xmlThrDefOutputBufferCreateFilenameDefault	(xmlOutputBufferCreateFilenameFunc func);
Packit 423ecb
xmlDeregisterNodeFunc	xmlDeregisterNodeDefault	(xmlDeregisterNodeFunc func);
Packit 423ecb
int	xmlThrDefDefaultBufferSize	(int v);
Packit 423ecb
xmlOutputBufferCreateFilenameFunc	xmlOutputBufferCreateFilenameDefault	(xmlOutputBufferCreateFilenameFunc func);
Packit 423ecb
int	xmlThrDefLoadExtDtdDefaultValue	(int v);
Packit 423ecb
xmlRegisterNodeFunc	xmlThrDefRegisterNodeDefault	(xmlRegisterNodeFunc func);
Packit 423ecb
int	xmlThrDefKeepBlanksDefaultValue	(int v);
Packit 423ecb
typedef void xmlDeregisterNodeFunc		(xmlNodePtr node);
Packit 423ecb
int	xmlThrDefParserDebugEntities	(int v);
Packit 423ecb
xmlParserInputBufferCreateFilenameFunc	xmlThrDefParserInputBufferCreateFilenameDefault	(xmlParserInputBufferCreateFilenameFunc func);
Packit 423ecb
void	xmlThrDefSetGenericErrorFunc	(void * ctx, 
xmlGenericErrorFunc handler);
Packit 423ecb
xmlParserInputBufferCreateFilenameFunc	xmlParserInputBufferCreateFilenameDefault	(xmlParserInputBufferCreateFilenameFunc func);
Packit 423ecb
int	xmlThrDefDoValidityCheckingDefaultValue	(int v);
Packit 423ecb
void	xmlCleanupGlobals		(void);
Packit 423ecb
int	xmlThrDefGetWarningsDefaultValue	(int v);
Packit 423ecb
xmlDeregisterNodeFunc	xmlThrDefDeregisterNodeDefault	(xmlDeregisterNodeFunc func);
Packit 423ecb
int	xmlThrDefSubstituteEntitiesDefaultValue	(int v);
Packit 423ecb
typedef void xmlRegisterNodeFunc		(xmlNodePtr node);
Packit 423ecb
int	xmlThrDefSaveNoEmptyTags	(int v);
Packit 423ecb
int	xmlThrDefIndentTreeOutput	(int v);
Packit 423ecb
typedef xmlOutputBufferPtr xmlOutputBufferCreateFilenameFunc	(const char * URI, 
xmlCharEncodingHandlerPtr encoder,
int compression);
Packit 423ecb
void	xmlInitGlobals			(void);
Packit 423ecb
int	xmlThrDefLineNumbersDefaultValue	(int v);
Packit 423ecb
const char *	xmlThrDefTreeIndentString	(const char * v);
Packit 423ecb
Packit 423ecb
    
Packit 423ecb
    
Packit 423ecb
      

Description

Packit 423ecb
    
Packit 423ecb
    
Packit 423ecb
      

Details

Packit 423ecb
      
Packit 423ecb
        

Structure xmlGlobalState

struct _xmlGlobalState {
Packit 423ecb
    const char *	xmlParserVersion
Packit 423ecb
    xmlSAXLocator	xmlDefaultSAXLocator
Packit 423ecb
    xmlSAXHandlerV1	xmlDefaultSAXHandler
Packit 423ecb
    xmlSAXHandlerV1	docbDefaultSAXHandler
Packit 423ecb
    xmlSAXHandlerV1	htmlDefaultSAXHandler
Packit 423ecb
    xmlFreeFunc	xmlFree
Packit 423ecb
    xmlMallocFunc	xmlMalloc
Packit 423ecb
    xmlStrdupFunc	xmlMemStrdup
Packit 423ecb
    xmlReallocFunc	xmlRealloc
Packit 423ecb
    xmlGenericErrorFunc	xmlGenericError
Packit 423ecb
    xmlStructuredErrorFunc	xmlStructuredError
Packit 423ecb
    void *	xmlGenericErrorContext
Packit 423ecb
    int	oldXMLWDcompatibility
Packit 423ecb
    xmlBufferAllocationScheme	xmlBufferAllocScheme
Packit 423ecb
    int	xmlDefaultBufferSize
Packit 423ecb
    int	xmlSubstituteEntitiesDefaultValue
Packit 423ecb
    int	xmlDoValidityCheckingDefaultValue
Packit 423ecb
    int	xmlGetWarningsDefaultValue
Packit 423ecb
    int	xmlKeepBlanksDefaultValue
Packit 423ecb
    int	xmlLineNumbersDefaultValue
Packit 423ecb
    int	xmlLoadExtDtdDefaultValue
Packit 423ecb
    int	xmlParserDebugEntities
Packit 423ecb
    int	xmlPedanticParserDefaultValue
Packit 423ecb
    int	xmlSaveNoEmptyTags
Packit 423ecb
    int	xmlIndentTreeOutput
Packit 423ecb
    const char *	xmlTreeIndentString
Packit 423ecb
    xmlRegisterNodeFunc	xmlRegisterNodeDefaultValue
Packit 423ecb
    xmlDeregisterNodeFunc	xmlDeregisterNodeDefaultValue
Packit 423ecb
    xmlMallocFunc	xmlMallocAtomic
Packit 423ecb
    xmlError	xmlLastError
Packit 423ecb
    xmlParserInputBufferCreateFilenameFunc	xmlParserInputBufferCreateFilenameValue
Packit 423ecb
    xmlOutputBufferCreateFilenameFunc	xmlOutputBufferCreateFilenameValue
Packit 423ecb
    void *	xmlStructuredErrorContext
Packit 423ecb
} xmlGlobalState;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlGlobalStatePtr

xmlGlobalState * xmlGlobalStatePtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Signature for the deregistration callback of a discarded node

Packit 423ecb
<tt>node</tt>:the current node
Packit 423ecb
        
Packit 423ecb
        

Function type xmlOutputBufferCreateFilenameFunc

xmlOutputBufferPtr	xmlOutputBufferCreateFilenameFunc	(const char * URI, 
xmlCharEncodingHandlerPtr encoder,
int compression)
Packit 423ecb

Signature for the function doing the lookup for a suitable output method corresponding to an URI.

Packit 423ecb
<tt>URI</tt>:the URI to write to
<tt>encoder</tt>:
<tt>compression</tt>:
<tt>Returns</tt>:the new xmlOutputBufferPtr in case of success or NULL if no method was found.
Packit 423ecb
        
Packit 423ecb
        

Function type xmlParserInputBufferCreateFilenameFunc

xmlParserInputBufferPtr	xmlParserInputBufferCreateFilenameFunc	(const char * URI, 
xmlCharEncoding enc)
Packit 423ecb

Signature for the function doing the lookup for a suitable input method corresponding to an URI.

Packit 423ecb
<tt>URI</tt>:the URI to read from
<tt>enc</tt>:the requested source encoding
<tt>Returns</tt>:the new xmlParserInputBufferPtr in case of success or NULL if no method was found.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Signature for the registration callback of a created node

Packit 423ecb
<tt>node</tt>:the current node
Packit 423ecb
        
Packit 423ecb
        

Variable docbDefaultSAXHandler

xmlSAXHandlerV1 docbDefaultSAXHandler;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable htmlDefaultSAXHandler

xmlSAXHandlerV1 htmlDefaultSAXHandler;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable oldXMLWDcompatibility

int oldXMLWDcompatibility;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlBufferAllocScheme

xmlBufferAllocationScheme xmlBufferAllocScheme;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlDefaultBufferSize

int xmlDefaultBufferSize;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlDefaultSAXHandler

xmlSAXHandlerV1 xmlDefaultSAXHandler;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlDefaultSAXLocator

xmlSAXLocator xmlDefaultSAXLocator;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlDeregisterNodeDefaultValue

xmlDeregisterNodeFunc xmlDeregisterNodeDefaultValue;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlDoValidityCheckingDefaultValue

int xmlDoValidityCheckingDefaultValue;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlFree

xmlFreeFunc xmlFree;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlGenericError

xmlGenericErrorFunc xmlGenericError;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlGenericErrorContext

void * xmlGenericErrorContext;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlGetWarningsDefaultValue

int xmlGetWarningsDefaultValue;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlIndentTreeOutput

int xmlIndentTreeOutput;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlKeepBlanksDefaultValue

int xmlKeepBlanksDefaultValue;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlLastError

xmlError xmlLastError;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlLineNumbersDefaultValue

int xmlLineNumbersDefaultValue;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlLoadExtDtdDefaultValue

int xmlLoadExtDtdDefaultValue;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlMalloc

xmlMallocFunc xmlMalloc;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlMallocAtomic

xmlMallocFunc xmlMallocAtomic;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlMemStrdup

xmlStrdupFunc xmlMemStrdup;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlOutputBufferCreateFilenameValue

xmlOutputBufferCreateFilenameFunc xmlOutputBufferCreateFilenameValue;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlParserDebugEntities

int xmlParserDebugEntities;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlParserInputBufferCreateFilenameValue

xmlParserInputBufferCreateFilenameFunc xmlParserInputBufferCreateFilenameValue;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlParserVersion

const char * xmlParserVersion;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlPedanticParserDefaultValue

int xmlPedanticParserDefaultValue;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlRealloc

xmlReallocFunc xmlRealloc;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlRegisterNodeDefaultValue

xmlRegisterNodeFunc xmlRegisterNodeDefaultValue;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlSaveNoEmptyTags

int xmlSaveNoEmptyTags;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlStructuredError

xmlStructuredErrorFunc xmlStructuredError;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlStructuredErrorContext

void * xmlStructuredErrorContext;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlSubstituteEntitiesDefaultValue

int xmlSubstituteEntitiesDefaultValue;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Variable xmlTreeIndentString

const char * xmlTreeIndentString;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Additional cleanup for multi-threading

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Registers a callback for node destruction

Packit 423ecb
<tt>func</tt>:function pointer to the new DeregisterNodeFunc
<tt>Returns</tt>:the previous value of the deregistration function
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Additional initialisation for multi-threading

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

xmlInitializeGlobalState() initialize a global state with all the default values of the library.

Packit 423ecb
<tt>gs</tt>:a pointer to a newly allocated global state
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Registers a callback for URI output file handling

Packit 423ecb
<tt>func</tt>:function pointer to the new OutputBufferCreateFilenameFunc
<tt>Returns</tt>:the old value of the registration function
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Registers a callback for URI input file handling

Packit 423ecb
<tt>func</tt>:function pointer to the new ParserInputBufferCreateFilenameFunc
<tt>Returns</tt>:the old value of the registration function
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Registers a callback for node creation

Packit 423ecb
<tt>func</tt>:function pointer to the new RegisterNodeFunc
<tt>Returns</tt>:the old value of the registration function
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>v</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>v</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>func</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>v</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>v</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>v</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>v</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>v</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>v</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>func</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>v</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>func</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>v</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>func</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>v</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>ctx</tt>:
<tt>handler</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>ctx</tt>:
<tt>handler</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>v</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Packit 423ecb
<tt>v</tt>:
<tt>Returns</tt>:
Packit 423ecb
        
Packit 423ecb
      
Packit 423ecb
    
Packit 423ecb
  </body>
Packit 423ecb
</html>