annotate lexer/Token.d @ 42:4e879f82dd64 new_gen

Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
author Anders Johnsen <skabet@gmail.com>
date Tue, 22 Apr 2008 22:25:07 +0200
parents 858b9805843d
children 495188f9078e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
1 module lexer.Token;
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
2
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
3 public
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
4 import misc.Location;
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
5
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
6 import Integer = tango.text.convert.Integer;
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
7
42
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
8 /**
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
9 The Token struct will be used through the Lexer, Parser and other
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
10 modules as a location into source.
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
11
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
12 The Token should always be optimized for size to limit unnecessary
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
13 memory usage.
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
14 */
1
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
15 struct Token
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
16 {
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
17 Tok type;
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
18 Location location;
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
19 uint length;
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
20
42
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
21 /**
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
22 Create a new token with a Tok type, Location in source and a
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
23 length of how many chars the Token span in the source
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
24 */
1
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
25 static Token opCall (Tok type, Location location, uint length)
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
26 {
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
27 Token t;
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
28 t.type = type;
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
29 t.location = location;
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
30 t.length = length;
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
31 return t;
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
32 }
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
33
42
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
34 /**
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
35 Get the type of the Token as a string
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
36 */
1
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
37 char[] getType ()
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
38 {
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
39 return typeToString[this.type];
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
40 }
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
41
42
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
42 /**
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
43 A human readable dump of a Token
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
44 */
1
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
45 char[] toString ()
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
46 {
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
47 return this.getType()~": Len: "~Integer.toString(this.length)
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
48 ~", Loc: "~location.toString;
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
49 }
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
50
42
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
51 /**
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
52 Get the string in the source that matches what this Token is
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
53 covering.
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
54 */
1
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
55 char[] get ()
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
56 {
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
57 return location.get(length);
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
58 }
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
59 }
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
60
42
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
61 /**
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
62 Tok is short for TokenType. This enum list is to supply the Token
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
63 with a type.
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
64
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
65 This enum is used to switch over "many" places.
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
66 */
1
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
67 enum Tok : ushort
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
68 {
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
69 /* Non-code related tokens */
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
70 EOF,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
71
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
72 /* Basic types */
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
73 Identifier,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
74 Integer,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
75
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
76 /* Basic operators */
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
77 Assign,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
78 Add, Sub,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
79 Mul, Div,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
80 Comma,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
81
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
82 /* Symbols */
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
83 OpenParentheses,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
84 CloseParentheses,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
85 OpenBrace,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
86 CloseBrace,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
87 Seperator,
36
ce17bea8e9bd Switch statements support
Anders Halager <halager@gmail.com>
parents: 28
diff changeset
88 Colon,
28
69464d465284 Now supporting structs - both read and write. Still a few errors though, so watch out.
Anders Johnsen <skabet@gmail.com>
parents: 22
diff changeset
89 Dot,
1
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
90
8
2e1069ee21af Added Ne, Lt, Le, Gt, Ge and Not in lexer
johnsen@johnsen-desktop
parents: 6
diff changeset
91 /* Comparator operators */
2e1069ee21af Added Ne, Lt, Le, Gt, Ge and Not in lexer
johnsen@johnsen-desktop
parents: 6
diff changeset
92 Eq, Ne,
2e1069ee21af Added Ne, Lt, Le, Gt, Ge and Not in lexer
johnsen@johnsen-desktop
parents: 6
diff changeset
93 Lt, Gt,
2e1069ee21af Added Ne, Lt, Le, Gt, Ge and Not in lexer
johnsen@johnsen-desktop
parents: 6
diff changeset
94 Le, Ge,
2e1069ee21af Added Ne, Lt, Le, Gt, Ge and Not in lexer
johnsen@johnsen-desktop
parents: 6
diff changeset
95
2e1069ee21af Added Ne, Lt, Le, Gt, Ge and Not in lexer
johnsen@johnsen-desktop
parents: 6
diff changeset
96 Not,
6
606a57c90a0b Now lexing == as Equals
johnsen@johnsen-desktop
parents: 5
diff changeset
97
1
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
98 /* Keywords */
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
99 Byte, Ubyte,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
100 Short, Ushort,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
101 Int, Uint,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
102 Long, Ulong,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
103
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
104 Float, Double,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
105
5
2c5a8f4c254a Added very simple if support.
Anders Halager <halager@gmail.com>
parents: 1
diff changeset
106 Bool,
2c5a8f4c254a Added very simple if support.
Anders Halager <halager@gmail.com>
parents: 1
diff changeset
107
37
858b9805843d Bug-fixes
Anders Halager <halager@gmail.com>
parents: 36
diff changeset
108 Void,
858b9805843d Bug-fixes
Anders Halager <halager@gmail.com>
parents: 36
diff changeset
109
22
e331e4e816e4 now handling structs to some extend
johnsen@johnsen-laptop
parents: 21
diff changeset
110 Struct,
e331e4e816e4 now handling structs to some extend
johnsen@johnsen-laptop
parents: 21
diff changeset
111
11
642c6a998fd9 Support for while statements and fixed scope for if
Anders Halager <halager@gmail.com>
parents: 8
diff changeset
112 If, Else,
642c6a998fd9 Support for while statements and fixed scope for if
Anders Halager <halager@gmail.com>
parents: 8
diff changeset
113 While,
36
ce17bea8e9bd Switch statements support
Anders Halager <halager@gmail.com>
parents: 28
diff changeset
114 Switch, Case, Default,
1
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
115 Return,
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
116
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
117 }
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
118
42
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
119 /**
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
120 An associative array to supply a Tok to String function.
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
121
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
122 Keep always this list updated when adding a new Tok.
4e879f82dd64 Added some docs for the lexer - now you can understand _some_ of the madness going on here :)
Anders Johnsen <skabet@gmail.com>
parents: 37
diff changeset
123 */
1
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
124 public char[][Tok] typeToString;
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
125
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
126 static this()
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
127 {
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
128 typeToString =
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
129 [
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
130 Tok.EOF:"EOF"[],
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
131 Tok.Identifier:"Identifier",
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
132 Tok.Byte:"Byte",
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
133 Tok.Short:"Short",
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
134 Tok.Int:"Int",
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
135 Tok.Long:"Long",
5
2c5a8f4c254a Added very simple if support.
Anders Halager <halager@gmail.com>
parents: 1
diff changeset
136 Tok.Bool:"Bool",
37
858b9805843d Bug-fixes
Anders Halager <halager@gmail.com>
parents: 36
diff changeset
137 Tok.Void:"Void",
8
2e1069ee21af Added Ne, Lt, Le, Gt, Ge and Not in lexer
johnsen@johnsen-desktop
parents: 6
diff changeset
138 Tok.Eq:"Eq",
2e1069ee21af Added Ne, Lt, Le, Gt, Ge and Not in lexer
johnsen@johnsen-desktop
parents: 6
diff changeset
139 Tok.Ne:"Ne",
2e1069ee21af Added Ne, Lt, Le, Gt, Ge and Not in lexer
johnsen@johnsen-desktop
parents: 6
diff changeset
140 Tok.Lt:"Lt",
2e1069ee21af Added Ne, Lt, Le, Gt, Ge and Not in lexer
johnsen@johnsen-desktop
parents: 6
diff changeset
141 Tok.Le:"Le",
2e1069ee21af Added Ne, Lt, Le, Gt, Ge and Not in lexer
johnsen@johnsen-desktop
parents: 6
diff changeset
142 Tok.Gt:"Gt",
2e1069ee21af Added Ne, Lt, Le, Gt, Ge and Not in lexer
johnsen@johnsen-desktop
parents: 6
diff changeset
143 Tok.Ge:"Ge",
1
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
144 Tok.OpenParentheses:"OpenParentheses",
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
145 Tok.CloseParentheses:"CloseParentheses",
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
146 Tok.OpenBrace:"OpenBrace",
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
147 Tok.CloseBrace:"CloseBrace",
28
69464d465284 Now supporting structs - both read and write. Still a few errors though, so watch out.
Anders Johnsen <skabet@gmail.com>
parents: 22
diff changeset
148 Tok.Dot:"Dot",
1
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
149 Tok.Assign:"Assign",
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
150 Tok.Add:"Add",
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
151 Tok.Sub:"Sub",
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
152 Tok.Mul:"Mul",
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
153 Tok.Div:"Div",
5
2c5a8f4c254a Added very simple if support.
Anders Halager <halager@gmail.com>
parents: 1
diff changeset
154 Tok.Integer:"Integer",
2c5a8f4c254a Added very simple if support.
Anders Halager <halager@gmail.com>
parents: 1
diff changeset
155 Tok.If:"If",
11
642c6a998fd9 Support for while statements and fixed scope for if
Anders Halager <halager@gmail.com>
parents: 8
diff changeset
156 Tok.While:"While",
36
ce17bea8e9bd Switch statements support
Anders Halager <halager@gmail.com>
parents: 28
diff changeset
157 Tok.Switch:"Switch",
ce17bea8e9bd Switch statements support
Anders Halager <halager@gmail.com>
parents: 28
diff changeset
158 Tok.Case:"Case",
ce17bea8e9bd Switch statements support
Anders Halager <halager@gmail.com>
parents: 28
diff changeset
159 Tok.Default:"Default",
21
0fb2d13dce37 Now working with gdc also (gdc use reverse paremeter validating on function calls)
johnsen@johnsen-laptop
parents: 11
diff changeset
160 Tok.Comma:"Comma",
5
2c5a8f4c254a Added very simple if support.
Anders Halager <halager@gmail.com>
parents: 1
diff changeset
161 Tok.Return:"Return",
22
e331e4e816e4 now handling structs to some extend
johnsen@johnsen-laptop
parents: 21
diff changeset
162 Tok.Struct:"Struct",
36
ce17bea8e9bd Switch statements support
Anders Halager <halager@gmail.com>
parents: 28
diff changeset
163 Tok.Colon:"Colon",
1
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
164 Tok.Seperator:"Seperator"
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
165 ];
2168f4cb73f1 First push
johnsen@johnsen-desktop
parents:
diff changeset
166 }