创建xml文件

xml

可扩展标记语言，标准通用标记语言的子集，是一种用于标记电子文件使其具有结构性的标记语言。它结合了标准通用标记语言和HTML的优点并消除其缺点。比标准通用标记语言要简单，但能实现标准通用标记语言的大部分的功能。XML技术已经广泛应用于e-Learning应用系统的开发,大多数的商用e-Learning平台都支持XML标准。一些主要的网络设备制造商，如CISCO、JUNIPER等，生产的网络设备也已提供了对XML的支持，以利于今后基于XML的网络管理。--[百度百科]

最近手头上有个案子需要用到xml，用来对设备进行相关的配置，由于之前没有新增的操作，以前只做了解析，
修改，这次探究一下，由于之前没有使用libxml2，这次想完整的看一下，搜集了些资料，修改试验下。

libxml2

libxml是一个用来解析XML文档的函数库。它用C语言写成，并且能为多种语言所调用，例如C语言，C++，XSH。C#, Python，Kylix/Delphi，Ruby，和PHP等。Perl中也可以使用XML::LibXML模块。它最初是为GNOME开发的项目，但现在可以用在各种各样的方面。libXML代码可移植性非常好，因为它基于标准的ANSI C库，并采用MIT许可证。--[维基百科]

libxml2安装

libxml2安装可以通过老三步：

./configure
make
make install

源码可以在http://xmlsoft.org/downloads.html下载。
或者通过

#apt-get install libxml2
#apt-get install libxm2-dev 

我的环境里已有，编译时直接指定库文件就可以了。

libxml2常用API

xmlDocPtr xmlParseFile(const char * filename)// 加载xml文件到内存DOM，使用完用xmlFreeDoc()释放
xmlSaveFormatFileEnc(const char * filename,  xmlDocPtr cur, const char * encoding, int format)//将内存中DOM树保存到xml文件
xmlDocPtr xmlParseMemory(const char * buffer, int size)//将内存中的xml数据生成DOM，使用完也要用xmlFreeDoc()释放
void xmlDocDumpFormatMemoryEnc(xmlDocPtr out_doc, xmlChar ** doc_txt_ptr,int * doc_txt_len, const char * txt_encoding, int format)  //将DOM树导出到内存中，形成一个XML格式的数据
xmlDocPtr xmlNewDoc (const xmlChar * version)//在内存中创建一个新的XML文档。所创建的文档需要使用xmlFreeDoc()来释放资源
void xmlFreeDoc(xmlDocPtr cur)//释放内存中的XML文档
xmlNodePtr xmlDocGetRootElement(xmlDocPtr doc)//获得根节点
xmlNodePtr xmlDocSetRootElement(xmlDocPtr doc, xmlNodePtr root)//设置根节点
xmlChar * xmlNodeGetContent  (xmlNodePtr cur)//获得节点的内容
void xmlNodeSetContentLen(xmlNodePtr cur, const xmlChar * content,  int len)//设置节点的内容长度
void xmlNodeAddContentLen(xmlNodePtr cur,  const xmlChar * content,  int len)//在节点的内容后面添加新的内容
xmlChar * xmlGetProp(xmlNodePtr node, const xmlChar * name)//获得节点的属性
xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar * name, const xmlChar * value)//设置节点的属性（如果该属性已经存在，则替换其值）
xmlXPathContextPtr xmlXPathNewContext(xmlDocPtr doc)//生成xpath的上下文关系句柄.该返回句柄由函数内部申请，此函数调用者需要用xmlXPathFreeContext来释放
void xmlXPathFreeContext(xmlXPathContextPtr ctxt)//释放xpath的上下文关系句柄
xmlXPathObjectPtr  xmlXPathEvalExpression (const xmlChar * str,xmlXPathContextPtr ctxt)//执行xpath的表达式，返回结果内容节点集合.该返回句柄由函数内部申请，此函数调用者需要用xmlXPathFreeObject()来释放
void xmlXPathFreeObject(xmlXPathObjectPtr obj)//释放xpath表达式运算结果集
//根节点相关函数
xmlNodePtr xmlDocGetRootElement (xmlDocPtr doc) //获取文档根节点
xmlNodePtr xmlDocSetRootElement (xmlDocPtr doc, xmlNodePtr root) //设置文档根节点
 
