libxml2库函数详解

头文件引用

xml2config --cflags

库文件引用

xml2config --libs

主要头文件

parse.h

tree.h

xpath.h

简单例程

Makefile:

INCLUDE=-I./ -I$HOME/include `xml2config --cflags`

LIBRARY=-L./ -L$HOME/lib `xml2config --libs`

*.c或*.cpp

#include <libxml/parse.h>

#include <libxml/tree.h>

#include <libxml/xpath.h>

函数功能

在分析XML数据是，去除空白字符。如果不去除空白字符，则这些字符也会被当做一个node来处理

函数接口

int  xmlKeepBlanksDefault(int val)

参数说明

val：0或者1。0表示去除空白字符，1表示不去除

返回值：0表示设置失败，1表示设置成功，一般不用判断

简单例程

xmlKeepBlanksDefault(0);

函数功能

将XML文件从硬盘上载入到内存中，并且生成DOM树。使用完毕之后，需要用xmlFreeDoc()来释放资源

函数接口

xmlDocPtr xmlParseFile(const char * filename)

参数说明

filename：XML文件名称。

返回值：如果载入成功，则返回这个文档的根节点。否则返回NULL

简单例程

xmlDodPtr pdoc;

pdoc = xmlParseFile("123.xml");

if( pdoc == NULL )

{

     printf("Fail to parse XML file.\n");

}

函数功能

将内存中的DOM树，保存到硬盘上，生成一个带格式的XML文件

函数接口

int  xmlSaveFormatFileEnc(const char * filename,  xmlDocPtr cur,

     const char * encoding, int format)

参数说明

filename：需要保存的文件的名称

cur：需要保存的XML文档

encoding：导出文件的编码类型，或者为NULL

format：是否格式化。0表示不格式化，1表示需要格式化。注意：只有当xmlIndentTreeOutput设置为1，或者xmlKeepBlanksDefault(0)时，format设置为1才能生效

返回值：写入文件中的字节数量

简单例程

xmlDodPtr pdoc;

pdoc = xmlParseFile("123.xml");

if( pdoc == NULL )

{

     printf("Fail to parse XML file.\n");

}

Do_something_with_pdoc();

int filesize;

filesize = xmlSaveFormatFileEnc("321.xml", pdoc, "gb2312",1);

if(filesize == -1)

{

     printf("Fail to save XML to file.\n");

}

函数功能

将一块内存中的XML数据生成一个DOM树。使用完毕之后，需要用xmlFreeDoc()来释放资源

函数接口

xmlDocPtr xmlParseMemory(const char * buffer, int size)

参数说明

buffer：存放XML格式数据的内存区

size：内存中XML格式数据的长度

返回值：如果载入成功，则返回这个文档的根节点；否则返回NULL

简单例程

char *buffer;

int size;

xmlDocPtr pdoc;

// read_data_to_buffer

buffer = ……

size = strlen(buffer);

pdoc = xmlParseMemory(buffer, size);

if( pdoc == NULL)

{

     printf("Fail to parse XML buffer.\n");

}

函数功能

将DOM树导出到内存中，形成一个XML格式的数据

函数接口

void xmlDocDumpFormatMemoryEnc(xmlDocPtr out_doc, xmlChar ** doc_txt_ptr,

     int * doc_txt_len, const char * txt_encoding, int format)

参数说明

out_doc：需要输出成为一个buffer的XML文档

doc_txt_ptr：输出文档的内存区。由该函数在内部申请。使用完成之后，必须调用xmlFree()函数来释放该内存块

doc_txt_len：输出文档内存区的长度

txt_encoding：输出文档的编码类型

format：是否格式化。0表示不格式化，1表示需要格式化。注意只有当xmlIndentTreeOutput设置为1，或者xmlKeepBlanksDefault(0)时，format设置为1才能生效

简单例程

xmlChar *outbuf;

int outlen;

xmlDocPtr pdoc;

pdoc = ……

