# VerificationTool

**Repository Path**: ILovePindleskin/VerificationTool

## Basic Information

- **Project Name**: VerificationTool
- **Description**: 需求验证工具，目前不支持用例的读取
- **Primary Language**: Unknown
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-16
- **Last Updated**: 2025-12-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



VerificationTool
介绍

## 简介
VerificationTool 是一个验证工具，旨在处理文档文件（如 DOCX）以提取需求信息，并生成可追踪性和完整性的报告。此工具能够通过命令行参数进行配置，支持多种操作模式，包括更改文档属性、生成图表文件、导出 Excel 报告等。

## 功能特性
- 提取 DOCX 文件中的需求和逆向关系。
- 生成 DOT 文件以表示需求之间的关系。
- 将 DOT 文件转换为 PNG 图像。
- 将需求信息写入 Excel 文件。
- 支持通过共享内存读写需求映射。
- 支持需求的去重处理。
- 支持需求的上下游关系查询。

## 安装
1. 确保已安装 CMake 和必要的构建工具。
2. 使用提供的 `CMakeLists.txt` 文件配置项目。
3. 构建项目以生成可执行文件。

```shell
mkdir build && cd build
cmake .. -G "Visual Studio 17 2022" -A Win32 -DCMAKE_PREFIX_PATH="C:\Qt\5.15.2\msvc2019" -DCMAKE_BUILD_TYPE=MinSizeRel
cmake --build . --config MinSizeRel


注意：
1. 必须使用32位编译
2. cmake配置时Visual Studio 17 2022和C:\Qt\5.15.2\msvc2019应该匹配，另外C:\Qt\5.15.2\msvc2019可以替换为32位Qt的安装目录
```

```ninja
mkdir build && cd build
cmake .. -G "Ninja" -DCMAKE_PREFIX_PATH="C:\Qt\5.15.2\msvc2019" -DCMAKE_BUILD_TYPE=MinSizeRel
ninja
```


## 使用说明
### 命令行参数
- `-d` 或 `-directory`：指定 DOCX 文件所在的目录路径。
- `-t` 或 `--target`：指定目标需求。
- `-s` 或 `--server`：更改 DOCX 文件属性。
- `-m` 或 `--modify`：启用主处理模式。
- `-p` 或 `--prefix`：启用前缀处理模式。

### 示例
```bash
# 基本使用
VerificationTool -d /path/to/docx -t target_requirement

# 更改 DOCX 文件属性
VerificationTool -d /path/to/docx -t target_requirement -c

# 仅处理主需求
VerificationTool -d /path/to/docx -t target_requirement -m

# 启用前缀处理模式
VerificationTool -d /path/to/docx -t target_requirement -p
```

### GUI 使用指南
VerificationTool 提供了图形用户界面（GUI），使操作更加直观和便捷。

#### 启动 GUI
编译完成后，在输出目录中找到 GUI 可执行文件并双击启动。

#### 主要功能区域
1. **文档选择区域**：通过文件夹浏览按钮选择包含 DOCX 文件的目录。
2. **需求配置区域**：设置目标需求、处理模式等参数。
3. **任务列表区域**：管理和显示待处理的需求列表。
4. **操作按钮**：包括开始处理、添加/删除任务、配置等功能按钮。

#### 基本操作流程
1. 点击文件夹图标按钮选择包含 DOCX 文件的工作目录。
2. 在需求输入框中输入目标需求（可选）。
3. 根据需要配置处理模式和其他选项。
4. 点击"开始"按钮执行验证操作。
5. 处理完成后，可以在输出目录查看生成的报告和图表。

#### 注意事项
- GUI 版本会自动使用与命令行版本相同的核心处理逻辑。
- 确保所有依赖库（如 Qt、Graphviz 等）都已正确安装。
- 处理大量文档时，可能需要较长时间，请耐心等待。

## 依赖项
- Qt：用于构建图形用户界面(GUI)。支持Qt 5.15.2及以上版本。
- duckx, minizip, xlnt, xlsxwriter, zlib：用于文件处理和数据写入。
- pugixml：用于 XML 文件解析。
- Graphviz：用于生成和渲染 DOT 文件。
- args.hxx：用于命令行参数解析。
- catch.hpp：用于单元测试。
- nlohmann/json：用于 JSON 解析和处理。

## 贡献指南
请确保提交的代码遵循项目编码规范，并提供适当的单元测试。所有贡献需通过 Pull Request 进行审查。

## 许可证
本项目根据 MIT 许可证发布。详情请参阅 LICENSE 文件。