Nex 项目技术文档

1. 安装指南

环境准备

• 确保已安装 Go 语言环境（Go 1.13 或更高版本）。
• 设置 GOPATH 环境变量，例如：

  export GOPATH=/tmp/go
  

安装步骤

1. 使用 go get 命令安装 Nex：

   go get github.com/blynn/nex
   

2. 安装完成后，Nex 可执行文件将位于 $GOPATH/bin 目录下。

2. 项目使用说明

概述

Nex 是一个类似于 Lex/Flex 的词法分析器生成器，专门为 Go 语言设计。它支持 UTF-8 编码，并且能够与 Go 的 yacc 集成，支持嵌套的结构化正则表达式。

基本使用

1. 创建一个 Nex 文件（例如 lc.nex），编写词法规则和用户代码。
2. 使用 Nex 命令生成 Go 代码并运行：

   nex -r -s lc.nex
   

3. 生成的 Go 代码可以直接编译和运行，处理标准输入并输出结果。

示例

以下是一个简单的 Nex 示例，用于统计字符和行数：

/\n/{ nLines++; nChars++ }
/./{ nChars++ }
//
package main
import ("fmt";"os")
func main() {
  var nLines, nChars int
  NN_FUN(NewLexer(os.Stdin))
  fmt.Printf("%d %d\n", nLines, nChars)
}

3. 项目 API 使用文档

Nex 命令行工具

• nex -r -s <file>：生成并运行词法分析器。
• nex -s <file>：仅生成 Go 代码并输出到标准输出。
• nex -s <file>：生成 Go 代码并保存到 <file>.nn.go。
• nex -p <prefix> <file>：修改生成的代码中的前缀（例如 yy）。

主要 API

• NewLexer(input io.Reader) *Lexer：创建一个新的词法分析器实例。
• Lexer.Lex(v *yySymType)：执行词法分析，返回匹配的 token。
• Lexer.Text() string：返回当前匹配的文本。

4. 项目安装方式

通过 Go 工具安装

go get github.com/blynn/nex

手动安装

1. 克隆项目仓库：

   git clone https://github.com/blynn/nex.git
   

2. 进入项目目录并编译：

   cd nex
   go build
   

3. 将生成的可执行文件移动到系统路径中：

   mv nex /usr/local/bin/
   

通过以上步骤，您可以成功安装并使用 Nex 项目。