xmlDocDumpFormatMemoryEnc(pdoc, &outbuf, &outlen, "gb2312", 1);

xmlFree(outbuf);

函数功能

在内存中创建一个新的XML文档。所创建的文档需要使用xmlFreeDoc()来释放资源

函数接口

xmlDocPtr xmlNewDoc     (const xmlChar * version)

参数说明

version：XML标准的版本，目前只能指定为“1.0”

简单例程

xmlDocPtr pdoc ;

pdoc = xmlNewDoc((const xmlChar*)"1.0");

if( pdoc == NULL )

{

     printf(“Fail to create new XML doc.\n”);

}

函数功能

释放内存中的XML文档

函数接口

void xmlFreeDoc(xmlDocPtr cur)

参数说明

cur：需要释放的XML文档

简单例程

xmlDocPtr pdoc ;

pdoc = xmlNewDoc((const xmlChar*)"1.0");

if( pdoc == NULL )

{

     printf(“Fail to create new XML doc.\n”);

}

xmlFreeDoc(podc);

函数功能

获得根节点

函数接口

xmlNodePtr    xmlDocGetRootElement(xmlDocPtr doc)

参数说明

doc：XML文档句柄。

返回值：XML文档的根节点，或者NULL。

使用流程

① 解析好文档的根节点指针，应用使用该指针可以遍历XML文件

② xmlNodePtr的next字段，指向下一个同级XML节点

③ properties字段为xmlAttr类型，指向该XML节点的属性

④ children字段为xmlNodePtr类型，指向该XML节点的子节点

简单例程

xmlDocPtr pdoc ;

xmlNodePtr root ;

pdoc = xmlParseFile("123.xml");

if( pdoc == NULL )

{

     printf("Fail to parse XML File.\n");

     return ;

}

root = xmlDocGetRootElement(pdoc);

if( root == NULL)

{

     printf("Fail to get root element\n");

     return;

}

函数功能

设置根节点

函数接口

xmlNodePtr    xmlDocSetRootElement(xmlDocPtr doc, xmlNodePtr root)

参数说明

doc：XML文档句柄

root：XML文档的新的根节点

返回值：如果该文档原来有根节点，则返回根节点，否则返回NULL

简单例程

xmlDocPtr pdoc ;

xmlNodePtr root;

pdoc = xmlNewDoc((const xmlChar*)"1.0");

if( pdoc == NULL )

{

     printf("Fail to create new XML doc.\n");

     return;

}

root = xmlNewDocNode(pdoc, NULL, (const xmlChar*)"root", NULL);

if( root == NULL )

{

     printf("Fail to create doc node.\n");

     return ;

}

xmlDocSetRootElement(pdoc, root);

函数功能

获得节点的内容

函数接口

xmlChar * xmlNodeGetContent  (xmlNodePtr cur)

参数说明

cur：节点的指针

返回值：节点的文本内容。如果该节点没有文本内容，则返回NULL。当返回值不为NULL时，需要用xmlFree()函数来释放返回的资源

简单例程

xmlNodePtr node;

xmlChar* content;

node = ….

content = xmlNodeGetContent(node);

xmlFree(content);

函数功能

设置节点的内容长度

函数接口

void xmlNodeSetContentLen(xmlNodePtr cur, const xmlChar * content,  int len)

参数说明

cur：节点的指针

content：节点的新文本内容

len：节点新文本内容的长度

简单例程

xmlNodePtr node;

xmlChar* content;

int len;

content = (xmlChar*)"1234567890";

len = strlen((char*)content);

xmlNodeSetContentLen(node, content, len);

函数功能

在节点的内容后面添加新的内容

函数接口

void xmlNodeAddContentLen(xmlNodePtr cur,  const xmlChar * content,  int len)

参数说明

cur：节点的指针

content：节点的新加的文本内容

len：节点新加的文本内容的长度

简单例程

xmlNodePtr node;

xmlChar* content;

int len;

content = (xmlChar*)"1234567890";

len = strlen((char*)content);

xmlNodeAddContentLen(node, content, len);

