1. simple_xml简介

SimpleXML是一个基于C语言的XML解析器，可用于读取和修改XML文件。该解析器与操作系统无关，可以在不同操作系统上运行，包括Linux、Windows、Mac OS X、Android等。在大多数操作系统中，XML文件是通过读写XML元素的属性、文本和子元素来进行操作的。SimpleXML提供了一些易于使用的函数来读取和写入这些元素的属性、文本和子元素。此外，SimpleXML还支持使用嵌入式操作系统，如Windows CE和VxWorks。

2. simple_xml的特点

SimpleXML主要有以下特点：

- SimpleXML实现了XML node对象，这是解析器最核心的功能实现。

- 基于XML node对象，SimpleXML派生了XML element对象，使得相关函数对XML element的操作更容易。

- 应用程序主要使用XML element对象的函数来读取或写入xml element的属性，文本，子节点等。

- SimpleXML提供了字符串的相关函数集，可以减少对标准库的依赖，便于跨平台的支持。

- SimpleXML支持全功能OS平台、也支持运行在裸机环境，但使用了动态内存分配，裸机环境下要考虑文件系统以及动态内核分配的实现。

- SimpleXML提供了在使用xml会用得上的一些函数，比如xml_ishex,用来判断字符串是否为hex格式的字符串。

- SimpleXML提供了文件操作抽象层和内存操作抽象层，用于分离与平台相关的API，主要目的是为了方便扩展未支持的文件系统和动态内存管理库。

3. 目录结构

SimpleXML的目录结构如下：

- /docs：

计划对各模块进行详细的解释说明，目前还没有完整的文档。

- /examples：

包含一个main.c和xmltest.xml作为示例，用于展示如何使用SimpleXML进行XML操作。

- /inc：

simple_xml的头文件，包括所有的头文件和宏定义。

- /src：

simple_xml的源文件，包括所有的源代码和函数实现。

- LICENSE：

MIT License，表示该项目使用MIT License进行许可。

- README.md：

对SimpleXML的说明，包括项目的背景、目的、使用方法等。

- Sconscript：

rt-thread软件包中编译脚本。

4. 移植方法

要在不同的操作系统中运行SimpleXML，需要进行以下移植步骤：

1. 将inc和src两个文件夹Copy到自己的目录。

2. 在调试SimpleXML的API的.c文件中包含头文件xml_export.h。

3. 配置xml_config.h中的宏OS_VER为目标系统，该宏定义了正在使用的操作系统版本。

SimpleXML已支持以下操作系统平台：

- Linux：

通过配置xml_config.h中的宏OS_VER为OS_LINUX进行支持。

- Windows：

通过配置xml_config.h中的宏OS_VER为OS_WINCE进行支持。

- Mac OS X：

通过配置xml_config.h中的宏OS_VER为OS_MACOSX进行支持。

- Android：

通过配置xml_config.h中的宏OS_VER为OS_ANDROID进行支持。

在未来的版本中，SimpleXML可能会支持更多的操作系统平台。

SimpleXML未支持的平台：

- Win10

- VxWorks

对于未支持的平台，可以进行以下移植步骤：

1. 配置xml_config.h中的宏OS_VER为OS_UNKOWN。

2. 调用xml_fconfig函数和xml_mconfig函数配置文件抽象操作函数和内存抽象操作函数。

对于使用SimpleXML进行文件操作，需要注意以下事项：

- 在使用文件操作抽象层时，需要确保目标平台有相应的文件操作API。

- 在使用内存操作抽象层时，需要确保目标平台有相应的动态内存管理API。

使用示例：

使用示例可以帮助用户更好地理解SimpleXML的使用方法。以下是一个简单的示例代码：

#include <stdio.h>
#include <xml_export.h>
int main()
{
// 打开XML文件
char *xml_path = "../../xmltest.xml";
FILE *xml_file = fopen(xml_path, "r");
if (!xml_file)
{
    printf("Can't open XML file.\n");
    return 1;
}
// 加载SimpleXML解析器
SimpleXML *xml = simpleXML_load(xml_file);
if (!xml)
{
    printf("Can't load SimpleXML parser.\n");
    return 2;
}
// 遍历XML文件

基于GCC+Makefile构建

仅在Linux的环境下做了测试。在WIN10下makefile的脚本未作兼容，使用起来会有问题，建议在WIN10使用的示例直接使用VS2019来搭建测试环境。

1. 进入目录example/build/make
2. 在命令行输入:
   $ make
3. 在命令行输入:
   $ ./simple_xml ../../xmltest.xml
4. 检查打印内容是否与xmltest.xml一致

基于rt-thread构建

手动移植

1. 将整个simple_xml目录放入rt-thread BSP里的packages目录
2. 手动在rtconfig.h头文件中加入

#define PKG_USING_SIMPLE_XML
#define PKG_USING_SIMPLE_XML_EXAMPLE

1. 在ENV工具中编译

> scons

1. 下载固件到目标板或qemu中。
2. 将example/xmltest.xml放入rt-thread的文件系统中。
3. 输入以下指令

msh />xml_test

• 使用软件包

1. 在ENV环境下使用menuconfig，找到simple_xml

RT-Thread online packages 
    → IoT - internet of things 
        → simple_xml  : Based on the XML parser of the C language.

1. 下载软件包

> pkgs --update

1. 同手动移植第3步

仓库

• github :「链接」
• github:「链接」