Merge pull request #128 from Pivot-Studio/refactor/seperate_code_gen

refactor: separate codegen logic

Author: RINNE-TAN

src/ast/builder/llvmbuilder.rs

@@ -0,0 +1,169 @@
+/// 为以后codegen逻辑完全分离作准备，此包代码应该遵循以下原则：
+/// 1. 所有Builder的字段都应该private，不应该被外部直接访问
+/// 2. 所有涉及llvm类型的函数（包括参数或返回值）都应该是private的
+pub mod llvmbuilder;
+pub mod no_op_builder;
+use std::{cell::RefCell, path::Path, rc::Rc};
+
+use enum_dispatch::enum_dispatch;
+use inkwell::{values::BasicValueEnum, FloatPredicate, IntPredicate};
+
+use self::llvmbuilder::LLVMBuilder;
+use self::no_op_builder::NoOpBuilder;
+
+use super::{
+    ctx::{Ctx, PLDiag},
+    node::{types::TypedIdentifierNode, TypeNodeEnum},
+    pltype::{FNType, Field, PLType, PriType},
+    range::{Pos, Range},
+};
+
+#[enum_dispatch]
+pub trait IRBuilder<'a, 'ctx> {
+    fn get_global_var_handle(&self, name: &str) -> Option<ValueHandle>;
+    fn new_subscope(&self, start: Pos);
+    fn add_global(
+        &self,
+        name: &str,
+        pltype: Rc<RefCell<PLType>>,
+        ctx: &mut Ctx<'a>,
+        line: u32,
+        pltp: &PLType,
+    ) -> ValueHandle;
+    fn alloc_vtp(&self, name: &str, v: ValueHandle) -> ValueHandle;
+    fn alloc(&self, name: &str, pltype: &PLType, ctx: &mut Ctx<'a>) -> ValueHandle;
+    fn build_conditional_branch(
+        &self,
+        cond: ValueHandle,
+        then_bb: BlockHandle,
+        else_bb: BlockHandle,
+    );
+    fn build_const_in_bounds_gep(&self, ptr: ValueHandle, index: &[u64], name: &str)
+        -> ValueHandle;
+    fn build_dbg_location(&self, pos: Pos);
+    fn build_in_bounds_gep(
+        &self,
+        ptr: ValueHandle,
+        index: &[ValueHandle],
+        name: &str,
+    ) -> ValueHandle;
+    fn build_return(&self, v: Option<ValueHandle>);
+    fn build_store(&self, ptr: ValueHandle, value: ValueHandle);
+    fn build_struct_gep(
+        &self,
+        structv: ValueHandle,
+        index: u32,
+        name: &str,
+    ) -> Result<ValueHandle, ()>;
+    fn build_sub_program(
+        &self,
+        paralist: Vec<Box<TypedIdentifierNode>>,
+        ret: Box<TypeNodeEnum>,
+        fntype: &FNType,
+        fnvalue: ValueHandle,
+        child: &mut Ctx<'a>,
+    ) -> Result<(), PLDiag>;
+    fn clear_insertion_position(&self);
+    fn const_string(&self, s: &str) -> ValueHandle;
+    fn create_parameter_variable(
+        &self,
+        fntype: &FNType,
+        pos: Pos,
+        i: usize,
+        child: &mut Ctx<'a>,
+        fnvalue: ValueHandle,
+        alloca: ValueHandle,
+        allocab: BlockHandle,
+    );
+    fn delete_block(&self, b: BlockHandle);
+    fn finalize_debug(&self);
+    fn float_value(&self, ty: &PriType, v: f64) -> ValueHandle;
+    fn get_first_basic_block(&self, v: ValueHandle) -> BlockHandle;
+    fn get_first_instruction(&self, bb: BlockHandle) -> Option<ValueHandle>;
+    fn get_last_basic_block(&self, v: ValueHandle) -> BlockHandle;
+    fn insert_var_declare(
+        &self,
+        name: &str,
+        pos: Pos,
+        pltype: &PLType,
+        v: ValueHandle,
+        ctx: &mut Ctx<'a>,
+    );
+    fn int_value(&self, ty: &PriType, v: u64, sign_ext: bool) -> ValueHandle;
+    fn position_at(&self, v: ValueHandle);
+    fn print_to_file(&self, file: &Path) -> Result<(), String>;
+    fn rm_curr_debug_location(&self);
+    fn try_set_fn_dbg(&self, pos: Pos, f: ValueHandle);
+    fn write_bitcode_to_path(&self, path: &Path) -> bool;
+    fn build_unconditional_branch(&self, bb: BlockHandle);
+    fn position_at_end_block(&self, block: BlockHandle);
+    fn add_body_to_struct_type(&self, name: &str, order_fields: &[Field], ctx: &mut Ctx<'a>);
+    fn get_or_insert_fn_handle(&self, pltp: &FNType, ctx: &mut Ctx<'a>) -> ValueHandle;
+    fn mv2heap(&self, val: ValueHandle, ctx: &mut Ctx<'a>) -> ValueHandle;
+    fn gc_add_root(&self, stackptr: BasicValueEnum<'ctx>, ctx: &mut Ctx<'a>);
+    fn gc_rm_root(&self, stackptr: ValueHandle, ctx: &mut Ctx<'a>);
+    fn gc_rm_root_current(&self, stackptr: ValueHandle, ctx: &mut Ctx<'a>);
+    fn gc_collect(&self, ctx: &mut Ctx<'a>);
+    fn get_or_add_global(
+        &self,
+        name: &str,
+        pltype: Rc<RefCell<PLType>>,
+        ctx: &mut Ctx<'a>,
+    ) -> ValueHandle;
+    fn build_load(&self, ptr: ValueHandle, name: &str) -> ValueHandle;
+    fn try_load2var(
+        &self,
+        range: Range,
+        v: ValueHandle,
+        tp: Rc<RefCell<PLType>>,
+        ctx: &mut Ctx<'a>,
+    ) -> Result<(ValueHandle, Rc<RefCell<PLType>>), PLDiag>;
+    fn get_function(&self, name: &str) -> Option<ValueHandle>;
+    fn build_call(&self, f: ValueHandle, args: &[ValueHandle]) -> Option<ValueHandle>;
+    fn add_function(
+        &self,
+        name: &str,
+        paramtps: &[PLType],
+        ret: PLType,
+        ctx: &mut Ctx<'a>,
+    ) -> ValueHandle;
+    fn opaque_struct_type(&self, name: &str);
+    fn build_int_z_extend(&self, v: ValueHandle, ty: &PriType, name: &str) -> ValueHandle;
+    fn build_or(&self, lhs: ValueHandle, rhs: ValueHandle, name: &str) -> ValueHandle;
+    fn build_and(&self, lhs: ValueHandle, rhs: ValueHandle, name: &str) -> ValueHandle;
+    fn build_float_compare(
+        &self,
+        op: FloatPredicate,
+        lhs: ValueHandle,
+        rhs: ValueHandle,
+        name: &str,
+    ) -> ValueHandle;
+    fn build_int_compare(
+        &self,
+        op: IntPredicate,
+        lhs: ValueHandle,
+        rhs: ValueHandle,
+        name: &str,
+    ) -> ValueHandle;
+    fn build_int_add(&self, lhs: ValueHandle, rhs: ValueHandle, name: &str) -> ValueHandle;
+    fn build_int_sub(&self, lhs: ValueHandle, rhs: ValueHandle, name: &str) -> ValueHandle;
+    fn build_int_mul(&self, lhs: ValueHandle, rhs: ValueHandle, name: &str) -> ValueHandle;
+    fn build_int_signed_div(&self, lhs: ValueHandle, rhs: ValueHandle, name: &str) -> ValueHandle;
+    fn build_float_neg(&self, v: ValueHandle, name: &str) -> ValueHandle;
+    fn build_float_add(&self, lhs: ValueHandle, rhs: ValueHandle, name: &str) -> ValueHandle;
+    fn build_float_sub(&self, lhs: ValueHandle, rhs: ValueHandle, name: &str) -> ValueHandle;
+    fn build_float_mul(&self, lhs: ValueHandle, rhs: ValueHandle, name: &str) -> ValueHandle;
+    fn build_float_div(&self, lhs: ValueHandle, rhs: ValueHandle, name: &str) -> ValueHandle;
+    fn append_basic_block(&self, func: ValueHandle, name: &str) -> BlockHandle;
+    fn build_int_truncate(&self, v: ValueHandle, dest_ty: &PriType, name: &str) -> ValueHandle;
+    fn build_int_neg(&self, v: ValueHandle, name: &str) -> ValueHandle;
+}
+
+pub type ValueHandle = usize;
+pub type BlockHandle = usize;
+
+#[enum_dispatch(IRBuilder)]
+pub enum BuilderEnum<'a, 'ctx> {
+    LLVM(LLVMBuilder<'a, 'ctx>),
+    NoOp(NoOpBuilder),
+}