//创建子节点相关函数
xmlNodePtr xmlNewNode (xmlNsPtr ns, const xmlChar * name) //创建新节点
xmlNodePtr xmlNewChild (xmlNodePtr parent, xmlNsPtr ns, const xmlChar * name, const xmlChar * content) //创建新的子节点
xmlNodePtr xmlCopyNode (const xmlNodePtr node, int extended) //复制当前节点
 
//添加子节点相关函数
xmlNodePtr xmlAddChild (xmlNodePtr parent, xmlNodePtr cur) //给指定节点添加子节点
xmlNodePtr xmlAddNextSibling (xmlNodePtr cur, xmlNodePtr elem) //添加后一个兄弟节点
xmlNodePtr xmlAddPrevSibling (xmlNodePtr cur, xmlNodePtr elem) //添加前一个兄弟节点
xmlNodePtr xmlAddSibling (xmlNodePtr cur, xmlNodePtr elem) //添加兄弟节点
 
//属性相关函数
xmlAttrPtr xmlNewProp (xmlNodePtr node, const xmlChar * name, const xmlChar * value) //创建新节点属性
xmlChar * xmlGetProp (xmlNodePtr node, const xmlChar * name) //读取节点属性
xmlAttrPtr xmlSetProp (xmlNodePtr node, const xmlChar * name, const xmlChar * value) //设置节点属性
others:
<libxml/parser.h>
 int xmlKeepBlanksDefault (int val) //设置是否忽略空白节点,比如空格,在分析前必须调用,默认值是0,最好设置成1。
xmlDocPtr xmlParseFile (const char * filename) //分析一个xml文件,并返回一个文档对象指针
 
<libxml/tree.h>
//xml操作的基础结构提及其指针类型
//xmlDoc  xmlDocPtr 文档对象的结构体及其指针
//xmlNode xmlNodePtr 节点对象的结构体及其指针
//xmlAttr xmlAttrPtr 节点属性的结构体及其指针
//xmlNs xmlNsPtr 节点命名空间的结构及其指针
 //作用同尾部同名的字符串函数。只不过针对相应的xml节点
