lutra-bin 0.6.0

Binary format library for Lutra: IR/RR encoding, decoding, and value representation
Documentation
#![cfg(feature = "std")]

use crate::ir;

pub fn print(program: &ir::Program) -> String {
    let mut printer = Printer {
        color: true,
        ..Printer::default()
    };

    printer.print_program(program)
}

pub fn print_no_color(program: &ir::Program) -> String {
    let mut printer = Printer {
        color: false,
        ..Printer::default()
    };

    printer.print_program(program)
}

pub fn print_ty(ty: &ir::Ty) -> String {
    let printer = Printer::default();

    printer.print_ty(ty)
}

#[derive(Clone, Default)]
struct Printer {
    indent: usize,
    color: bool,
}

const INDENT: usize = 2;

impl Printer {
    fn indent(&mut self) {
        self.indent += INDENT;
    }

    fn dedent(&mut self) {
        self.indent -= INDENT;
    }

    #[must_use]
    fn new_line(&self) -> String {
        let mut r = "\n".to_string();
        r += &" ".repeat(self.indent);
        r
    }
}

impl Printer {
    fn print_program(&mut self, program: &ir::Program) -> String {
        let mut r = String::new();

        for ty_def in &program.defs {
            r += "type ";
            r += &display_path(&ty_def.name.0);
            r += " = ";
            r += &self.print_ty(&ty_def.ty);
            r += ";\n";
        }

        r += "let main = ";
        r += &self.print_expr(&program.main);
        r
    }

    fn print_expr(&mut self, expr: &ir::Expr) -> String {
        let mut r = match &expr.kind {
            ir::ExprKind::Pointer(ptr) => match ptr {
                ir::Pointer::External(ptr) => {
                    format!("external.{}", ptr.id)
                }
                ir::Pointer::Binding(id) => format!("var.{id}"),
                ir::Pointer::Parameter(ir::ParameterPtr {
                    function_id,
                    param_position,
                }) => format!("fn.{function_id}+{param_position}"),
            },
            ir::ExprKind::Literal(literal) => {
                format!("{literal}")
            }
            ir::ExprKind::Call(call) => {
                let mut r = "(call".to_string();
                self.indent();
                r += &self.new_line();
                r += &self.print_expr(&call.function);
                r += ",";
                for arg in &call.args {
                    r += &self.new_line();
                    r += &self.print_expr(arg);
                    r += ",";
                }
                self.dedent();
                r += &self.new_line();
                r += ")";
                r
            }
            ir::ExprKind::Function(func) => {
                let mut r = "(func ".to_string();
                r += &func.id.to_string();
                r += " ->";

                self.indent();
                r += &self.new_line();

                r += &self.print_expr(&func.body);

                self.dedent();
                r += &self.new_line();
                r += ")";

                r
            }
            ir::ExprKind::Tuple(fields) => {
                let mut r = "(tuple".to_string();
                self.indent();
                for field in fields {
                    r += &self.new_line();
                    if field.unpack {
                        r += "..";
                    }
                    r += &self.print_expr(&field.expr);
                    r += ",";
                }
                self.dedent();
                r += &self.new_line();
                r += ")";
                r
            }
            ir::ExprKind::Array(items) => {
                let mut r = "(array".to_string();
                if !items.is_empty() {
                    self.indent();
                    for item in items {
                        r += &self.new_line();
                        r += &self.print_expr(item);
                        r += ",";
                    }
                    self.dedent();
                    r += &self.new_line();
                }
                r += ")";
                r
            }
            ir::ExprKind::EnumVariant(variant) => {
                let mut r = format!("(enum_variant {}", variant.tag);

                if !is_expr_unit(&variant.inner) {
                    self.indent();
                    r += &self.new_line();
                    r += &self.print_expr(&variant.inner);
                    self.dedent();
                    r += &self.new_line();
                }
                r += ")";
                r
            }
            ir::ExprKind::EnumTag(enum_tag) => {
                let mut r = "(enum_tag".to_string();
                self.indent();
                r += &self.new_line();

                r += &self.print_expr(&enum_tag.subject);

                self.dedent();
                r += &self.new_line();
                r += ")";
                r
            }
            ir::ExprKind::EnumUnwrap(unwrap) => {
                let mut r = "(enum_unwrap".to_string();
                self.indent();
                r += &self.new_line();

                r += &self.print_expr(&unwrap.subject);

                r += &self.new_line();
                r += &format!("{}", unwrap.tag);
                self.dedent();
                r += &self.new_line();
                r += ")";
                r
            }
            ir::ExprKind::TupleLookup(lookup) => {
                let mut r = "(tuple_lookup".to_string();
                self.indent();
                r += &self.new_line();
                r += &self.print_expr(&lookup.base);
                r += &self.new_line();
                r += &lookup.position.to_string();
                self.dedent();
                r += &self.new_line();
                r += ")";
                r
            }
            ir::ExprKind::Binding(binding) => {
                let mut r = String::new();
                let mut binding = binding.as_ref();

                loop {
                    r += "let ";

                    r += &binding.id.to_string();

                    r += " =";

                    if let ir::ExprKind::Binding(_) = &binding.expr.kind {
                        self.indent();
                        r += &self.new_line();
                        r += &self.print_expr(&binding.expr);
                        self.dedent();
                    } else {
                        r += " ";
                        r += &self.print_expr(&binding.expr);
                    }

                    r += ";";
                    r += &self.new_line();

                    if let ir::ExprKind::Binding(inner) = &binding.main.kind {
                        binding = inner.as_ref();
                    } else {
                        break;
                    }
                }

                r += &self.print_expr(&binding.main);
                r
            }
            ir::ExprKind::Switch(switch_branches) => {
                let mut r = "(".to_string();
                self.indent();

                r += &self.new_line();
                r += "switch,";

                for branch in switch_branches {
                    r += &self.new_line();
                    r += "(";
                    self.indent();

                    r += &self.new_line();
                    r += &self.print_expr(&branch.condition);
                    r += ",";

                    r += &self.new_line();
                    r += &self.print_expr(&branch.value);
                    r += ",";

                    self.dedent();
                    r += &self.new_line();
                    r += "),";
                }

                self.dedent();
                r += &self.new_line();
                r += ")";
                r
            }
        };

        let print_ty = !matches!(expr.kind, ir::ExprKind::Binding(_));
        if print_ty {
            if self.color {
                r += "\x1b[90m";
            }
            r += ": ";
            r += &self.print_ty(&expr.ty);
            if self.color {
                r += "\x1b[0m";
            }
        }
        r
    }

    #[allow(clippy::only_used_in_recursion)]
    fn print_ty(&self, ty: &ir::Ty) -> String {
        match &ty.kind {
            ir::TyKind::Primitive(prim) => prim.name().to_string(),
            ir::TyKind::Tuple(fields) => {
                let mut r = "{".to_string();
                for (index, field) in fields.iter().enumerate() {
                    if index > 0 {
                        r += ", ";
                    }
                    if let Some(name) = &field.name {
                        r += &display_ident(name);
                        r += ": ";
                    }
                    r += &self.print_ty(&field.ty);
                }
                r += "}";
                r
            }
            ir::TyKind::Array(items) => {
                format!("[{}]", self.print_ty(items))
            }
            ir::TyKind::Enum(variants) => {
                let mut r = "enum {".to_string();
                for (index, variant) in variants.iter().enumerate() {
                    if index > 0 {
                        r += ", ";
                    }
                    let is_recursive =
                        crate::layout::does_enum_variant_contain_recursive(ty, index as u16);

                    if is_recursive {
                        r += "@recursive ";
                    }

                    r += &display_ident(&variant.name);
                    if !is_ty_unit(&variant.ty) {
                        r += ": ";
                        r += &self.print_ty(&variant.ty);
                    }
                }
                r += "}";
                r
            }
            ir::TyKind::Function(func) => {
                let mut r = "func (".to_string();
                for (index, param) in func.params.iter().enumerate() {
                    if index > 0 {
                        r += ", ";
                    }
                    r += &self.print_ty(param);
                }
                r += ") -> ";
                r += &self.print_ty(&func.body);
                r
            }
            ir::TyKind::Ident(path) => {
                if path.0.first().is_some_and(|x| x == "std") {
                    display_path(&path.0[1..])
                } else {
                    display_path(&path.0)
                }
            }
        }
    }
}

fn is_expr_unit(expr: &ir::Expr) -> bool {
    if !is_ty_unit(&expr.ty) {
        return false;
    }
    expr.kind.as_tuple().is_some_and(|f| f.is_empty())
}

fn is_ty_unit(ty: &ir::Ty) -> bool {
    ty.kind.as_tuple().is_some_and(|f| f.is_empty())
}

fn display_path(path: &[String]) -> String {
    let mut r = String::new();
    for (index, part) in path.iter().enumerate() {
        if index > 0 {
            r += "::";
        }
        r += display_ident(part).as_ref();
    }
    r
}

pub fn display_ident(s: &str) -> std::borrow::Cow<'_, str> {
    fn forbidden_start(c: char) -> bool {
        !(c.is_ascii_alphabetic() || matches!(c, '_' | '$'))
    }
    fn forbidden_subsequent(c: char) -> bool {
        !(c.is_ascii_alphanumeric() || matches!(c, '_'))
    }
    let needs_escape = s.is_empty()
        || s.starts_with(forbidden_start)
        || (s.len() > 1 && s.chars().skip(1).any(forbidden_subsequent));

    if needs_escape {
        format!("`{s}`").into()
    } else {
        s.into()
    }
}