CHMLIB 技术文档

本文档将详细介绍如何安装、使用以及API调用CHMLIB，帮助用户更好地理解并应用该库。

1. 安装指南

1.1 安装依赖

CHMLIB 在编译时需要一些依赖，确保您的系统中安装了以下依赖：

• GCC 2.95 到 4.4 版本
• 标准Linux库

1.2 编译与安装

从源代码编译并安装CHMLIB的步骤如下：

tar -zxvf chmlib-0.40a.tar.gz
cd chmlib-0.40a
./configure
make
make install

确保执行 make install 时具有适当的权限。

2. 项目使用说明

CHMLIB 提供了访问 Microsoft Html Help 文件（.chm）的功能，支持查找和读取档案中的文件。

2.1 示例代码

以下是一个简单的示例，展示了如何使用CHMLIB打开一个.chm文件并提取内容：

#include <stdio.h>
#include <chmlib.h>

int main() {
    CHMFile *chm = chm_open("example.chm", CHM_READ);
    if (chm == NULL) {
        printf("无法打开文件\n");
        return 1;
    }

    // 获取文件列表
    char **files = chm_get_file_list(chm);
    for (int i = 0; files[i] != NULL; ++i) {
        printf("文件: %s\n", files[i]);
    }

    // 读取文件内容
    char *file_content;
    unsigned long size;
    if (chm_read_file(chm, "example.html", &file_content, &size) == 0) {
        printf("文件内容:\n%s\n", file_content);
    } else {
        printf("读取文件失败\n");
    }

    // 清理资源
    chm_close(chm);
    chm_free_file_list(files);
    free(file_content);

    return 0;
}

3. 项目API使用文档

以下是一些关键的CHMLIB API函数：

3.1 chm_open

打开一个.chm文件。

CHMFile *chm_open(const char *filename, int flags);

参数：

• filename: 要打开的.chm文件的路径。
• flags: 操作模式（通常是CHM_READ）。

返回值：返回一个CHMFile指针，如果打开失败则为NULL。

3.2 chm_get_file_list

获取.chm文件中所有文件的列表。

char **chm_get_file_list(CHMFile *chm);

参数：

• chm: 通过chm_open返回的CHMFile指针。

返回值：返回一个以NULL结尾的字符串数组，包含文件名。

3.3 chm_read_file

读取.chm文件中的文件内容。

int chm_read_file(CHMFile *chm, const char *filename, char **content, unsigned long *size);

参数：

• chm: 通过chm_open返回的CHMFile指针。
• filename: 要读取的文件名。
• content: 读取的内容会被写入此指针指向的内存。
• size: 内容的大小会被写入此指针指向的变量。

返回值：成功返回0，失败返回非0值。

3.4 chm_close

关闭打开的.chm文件。

void chm_close(CHMFile *chm);

参数：

• chm: 通过chm_open返回的CHMFile指针。

4. 项目安装方式

CHMLIB可以通过源代码编译的方式安装，具体步骤请参考本文档的“1. 安装指南”部分。

请确保在编译和安装过程中遵循所有步骤，以确保正确安装CHMLIB库。