summaryrefslogtreecommitdiff
path: root/projects/hackc/syntax.py
blob: 281bd1742f0c43a9d59cfa8a0031658fd7023681 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
from .tokens import Token
from .utils import *

SCOPES = ["static", "field", "var"]
PRIMITIVE_TYPES = ["int", "char", "boolean"]


class Class:
    def __init__(self, name: Token, variables: list, subroutines: list):
        self.name = name
        self.variables = variables
        self.subroutines = subroutines

    @classmethod
    def from_tokens(cls, tokens: list):
        """Construct a class from a list of tokens.

        In standard Jack, one file is exactly one class.

        Format:
        class <name> {
            <zero or more class variable declarations>
            <zero or more subroutines>
        }
        """
        if len(tokens) < 4:
            return None
        if tokens[0] != "class":
            raise JackSyntaxError(
                f"Expected `class`, got `{tokens[0]}` instead", tokens[0]
            )

        name = tokens[1]
        if name.type != "identifier":
            raise JackSyntaxError(f"You cannot name a class `{name}`", name)

        if tokens[2] != LEFT_BRACE:
            raise JackSyntaxError(
                f"Expected `{LEFT_BRACE}`, got `{tokens[2]}` instead", tokens[2]
            )

        tokens_consumed = 3

        while True:
            variables, token_cnt = Variable.from_tokens(
                tokens[tokens_consumed:], context="class"
            )
            if variables is None:
                break
            variables.print_verbose()
            tokens_consumed += token_cnt

        return Class(name, variables, [])


class Variable:
    def __init__(self, scope: Token, type: Token, names: list[Token]):
        self.scope = scope
        self.type = type
        self.names = names

    @classmethod
    def from_tokens(cls, tokens: list, context: str) -> tuple:
        """Construct variable declaration statement from a list of tokens.
        Return a tuple of an instance of Variable and number of tokens consumed.
        When `tokens` does not begin with a variable declaration, return (None, 0).

        context -- "class" (<scope> = static | field) or "subroutine" (<scope> = var)

        Format:
        <scope> <type> <one or more names, joined with a comma>;

        <scope> = static | field | var
        <type> = int | char | boolean | <class name>
        """
        if len(tokens) < 4 or tokens[0] not in SCOPES:
            # not variable declaration
            return (None, 0)

        scope = tokens[0]
        if scope in ["static", "field"] and context != "class":
            raise JackSyntaxError(
                f"You cannot declare a {scope} variable in a subroutine", scope
            )
        if scope == "var" and context != "subroutine":
            raise JackSyntaxError(
                f"You cannot declare a local variable outside of a subroutine",
                scope,
            )

        type = tokens[1]
        if type not in PRIMITIVE_TYPES and type.type != "identifier":
            raise JackSyntaxError(f"Expected datatype, got `{tokens[1]}` instead", type)

        tokens_consumed = 2
        names = []  # names of variables
        expecting_identifier = True

        for token in tokens[2:]:
            tokens_consumed += 1
            if token.type == "identifier":
                if expecting_identifier:
                    names.append(token)
                    expecting_identifier = False
                else:
                    raise JackSyntaxError(f"Expected `,`, got `{token}` instead", token)
            elif token == ",":
                if not expecting_identifier:
                    expecting_identifier = True
                else:
                    raise JackSyntaxError(
                        f"Expected variable name, got `,` instead", token
                    )
            elif token == ";":
                if expecting_identifier:
                    raise JackSyntaxError(
                        f"Expected variable name, got `;` instead", token
                    )
                break
            else:
                expected = "variable name" if expecting_identifier else "`,` or `;`"
                raise JackSyntaxError(
                    f"Expected {expected}, got `{token}` instead", token
                )

        return (Variable(scope, type, names), tokens_consumed)

    def print_verbose(self):
        print(f"Declare {len(self.names)} variable(s):")
        for name in self.names:
            print(self.scope, self.type, name)


class Subroutine:
    def __init__(self):
        pass


class Statement:
    def __init__(self):
        super().__init__()


class IfStatement(Statement):
    def __init__(self):
        super().__init__()