xmlChar* xmlStrcat (xmlChar *cur, const xmlChar * add)
const xmlChar *xmlStrchr(const xmlChar * str, xmlChar val)
int xmlStrcmp (const xmlChar * str1, const xmlChar * str2)
int xmlStrlen (const xmlChar * str)
xmlChar *xmlStrncat (xmlChar * cur, const xmlChar * add, int len)
int xmlStrncmp (const xmlChar * str1, const xmlChar * str2, int len)
const xmlChar *xmlStrstr (const xmlChar * str, const xmlChar * val）

创建xml文件

我按照网上的资源简单的修改测试一下OSD设置

#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <assert.h>

#include <libxml/parser.h>
#include <libxml/tree.h>
#include <libxml/xmlmemory.h>

#define OSD_FILE     "osd.xml"
#define STR_LEN        16
#define OSD_STR_LEN         1024


typedef struct osd_t 
{
        int num;          
        unsigned char str[OSD_STR_LEN]; 
        char size[STR_LEN];
        char color[STR_LEN];
        char x[STR_LEN];
        char y[STR_LEN];
}osd;

static void set_osd_item(osd *osd_item)
{
        assert(osd_item);
        osd_item->num = 1;
        snprintf(osd_item->str, OSD_STR_LEN, "%s", "初始化中");
        snprintf(osd_item->size, STR_LEN, "%s", "4");
        snprintf(osd_item->color, STR_LEN, "%s", "1");
        snprintf(osd_item->x, STR_LEN, "%s", "50");
        snprintf(osd_item->y, STR_LEN, "%s", "50");
}

static xmlNodePtr create_osd_node(const osd *osd_item)
{
        assert(osd_item);
        char num[STR_LEN] = {0};
        xmlNodePtr osd_node = NULL;

        osd_node = xmlNewNode(NULL, BAD_CAST"osd");
        if (osd_node == NULL)
        {
                fprintf(stderr, "Failed to create new node.\n");
                return NULL;
        }

        snprintf(num, STR_LEN, "%d", osd_item->num);
        xmlNewProp(osd_node, BAD_CAST"num", (xmlChar*)num);

        xmlNewChild(osd_node, NULL, BAD_CAST"str", (xmlChar *)osd_item->str);
        xmlNewChild(osd_node, NULL, BAD_CAST"size", (xmlChar *)osd_item->size);
        xmlNewChild(osd_node, NULL, BAD_CAST"color", (xmlChar *)osd_item->color);
        xmlNewChild(osd_node, NULL, BAD_CAST"x", (xmlChar *)osd_item->x);
        xmlNewChild(osd_node, NULL, BAD_CAST"y", (xmlChar *)osd_item->y);

        return osd_node;
}

static int add_osd_node_to_root(xmlNodePtr root_node)
{
        xmlNodePtr osd_node = NULL;
        osd *osd_item = NULL;

        osd_item = (osd *)malloc(sizeof(osd));
        if (osd_item == NULL)
        {
                fprintf(stderr, "Failed to malloc memory.\n");
                return -1;
        }

        set_osd_item(osd_item);
        osd_node = create_osd_node(osd_item); 
        if (osd_node == NULL)
        {
                fprintf(stderr, "Failed to create osd node.\n");
                goto FAILED;
        }

        xmlAddChild(root_node, osd_node);
        free(osd_item);
        return 0;

FAILED:
        if (osd_item)
        {
                free(osd_item);
        }
        return -1;
}

static int create_osd_block(const char *osd_block_file)
{
        assert(osd_block_file);
        xmlDocPtr doc = NULL;
        xmlNodePtr root_node = NULL;

        // create xml file
        doc = xmlNewDoc(BAD_CAST"1.0");
        if (doc == NULL)
        {
                fprintf(stderr, "Failed to new doc.\n");
                return -1;
        }

        // create root node
        root_node = xmlNewNode(NULL, BAD_CAST"osd_block");
        if (root_node == NULL)
        {
                fprintf(stderr, "Failed to new root node.\n");
                goto FAILED;
        }

        // add root node to doc
        xmlDocSetRootElement(doc, root_node);
        if (add_osd_node_to_root(root_node) != 0)
        {
                fprintf(stderr, "Failed to add a new osd node.\n");
                goto FAILED;
        }

        /*
           xmlNodePtr node = xmlNewNode(NULL,BAD_CAST"son");
           xmlAddChild(root_node,node);
           xmlNodePtr grandson = xmlNewNode(NULL,BAD_CAST"grandson");
           xmlAddChild(node,grandson);
           xmlAddChild(grandson, xmlNewText(BAD_CAST"This is a grandson node"));
         */

        // add doc to xml file 
        xmlSaveFormatFileEnc(osd_block_file, doc, "UTF-8", 1);
        //xmlSaveFile("test.xml", doc);
        xmlFreeDoc(doc);

        return 0; 

FAILED:
        if (doc)
        {
                xmlFreeDoc(doc);
        }

        return -1;
}

static int add_osd_node(const char *osd_block_file)
{
        assert(osd_block_file);
        xmlDocPtr doc = NULL;
        xmlNodePtr root_node = NULL;
        xmlNodePtr osd_node = NULL;
        osd *osd_item = NULL;

        doc = xmlParseFile(osd_block_file);
        if (doc == NULL)
        {
                fprintf(stderr, "Failed to parser xml file:%s\n", osd_block_file);
                return -1;
        }

        root_node = xmlDocGetRootElement(doc);
        if (root_node == NULL)
        {
                fprintf(stderr, "Failed to get root node.\n");
                goto FAILED;
        }


        if (add_osd_node_to_root(root_node) != 0)
        {
                fprintf(stderr, "Failed to add a new osd node.\n");
                goto FAILED;
        }

        xmlSaveFormatFileEnc(osd_block_file, doc, "UTF-8", 1);
        xmlFreeDoc(doc);

        return 0;

FAILED:
        if (doc)
        {
                xmlFreeDoc(doc);
        }

        return -1;
}

static int add_osd_node_2(const char *osd_block_file)
{
        assert(osd_block_file);
        xmlDocPtr doc = NULL;
        xmlNodePtr root_node = NULL;
        xmlNodePtr osd_node = NULL;
        osd *osd_item = NULL;

        doc = xmlParseFile(osd_block_file);
        if (doc == NULL)
        {
                fprintf(stderr, "Failed to parser xml file:%s\n", osd_block_file);
                return -1;
        }

        root_node = xmlDocGetRootElement(doc);
        if (root_node == NULL)
        {
                fprintf(stderr, "Failed to get root node.\n");
                goto FAILED;
        }

        xmlNodePtr node = xmlNewNode(NULL,BAD_CAST"son");
        xmlAddChild(root_node,node);
        xmlNodePtr grandson = xmlNewNode(NULL,BAD_CAST"grandson");
        xmlAddChild(node,grandson);
        xmlAddChild(grandson, xmlNewText(BAD_CAST"This is a grandson node"));

        xmlSaveFormatFileEnc(osd_block_file, doc, "UTF-8", 1);
        xmlFreeDoc(doc);

        return 0;

FAILED:
        if (doc)
        {
                xmlFreeDoc(doc);
        }

        return -1;
}

int main(int argc, char *argv[])
{
        char *osd_block_file = OSD_FILE;

        if (argc == 2)
        {
                osd_block_file = argv[1];
        }

        if (access(osd_block_file, F_OK) == 0)
        {
                add_osd_node(osd_block_file);
                //add_osd_node_2(osd_block_file);
        }
        else 
        {
                create_osd_block(osd_block_file);
        }

        return 0;
}

编译 运行会生成osd.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<osd_block>
  <osd num="1">
    <str>初始化中</str>
    <size>4</size>
    <color>1</color>
    <x>50</x>
    <y>50</y>
  </osd>
</osd_block>

现存问题

上面是我参照网上的测试例子简单修改的，发现是可以生成xml文件，并成功在根节点设置了一个osd节点，但当再添加一个节点时，发现节点内容是正确的，但是格式是不对的。

<?xml version="1.0" encoding="UTF-8"?>
<osd_block>
  <osd num="1">
    <str>初始化中</str>
    <size>4</size>
    <color>1</color>
    <x>50</x>
    <y>50</y>
  </osd>
<osd num="1"><str>初始化中</str><size>4</size><color>1</color><x>50</x><y>50</y></osd></osd_block>

我在create_osd_block里面插入这样一段代码

xmlNodePtr node = xmlNewNode(NULL,BAD_CAST"son");
xmlAddChild(root_node,node);
xmlNodePtr grandson = xmlNewNode(NULL,BAD_CAST"grandson");
xmlAddChild(node,grandson);
xmlAddChild(grandson, xmlNewText(BAD_CAST"This is a grandson node"));

发现格式是正确的

<?xml version="1.0" encoding="UTF-8"?>
<osd_block>
  <osd num="1">
    <str>初始化中</str>
    <size>4</size>
    <color>1</color>
    <x>50</x>
    <y>50</y>
  </osd>
  <son>
    <grandson>This is a grandson node</grandson>
  </son>
</osd_block>

看来是add_osd_node的问题，下面的工作将找一下原因。具体原因将在下一篇中说明。
输出格式化的xml文件 http://www.jianshu.com/p/10085da2d7ad

引用参考

• http://blog.csdn.net/hanchaoman/article/details/42557195
• http://www.cnblogs.com/Anker/p/3542058.html