Oniguruma 开源项目使用教程

1. 项目目录结构及介绍

Oniguruma 是一个现代且灵活的正则表达式库，支持多种字符编码。以下是项目的目录结构及其介绍：

oniguruma/
├── AUTHORS
├── CMakeLists.txt
├── COPYING
├── ChangeLog
├── HISTORY
├── INSTALL
├── Makefile.am
├── NEWS
├── README
├── README.md
├── README_japanese
├── autogen.sh
├── compile
├── config.guess
├── config.sub
├── configure.ac
├── depcomp
├── doc/
│   ├── API
│   ├── RE
│   └── RE.ja
├── harness/
│   └── ...
├── m4/
│   └── ...
├── samples/
│   ├── callout.c
│   ├── count.c
│   ├── echo.c
│   ├── encode.c
│   ├── listcap.c
│   ├── names.c
│   ├── posix.c
│   ├── regset.c
│   ├── scan.c
│   ├── simple.c
│   ├── sql.c
│   └── user_property.c
├── src/
│   ├── oniguruma.h
│   ├── onig-config.in
│   ├── regenc.h
│   ├── regint.h
│   ├── regparse.h
│   ├── regcomp.c
│   ├── regenc.c
│   ├── regerror.c
│   ├── regext.c
│   ├── regexec.c
│   ├── regparse.c
│   ├── regsyntax.c
│   ├── regtrav.c
│   ├── regversion.c
│   ├── st.h
│   ├── st.c
│   ├── oniggnu.h
│   ├── reggnu.c
│   ├── onigposix.h
│   ├── regposerr.c
│   └── regposix.c
├── test/
│   └── ...
├── tis-ci/
│   └── ...
└── windows/
    └── ...

目录介绍

• doc/: 包含项目的文档，如 API 文档和正则表达式语法文档。
• samples/: 包含多个示例程序，展示了如何使用 Oniguruma 库。
• src/: 包含 Oniguruma 库的核心源代码文件。
• test/: 包含测试文件，用于验证库的功能。
• windows/: 包含 Windows 平台相关的文件和脚本。

2. 项目启动文件介绍

Oniguruma 项目的启动文件主要是 src/oniguruma.h，这是库的主要头文件，包含了所有必要的 API 声明。用户在编写使用 Oniguruma 库的程序时，需要包含此头文件。

#include "oniguruma.h"

3. 项目配置文件介绍

Oniguruma 项目的配置文件主要是 configure.ac 和 Makefile.am。这些文件用于生成项目的构建系统配置。

• configure.ac: 这是 Autoconf 的配置文件，用于生成 configure 脚本。configure 脚本用于检测系统环境并生成相应的 Makefile。
• Makefile.am: 这是 Automake 的配置文件，用于生成 Makefile.in。Makefile.in 是 configure 脚本的输入文件，最终生成 Makefile。

配置步骤

1. 生成 configure 脚本:

   autoreconf -vfi
   

2. 运行 configure 脚本:

   ./configure
   

3. 编译和安装:

   make
   make install
   

通过以上步骤，可以完成 Oniguruma 库的配置、编译和安装。