GoGLL 项目使用教程

GoGLL 项目使用教程

gogll Generates generalised LL (GLL) and reduced size LR(1) parsers with matching lexers 项目地址: https://gitcode.com/gh_mirrors/go/gogll

1. 项目的目录结构及介绍

GoGLL 是一个用于生成 GLL 或 LR(1) 解析器和基于 FSA 的词法分析器的项目。以下是项目的目录结构及其介绍：

• ast：包含抽象语法树（AST）相关的代码。
• cfg：包含配置文件相关的代码。
• doc：存放项目文档。
• examples：包含示例代码和语法文件。
• frstflw：包含计算 FIRST 和 FOLLOW 集的代码。
• gen：包含代码生成器相关的代码。
• gslot：包含符号槽相关的代码。
• lex：包含词法分析器相关的代码。
• lexer：包含词法分析器生成器相关的代码。
• lr1：包含 LR(1) 解析器相关的代码。
• parser：包含解析器相关的代码。
• sc：包含词法分析器中的扫描器代码。
• sppf：包含共享解析森林（SPFP）相关的代码。
• symbols：包含符号表相关的代码。
• test：包含测试代码。
• token：包含标记相关的代码。
• util：包含实用工具相关的代码。
• workflows：包含 GitHub 工作流文件。
• ChangeLog.md：项目的更新日志。
• LICENSE：项目的许可文件。
• README.md：项目的介绍文件。
• go.mod：Go 项目的依赖管理文件。
• go.sum：Go 项目的依赖和校验文件。
• gogll.md：项目的详细说明文件。
• main.go：项目的主入口文件。
• makefile：项目的构建文件。

2. 项目的启动文件介绍

项目的启动文件是 main.go，它负责初始化和启动整个项目。以下是 main.go 的主要功能：

• 解析命令行参数。
• 根据参数指定生成 Go 或 Rust 代码的解析器和词法分析器。
• 读取和解析输入的 BNF（巴科斯-诺尔范式）文件。
• 根据输入的 BNF 文件生成对应的解析器和词法分析器代码。
• 如果指定了输出目录，则将生成的代码输出到指定目录。

3. 项目的配置文件介绍

项目的配置文件是 gogll.md，它包含了项目的详细说明和示例。以下是 gogll.md 的主要内容：

• 项目的简介和功能介绍。
• 如何安装和配置项目。
• 如何使用命令行工具生成解析器和词法分析器代码。
• 生成代码的配置选项说明，如生成 Go 或 Rust 代码、生成 GLL 或 LR(1) 解析器等。
• 项目的更新日志，记录了项目的版本更新和功能变更。
• 项目使用的许可协议。

gogll.md 是项目的主要文档，为用户提供了从安装到使用项目所需的所有信息。

gogll Generates generalised LL (GLL) and reduced size LR(1) parsers with matching lexers 项目地址: https://gitcode.com/gh_mirrors/go/gogll