phantasmal-world/src/scripting/assembly.ts

import Logger from "js-logger";
import {
    Arg,
    Instruction,
    InstructionSegment,
    Opcode,
    OPCODES_BY_MNEMONIC,
    Param,
    Segment,
    SegmentType,
    Type,
    DataSegment,
} from "../data_formats/parsing/quest/bin";
import {
    AssemblyLexer,
    CodeSectionToken,
    DataSectionToken,
    IdentToken,
    IntToken,
    LabelToken,
    RegisterToken,
    Token,
    TokenType,
} from "./AssemblyLexer";

const logger = Logger.get("scripting/assembly");

export type AssemblyWarning = {
    line_no: number;
    col: number;
    length: number;
    message: string;
};

export type AssemblyError = AssemblyWarning;

export function assemble(
    assembly: string[],
    manual_stack: boolean = false
): {
    object_code: Segment[];
    warnings: AssemblyWarning[];
    errors: AssemblyError[];
} {
    return new Assembler(assembly, manual_stack).assemble();
}

class Assembler {
    private lexer = new AssemblyLexer();
    private line_no!: number;
    private tokens!: Token[];
    private object_code!: Segment[];
    // The current segment.
    private segment?: Segment;
    private warnings!: AssemblyWarning[];
    private errors!: AssemblyError[];
    // Encountered labels.
    private labels!: Set<number>;
    // True iff we're in a code section, false iff we're in a data section.
    private code_section = true;

    constructor(private assembly: string[], private manual_stack: boolean) {}

    assemble(): {
        object_code: Segment[];
        warnings: AssemblyWarning[];
        errors: AssemblyError[];
    } {
        this.line_no = 1;
        this.object_code = [];
        this.warnings = [];
        this.errors = [];
        this.labels = new Set();
        this.code_section = true;

        for (const line of this.assembly) {
            this.tokens = this.lexer.tokenize_line(line);

            if (this.tokens.length > 0) {
                const token = this.tokens.shift()!;

                switch (token.type) {
                    case TokenType.Label:
                        this.parse_label(token);
                        break;
                    case TokenType.CodeSection:
                        this.parse_code_section(token);
                        break;
                    case TokenType.DataSection:
                        this.parse_data_section(token);
                        break;
                    case TokenType.Int:
                        if (this.code_section) {
                            this.add_error({
                                col: token.col,
                                length: token.len,
                                message: "Unexpected token.",
                            });
                        } else {
                            this.parse_bytes(token);
                        }
                        break;
                    case TokenType.Ident:
                        if (this.code_section) {
                            this.parse_instruction(token);
                        } else {
                            this.add_error({
                                col: token.col,
                                length: token.len,
                                message: "Unexpected token.",
                            });
                        }
                        break;
                    case TokenType.InvalidSection:
                        this.add_error({
                            col: token.col,
                            length: token.len,
                            message: "Invalid section type.",
                        });
                        break;
                    case TokenType.InvalidIdent:
                        this.add_error({
                            col: token.col,
                            length: token.len,
                            message: "Invalid identifier.",
                        });
                        break;
                    default:
                        this.add_error({
                            col: token.col,
                            length: token.len,
                            message: "Unexpected token.",
                        });
                        break;
                }
            }

            this.line_no++;
        }

        return {
            object_code: this.object_code,
            warnings: this.warnings,
            errors: this.errors,
        };
    }

    private add_instruction(opcode: Opcode, args: Arg[]): void {
        if (!this.segment) {
            // Unreachable code, technically valid.
            const instruction_segment: InstructionSegment = {
                labels: [],
                type: SegmentType.Instructions,
                instructions: [],
            };

            this.segment = instruction_segment;
            this.object_code.push(instruction_segment);
        }

        (this.segment as InstructionSegment).instructions.push(new Instruction(opcode, args));
    }

