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 # Library used to pretty print Nit code.
20 # var tc = new ToolContext
21 # var nmodule = tc.parse_something("class A\nfun toto : Int do return 5\nend")
22 # var ppv = new PrettyPrinterVisitor
23 # var pmodule = ppv.pretty(nmodule)
24 # assert pmodule.write_to_string == """
26 # \tfun toto: Int do return 5
29 # See `nitpretty` tool for more documentation.
37 # The `PrettyPrinterVisitor` is used to visit a node and pretty print it.
39 # The main method here is `visit` that performs the pretty printing of a `ANode`.
41 # Because some tokens like `TComment` are not stored in the AST,
42 # we visit the AST like traditionnal visitor and also maintain a
43 # pointer to the `current_token` (actually the next one to be printed).
45 # Visited productions are in charges to move the token pointer using methods such as:
47 # * `consume`: print `current_token` and move to the next one
48 # * `skip`: move to the next token without printing the current one
49 # * `skip_to`: move to a specified token skipping all the tokens before
50 # * `catch_up`: consume all the tokens between `current_token` and a specified token
51 # * `finish_line`: consume all the tokens between `current_token` and the end of line
52 class PrettyPrinterVisitor
54 fun pretty
(n
: ANode): Template do
59 current_token
= n
.first_token
61 else if n
isa Token then
64 while p
!= null and not p
isa Prod do
68 current_token
= p
.first_token
72 return tpl
.as(not null)
75 # Pretty print the whole `nmodule` with comments before and after.
76 fun pretty_nmodule
(nmodule
: AModule): Template do
78 nmodule
.parentize_tokens
79 current_token
= nmodule
.location
.file
.first_token
81 catch_up nmodule
.location
.file
.last_token
83 return tpl
.as(not null)
86 # Prepare `self` for a new visit.
96 # Visit `n` if not null.
97 fun visit
(n
: nullable ANode) do
98 if n
== null then return
99 n
.accept_pretty_printer
self
102 # Visit a list of `Anode`.
103 fun visit_list
(n
: nullable ANodes[ANode]) do
104 if n
== null then return
105 n
.accept_pretty_printer
self
108 # Is the node inlinable and can fit on the line.
109 fun can_inline
(n
: nullable ANode): Bool do
110 if n
== null then return true
111 if n
.must_be_inline
then return true
112 if n
.must_be_block
then return false
114 if n
.collect_length
+ current_length
> max_size
then return false
115 # check block is inlinable
116 return n
.is_inlinable
119 # Collect all `TComment` between `from` and `to`.
120 fun collect_comments
(from
: nullable ANode, to
: nullable ANode): Array[TComment] do
121 var res
= new Array[TComment]
122 if from
isa Prod then from
= from
.first_token
123 if to
isa Prod then to
= to
.first_token
124 if from
== null or to
== null then return res
127 if from
isa TComment then res
.add from
128 from
= from
.as(Token).next_token
134 # Token under cursor.
136 # This is the next token to visit.
137 var current_token
: nullable Token = null
139 # Skip the `current_token`.
140 fun skip
do current_token
= current_token
.next_token
142 # Skip `current_token` until the end of line.
143 fun skip_line
do current_token
= current_token
.last_real_token_in_line
145 # Skip `current_token` until `target` is reached.
146 fun skip_to
(target
: nullable Token) do
147 if target
== null then return
148 while current_token
!= target
do skip
151 # Visit `current_token`.
152 fun consume
(token
: String) do
153 assert current_token
.text
== token
157 # Is there token to visit between `current_token` and `target`?
158 fun need_catch_up
(target
: nullable Token): Bool do
159 if target
== null then return false
160 return current_token
!= target
163 # Visit all tokens between `current_token` and `target`.
164 fun catch_up
(target
: nullable ANode) do
165 if target
== null then return
166 if current_token
== null then return
168 if target
isa Token then
170 else if target
isa Prod then
171 token
= target
.first_token
.as(not null)
175 assert current_token
.location
<= token
.location
176 while current_token
!= token
do visit current_token
179 # Visit all tokens between `current_token` and the end of line.
181 if current_token
isa TComment then
186 while current_token
isa TEol do skip
189 # The template under construction.
190 private var tpl
: nullable Template = null
192 # Current indent level.
195 # Size of a tabulation in spaces.
201 # Length of the current line.
202 var current_length
= 0
204 # Length of the previous line.
205 var previous_length
= 0
207 # Is the last line a blank line?
208 fun last_line_is_blank
: Bool do return previous_length
== 0
210 # Add `t` to current template.
211 fun add
(t
: String) do
212 if t
.is_empty
then return
213 while wait_addn
> 0 do
218 current_length
+= t
.length
223 if current_length
== 0 and last_line_is_blank
then return
224 previous_length
= current_length
229 # End of line chars are stored until another char is added.
230 # This avoid empty files with only a '`\n`'.
231 private var wait_addn
= 0
233 # Add `'\t' * indent`.
234 fun addt
do add
"\t" * indent
239 # Visit explicit receiver, implicit self will be ignored.
240 fun visit_recv
(n_expr
: AExpr) do
241 if not n_expr
isa AImplicitSelfExpr then
248 # Base framework redefs
250 redef class ANodes[E
]
251 private fun accept_pretty_printer
(v
: PrettyPrinterVisitor) do
253 var e_can_inline
= v
.can_inline
(e
)
256 if not e_can_inline
then
272 # Start visit of `self` using a `PrettyPrinterVisitor`
273 private fun accept_pretty_printer
(v
: PrettyPrinterVisitor) is abstract
275 # Collect the length (in `Char`) of the node.
276 private fun collect_length
: Int is abstract
278 # Is `self` printable in one line?
279 private fun is_inlinable
: Bool do return true
281 # Force `self` to be rendered as a block.
282 private var force_block
= false
284 # Does `self` have to be rendered as a block?
285 private fun must_be_block
: Bool do return force_block
287 # Force `self` to be rendered as a line.
288 private var force_inline
= false
290 # Does `self` have be rendered as a line?
291 private fun must_be_inline
: Bool do
292 if parent
!= null and parent
.must_be_inline
then return true
296 # Does `self` was written in one line before transformation?
297 private fun was_inline
: Bool is abstract
301 redef fun accept_pretty_printer
(v
) do
303 v
.current_token
= next_token
306 redef fun collect_length
do return text
.length
307 redef fun is_inlinable
do return true
308 redef fun was_inline
do return true
312 redef fun accept_pretty_printer
(v
) do v
.visit first_token
314 # The token where the production really start (skipping ADoc).
315 private fun start_token
: nullable Token do return first_token
317 # Collect all `TComment` contained in the production
318 # (between `start_token` and `end_token`).
319 private fun collect_comments
: Array[TComment] do
320 var res
= new Array[TComment]
321 if start_token
== null or last_token
== null then return res
322 var token
= start_token
324 while token
!= last_token
do
325 if token
isa TComment then res
.add token
326 token
= token
.next_token
332 redef fun collect_length
do
334 if start_token
== null or last_token
== null then return res
335 var token
= start_token
337 while token
!= last_token
do
338 res
+= token
.text
.length
339 token
= token
.next_token
342 res
+= token
.text
.length
346 redef fun was_inline
do
347 return first_token
.location
.line_start
== last_token
.location
.line_end
354 redef fun accept_pretty_printer
(v
) do
365 if is_last_in_group
then v
.addn
379 if next_token
isa TComment and is_first_in_group
then v
.addn
383 var prev_token
= self.prev_token
384 if prev_token
isa TComment and prev_token
.is_inline
and is_last_in_group
then v
.addn
391 # Is `self` part of an `ADoc`?
392 private fun is_adoc
: Bool do return parent
isa ADoc and parent
.parent
!= null
394 # Is `self` part of a licence?
395 private fun is_licence
: Bool do
396 var prev_token
= self.prev_token
398 if prev_token
== null then
400 else if prev_token
isa TComment then
401 return prev_token
.is_licence
407 # Is `self` starts and ends its line?
408 private fun is_inline
: Bool do
409 return self == first_real_token_in_line
and self == last_real_token_in_line
412 # Is `self` an orphan line (blank before and after)?
413 private fun is_orphan
: Bool do
414 return prev_token
isa TEol and
415 (prev_token
.prev_token
isa TEol or prev_token
.prev_token
isa TComment) and
419 # Is `self` the first comment of a group of comment?
420 private fun is_first_in_group
: Bool do return not prev_token
isa TComment
422 # Is `self` the last comment of a group of comments?
423 private fun is_last_in_group
: Bool do return not next_token
isa TComment
427 redef fun accept_pretty_printer
(v
) do for comment
in n_comment
do v
.visit comment
428 redef fun is_inlinable
do return n_comment
.length
<= 1
433 redef class AAnnotations
434 redef fun accept_pretty_printer
(v
) do
438 if v
.can_inline
(self) then
440 for n_item
in n_items
do
442 if n_item
!= n_items
.last
then
447 else if n_items
.length
> 1 then
451 for n_item
in n_items
do
460 if not was_inline
and v
.current_token
isa TKwend then v
.skip
463 redef fun is_inlinable
do
464 if not super then return false
465 for annot
in n_items
do if not annot
.is_inlinable
then return false
470 redef class AAnnotation
471 redef fun accept_pretty_printer
(v
) do
473 if not n_args
.is_empty
then
474 if n_opar
== null then
485 redef class ATypeExpr
486 redef fun accept_pretty_printer
(v
) do v
.visit n_type
492 redef fun accept_pretty_printer
(v
) do
493 v
.catch_up start_token
496 if not n_imports
.is_empty
then
499 for n_import
in n_imports
do
505 if not n_extern_code_blocks
.is_empty
then
508 for n_extern_block
in n_extern_code_blocks
do
509 v
.catch_up n_extern_block
510 v
.visit n_extern_block
512 if n_extern_block
!= n_extern_code_blocks
.last
then v
.addn
515 if not n_classdefs
.is_empty
then v
.addn
518 if not n_classdefs
.is_empty
then
521 for n_classdef
in n_classdefs
do
522 v
.catch_up n_classdef
524 if n_classdef
!= n_classdefs
.last
then v
.addn
532 redef fun start_token
do
533 if n_moduledecl
!= null then return n_moduledecl
.first_token
534 if not n_imports
.is_empty
then return n_imports
.first
.first_token
535 if not n_classdefs
.is_empty
then return n_classdefs
.first
.first_token
539 redef fun is_inlinable
do return false
542 redef class AModuledecl
543 redef fun accept_pretty_printer
(v
) do
549 if n_annotations
!= null then
550 var annot_inline
= v
.can_inline
(n_annotations
)
551 v
.visit n_annotations
553 if not annot_inline
then
554 if v
.current_token
isa TKwend then
568 redef class AModuleName
569 redef fun accept_pretty_printer
(v
) do
570 for path
in n_path
do
579 redef class ANoImport
580 redef fun accept_pretty_printer
(v
) do
589 redef class AStdImport
590 redef fun accept_pretty_printer
(v
) do
591 if not n_visibility
isa APublicVisibility then
606 redef class AClassdef
607 redef fun accept_pretty_printer
(v
) do
608 for n_propdef
in n_propdefs
do
611 if n_propdef
.n_doc
!= null or not v
.can_inline
(n_propdef
) then
612 if n_propdef
!= n_propdefs
.first
then v
.addn
614 if n_propdef
!= n_propdefs
.last
then v
.addn
622 redef class AStdClassdef
623 redef fun accept_pretty_printer
(v
) do
625 var can_inline
= v
.can_inline
(self)
627 if not n_visibility
isa APublicVisibility then
632 if n_kwredef
!= null then
641 if not n_formaldefs
.is_empty
then
643 v
.visit_list n_formaldefs
647 if n_extern_code_block
!= null then
649 v
.visit n_extern_code_block
655 if not n_superclasses
.is_empty
then
656 for n_superclass
in n_superclasses
do
666 for n_superclass
in n_superclasses
do
667 v
.catch_up n_superclass
674 if not n_superclasses
.is_empty
and not n_propdefs
.is_empty
then
689 redef fun is_inlinable
do
690 if not super then return false
691 if not n_propdefs
.is_empty
then return false
692 if n_superclasses
.length
> 1 then return false
693 if not collect_comments
.is_empty
then return false
697 redef fun start_token
do
698 if not n_visibility
isa APublicVisibility then return n_visibility
.first_token
699 if n_kwredef
!= null then return n_kwredef
700 return n_classkind
.first_token
704 redef class AAbstractClasskind
705 redef fun accept_pretty_printer
(v
) do
712 redef class AExternClasskind
713 redef fun accept_pretty_printer
(v
) do
720 redef class AFormaldef
721 redef fun accept_pretty_printer
(v
) do
724 if n_type
!= null then
733 redef fun accept_pretty_printer
(v
) do
734 if n_kwnullable
!= null then
741 if not n_types
.is_empty
then
749 redef class ASuperclass
750 redef fun accept_pretty_printer
(v
) do
760 redef fun accept_pretty_printer
(v
) do
764 if not n_visibility
isa APublicVisibility then
769 if n_kwredef
!= null then
775 # Factorize annotations visit for all APropdef.
777 # Return true if annotations were inlined.
778 fun visit_annotations
(v
: PrettyPrinterVisitor, n_annotations
: nullable AAnnotations): Bool do
779 var res
= v
.can_inline
(n_annotations
)
780 if n_annotations
!= null then v
.visit n_annotations
784 # Factorize block visit for APropdefs.
786 # Were annotations printed inline? If so, we need to print the block differently.
787 fun visit_block
(v
: PrettyPrinterVisitor, n_block
: nullable AExpr, annot_inline
: Bool) do
788 if n_block
== null then return
789 while not v
.current_token
isa TKwdo do v
.skip
790 if n_annotations
!= null and not annot_inline
then
797 if v
.can_inline
(n_block
) then
800 if n_block
isa ABlockExpr then
801 if n_block
.n_expr
.is_empty
then
802 v
.visit n_block
.n_kwend
804 v
.visit n_block
.n_expr
.first
805 v
.current_token
= n_block
.n_kwend
810 if v
.current_token
isa TKwend then v
.skip
817 if n_block
isa ABlockExpr then
818 n_block
.force_block
= true
820 v
.catch_up n_block
.n_kwend
829 if n_block
isa ABlockExpr then
830 v
.visit n_block
.n_kwend
838 redef fun start_token
do
839 if n_doc
== null then return super
840 return n_doc
.last_token
.next_token
844 redef class AAttrPropdef
845 redef fun accept_pretty_printer
(v
) do
851 if n_type
!= null then
857 if n_expr
!= null then
864 var annot_inline
= visit_annotations
(v
, n_annotations
)
865 visit_block
(v
, n_block
, annot_inline
)
870 redef fun first_token
do
871 if n_doc
!= null then return n_doc
.first_token
872 if not n_visibility
isa APublicVisibility then return n_visibility
.first_token
873 if n_kwredef
!= null then return n_kwredef
877 redef fun is_inlinable
do return true
880 redef class ATypePropdef
881 redef fun accept_pretty_printer
(v
) do
889 visit_annotations
(v
, n_annotations
)
894 redef fun is_inlinable
do return true
897 redef class AMethPropdef
898 redef fun accept_pretty_printer
(v
) do
899 # TODO: Handle extern annotations
901 var before
= v
.indent
903 if n_kwinit
!= null then v
.visit n_kwinit
904 if n_kwmeth
!= null then v
.visit n_kwmeth
905 if n_kwnew
!= null then v
.visit n_kwnew
907 if not n_methid
== null then
914 var annot_inline
= visit_annotations
(v
, n_annotations
)
916 if n_extern_calls
!= null or n_extern_code_block
!= null then
918 if n_extern_calls
!= null then v
.visit n_extern_calls
919 if n_extern_code_block
!= null then v
.visit n_extern_code_block
922 visit_block
(v
, n_block
, annot_inline
)
924 assert v
.indent
== before
928 # * block is empty or can be inlined
929 # * contains no comments
930 redef fun is_inlinable
do
931 if not super then return false
932 if n_annotations
!= null and not n_annotations
.is_inlinable
then return false
933 if n_block
!= null and not n_block
.is_inlinable
then return false
934 if n_extern_calls
!= null and not n_extern_calls
.is_inlinable
then return false
935 if n_extern_code_block
!= null and not n_extern_code_block
.is_inlinable
then return false
936 if not collect_comments
.is_empty
then return false
941 redef class AMainMethPropdef
942 redef fun accept_pretty_printer
(v
) do
948 redef class ASignature
949 redef fun accept_pretty_printer
(v
) do
950 if not n_params
.is_empty
then
952 v
.visit_list n_params
956 if n_type
!= null then
965 redef fun accept_pretty_printer
(v
) do
968 if n_type
!= null then
974 if n_dotdotdot
!= null then v
.visit n_dotdotdot
980 redef class AExternCalls
981 redef fun accept_pretty_printer
(v
) do
982 var can_inline
= v
.can_inline
(self)
987 v
.visit_list n_extern_calls
992 v
.visit_list n_extern_calls
999 redef class AFullPropExternCall
1000 redef fun accept_pretty_printer
(v
) do
1007 redef class ALocalPropExternCall
1008 redef fun accept_pretty_printer
(v
) do v
.visit n_methid
1011 redef class AInitPropExternCall
1012 redef fun accept_pretty_printer
(v
) do v
.visit n_type
1015 redef class ACastAsExternCall
1016 redef fun accept_pretty_printer
(v
) do
1026 redef class AAsNullableExternCall
1027 redef fun accept_pretty_printer
(v
) do
1032 v
.visit n_kwnullable
1036 redef class AAsNotNullableExternCall
1037 redef fun accept_pretty_printer
(v
) do
1044 v
.visit n_kwnullable
1048 redef class AExternCodeBlock
1049 redef fun accept_pretty_printer
(v
) do
1050 if n_in_language
!= null then
1051 v
.visit n_in_language
1055 v
.visit n_extern_code_segment
1058 redef fun is_inlinable
do
1059 if not super then return false
1060 return n_extern_code_segment
.is_inlinable
1064 redef class AInLanguage
1065 redef fun accept_pretty_printer
(v
) do
1072 redef class TExternCodeSegment
1073 redef fun accept_pretty_printer
(v
) do
1074 var can_inline
= v
.can_inline
(self)
1079 var text
= text
.substring
(2, text
.length
- 4)
1080 var lines
= text
.r_trim
.split
("\n")
1082 if text
.is_empty
then
1087 if not lines
.first
.trim
.is_empty
then
1095 for line
in lines
do
1104 v
.current_token
= next_token
1108 redef fun is_inlinable
do
1109 if not super then return false
1110 return location
.line_start
== location
.line_end
1116 redef class ABlockExpr
1117 redef fun accept_pretty_printer
(v
) do
1118 var before
= v
.indent
1119 var can_inline
= v
.can_inline
(self)
1121 if can_inline
and not n_expr
.is_empty
then
1122 v
.visit n_expr
.first
1125 for nexpr
in n_expr
do
1126 var expr_inline
= v
.can_inline
(nexpr
)
1127 if not expr_inline
and nexpr
!= n_expr
.first
then v
.addn
1133 if not expr_inline
and nexpr
!= n_expr
.last
then v
.addn
1137 assert v
.indent
== before
1140 redef fun is_inlinable
do
1141 if not super then return false
1142 if not collect_comments
.is_empty
then return false
1144 if not n_expr
.is_empty
then
1145 if n_expr
.length
> 1 then return false
1146 if not n_expr
.first
.is_inlinable
then return false
1154 redef fun accept_pretty_printer
(v
) do
1155 var before
= v
.indent
1156 var can_inline
= v
.can_inline
(self)
1160 if v
.can_inline
(n_expr
) then
1169 # skip comments before `then` token
1170 while not v
.current_token
isa TKwthen do v
.skip
1172 var n_else
= self.n_else
1176 if n_then
!= null then v
.visit n_then
1179 n_else
.force_inline
= true
1184 else if n_then
== null then
1188 v
.skip_to last_token
.last_real_token_in_line
1194 if n_then
!= null then
1195 if n_then
isa ABlockExpr then
1196 n_then
.force_block
= true
1206 while not v
.current_token
isa TKwelse do
1207 v
.consume v
.current_token
.text
1214 if n_else
isa AIfExpr then
1215 n_else
.force_block
= true
1223 if n_else
isa ABlockExpr then
1224 n_else
.force_block
= true
1232 if last_token
isa TKwend then
1233 v
.catch_up last_token
1244 if last_token
.location
>= v
.current_token
.location
then v
.catch_up last_token
1248 if v
.current_token
isa TKwend then v
.skip
1252 assert v
.indent
== before
1255 redef fun is_inlinable
do
1256 if not super then return false
1257 if n_then
!= null and not n_then
.is_inlinable
then return false
1258 var n_else
= self.n_else
1259 if (n_else
isa ABlockExpr and not n_else
.n_expr
.is_empty
) or
1260 (not n_else
isa ABlockExpr and n_else
!= null) then
1263 if not collect_comments
.is_empty
then return false
1267 # Does this `if` statement contains a `else` part?
1268 private fun has_else
(v
: PrettyPrinterVisitor): Bool do
1270 if n_else
== null then return false
1271 var n_kwelse
= collect_kwelse
1272 if n_kwelse
== null then return false
1274 if n_else
isa ABlockExpr then
1275 var comments
: Array[TComment]
1277 if n_then
== null then
1278 comments
= v
.collect_comments
(n_expr
.last_token
, n_else
.last_token
)
1280 comments
= v
.collect_comments
(n_then
.last_token
, n_else
.last_token
)
1283 if not comments
.is_empty
then return true
1284 return not n_else
.n_expr
.is_empty
1290 # Lookup for `else` token in `self`.
1291 private fun collect_kwelse
: nullable TKwelse do
1292 var token
= first_token
1294 while token
!= last_token
do
1295 if token
isa TKwelse then return token
1296 token
= token
.next_token
1303 # Used to factorize work on loops.
1304 private class ALoopHelper
1307 fun loop_block
: nullable ANode is abstract
1308 fun loop_label
: nullable ANode is abstract
1310 fun visit_loop_block
(v
: PrettyPrinterVisitor) do
1311 var n_block
= loop_block
1316 if n_block
isa ABlockExpr then
1317 n_block
.force_block
= true
1319 v
.catch_up n_block
.n_kwend
1322 v
.visit n_block
.n_kwend
1332 if loop_label
!= null then
1338 fun visit_loop_inline
(v
: PrettyPrinterVisitor) do
1339 var n_block
= loop_block
1342 if n_block
isa ABlockExpr then
1343 if n_block
.n_expr
.is_empty
then
1344 v
.visit n_block
.n_kwend
1346 v
.visit n_block
.n_expr
.first
1347 v
.current_token
= n_block
.n_kwend
1352 if v
.current_token
isa TKwend then v
.skip
1355 if loop_label
!= null then
1361 redef fun is_inlinable
do
1362 var n_block
= loop_block
1363 if not super then return false
1364 if n_block
isa ABlockExpr and not n_block
.is_inlinable
then return false
1365 if not collect_comments
.is_empty
then return false
1370 redef class ALoopExpr
1373 redef fun loop_block
do return n_block
1374 redef fun loop_label
do return n_label
1376 redef fun accept_pretty_printer
(v
) do
1377 var can_inline
= v
.can_inline
(self)
1379 if can_inline
then visit_loop_inline v
else visit_loop_block v
1383 redef class AWhileExpr
1386 redef fun loop_block
do return n_block
1387 redef fun loop_label
do return n_label
1389 redef fun accept_pretty_printer
(v
) do
1390 var can_inline
= v
.can_inline
(self)
1396 if can_inline
then visit_loop_inline v
else visit_loop_block v
1403 redef fun loop_block
do return n_block
1404 redef fun loop_label
do return n_label
1406 redef fun accept_pretty_printer
(v
) do
1407 var can_inline
= v
.can_inline
(self)
1409 if can_inline
then visit_loop_inline v
else visit_loop_block v
1413 redef class AForExpr
1416 redef fun loop_block
do return n_block
1417 redef fun loop_label
do return n_label
1419 redef fun accept_pretty_printer
(v
) do
1420 var can_inline
= v
.can_inline
(self)
1424 for n_id
in n_ids
do
1426 if n_id
!= n_ids
.last
then v
.add
", "
1435 if can_inline
then visit_loop_inline v
else visit_loop_block v
1439 redef class ABreakExpr
1440 redef fun accept_pretty_printer
(v
) do
1443 if n_expr
!= null then
1448 if n_label
!= null then
1454 redef fun is_inlinable
do return true
1457 redef class AContinueExpr
1458 redef fun accept_pretty_printer
(v
) do
1459 v
.visit n_kwcontinue
1461 if n_expr
!= null then
1466 if n_label
!= null then
1472 redef fun is_inlinable
do return true
1477 redef class ASendExpr
1478 redef fun is_inlinable
do return true
1481 redef class ACallExpr
1482 redef fun accept_pretty_printer
(v
) do
1483 var can_inline
= v
.can_inline
(self)
1486 if not n_expr
isa AImplicitSelfExpr and not can_inline
then
1494 if not n_args
.n_exprs
.is_empty
then
1495 if is_stmt
and n_args
.n_exprs
.length
== 1 then
1497 if v
.current_token
isa TOpar then v
.skip
1498 v
.visit n_args
.n_exprs
.first
1499 if v
.current_token
isa TCpar then v
.skip
1501 if v
.current_token
isa TOpar then
1507 v
.visit_list n_args
.n_exprs
1508 if v
.current_token
isa TCpar then v
.consume
")"
1513 # Is the call alone on its line?
1514 fun is_stmt
: Bool do return parent
isa ABlockExpr
1517 redef class ACallAssignExpr
1518 redef fun accept_pretty_printer
(v
) do
1522 if not n_args
.n_exprs
.is_empty
then
1524 v
.visit_list n_args
.n_exprs
1535 redef class ACallReassignExpr
1536 redef fun accept_pretty_printer
(v
) do
1540 if not n_args
.n_exprs
.is_empty
then
1542 v
.visit_list n_args
.n_exprs
1553 redef class ABraExpr
1554 redef fun accept_pretty_printer
(v
) do
1557 if not n_args
.n_exprs
.is_empty
then
1559 v
.visit_list n_args
.n_exprs
1565 redef class ABraAssignExpr
1566 redef fun accept_pretty_printer
(v
) do
1569 if not n_args
.n_exprs
.is_empty
then
1571 v
.visit_list n_args
.n_exprs
1582 redef class ABraReassignExpr
1583 redef fun accept_pretty_printer
(v
) do
1586 if not n_args
.n_exprs
.is_empty
then
1588 v
.visit_list n_args
.n_exprs
1599 redef class AAssignMethid
1600 redef fun accept_pretty_printer
(v
) do
1606 redef class ABraMethid
1607 redef fun accept_pretty_printer
(v
) do
1613 redef class ABraassignMethid
1614 redef fun accept_pretty_printer
(v
) do
1621 redef class AInitExpr
1622 redef fun accept_pretty_printer
(v
) do
1623 if not n_expr
isa AImplicitSelfExpr then
1630 if not n_args
.n_exprs
.is_empty
then
1632 v
.visit_list n_args
.n_exprs
1638 redef class ANewExpr
1639 redef fun accept_pretty_printer
(v
) do
1640 var can_inline
= v
.can_inline
(self)
1645 if n_id
!= null then
1648 if not can_inline
then
1657 if not n_args
.n_exprs
.is_empty
then
1659 v
.visit_list n_args
.n_exprs
1664 redef fun is_inlinable
do return true
1669 redef class AAttrExpr
1670 redef fun accept_pretty_printer
(v
) do
1675 redef fun is_inlinable
do return true
1678 redef class AAttrAssignExpr
1679 redef fun accept_pretty_printer
(v
) do
1689 redef class AAttrReassignExpr
1690 redef fun accept_pretty_printer
(v
) do
1702 redef class AVardeclExpr
1703 redef fun accept_pretty_printer
(v
) do
1708 if n_type
!= null then
1714 if n_expr
!= null then
1722 redef fun is_inlinable
do return true
1725 redef class AVarAssignExpr
1726 redef fun accept_pretty_printer
(v
) do
1735 redef class AAssertExpr
1736 redef fun accept_pretty_printer
(v
) do
1737 var can_inline
= v
.can_inline
(self)
1740 if n_id
!= null then
1748 var n_else
= self.n_else
1750 if n_else
!= null then
1760 if n_else
isa ABlockExpr then
1762 n_else
.force_block
= true
1766 v
.visit n_else
.n_kwend
1780 redef fun is_inlinable
do
1781 if not super then return false
1782 if n_else
!= null and not n_else
.is_inlinable
then return false
1787 redef class AReturnExpr
1788 redef fun accept_pretty_printer
(v
) do
1791 if n_expr
!= null then
1798 redef class ASuperExpr
1799 redef fun accept_pretty_printer
(v
) do
1802 if not n_args
.n_exprs
.is_empty
then
1803 if is_stmt
and n_args
.n_exprs
.length
== 1 then
1805 if v
.current_token
isa TOpar then v
.skip
1806 v
.visit n_args
.n_exprs
.first
1807 if v
.current_token
isa TCpar then v
.skip
1809 if v
.current_token
isa TOpar then
1815 v
.visit_list n_args
.n_exprs
1816 if v
.current_token
isa TCpar then v
.consume
")"
1821 # Is the call alone on its line?
1822 fun is_stmt
: Bool do return self.first_token
.is_starting_line
1824 redef fun is_inlinable
do return true
1827 redef class AOnceExpr
1828 redef fun accept_pretty_printer
(v
) do
1834 redef fun is_inlinable
do return true
1837 redef class AAbortExpr
1838 redef fun accept_pretty_printer
(v
) do v
.visit n_kwabort
1839 redef fun is_inlinable
do return true
1842 redef class ANotExpr
1843 redef fun accept_pretty_printer
(v
) do
1850 redef class AAsCastExpr
1851 redef fun accept_pretty_printer
(v
) do
1861 redef class AAsNotnullExpr
1862 redef fun accept_pretty_printer
(v
) do
1876 # Used to factorize work on Or, And, Implies and Binop expressions.
1877 private class ABinOpHelper
1880 fun bin_expr1
: AExpr is abstract
1881 fun bin_expr2
: AExpr is abstract
1884 fun bin_op
: String is abstract
1886 redef fun accept_pretty_printer
(v
) do
1887 var can_inline
= v
.can_inline
(self)
1889 if not can_inline
then
1890 if (self isa ABinopExpr and bin_expr1
isa ABinopExpr) or
1891 (self isa AAndExpr and (bin_expr1
isa AAndExpr or bin_expr1
isa AOrExpr)) or
1892 (self isa AOrExpr and (bin_expr1
isa AAndExpr or bin_expr1
isa AOrExpr))
1894 bin_expr1
.force_block
= true
1914 redef class AAndExpr
1917 redef fun bin_expr1
do return n_expr
1918 redef fun bin_expr2
do return n_expr2
1919 redef fun bin_op
do return "and"
1925 redef fun bin_expr1
do return n_expr
1926 redef fun bin_expr2
do return n_expr2
1927 redef fun bin_op
do return "or"
1930 redef class AImpliesExpr
1933 redef fun bin_expr1
do return n_expr
1934 redef fun bin_expr2
do return n_expr2
1935 redef fun bin_op
do return "implies"
1938 redef class ABinopExpr
1941 redef fun bin_expr1
do return n_expr
1942 redef fun bin_expr2
do return n_expr2
1946 redef fun bin_op
do return "=="
1950 redef fun bin_op
do return ">="
1954 redef fun bin_op
do return ">>"
1958 redef fun bin_op
do return ">"
1962 redef fun bin_op
do return "<="
1966 redef fun bin_op
do return "<<"
1970 redef fun bin_op
do return "<"
1973 redef class AMinusExpr
1974 redef fun bin_op
do return "-"
1978 redef fun bin_op
do return "!="
1981 redef class APercentExpr
1982 redef fun bin_op
do return "%"
1985 redef class APlusExpr
1986 redef fun bin_op
do return "+"
1989 redef class ASlashExpr
1990 redef fun bin_op
do return "/"
1993 redef class AStarExpr
1994 redef fun bin_op
do return "*"
1997 redef class AStarstarExpr
1998 redef fun bin_op
do return "**"
2001 redef class AStarshipExpr
2002 redef fun bin_op
do return "<=>"
2005 redef class AIsaExpr
2006 redef fun accept_pretty_printer
(v
) do
2015 redef class AOrElseExpr
2016 redef fun accept_pretty_printer
(v
) do
2026 redef fun is_inlinable
do return true
2031 redef class AUminusExpr
2032 redef fun accept_pretty_printer
(v
) do
2038 redef class ANullExpr
2039 redef fun accept_pretty_printer
(v
) do v
.visit n_kwnull
2040 redef fun is_inlinable
do return true
2043 redef class AParExpr
2044 redef fun accept_pretty_printer
(v
) do
2051 redef class AArrayExpr
2052 redef fun accept_pretty_printer
(v
) do
2054 v
.visit_list n_exprs
2059 redef class ACrangeExpr
2060 redef fun accept_pretty_printer
(v
) do
2069 redef class AOrangeExpr
2070 redef fun accept_pretty_printer
(v
) do
2081 redef class AStringFormExpr
2082 redef fun accept_pretty_printer
(v
) do
2083 var can_inline
= v
.can_inline
(self)
2088 var text
= n_string
.text
2091 while i
< text
.length
do
2094 if v
.current_length
>= v
.max_size
and i
<= text
.length
- 3 then
2106 v
.current_token
= n_string
.next_token
2111 redef class ASuperstringExpr
2112 redef fun accept_pretty_printer
(v
) do
2113 for n_expr
in n_exprs
do v
.visit n_expr
2116 redef fun must_be_inline
do
2117 if super then return true
2119 if not n_exprs
.is_empty
then
2120 var first
= n_exprs
.first
2121 return first
isa AStringFormExpr and first
.n_string
.text
.has_prefix
("\"\
"\"")