# BrainFuck Pro 使用C语言实现的BrainFuck解释器，并且扩展了部分语法。 ## 关于BrainFuck Brainfuck，是一种极小化的程序语言，它是由Urban Müller在1993年创造的。这种语言有时被简称为BF。 ## 命令行参数 ``` 使用: BrainFuck [参数] 文件.. 参数: -e --eval 从一个字符串中运行代码 -v --version 显示版本信息 -h --help 显示帮助信息 -s --step 以步进模式运行 -i --information 以详细信息模式运行 -n --noninit 每次运行命令行参数指定的文件时不复位读取头 -p --print 默认每次解析完指令后总显示出来 ``` ## 支持的语法 ``` 使用：指令[指令[指令...]] 指令： > 读取头向后移动1格 < 读取头向前移动1格 + 读取头所指格子的数据增加1 - 读取头所指格子的写入数据减1 >n 读取头向后移动n格 +>+++>>+>++>+>+++>>+>++>>>+>+>+>++>+>>>>+++>+>>++>+>+++>>++>++>>+>>+>++>++>+>>>>+++>+>>>>++>++>>>>+>>++>+>+++>>>++>>++++++>>+>>++>+>>>>+++>>+++++>>+>+++>>>++>>++>>+>>++>+>+++>>>++>>+++++++++++++>>+>>++>+>+++>+>+++>>>++>>++++>>+>>++>+>>>>+++>>+++++>>>>++>>>>+>+>++>>+++>+>>>>+++>+>>>>+++>+>>>>+++>>++>++>+>+++>+>++>++>>>>>>++>+>+++>>>>>+++>>>++>+>+++>+>+>++>>>>>>++>>>+>>>++>+>>>>+++>+>>>+>>++>+>++++++++++++++++++>>>>+>+>>>+>>++>+>+++>>>++>>++++++++>>+>>++>+>>>>+++>>++++++>>>+>++>>+++>+>+>++>+>+++>>>>>+++>>>+>+>>++>+>+++>>>++>>++++++++>>+>>++>+>>>>+++>>++++>>+>+++>>>>>>++>+>+++>>+>++>>>>+>+>++>+>>>>+++>>+++>>>+[[->>+<<]<+]+++++[->+++++++++<]>.[+]>>[<<+++++++[->+++++++++<]>-.------------------->-[-<.<+>>]<[+]<+>>>]<<<[-[-[-[>>+<++++++[->+++++<]]>++++++++++++++<]>+++<]++++++[->+++++++<]>+<<<-[->>>++<<<]>[->>.<<]<<] ``` 使用BrainFuckPro实现的HelloWorld程序。 ```brainfuck ++++++++++[>+++++++>++++++++++>+++>+<<<<-] >++.>+.+++++++..+++.>++.<<+++++++++++++++. >.+++.------.--------.>+.>. ``` **注意：命令行模式不支持输入多行的代码** ## 命令行模式 执行完成指定文件后，BrainFuckPro进入命令行交互模式。使用者可以通过stdin即时写入指令操控读取头。 命令行菜单支持的操作（同时为步进模式菜单） ``` v 显示版本号 h 显示帮助 m 显示菜单 d 开启/关闭 每次解析完指令后总显示出来 w 显示详细信息 p 显示完整的纸带信息 t 显示读取头前后20个格子的信息 r 显示读取头信息 n 重置环境 f 运行指定文件 s 开启/关闭 步进模式 (默认关闭) i 开启/关闭 详细信息模式 (默认关闭) c 清空屏幕 (调用系统clear命令) q 退出 e 退出菜单 ``` ## 关于API BrainFuckPro为C语言提供了相应的API。若需要使用，请链接库`BrainFuck_LIB`和包含头文件`brainfuck.h`。 ```c #define bf_setEnvMode(env, name, mode) (bf_setEnv##name##Mode((env), (mode))) // bf_setEnvMode用于设置enc的mode // 目前env的mode支持step(步进模式)和information(执行时显示信息) // mode: 0-关闭 1-打开 -1-若打开则关闭，否则打开 其他值-无实际操作 // 返回值为对应mode的实际值 char *bf_getVersionInfo(void); // 获取版本和版本信息字符串 char *bf_getVersion(void); // 获取版本 // bf_env指针通常可以使用void *来代替 bf_env *bf_setEnv(void); // 设置一个运行环境(返回一个指针) void bf_freeEnv(bf_env *env); // 释放一个环境 void bf_resetEnv(bf_env *env); // 重启env，清空一切数据 void bf_initEnv(bf_env *env); // 复位读取头到初始位置 // bf_code指针通常可以使用void *来代替 void bf_freeBrainFuck(bf_code code); // 释放代码 bf_code bf_parserBrainFuck_File(FILE *file); // 读取文件并生成代码(返回一个code) bf_code bf_parserBrainFuck_Str(const char *str); // 读取字符串并生成代码(返回一个code) void bf_printBrainFuck(bf_code code); // 打印代码 int bf_runBrainFuck(bf_code code, bf_env *env); // 在指定环境中执行代码 (返回0表示无异常) char *bf_printError(char *info, bf_env *env); // 打印错误信息, 若无错误则不执行, 返回错误信息（若无则返回NULL） void bf_printPaperTape(bf_env *env); // 打印纸带 void bf_printHead(bf_env *env); // 打印读取头信息 void bf_printEnv(bf_env *env); // 打印env信息 void bf_printEnvWithMode(bf_env *env); // 打印env信息和env的mode信息 bf_STEP_FUNC bf_setEnvStepFunc(bf_env *env, bf_STEP_FUNC step_func); // 设置步进函数, 每次不仅时当用户输入m时则回调该函数(step_func) ``` `bf_env`即图灵机的纸带，`bf_code`即读取头的指令。二者本质上均为指针，且在brainfuck.h中无具体实现，使用者可以使用`void *`来代替。 ## 构建 使用cmake+make来构建本项目。 创建目录 ```shell $ mkdir build $ cd build ``` 执行cmake ```shell $ cmake .. ``` 若在windows平台上使用Mingw编译，则 ```shell $ cmake .. -G "MinGW Makefiles" ``` cmake编译支持如下选项 ``` build_with_rpath 构建项目时生成的可执行文件的rpath设置为为install时的rpath，若只构建不安装程序请设置为OFF。默认为OFF build_test 开启test，可使用CTest测试项目 ``` 使用make编译 ```shell $ make ``` 安装程序 ```shell $ make install ``` 可以在cmake时指定安装目录。 安装步骤不是必须的，你可以直接运行编译后的二进制文件。 可执行文件会安装在bin目录，动态库则会安装在lib目录（或bin目录），头文件则安装在include目录。 在windows平台下使用VisualStudio编译需要自行添加对getopt模块的支持。 ## 声明 ### 版权声明 版权所有 (c) 2021 [SuperHuan](https://github.com/SuperH-0630) 保留所有权利。 BrainFuckPro编程语言C解释器由SuperHuan开发，技术归属SuperHuan。 本授权协议适用于BrainFuckPro编程语言C解释器，SuperHuan拥有对本授权协议最终解释权和修改权。 ### 免责声明 BrainFuckPro编程语言C解释器为免费开源程序。 编译、运行该程序过程中造成的损失（包括但不限于系统损坏、文件丢失）均由您个人承担， 与开发者无关。 ### LICENSE 该代码是在 MIT License 下发布的。