# BrainFuck

**Repository Path**: William-Mindless-Buddha/brain-fuck

## Basic Information

- **Project Name**: BrainFuck
- **Description**: 🧠BrainFuck🧠的解释器和编译器，使用C++开发。其中解释器包含交互模式和脚本模式，编译器可将BrainFuck代码编译为可执行程序。
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 1
- **Created**: 2024-12-13
- **Last Updated**: 2025-06-17

## Categories & Tags

**Categories**: ci

**Tags**: None

## README

# BrainFuck

### 一、介绍

🧠BrainFuck🧠的解释器和编译器，使用C++开发。其中解释器包含交互模式和脚本模式，编译器可将BrainFuck代码编译为可执行程序。目前仅适用于Windows系统，平台为x86_64，最终程序在Debug模式下生成。安装包可在0.0.1-alpha标签下的发行版中下载。

### 二、使用说明

#### 2.1  🧠BrainFuck🧠解释器

- 交互模式
  - 进入BrainFuckInterpreter的安装目录，打开PowerShell使用，当然也可以预先将安装目录配置到环境变量中。
  - 输入`./BrainFuck.exe -i`或`./BrainFuck.exe --interactive`并回车即可进入交互模式。
  - 交互模式中可输入`&show`以查看已运行的所有BrainFuck代码。
  - 交互模式中可输入`&exit`以退出。

- 脚本模式
  - 进入BrainFuckInterpreter的安装目录，打开PowerShell使用，当然也可以预先将安装目录配置到环境变量中。
  - 输入`./BrainFuck.exe -s -f <script>`并回车即代表使用脚本模式。
  - `-s`可用`--script`替换，`-f`可用`--file`替换，`<script>`代表脚本的文件名。

- 其他选项
  - `-h`或`--help`用于输出帮助文档。
  - `-c`或`--capacity`后跟一个数字用于指定纸带容量。
  - `-v`或`--visible`用于开启可视化，让BrainFuck代码的执行过程被输出到控制台上。
  - `-e`或`--execute-mode`后跟一个模式字符串用于指定代码执行的模式，目前有`step`和`fast`两种模式，前者让每一个BrainFuck的命令的执行执行结果都输出到控制台上，后者每次执行新的BrainFuck命令的结果输出都将覆盖上一次结果输出。

#### 2.2  🧠BrainFuck🧠编译器

- 进入BrainFuckCompiler的安装目录，打开PowerShell使用，当然也可以预先将安装目录配置到环境变量中。
- 各选项含义
  - `-h`或`--help`用于输出帮助文档。
  - `-a`或`--assemble`后跟一个字符串用于指定BrainFuck编译生成的汇编代码文件的文件名。
  - `-c`或`--capacity`后跟一个数字用于指定纸带容量。
  - `-e`或`--execute`后跟一个字符串用于指定BrainFuck编译生成的可执行文件的文件名。
  - `-f`或`--file`后跟一个字符串用于指定BrainFuck代码文件的文件名。
  - `-i`或`--intermediate-dir`后跟一个字符串用于指定BrainFuck编译过程中生成的中间文件的存储路径。
  - `--init-paper-tape-ch`后跟一个字符串用于指定纸带上的初始字符。若后跟的字符串是单字符字符串，则纸带上的初始字符就是该单字符，若后跟的字符串是以字母n开头且之后是一个数字字符串的形式，则编译器会解析出这个数字，并将这个数字转换为char类型作为纸带上的初始字符。
  - `-o`或`--object`后跟一个字符串用于指定BrainFuck编译生成的obj文件的文件名。
  - `-p`或`--purify`后跟一个字符串用于指定BrainFuck编译生成的纯净BrainFuck文件的文件名。
  - `-t`或`--target-dir`后跟一个字符串用于指定BrainFuck编译生成的可执行文件的存储路径。

### 三、参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request