1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Utils and tools related to parsers and AST
21 redef class ToolContext
22 # Parse a full module given as a string
23 # Fatal error if the `string` is not a syntactically correct module
24 fun parse_module
(string
: String): AModule
26 var source
= new SourceFile.from_string
("", string
)
27 var lexer
= new Lexer(source
)
28 var parser
= new Parser(lexer
)
29 var tree
= parser
.parse
32 if eof
isa AError then
33 self.fatal_error
(null, "Fatal Error: {eof.message}")
36 return tree
.n_base
.as(not null)
39 # Parse a full classdef given as a string
40 # Fatal error if the `string` is not a syntactically correct class definition
41 fun parse_classdef
(string
: String): AClassdef
43 var nmodule
= parse_module
(string
)
44 var nclassdefs
= nmodule
.n_classdefs
45 if nclassdefs
.length
!= 1 then
46 self.fatal_error
(null, "Fatal Error: not a classdef")
49 return nclassdefs
.first
52 # Parse a full propdef given as a string
53 # Fatal error if the `string` is not a syntactically correct property definition
54 fun parse_propdef
(string
: String): APropdef
56 var mod_string
= "class Dummy\n{string}\nend"
57 var nclassdef
= parse_classdef
(mod_string
)
58 var npropdefs
= nclassdef
.n_propdefs
59 if npropdefs
.length
!= 1 then
60 self.fatal_error
(null, "Fatal Error: not a propdef")
63 return npropdefs
.first
66 # Parse a full statement block given as a string
67 # Fatal error if the `string` is not a syntactically correct statement block
68 fun parse_stmts
(string
: String): AExpr
70 var mod_string
= "do\n{string}\nend"
71 var nmodule
= parse_module
(mod_string
)
72 var nblock
= nmodule
.n_classdefs
.first
.n_propdefs
.first
.as(AMainMethPropdef).n_block
.as(ABlockExpr).n_expr
.first
.as(ADoExpr).n_block
.as(not null)
76 # Parse a full expression given as a string
77 # Fatal error if the `string` is not a syntactically correct expression
78 fun parse_expr
(string
: String): AExpr
80 var mod_string
= "var dummy = \n{string}"
81 var nmodule
= parse_module
(mod_string
)
82 var nexpr
= nmodule
.n_classdefs
.first
.n_propdefs
.first
.as(AMainMethPropdef).n_block
.as(ABlockExpr).n_expr
.first
.as(AVardeclExpr).n_expr
.as(not null)
86 # Try to parse the `string` as something
88 # Returns the first possible syntacticaly correct type among:
92 # - an expression `AExpr`
93 # - a block of statements `ABlockExpr`
94 # - a full module `AModule`
95 # - a `AError` if nothing else matches
97 # var tc = new ToolContext
98 # assert tc.parse_something("foo") isa TId
99 # assert tc.parse_something("foo[bar]") isa AExpr
100 # assert tc.parse_something("Foo[Bar]") isa AType
101 # assert tc.parse_something("foo\nbar") isa ABlockExpr
102 # assert tc.parse_something("fun foo do bar\nfoo") isa AModule
103 # assert tc.parse_something("fun fun") isa AParserError
104 # assert tc.parse_something("?%^&") isa ALexerError
105 fun parse_something
(string
: String): ANode
107 var source
= new SourceFile.from_string
("", string
)
113 lexer
= new InjectedLexer(source
)
114 lexer
.injected_before
.add
new TKwvar
115 lexer
.injected_before
.add
new TId
116 lexer
.injected_before
.add
new TColumn
117 lexer
.injected_before
.add
new TClassid
118 lexer
.injected_before
.add
new TObra
119 lexer
.injected_after
.add
new TCbra
120 tree
= (new Parser(lexer
)).parse
122 if not eof
isa AError then
123 var ntype
= tree
.n_base
.n_classdefs
.first
.n_propdefs
.first
.as(AMainMethPropdef).n_block
.as(ABlockExpr).n_expr
.first
.as(AVardeclExpr).n_type
.n_types
.first
128 lexer
= new Lexer(source
)
129 var first
= lexer
.next
130 if not first
isa EOF then
131 var second
= lexer
.next
132 if second
isa EOF and not second
isa AError then
137 lexer
= new InjectedLexer(source
)
138 lexer
.injected_before
.add
new TKwvar
139 lexer
.injected_before
.add
new TId
140 lexer
.injected_before
.add
new TAssign
141 lexer
.injected_before
.add
new TOpar
142 lexer
.injected_after
.add
new TCpar
143 tree
= (new Parser(lexer
)).parse
145 if not eof
isa AError then
146 var nexpr
= tree
.n_base
.n_classdefs
.first
.n_propdefs
.first
.as(AMainMethPropdef).n_block
.as(ABlockExpr).n_expr
.first
.as(AVardeclExpr).n_expr
.as(AParExpr).n_expr
149 if eof
.location
> error
.location
then error
= eof
151 lexer
= new InjectedLexer(source
)
152 lexer
.injected_before
.add
new TKwdo
153 lexer
.injected_before
.add
new TEol
154 lexer
.injected_after
.add
new TEol
155 lexer
.injected_after
.add
new TKwend
156 tree
= (new Parser(lexer
)).parse
158 if not eof
isa AError then
159 var nblock
= tree
.n_base
.n_classdefs
.first
.n_propdefs
.first
.as(AMainMethPropdef).n_block
.as(ABlockExpr).n_expr
.first
.as(ADoExpr).n_block
.as(not null)
162 if eof
.location
> error
.location
then error
= eof
164 lexer
= new Lexer(source
)
165 tree
= (new Parser(lexer
)).parse
167 if not eof
isa AError then
168 return tree
.n_base
.as(not null)
170 if eof
.location
> error
.location
then error
= eof
179 var injected_before
= new List[Token]
180 var injected_after
= new List[Token]
181 private var is_finished
= false
185 if not injected_before
.is_empty
then
186 var tok
= injected_before
.shift
187 if tok
._location
== null then tok
._location
= new Location(file
, 1, 1, 1, 0)
190 if not is_finished
then
192 if not next
isa EOF then return next
193 injected_after
.push
(next
)
197 var tok
= injected_after
.shift
198 if tok
._location
== null then tok
._location
= new Location(file
, 1, 1, 1, 0)
204 # Return an array of tokens that match a given text
205 fun collect_tokens_by_text
(text
: String): Array[Token]
207 var v
= new CollectTokensByTextVisitor(text
)
212 # Return an array of node that are annotated
213 # The attached node can be retrieved by two invocation of parent
214 fun collect_annotations_by_name
(name
: String): Array[AAnnotation]
216 var v
= new CollectAnnotationsByNameVisitor(name
)
222 private class CollectTokensByTextVisitor
225 init(text
: String) do self.text
= text
226 var result
= new Array[Token]
227 redef fun visit
(node
)
230 if node
isa Token and node
.text
== text
then result
.add
(node
)
234 private class CollectAnnotationsByNameVisitor
237 init(name
: String) do self.name
= name
238 var result
= new Array[AAnnotation]
239 redef fun visit
(node
)
242 if node
isa AAnnotation and node
.n_atid
.n_id
.text
== name
then result
.add
(node
)