VMトランスレーター後半 / write_label()、write_goto()、write_if() / BasicLoop.vm

Chapter 8
Code_Writer.pyにwrite_label()write_goto()write_if()という3つの函数を加える。

Code_Writer.py:

class Code_Writer:
    def __init__(self, file_path):
        self.file = open(file_path, "w")
        self.label_count = 0
        
        self.calcs = {
            "neg":"M=-D",
            "not":"M=!D",
            "add":"M=D+M",
            "sub":"M=M-D",
            "and":"M=D&M",
            "or":"M=D|M",}
        self.jumps = {
            "eq":"D;JEQ",
            "gt":"D;JGT",
            "lt":"D;JLT",}
        self.segments = {
            "local":"LCL",
            "argument":"ARG",
            "this":"THIS",
            "that":"THAT",
            "pointer":3,
            "temp":5,
            "static":16,}
 
    def write_arithmetic(self, command):
        # まずスタックポインタをデクリメントして、
        # 今のスタックポインタの位置にある値をDレジスタに取り出して、
        self.__decrement_pointer("SP")
        self.__load_d_with_ram_ram_pointer("SP")
        
        # 単項演算子の場合:
        # 演算結果を今のスタックポインタの位置に上書きして、
        if self.__is_unary_op(command):
            self.file.write(self.calcs[command] + "\n")

        # 二項演算子の場合:
        # さらにスタックポインタをデクリメントして、
        # スタックポインタの指し示すアドレスをAレジスタに取り出して、
        elif self.__is_binary_op(command):
            self.__decrement_pointer("SP")
            self.file.write("A=M\n")

            # 比較演算子の場合:
            # 比較する手段として、今のスタックポインタの位置にある値からDレジスタの値を引いて、
            if self.__is_comparison_op(command):
                self.file.write("D=M-D\n")

                true_label = "TRUE" + str(self.label_count)
                end_label = "END" + str(self.label_count)
                self.label_count += 1

                # 引き算の結果が比較演算子にtrueなら(イ)に飛んで、
                self.file.write("@" + true_label + "\n") # (ここでどうしてもAレジスタの値が変化する)
                self.file.write(self.jumps[command] + "\n")

                # 引き算の結果がfalseなら、
                # ここに来る前にAレジスタの値が変化したのでスタックポインタの位置を取得し直して、
                # 今のスタックポインタの位置に0 (false)を書き込んで、
                # (ロ)に飛んで、抜ける。
                self.__load_a_with_pointer("SP")
                self.file.write("M=0\n")
                self.file.write("@" + end_label + "\n")
                self.file.write("0;JMP\n")

                # (イ)
                # ここに来る前にAレジスタの値が変化したのでスタックポインタの位置を取得し直して、
                # 今のスタックポインタの位置に-1 (true、全ビット1)を書き込んで、
                # 抜ける。
                self.file.write("(" + true_label + ")\n")
                self.__load_a_with_pointer("SP")
                self.file.write("M=-1\n")

                # (ロ)
                self.file.write("(" + end_label + ")\n")

            # 和、差、論理積、論理和の場合:
            # 今のスタックポインタの位置にある値と先に取り出したDレジスタの値との演算結果を
            # 今のスタックポインタの位置に上書きして、    
            else:
                self.file.write(self.calcs[command] + "\n")

        # 最後にスタックポインタをインクリメントする。
        self.__increment_pointer("SP")
        return self

    def write_push_pop(self, command, segment, index):
        if command == "C_PUSH":

            # 即値をプッシュする場合:
            if segment == "constant":
                self.__load_d_with_immediate_value(index) # 即値をDレジスタに読み込んで、
                self.__load_ram_ram_pointer_with_d("SP") # Dレジスタの値を今のスタックポインタの位置に書き込んで、
                
            # 各種ポインタの指し示すアドレスにある値をプッシュする場合:
            else:
                self.__load_register_with_offsetted_address("A", self.segments[segment], index) # オフセットしたアドレスをAレジスタに読み込んで、
                self.file.write("D=M\n") # そのアドレスにある値をDレジスタに読み込んで、
                self.__load_ram_ram_pointer_with_d("SP") # Dレジスタの値を今のスタックポインタの位置に書き込んで、
                
            self.__increment_pointer("SP") # 最後にスタックポインタをインクリメントする。


        elif command == "C_POP":
            self.__decrement_pointer("SP") # まずスタックポインタをデクリメントして、

            self.__load_register_with_offsetted_address("D", self.segments[segment], index) # オフセットしたアドレスをDレジスタに読み込んで、
            self.__load_generic_regisiter_with_d("R13") # そのDレジスタの値をR13に假置きして、
            self.__load_d_with_ram_ram_pointer("SP") # 今のスタックポインタの位置にある値をDレジスタに読み込んで、
            self.__load_ram_ram_pointer_with_d("R13") # それを、R13の指し示すアドレスの位置に書き込む。

        return self

    def write_label(self, label):
        self.file.write("(" + label + ")\n")

    def write_goto(self, label):
        self.file.write("@" + label + "\n")
        self.file.write("0;JMP\n")

    def write_if(self, label):
        # スタックの最後尾値が0でない場合(falseでない場合)にジャンプする。
        self.__decrement_pointer("SP") 
        self.__load_d_with_ram_ram_pointer("SP")
        self.file.write("@" + label + "\n")
        self.file.write("D;JNE\n")

    def write_halt(self):
        self.file.write("@HALT\n")
        self.file.write("(HALT)\n")
        self.file.write("0;JMP\n")

    def close(self):
        self.file.close()

    
        