    private add_bytes(bytes: number[]): void {
        if (!this.segment) {
            // Unadressable data, technically valid.
            const data_segment: DataSegment = {
                labels: [],
                type: SegmentType.Data,
                data: new Uint8Array(bytes).buffer,
            };

            this.segment = data_segment;
            this.object_code.push(data_segment);
        } else {
            const d_seg = this.segment as DataSegment;
            const buf = new ArrayBuffer(d_seg.data.byteLength + bytes.length);
            const arr = new Uint8Array(buf);

            arr.set(new Uint8Array(d_seg.data));
            arr.set(new Uint8Array(bytes));

            d_seg.data = buf;
        }
    }

    private add_error({
        col,
        length,
        message,
    }: {
        col: number;
        length: number;
        message: string;
    }): void {
        this.errors.push({
            line_no: this.line_no,
            col,
            length,
            message,
        });
    }

    private add_warning({
        col,
        length,
        message,
    }: {
        col: number;
        length: number;
        message: string;
    }): void {
        this.warnings.push({
            line_no: this.line_no,
            col,
            length,
            message,
        });
    }

    private parse_label({ col, len, value: label }: LabelToken): void {
        if (this.labels.has(label)) {
            this.add_error({
                col,
                length: len,
                message: "Duplicate label.",
            });
        }

        this.labels.add(label);

        const next_token = this.tokens.shift();

        if (this.code_section) {
            this.segment = {
                type: SegmentType.Instructions,
                labels: [label],
                instructions: [],
            };
            this.object_code.push(this.segment);

            if (next_token) {
                if (next_token.type === TokenType.Ident) {
                    this.parse_instruction(next_token);
                } else {
                    this.add_error({
                        col: next_token.col,
                        length: next_token.len,
                        message: "Expected opcode mnemonic.",
                    });
                }
            }
        } else {
            this.segment = {
                type: SegmentType.Data,
                labels: [label],
                data: new ArrayBuffer(0),
            };
            this.object_code.push(this.segment);

            if (next_token) {
                if (next_token.type === TokenType.Int) {
                    this.parse_bytes(next_token);
                } else {
                    this.add_error({
                        col: next_token.col,
                        length: next_token.len,
                        message: "Expected bytes.",
                    });
                }
            }
        }
    }

    private parse_code_section({ col, len }: CodeSectionToken): void {
        if (this.code_section) {
            this.add_warning({
                col,
                length: len,
                message: "Unnecessary code section marker.",
            });
        }

        this.code_section = true;

        const next_token = this.tokens.shift();

        if (next_token) {
            this.add_error({
                col: next_token.col,
                length: next_token.len,
                message: "Unexpected token.",
            });
        }
    }

    private parse_data_section({ col, len }: DataSectionToken): void {
        if (!this.code_section) {
            this.add_warning({
                col,
                length: len,
                message: "Unnecessary data section marker.",
            });
        }

        this.code_section = false;

        const next_token = this.tokens.shift();

        if (next_token) {
            this.add_error({
                col: next_token.col,
                length: next_token.len,
                message: "Unexpected token.",
            });
        }
    }

    private parse_instruction({ col, len, value }: IdentToken): void {
        const opcode = OPCODES_BY_MNEMONIC.get(value);

        if (!opcode) {
            this.add_error({
                col,
                length: len,
                message: "Unknown instruction.",
            });
        } else {
            const varargs =
                opcode.params.findIndex(p => p.type === Type.U8Var || p.type === Type.ILabelVar) !==
                -1;

            const param_count =
                opcode.params.length + (this.manual_stack ? 0 : opcode.stack_params.length);

            let arg_count = 0;

            for (const token of this.tokens) {
                if (token.type !== TokenType.ArgSeperator) {
                    arg_count++;
                }
            }

            const last_token = this.tokens[this.tokens.length - 1];
            let error_length = last_token ? last_token.col + last_token.len - col : 0;
            const ins_args: Arg[] = [];

            if (!varargs && arg_count !== param_count) {
                this.add_error({
                    col,
                    length: error_length,
                    message: `Expected ${param_count} argument${
                        param_count === 1 ? "" : "s"
                    }, got ${arg_count}.`,
                });

                return;
            } else if (varargs && arg_count < param_count) {
                this.add_error({
                    col,
                    length: error_length,
                    message: `Expected at least ${param_count} argument${
                        param_count === 1 ? "" : "s"
                    }, got ${arg_count}.`,
                });

                return;
            } else if (varargs || arg_count === opcode.params.length) {
                // Inline arguments.
                if (!this.parse_args(opcode.params, ins_args)) {
                    return;
                }
            } else {
                // Stack arguments.
                const stack_args: Arg[] = [];

                if (!this.parse_args(opcode.stack_params, stack_args)) {
                    return;
                }

                for (let i = 0; i < opcode.stack_params.length; i++) {
                    const param = opcode.stack_params[i];
                    const arg = stack_args[i];

                    if (arg == undefined) {
                        continue;
                    }

                    switch (param.type) {
                        case Type.U8:
                        case Type.RegRef:
                            this.add_instruction(Opcode.arg_pushb, [arg]);
                            break;
                        case Type.U16:
                        case Type.ILabel:
                        case Type.DLabel:
                            this.add_instruction(Opcode.arg_pushw, [arg]);
                            break;
                        case Type.U32:
                        case Type.I32:
                        case Type.F32:
                            this.add_instruction(Opcode.arg_pushl, [arg]);
                            break;
                        case Type.String:
                            this.add_instruction(Opcode.arg_pushs, [arg]);
                            break;
                        default:
                            logger.error(`Type ${Type[param.type]} not implemented.`);
                    }
                }
            }

            this.add_instruction(opcode, ins_args);
        }
    }

    /**
     * @returns true if arguments can be translated to object code, possibly after truncation. False otherwise.
     */
    private parse_args(params: Param[], args: Arg[]): boolean {
        let semi_valid = true;
        let should_be_arg = true;
        let param_i = 0;

        for (let i = 0; i < this.tokens.length; i++) {
            const token = this.tokens[i];
            const param = params[param_i];

            if (token.type === TokenType.ArgSeperator) {
                if (should_be_arg) {
                    this.add_error({
                        col: token.col,
                        length: token.len,
                        message: "Expected an argument.",
                    });
                } else {
                    if (param.type !== Type.U8Var && param.type !== Type.ILabelVar) {
                        param_i++;
                    }
                }

                should_be_arg = true;
            } else {
                if (!should_be_arg) {
                    const prev_token = this.tokens[i - 1];
                    const col = prev_token.col + prev_token.len;

                    this.add_error({
                        col,
                        length: token.col - col,
                        message: "Expected a comma.",
                    });
                }

                should_be_arg = false;

                let match: boolean;

                switch (token.type) {
                    case TokenType.Int:
                        switch (param.type) {
                            case Type.U8:
                            case Type.U8Var:
                                match = true;
                                this.parse_uint(1, token, args);
                                break;
                            case Type.U16:
                            case Type.ILabel:
                            case Type.ILabelVar:
                            case Type.DLabel:
                                match = true;
                                this.parse_uint(2, token, args);
                                break;
                            case Type.U32:
                                match = true;
                                this.parse_uint(4, token, args);
                                break;
                            case Type.I32:
                                match = true;
                                this.parse_sint(4, token, args);
                                break;
                            case Type.F32:
                                match = true;
                                args.push({
                                    value: token.value,
                                    size: 4,
                                });
                                break;
                            default:
                                match = false;
                                break;
                        }
                        break;
                    case TokenType.Float:
                        match = param.type === Type.F32;

                        if (match) {
                            args.push({
                                value: token.value,
                                size: 4,
                            });
                        }

                        break;
                    case TokenType.Register:
                        match = param.type === Type.RegRef;
                        this.parse_register(token, args);
                        break;
                    case TokenType.String:
                        match = param.type === Type.String;

                        if (match) {
                            args.push({
                                value: token.value,
                                size: 2 * token.value.length + 2,
                            });
                        }

                        break;
                    default:
                        match = false;
                        break;
                }

                if (!match) {
                    semi_valid = false;

                    let type_str = Type[param.type];

                    switch (param.type) {
                        case Type.U8:
                            type_str = "an unsigned 8-bit integer";
                            break;
                        case Type.U16:
                            type_str = "an unsigned 16-bit integer";
                            break;
                        case Type.U32:
                            type_str = "an unsigned 32-bit integer";
                            break;
                        case Type.I32:
                            type_str = "a signed 32-bit integer";
                            break;
                        case Type.F32:
                            type_str = "a float";
                            break;
                        case Type.RegRef:
                            type_str = "a register reference";
                            break;
                        case Type.ILabel:
                            type_str = "an instruction label";
                            break;
                        case Type.DLabel:
                            type_str = "a data label";
                            break;
                        case Type.U8Var:
                            type_str = "an unsigned 8-bit integer";
                            break;
                        case Type.ILabelVar:
                            type_str = "an instruction label";
                            break;
                        case Type.String:
                            type_str = "a string";
                            break;
                    }

                    this.add_error({
                        col: token.col,
                        length: token.len,
                        message: `Expected ${type_str}.`,
                    });
                }
            }
        }

        this.tokens = [];
        return semi_valid;
    }

