C++/Rust 元编程之 BrainFuck 编译器（constexpr/ 过程宏解法）

原文地址： C++/Rust 元编程之 BrainFuck 编译器（constexpr/ 过程宏解法）

引子

接上一篇 C++ 元编程之 BrainFuck 编译器（模板元解法） 挖了个坑：用constexpr方式实现，我发现更容易实现了，代码不到100行搞定，同时也尝试了一下用Rust过程宏来作元编程，最后我会对这二者进行比较。

以前模板元方式解法不支持嵌套循环，同时也不支持输入输出，在此次实现中，支持嵌套循环、输出。

C++版本：

   
 
 
    // compile time
constexpr auto res = brain_fuck(R"(
 ++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.
 >---.+++++++..+++.>>.<-.<.+++.------.--------.>>+.>++.
)");
puts(res);

// runtime
if (argc > 1) puts(brain_fuck(argv[1]));
 

   

Rust版本：

   
 
 
    println!("{}", brain_fuck!(
 ++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.
 >---.+++++++..+++.>>.<-.<.+++.------.--------.>>+.>++.
));
 

   

而二者背后实现的算法是一致的。

C++ constexpr解法

其实模板元解法和constexpr解法能力相同，只是实现代价不一样，后者更容易实现，写起来就像普通函数同样。运行结果可看： https://godbolt.org/z/EYn7PG

首先定义一个Stream类，用于存放输出结果：

   
 
 
    template<size_t N>
class Stream {
public:
 constexpr void push(char c) { data_[idx_++] = c; }
 constexpr operator const char*() const { return data_; }
 constexpr size_t size() { return idx_; }
private:
 size_t idx_{};
 char data_[N]{};
};
 

   

而后写一个parse函数，解析BrainFuck代码，经典的递归降低分析：

   
 
 
    template<typename STREAM>
constexpr auto parse(const char* input, bool skip, char* cells,
 size_t& pc, STREAM&& output) -> size_t {
 const char* c = input;
 while(*c) {
 switch(*c) {
 case '+': if (!skip) ++cells[pc]; break;
 case '-': if (!skip) --cells[pc]; break;
 case '.': if (!skip) output.push(cells[pc]); break;
 case '>': if (!skip) ++pc; break;
 case '<': if (!skip) --pc; break;
 case '[': {
 while (!skip && cells[pc] != 0)
 parse(c + 1, false, cells, pc, output);
 c += parse(c + 1, true, cells, pc, output) + 1;
 } break;
 case ']': return c - input;
 default: break;
 }
 ++c;
 }
 return c - input;
}

constexpr size_t CELL_SIZE = 16;
template<typename STREAM>
constexpr auto parse(const char* input, STREAM&& output) -> STREAM&& {
 char cells[CELL_SIZE]{};
 size_t pc{};
 parse(input, false, cells, pc, output);
 return output;
}
 

   

最后用brain_fuck函数串起来：

   
 
 
    template<size_t OUTPUT_SIZE = 15>
constexpr auto brain_fuck(const char* input) {
 Stream<OUTPUT_SIZE> output;
 return parse(input, output);
}
 

   

以上就是实现一个BrainFuck编译器的全部细节。

延伸一下，若是你细心的话，你会发现输出大小须要手动指定（默认15字节），若是大小过大，那么多余的空间浪费了；若是大小太小，编译报错。思考一下，有什么办法肯定大小呢？毕竟C++20以前constexpr不支持动态分配内存，像链表这种随时扩容的方式暂时不可行。

咱们能够实现一个函数brain_fuck_output_size来提早计算好所须要大小：

   
 
 
    // calculate output size
constexpr auto brain_fuck_output_size(const char* input) -> size_t {
 struct {
 size_t sz{};
 constexpr void push(...) { ++sz; }
 } dummy;
 return parse(input, dummy).sz + 1; // include '\0'
}
 

   

咱们实现一个dummy对象，其push接口只是简单地计数，最终dummy的长度就是输出的长度。

这也是为啥STREAM做为模板参数类型的缘由，由于只须要依赖 push 接口，而不须要依赖具体的类型，这也是泛型的魅力。

   
 
 
    #define BRAIN_FUCK(in) brain_fuck<brain_fuck_output_size(in)>(in)
constexpr auto res = BRAIN_FUCK(R"(
 ++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.
 >---.+++++++..+++.>>.<-.<.+++.------.--------.>>+.>++.
)");
 

   

Rust过程宏解法

Rust作元编程，目前只能经过宏的方式作，并且能力也有限。这里须要用过程宏手段。目前我把 brain_fuck 提交到cargo仓库了： https://crates.io/crates/brain_fuck ，能够体验一下。

一样地写一个parse函数：

   
 
 
    const CELL_SIZE: usize = 16;
fn parse(code: &[u8], skip: bool, cells: &mut [u8; CELL_SIZE],
 pc: &mut usize, output: &mut Vec<u8>) -> usize {
 let mut idx = 0;
 while idx < code.len() {
 let c = code[idx];
 match c {
 b'+' if !skip => cells[*pc] += 1,
 b'-' if !skip => cells[*pc] -= 1,
 b'.' if !skip => output.push(cells[*pc]),
 b'>' if !skip => *pc += 1,
 b'<' if !skip => *pc -= 1,
 b'[' => {
 while !skip && cells[*pc] != 0 {
 parse(&code[idx+1..], false, cells, pc, output);
 }
 idx += parse(&code[idx+1..], true, cells, pc, output) + 1;
 },
 b']' => return idx,
 _ => {}
 }
 idx += 1;
 }
 idx
}
 

   

用过程宏brain_fuck包装一下：

   
 
 
    #[proc_macro]
pub fn brain_fuck(_item: TokenStream) -> TokenStream {
 let input = _item.to_string();
 let mut cells: [u8; CELL_SIZE] = [0; CELL_SIZE];
 let mut pc = 0;
 let mut output = Vec::<u8>::new();

 parse(&input.as_bytes(), false, &mut cells, &mut pc, &mut output);

 TokenStream::from_str(
 &format!("\"{}\"", from_utf8(&output).unwrap())
 ).unwrap()
}
 

   

结论

对比C++和Rust版本，实现代价同样。

C++版本实现过程当中能够先不加constexpr关键字，经过打印等debug手段调试经过后，最终加上constexpr关键字便可，最后既能够在运行时使用，也能够在编译时使用。若是在编译期出现内存越界（cells越界）状况下，编译报错，即避免了ub。

Rust实现过程宏只能经过lib方式作，一样地也能够直接加打印，在编译的时候输出，最终将打印去掉。输出结果能够直接用 Vec 这种动态容器存，C++20以前暂时得经过定长（预留长度或提早计算）数组搞。而Rust的过程宏只能用在编译时，没法用在运行时，并且只支持字面量方式，不支持变量传参给过程宏。

从生成的汇编结果来看，C++版本更加简单粗暴，g++编译器生成的汇编字符串结果直接存到8字节整型中，clang则比较直观，main和数据只有15行：

   
 
 
    main: # @main
 subq $24, %rsp
 movq .L__const.main.res+16(%rip), %rax
 movq %rax, 16(%rsp)
 movups .L__const.main.res(%rip), %xmm0
 movaps %xmm0, (%rsp)
 leaq 8(%rsp), %rdi
 callq puts
 xorl %eax, %eax
 addq $24, %rsp
 retq
.L__const.main.res:
 .quad 13 # 0xd
 .asciz "Hello World!\n\000"
 .zero 1
 

   

而Rust编译器生成的汇编结果就不够C++那么简洁紧凑，这里就不贴出来了。

本文分享自微信公众号 - Rust语言中文社区（rust-china）。
若有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一块儿分享。