函数功能

获得节点的属性

函数接口

xmlChar * xmlGetProp(xmlNodePtr node, const xmlChar * name)

参数说明

node：XML节点的指针

name：该节点的属性的名称

返回值：该属性的值或者为NULL。如果不为NULL，则需要用xmlFree()来释放资源

简单例程

xmlNodePtr node;

xmlChar* prop;

node = ….

prop = xmlGetProp(node, (const xmlChar*)"name");

if( prop != NULL)

     xmlFree(prop);

函数功能

设置节点的属性（如果该属性已经存在，则替换其值）

函数接口

xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar * name, const xmlChar * value)

参数说明

node：需要设置属性的节点

name：属性的名称

value：属性的值

返回值：该属性节点的指针

简单例程

xmlNodePtr node;

xmlAttrPtr attr;

node = ….

attr = xmlSetProp(node, (cosnt xmlChar*)"Dept-Name", (const xmlChar*)"ES");

if( attr == NULL)

{

     printf("Fail to set prop of this node.\n");

}

函数功能

生成xpath的上下文关系句柄

函数接口

xmlXPathContextPtr xmlXPathNewContext(xmlDocPtr doc)

参数说明

doc：需要处理的XML文档

返回值：该文档的XPath上下文关系句柄或者NULL。该返回句柄由函数内部申请，此函数调用者需要用xmlXPathFreeContext来释放

简单例程

xmlDocPtr pdoc;

xmlXPathContextPtr xpathctx;

pdoc = ….

xpathctx = xmlXPathNewContext(pdoc);

if( xpathctx != NULL)

     xmlXPathFreeContext(xpathctx);

函数功能

释放xpath的上下文关系句柄

函数接口

void xmlXPathFreeContext(xmlXPathContextPtr ctxt)

参数说明

ctxt：需要释放的xpath上下文关系句柄

简单例程

参见xmlXPathNewContext()的例程

函数功能

执行xpath的表达式，返回结果内容节点集合

XPath表达式的表示方法，请参考：

http://www.zvon.org/xxl/XPathTutorial/General/examples.html

函数接口

xmlXPathObjectPtr  xmlXPathEvalExpression (const xmlChar * str,

                             xmlXPathContextPtr ctxt)

参数说明

str：xpath表达式

ctxt：xpath的上下文关系句柄

返回值：满足表达式的结果集合或者为NULL。该返回句柄由函数内部申请，此函数调用者需要用xmlXPathFreeObject()来释放

简单例程

xmlDocPtr pdoc;

xmlXPathContextPtr xpathctx;

xmlXPathObjectPtr xpathobj;

pdoc = ….

xpathctx = xmlXPathNewContext(pdoc);

if( xpathctx == NULL)

{

     printf("Fail to create xpath context.\n");

     return ;

}

Xpathobj = xmlXPathEvalExpression(BAD_CAST "//@value", xpathctx);

if( xpathobj == NULL)

{

     printf("Fail to evaluate xpath expression.\n");

     xmlXPathFreeContext(xpathctx);

     return;

}

xmlXPathFreeObject(xpathobj);

xmlXPathFreeContext(xpathctx);

结果集说明：

xpathobj-> nodesetval：存储结果列表，如果为NULL，表示无结果

xpathObj->nodesetval->nodeNr：表示结果的数量

xpathObj->nodesetval->nodeTab：表示结果的数组，可以通过下标访问

例如：

int number;

xmlNodePtr node;

if( xpathobj-> nodesetval == NULL)

     number = 0;

else

     number = xpathObj->nodesetval->nodeNr;

for(int i=0;i<number;i++)

{

     node = xpathObj->nodesetval->nodeTab[i];

     do_some_work_with_node();

}

函数功能

释放xpath表达式运算结果集

函数接口

void xmlXPathFreeObject(xmlXPathObjectPtr obj)

参数说明

obj：需要释放的xpath表达式运算结果集合

简单例程

参见xmlXPathEvalExpression()的例程