    private parse_uint(size: number, { col, len, value }: IntToken, args: Arg[]): void {
        const bit_size = 8 * size;
        const max_value = Math.pow(2, bit_size) - 1;

        if (value < 0) {
            this.add_error({
                col,
                length: len,
                message: `Unsigned ${bit_size}-bit integer can't be less than 0.`,
            });
        } else if (value > max_value) {
            this.add_error({
                col,
                length: len,
                message: `Unsigned ${bit_size}-bit integer can't be greater than ${max_value}.`,
            });
        } else {
            args.push({
                value,
                size,
            });
        }
    }

    private parse_sint(size: number, { col, len, value }: IntToken, args: Arg[]): void {
        const bit_size = 8 * size;
        const min_value = -Math.pow(2, bit_size - 1);
        const max_value = Math.pow(2, bit_size - 1) - 1;

        if (value < min_value) {
            this.add_error({
                col,
                length: len,
                message: `Signed ${bit_size}-bit integer can't be less than ${min_value}.`,
            });
        } else if (value > max_value) {
            this.add_error({
                col,
                length: len,
                message: `Signed ${bit_size}-bit integer can't be greater than ${max_value}.`,
            });
        } else {
            args.push({
                value,
                size,
            });
        }
    }

    private parse_register({ col, len, value }: RegisterToken, args: Arg[]): void {
        if (value > 255) {
            this.add_error({
                col,
                length: len,
                message: `Invalid register reference, expected r0-r255.`,
            });
        } else {
            args.push({
                value,
                size: 1,
            });
        }
    }

    private parse_bytes(first_token: IntToken): void {
        const bytes = [];
        let token: Token = first_token;
        let i = 0;

        while (token.type === TokenType.Int) {
            if (token.value < 0) {
                this.add_error({
                    col: token.col,
                    length: token.len,
                    message: "Unsigned 8-bit integer can't be less than 0.",
                });
            } else if (token.value > 255) {
                this.add_error({
                    col: token.col,
                    length: token.len,
                    message: "Unsigned 8-bit integer can't be greater than 255.",
                });
            }

            bytes.push(token.value);

            if (i < this.tokens.length) {
                token = this.tokens[i++];
            } else {
                break;
            }
        }

        if (i < this.tokens.length) {
            this.add_error({
                col: token.col,
                length: token.len,
                message: "Expected an unsigned 8-bit integer.",
            });
        }

        this.add_bytes(bytes);
    }
}