########################################################################
    """
    def set_pointer(self, pointer_name, val):
        self.file.write("@" + str(val) + "\n")
        self.file.write("D=A\n")
        self.file.write("@" + pointer_name + "\n")
        self.file.write("M=D\n")
    """

    def load_ram_address_with_immediate_value(self, address, immediate_value):
        self.file.write("@" + str(immediate_value) + "\n")
        self.file.write("D=A\n")
        self.file.write("@" + str(address) + "\n")
        self.file.write("M=D\n")

    def __decrement_pointer(self, pointer_name):
        self.file.write("@" + pointer_name + "\n")
        self.file.write("M=M-1\n")
    def __increment_pointer(self, pointer_name):
        self.file.write("@" + pointer_name + "\n")
        self.file.write("M=M+1\n")
    def __load_d_with_immediate_value(self, immediate_value):
        self.file.write("@" + str(immediate_value) + "\n")
        self.file.write("D=A\n")
    def __load_a_with_pointer(self, pointer_name):
        self.file.write("@" + pointer_name + "\n")
        self.file.write("A=M\n")
    def __load_d_with_ram_ram_pointer(self, pointer_name):
        self.file.write("@" + pointer_name + "\n")
        self.file.write("A=M\n")
        self.file.write("D=M\n")
    def __load_ram_ram_pointer_with_d(self, pointer_name):
        self.file.write("@" + pointer_name + "\n")
        self.file.write("A=M\n")
        self.file.write("M=D\n")
    def __load_generic_regisiter_with_d(self, ram_index):
        self.file.write("@" + ram_index + "\n")
        self.file.write("M=D\n")
    def __is_unary_op(self, command):
        return command == "neg" or command == "not"
    def __is_binary_op(self, command):
        return not self.__is_unary_op(command)
    def __is_comparison_op(self, command):
        return command == "eq" or command == "gt" or command == "lt"
    def __load_register_with_offsetted_address(self, register, base_address, offset_val):
        self.__load_d_with_immediate_value(offset_val) # オフセット値をDレジスタに読み込んで、
        try:
            self.__load_a_with_pointer(base_address) # 当該ポインタのベースアドレス(ポインタで指定)をAレジスタに読み込んで、
        except:
            self.file.write("@" + str(base_address) + "\n") # 当該ポインタのベースアドレス(即値で指定)をAレジスタに読み込んで、
        self.file.write(register + "=D+A\n") # オフセットしたアドレスをどれかレジスタに読み込んで、


    
        
########################################################################
if __name__ == "__main__":
    c = Code_Writer("Test.asm")

    c.load_ram_address_with_immediate_value(0, 256) # SP

    c.write_label("SUTE0")
    c.write_goto("SUTE0")

    c.write_label("SUTE1")
    c.write_if("SUTE1")

    c.write_halt()
    c.close()

VM_Translator.py:

from Parser import *
from Code_Writer import *

# .vmファイルを入力して.asmファイルを出力する。
class VM_Translator:
    def __init__(self, vm_file_path):
        self.parser = Parser(vm_file_path)

        asm_file_path = self.__replace_file_extension(vm_file_path, "asm")
        self.code_writer = Code_Writer(asm_file_path)

    def generate_asm(self):
        while self.parser.has_more_lines():
            self.parser.advance()
            
            command_type = self.parser.command_type()
            arg1 = self.parser.arg1()
            arg2 = self.parser.arg2()
            
            if command_type == "C_PUSH" or command_type == "C_POP":
                self.code_writer.write_push_pop(command_type, arg1, arg2)

            elif command_type == "C_ARITHMETIC":
                self.code_writer.write_arithmetic(arg1)

            elif command_type == "C_LABEL":
                self.code_writer.write_label(arg1)

            elif command_type == "C_GOTO":
                self.code_writer.write_goto(arg1)

            elif command_type == "C_IF":
                self.code_writer.write_if(arg1)

        self.code_writer.write_halt()
        self.parser.close()
        self.code_writer.close()

    def __replace_file_extension(self, file_name, new_extension):
        return file_name.split(".")[0] + "." + new_extension
 

############################################################
if __name__ == "__main__":
    # 1~ARG[0]の総和を求める。
    a = VM_Translator("BasicLoop\BasicLoop.vm")
    a.code_writer.load_ram_address_with_immediate_value(0, 256) # SP。天下り的にセットする。
    a.code_writer.load_ram_address_with_immediate_value(1, 300) # LCL。天下り的にセットする。
    a.code_writer.load_ram_address_with_immediate_value(2, 400) # ARG。天下り的にセットする。
    
    a.code_writer.load_ram_address_with_immediate_value(400+0, 3) # ARG[0]を3にセットする。
    a.generate_asm()

BasicLoop.vm

// This file is part of www.nand2tetris.org
// and the book "The Elements of Computing Systems"
// by Nisan and Schocken, MIT Press.
// File name: projects/08/ProgramFlow/BasicLoop/BasicLoop.vm

// Computes the sum 1 + 2 + ... + argument[0] and pushes the 
// result onto the stack. Argument[0] is initialized by the test 
// script before this code starts running.
push constant 0    
pop local 0         // initializes sum = 0
label LOOP_START
push argument 0    
push local 0
add
pop local 0         // sum = sum + counter
push argument 0
push constant 1
sub
pop argument 0      // counter--
push argument 0
if-goto LOOP_START  // If counter != 0, goto LOOP_START
push local 0

正解:

実行結果: