ydiff 项目教程

1. 项目目录结构及介绍

ydiff 项目的目录结构如下：

ydiff/
├── demos/
│   ├── ...
├── LICENSE
├── Makefile
├── README.md
├── diff-cpp/
│   ├── ...
├── diff-js/
│   ├── ...
├── diff-lisp/
│   ├── ...
├── diff-yin/
│   ├── ...
├── diff.css
├── diff.rkt
├── htmlize.rkt
├── nav.js
├── parse-cpp.rkt
├── parse-js.rkt
├── parse-lisp.rkt
├── parse-yin.rkt
├── parsec.rkt
├── structs.rkt
└── utils.rkt

目录结构介绍

• demos/: 包含示例文件，用于演示 ydiff 的功能。
• LICENSE: 项目的许可证文件，采用 GPL-3.0 许可证。
• Makefile: 用于编译项目的 Makefile 文件。
• README.md: 项目的说明文档，包含项目的基本信息和使用方法。
• diff-cpp/, diff-js/, diff-lisp/, diff-yin/: 这些目录包含不同语言的解析和比较代码。
• diff.css: 用于生成 HTML 输出的样式文件。
• diff.rkt: 主程序文件，用于执行结构化比较。
• htmlize.rkt: 用于将比较结果转换为 HTML 格式的工具。
• nav.js: 用于 HTML 输出的导航脚本。
• parse-cpp.rkt, parse-js.rkt, parse-lisp.rkt, parse-yin.rkt: 这些文件包含不同语言的解析器代码。
• parsec.rkt: 通用的解析器工具。
• structs.rkt: 定义了项目中使用的数据结构。
• utils.rkt: 包含项目中使用的通用工具函数。

2. 项目启动文件介绍

项目的启动文件是 diff.rkt。这个文件是 ydiff 的主程序文件，负责执行结构化比较并生成输出。

启动文件功能

• 解析输入文件: diff.rkt 会解析用户提供的输入文件，并将其转换为内部数据结构。
• 执行比较: 文件会根据解析后的数据结构执行结构化比较，识别代码的变更、移动和重构。
• 生成输出: 比较结果会通过 htmlize.rkt 工具转换为 HTML 格式，并生成一个 HTML 文件供用户查看。

启动方法

要启动 ydiff，首先需要确保已经安装了 Racket 编程语言。然后，在项目根目录下运行以下命令：

racket diff.rkt <input_file1> <input_file2>

这将生成一个 HTML 文件，包含两个输入文件的比较结果。

3. 项目的配置文件介绍

ydiff 项目没有专门的配置文件，所有的配置和参数都是通过命令行参数传递的。主要的配置选项包括：

• 输入文件: 通过命令行指定需要比较的两个文件。
• 输出文件: 默认情况下，输出文件名为 input_file1-input_file2.html，可以通过命令行参数进行自定义。
• 样式文件: 生成的 HTML 文件依赖于 diff.css 和 nav.js 文件，这些文件需要与生成的 HTML 文件放在同一目录下。

配置示例

racket diff.rkt demos/mk1.ss demos/mk2.ss

这将比较 demos/mk1.ss 和 demos/mk2.ss 文件，并生成一个名为 mk1-mk2.html 的 HTML 文件。

注意事项

• 确保 diff.css 和 nav.js 文件与生成的 HTML 文件在同一目录下，否则生成的 HTML 文件可能无法正确显示。
• 如果需要自定义输出文件名，可以通过命令行参数进行指定。

通过以上步骤，您可以顺利地使用 ydiff 项目进行代码的结构化比较。