1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Load nit source files and build the associated model
21 # FIXME split this module into submodules
22 # FIXME add missing error checks
28 private import more_collections
32 redef class ToolContext
34 var opt_path
= new OptionArray("Set include path for loaders (may be used more than once)", "-I", "--path")
36 # Option --only-metamodel
37 var opt_only_metamodel
= new OptionBool("Stop after meta-model processing", "--only-metamodel")
40 var opt_only_parse
= new OptionBool("Only proceed to parse step of loaders", "--only-parse")
42 # Option --ignore-visibility
43 var opt_ignore_visibility
= new OptionBool("Do not check, and produce errors, on visibility issues.", "--ignore-visibility")
48 option_context
.add_option
(opt_path
, opt_only_parse
, opt_only_metamodel
, opt_ignore_visibility
)
51 # The modelbuilder 1-to-1 associated with the toolcontext
52 fun modelbuilder
: ModelBuilder do return modelbuilder_real
.as(not null)
54 private var modelbuilder_real
: nullable ModelBuilder = null
56 # Combine module to make a single one if required.
57 fun make_main_module
(mmodules
: Array[MModule]): MModule
59 assert not mmodules
.is_empty
61 if mmodules
.length
== 1 then
62 mainmodule
= mmodules
.first
64 # We need a main module, so we build it by importing all modules
65 mainmodule
= new MModule(modelbuilder
.model
, null, mmodules
.first
.name
+ "-m", new Location(mmodules
.first
.location
.file
, 0, 0, 0, 0))
66 mainmodule
.is_fictive
= true
67 mainmodule
.set_imported_mmodules
(mmodules
)
72 # Run `process_mainmodule` on all phases
73 fun run_global_phases
(mmodules
: Array[MModule])
75 var mainmodule
= make_main_module
(mmodules
)
76 for phase
in phases_list
do
77 if phase
.disabled
then continue
78 phase
.process_mainmodule
(mainmodule
, mmodules
)
84 # Specific action to execute on the whole program.
85 # Called by the `ToolContext::run_global_phases`.
87 # `mainmodule` is the main module of the program.
88 # It could be an implicit module (called like the first given_mmodules).
90 # `given_modules` is the list of explicitely requested modules.
91 # from the command-line for instance.
93 # REQUIRE: `not given_modules.is_empty`
94 # REQUIRE: `(given_modules.length == 1) == (mainmodule == given_modules.first)`
97 fun process_mainmodule
(mainmodule
: MModule, given_mmodules
: SequenceRead[MModule]) do end
101 # A model builder knows how to load nit source files and build the associated model
103 # The model where new modules, classes and properties are added
106 # The toolcontext used to control the interaction with the user (getting options and displaying messages)
107 var toolcontext
: ToolContext
109 # Run phases on all loaded modules
112 var mmodules
= model
.mmodules
.to_a
113 model
.mmodule_importation_hierarchy
.sort
(mmodules
)
114 var nmodules
= new Array[AModule]
115 for mm
in mmodules
do
116 nmodules
.add
(mmodule2nmodule
[mm
])
118 toolcontext
.run_phases
(nmodules
)
120 if toolcontext
.opt_only_metamodel
.value
then
121 self.toolcontext
.info
("*** ONLY METAMODEL", 1)
126 # Instantiate a modelbuilder for a model and a toolcontext
127 # Important, the options of the toolcontext must be correctly set (parse_option already called)
130 assert toolcontext
.modelbuilder_real
== null
131 toolcontext
.modelbuilder_real
= self
133 # Setup the paths value
134 paths
.append
(toolcontext
.opt_path
.value
)
136 var path_env
= "NIT_PATH".environ
137 if not path_env
.is_empty
then
138 paths
.append
(path_env
.split_with
(':'))
141 var nit_dir
= toolcontext
.nit_dir
142 var libname
= "{nit_dir}/lib"
143 if libname
.file_exists
then paths
.add
(libname
)
146 # Load a bunch of modules.
147 # `modules` can contains filenames or module names.
148 # Imported modules are automatically loaded and modelized.
149 # The result is the corresponding model elements.
150 # Errors and warnings are printed with the toolcontext.
152 # Note: class and property model element are not analysed.
153 fun parse
(modules
: Sequence[String]): Array[MModule]
156 # Parse and recursively load
157 self.toolcontext
.info
("*** PARSE ***", 1)
158 var mmodules
= new ArraySet[MModule]
160 var nmodule
= self.load_module
(a
)
161 if nmodule
== null then continue # Skip error
162 mmodules
.add
(nmodule
.mmodule
.as(not null))
165 self.toolcontext
.info
("*** END PARSE: {time1-time0} ***", 2)
167 self.toolcontext
.check_errors
169 if toolcontext
.opt_only_parse
.value
then
170 self.toolcontext
.info
("*** ONLY PARSE...", 1)
177 # Return a class named `name` visible by the module `mmodule`.
178 # Visibility in modules is correctly handled.
179 # If no such a class exists, then null is returned.
180 # If more than one class exists, then an error on `anode` is displayed and null is returned.
181 # FIXME: add a way to handle class name conflict
182 fun try_get_mclass_by_name
(anode
: ANode, mmodule
: MModule, name
: String): nullable MClass
184 var classes
= model
.get_mclasses_by_name
(name
)
185 if classes
== null then
189 var res
: nullable MClass = null
190 for mclass
in classes
do
191 if not mmodule
.in_importation
<= mclass
.intro_mmodule
then continue
192 if not mmodule
.is_visible
(mclass
.intro_mmodule
, mclass
.visibility
) then continue
196 error
(anode
, "Ambigous class name '{name}'; conflict between {mclass.full_name} and {res.full_name}")
203 # Return a property named `name` on the type `mtype` visible in the module `mmodule`.
204 # Visibility in modules is correctly handled.
205 # Protected properties are returned (it is up to the caller to check and reject protected properties).
206 # If no such a property exists, then null is returned.
207 # If more than one property exists, then an error on `anode` is displayed and null is returned.
208 # FIXME: add a way to handle property name conflict
209 fun try_get_mproperty_by_name2
(anode
: ANode, mmodule
: MModule, mtype
: MType, name
: String): nullable MProperty
211 var props
= self.model
.get_mproperties_by_name
(name
)
212 if props
== null then
216 var cache
= self.try_get_mproperty_by_name2_cache
[mmodule
, mtype
, name
]
217 if cache
!= null then return cache
219 var res
: nullable MProperty = null
220 var ress
: nullable Array[MProperty] = null
221 for mprop
in props
do
222 if not mtype
.has_mproperty
(mmodule
, mprop
) then continue
223 if not mmodule
.is_visible
(mprop
.intro_mclassdef
.mmodule
, mprop
.visibility
) then continue
225 # new-factories are invisible outside of the class
226 if mprop
isa MMethod and mprop
.is_new
and (not mtype
isa MClassType or mprop
.intro_mclassdef
.mclass
!= mtype
.mclass
) then
235 # Two global properties?
236 # First, special case for init, keep the most specific ones
237 if res
isa MMethod and mprop
isa MMethod and res
.is_init
and mprop
.is_init
then
238 var restype
= res
.intro_mclassdef
.bound_mtype
239 var mproptype
= mprop
.intro_mclassdef
.bound_mtype
240 if mproptype
.is_subtype
(mmodule
, null, restype
) then
241 # found a most specific constructor, so keep it
247 # Ok, just keep all prop in the ress table
249 ress
= new Array[MProperty]
256 if ress
!= null and res
isa MMethod and res
.is_init
then
257 # special case forinit again
258 var restype
= res
.intro_mclassdef
.bound_mtype
259 var ress2
= new Array[MProperty]
261 var mproptype
= mprop
.intro_mclassdef
.bound_mtype
262 if not restype
.is_subtype
(mmodule
, null, mproptype
) then
264 else if not mprop
isa MMethod or not mprop
.is_init
then
268 if ress2
.is_empty
then
277 assert ress
.length
> 1
278 var s
= new Array[String]
279 for mprop
in ress
do s
.add mprop
.full_name
280 self.error
(anode
, "Ambigous property name '{name}' for {mtype}; conflict between {s.join(" and ")}")
283 self.try_get_mproperty_by_name2_cache
[mmodule
, mtype
, name
] = res
287 private var try_get_mproperty_by_name2_cache
= new HashMap3[MModule, MType, String, nullable MProperty]
290 # Alias for try_get_mproperty_by_name2(anode, mclassdef.mmodule, mclassdef.mtype, name)
291 fun try_get_mproperty_by_name
(anode
: ANode, mclassdef
: MClassDef, name
: String): nullable MProperty
293 return try_get_mproperty_by_name2
(anode
, mclassdef
.mmodule
, mclassdef
.bound_mtype
, name
)
296 # The list of directories to search for top level modules
297 # The list is initially set with :
298 # * the toolcontext --path option
299 # * the NIT_PATH environment variable
300 # * `toolcontext.nit_dir`
301 # Path can be added (or removed) by the client
302 var paths
= new Array[String]
304 # Like (an used by) `get_mmodule_by_name` but just return the ModulePath
305 private fun search_mmodule_by_name
(anode
: ANode, mgroup
: nullable MGroup, name
: String): nullable ModulePath
307 # First, look in groups
310 var dirname
= c
.filepath
311 if dirname
== null then break # virtual group
312 if dirname
.has_suffix
(".nit") then break # singleton project
314 # Second, try the directory to find a file
315 var try_file
= dirname
+ "/" + name
+ ".nit"
316 if try_file
.file_exists
then
317 var res
= self.identify_file
(try_file
.simplify_path
)
322 # Third, try if the requested module is itself a group
323 try_file
= dirname
+ "/" + name
+ "/" + name
+ ".nit"
324 if try_file
.file_exists
then
325 var res
= self.identify_file
(try_file
.simplify_path
)
333 # Look at some known directories
334 var lookpaths
= self.paths
336 # Look in the directory of the group project also (even if not explicitely in the path)
337 if mgroup
!= null then
338 # path of the root group
339 var dirname
= mgroup
.mproject
.root
.filepath
340 if dirname
!= null then
341 dirname
= dirname
.join_path
("..").simplify_path
342 if not lookpaths
.has
(dirname
) and dirname
.file_exists
then
343 lookpaths
= lookpaths
.to_a
344 lookpaths
.add
(dirname
)
349 var candidate
= search_module_in_paths
(anode
.hot_location
, name
, lookpaths
)
351 if candidate
== null then
352 if mgroup
!= null then
353 error
(anode
, "Error: cannot find module {name} from {mgroup.name}. tried {lookpaths.join(", ")}")
355 error
(anode
, "Error: cannot find module {name}. tried {lookpaths.join(", ")}")
362 # Get a module by its short name; if required, the module is loaded, parsed and its hierarchies computed.
363 # If `mgroup` is set, then the module search starts from it up to the top level (see `paths`);
364 # if `mgroup` is null then the module is searched in the top level only.
365 # If no module exists or there is a name conflict, then an error on `anode` is displayed and null is returned.
366 fun get_mmodule_by_name
(anode
: ANode, mgroup
: nullable MGroup, name
: String): nullable MModule
368 var path
= search_mmodule_by_name
(anode
, mgroup
, name
)
369 if path
== null then return null # Forward error
370 var res
= self.load_module
(path
.filepath
)
371 if res
== null then return null # Forward error
372 return res
.mmodule
.as(not null)
375 # Search a module `name` from path `lookpaths`.
376 # If found, the path of the file is returned
377 private fun search_module_in_paths
(location
: nullable Location, name
: String, lookpaths
: Collection[String]): nullable ModulePath
379 var candidate
: nullable String = null
380 for dirname
in lookpaths
do
381 var try_file
= (dirname
+ "/" + name
+ ".nit").simplify_path
382 if try_file
.file_exists
then
383 if candidate
== null then
385 else if candidate
!= try_file
then
386 # try to disambiguate conflicting modules
387 var abs_candidate
= module_absolute_path
(candidate
)
388 var abs_try_file
= module_absolute_path
(try_file
)
389 if abs_candidate
!= abs_try_file
then
390 toolcontext
.error
(location
, "Error: conflicting module file for {name}: {candidate} {try_file}")
394 try_file
= (dirname
+ "/" + name
+ "/" + name
+ ".nit").simplify_path
395 if try_file
.file_exists
then
396 if candidate
== null then
398 else if candidate
!= try_file
then
399 # try to disambiguate conflicting modules
400 var abs_candidate
= module_absolute_path
(candidate
)
401 var abs_try_file
= module_absolute_path
(try_file
)
402 if abs_candidate
!= abs_try_file
then
403 toolcontext
.error
(location
, "Error: conflicting module file for {name}: {candidate} {try_file}")
408 if candidate
== null then return null
409 return identify_file
(candidate
)
412 # cache for `identify_file` by realpath
413 private var identified_files
= new HashMap[String, nullable ModulePath]
415 # Identify a source file
416 # Load the associated project and groups if required
417 private fun identify_file
(path
: String): nullable ModulePath
419 # special case for not a nit file
420 if path
.file_extension
!= "nit" then
421 # search in known -I paths
422 var res
= search_module_in_paths
(null, path
, self.paths
)
423 if res
!= null then return res
425 # Found nothins? maybe it is a group...
427 if path
.file_exists
then
428 var mgroup
= get_mgroup
(path
)
429 if mgroup
!= null then
430 var owner_path
= mgroup
.filepath
.join_path
(mgroup
.name
+ ".nit")
431 if owner_path
.file_exists
then candidate
= owner_path
435 if candidate
== null then
436 toolcontext
.error
(null, "Error: cannot find module `{path}`.")
442 # Fast track, the path is already known
443 var pn
= path
.basename
(".nit")
444 var rp
= module_absolute_path
(path
)
445 if identified_files
.has_key
(rp
) then return identified_files
[rp
]
448 var mgrouppath
= path
.join_path
("..").simplify_path
449 var mgroup
= get_mgroup
(mgrouppath
)
451 if mgroup
== null then
453 var mproject
= new MProject(pn
, model
)
454 mgroup
= new MGroup(pn
, mproject
, null) # same name for the root group
455 mgroup
.filepath
= path
456 mproject
.root
= mgroup
457 toolcontext
.info
("found project `{pn}` at {path}", 2)
460 var res
= new ModulePath(pn
, path
, mgroup
)
461 mgroup
.module_paths
.add
(res
)
463 identified_files
[rp
] = res
468 private var mgroups
= new HashMap[String, nullable MGroup]
470 # return the mgroup associated to a directory path
471 # if the directory is not a group null is returned
472 private fun get_mgroup
(dirpath
: String): nullable MGroup
474 var rdp
= module_absolute_path
(dirpath
)
475 if mgroups
.has_key
(rdp
) then
479 # Hack, a group is determined by:
480 # * the presence of a honomymous nit file
481 # * the fact that the directory is named `src`
482 var pn
= rdp
.basename
(".nit")
483 var mp
= dirpath
.join_path
(pn
+ ".nit").simplify_path
485 var dirpath2
= dirpath
486 if not mp
.file_exists
then
488 # With a src directory, the group name is the name of the parent directory
489 dirpath2
= rdp
.dirname
490 pn
= dirpath2
.basename
("")
496 # check parent directory
497 var parentpath
= dirpath
.join_path
("..").simplify_path
498 var parent
= get_mgroup
(parentpath
)
501 if parent
== null then
502 # no parent, thus new project
503 var mproject
= new MProject(pn
, model
)
504 mgroup
= new MGroup(pn
, mproject
, null) # same name for the root group
505 mproject
.root
= mgroup
506 toolcontext
.info
("found project `{mproject}` at {dirpath}", 2)
508 mgroup
= new MGroup(pn
, parent
.mproject
, parent
)
509 toolcontext
.info
("found sub group `{mgroup.full_name}` at {dirpath}", 2)
511 var readme
= dirpath2
.join_path
("README.md")
512 if not readme
.file_exists
then readme
= dirpath2
.join_path
("README")
513 if readme
.file_exists
then
515 var s
= new IFStream.open
(readme
)
517 mdoc
.content
.add
(s
.read_line
)
520 mdoc
.original_mentity
= mgroup
522 mgroup
.filepath
= dirpath
523 mgroups
[rdp
] = mgroup
527 # Transform relative paths (starting with '../') into absolute paths
528 private fun module_absolute_path
(path
: String): String do
529 return getcwd
.join_path
(path
).simplify_path
532 # Try to load a module AST using a path.
533 # Display an error if there is a problem (IO / lexer / parser) and return null
534 fun load_module_ast
(filename
: String): nullable AModule
536 if filename
.file_extension
!= "nit" then
537 self.toolcontext
.error
(null, "Error: file {filename} is not a valid nit module.")
540 if not filename
.file_exists
then
541 self.toolcontext
.error
(null, "Error: file {filename} not found.")
545 self.toolcontext
.info
("load module {filename}", 2)
548 var file
= new IFStream.open
(filename
)
549 var lexer
= new Lexer(new SourceFile(filename
, file
))
550 var parser
= new Parser(lexer
)
551 var tree
= parser
.parse
554 # Handle lexer and parser error
555 var nmodule
= tree
.n_base
556 if nmodule
== null then
557 var neof
= tree
.n_eof
558 assert neof
isa AError
559 error
(neof
, neof
.message
)
566 # Try to load a module and its imported modules using a path.
567 # Display an error if there is a problem (IO / lexer / parser / importation) and return null
568 # Note: usually, you do not need this method, use `get_mmodule_by_name` instead.
569 fun load_module
(filename
: String): nullable AModule
571 # Look for the module
572 var file
= identify_file
(filename
)
573 if file
== null then return null # forward error
575 # Already known and loaded? then return it
576 var mmodule
= file
.mmodule
577 if mmodule
!= null then
578 return mmodule2nmodule
[mmodule
]
582 var nmodule
= load_module_ast
(file
.filepath
)
583 if nmodule
== null then return null # forward error
585 # build the mmodule and load imported modules
586 mmodule
= build_a_mmodule
(file
.mgroup
, file
.name
, nmodule
)
588 if mmodule
== null then return null # forward error
590 # Update the file information
591 file
.mmodule
= mmodule
593 # Load imported module
594 build_module_importation
(nmodule
)
599 # Injection of a new module without source.
600 # Used by the interpreted
601 fun load_rt_module
(parent
: nullable MModule, nmodule
: AModule, mod_name
: String): nullable AModule
606 if parent
!= null then mgroup
= parent
.mgroup
607 var mmodule
= new MModule(model
, mgroup
, mod_name
, nmodule
.location
)
608 nmodule
.mmodule
= mmodule
609 nmodules
.add
(nmodule
)
610 self.mmodule2nmodule
[mmodule
] = nmodule
612 if parent
!= null then
613 var imported_modules
= new Array[MModule]
614 imported_modules
.add
(parent
)
615 mmodule
.set_visibility_for
(parent
, intrude_visibility
)
616 mmodule
.set_imported_mmodules
(imported_modules
)
618 build_module_importation
(nmodule
)
624 # Visit the AST and create the `MModule` object
625 private fun build_a_mmodule
(mgroup
: nullable MGroup, mod_name
: String, nmodule
: AModule): nullable MModule
627 # Check the module name
628 var decl
= nmodule
.n_moduledecl
630 #warning(nmodule, "Warning: Missing 'module' keyword") #FIXME: NOT YET FOR COMPATIBILITY
632 var decl_name
= decl
.n_name
.n_id
.text
633 if decl_name
!= mod_name
then
634 error
(decl
.n_name
, "Error: module name missmatch; declared {decl_name} file named {mod_name}")
639 var mmodule
= new MModule(model
, mgroup
, mod_name
, nmodule
.location
)
640 nmodule
.mmodule
= mmodule
641 nmodules
.add
(nmodule
)
642 self.mmodule2nmodule
[mmodule
] = nmodule
645 var ndoc
= decl
.n_doc
647 var mdoc
= ndoc
.to_mdoc
649 mdoc
.original_mentity
= mmodule
651 advice
(decl
, "missing-doc", "Documentation warning: Undocumented module `{mmodule}`")
658 # Analysis the module importation and fill the module_importation_hierarchy
659 private fun build_module_importation
(nmodule
: AModule)
661 if nmodule
.is_importation_done
then return
662 nmodule
.is_importation_done
= true
663 var mmodule
= nmodule
.mmodule
.as(not null)
665 var imported_modules
= new Array[MModule]
666 for aimport
in nmodule
.n_imports
do
668 if not aimport
isa AStdImport then
671 var mgroup
= mmodule
.mgroup
672 if aimport
.n_name
.n_quad
!= null then mgroup
= null # Start from top level
673 for grp
in aimport
.n_name
.n_path
do
674 var path
= search_mmodule_by_name
(grp
, mgroup
, grp
.text
)
675 if path
== null then return # Skip error
678 var mod_name
= aimport
.n_name
.n_id
.text
679 var sup
= self.get_mmodule_by_name
(aimport
.n_name
, mgroup
, mod_name
)
680 if sup
== null then continue # Skip error
681 aimport
.mmodule
= sup
682 imported_modules
.add
(sup
)
683 var mvisibility
= aimport
.n_visibility
.mvisibility
684 if mvisibility
== protected_visibility
then
685 error
(aimport
.n_visibility
, "Error: only properties can be protected.")
688 if sup
== mmodule
then
689 error
(aimport
.n_name
, "Error: Dependency loop in module {mmodule}.")
691 if sup
.in_importation
< mmodule
then
692 error
(aimport
.n_name
, "Error: Dependency loop between modules {mmodule} and {sup}.")
695 mmodule
.set_visibility_for
(sup
, mvisibility
)
698 var mod_name
= "standard"
699 var sup
= self.get_mmodule_by_name
(nmodule
, null, mod_name
)
700 if sup
!= null then # Skip error
701 imported_modules
.add
(sup
)
702 mmodule
.set_visibility_for
(sup
, public_visibility
)
705 self.toolcontext
.info
("{mmodule} imports {imported_modules.join(", ")}", 3)
706 mmodule
.set_imported_mmodules
(imported_modules
)
708 # Force standard to be public if imported
709 for sup
in mmodule
.in_importation
.greaters
do
710 if sup
.name
== "standard" then
711 mmodule
.set_visibility_for
(sup
, public_visibility
)
715 # TODO: Correctly check for useless importation
717 var directs
= mmodule
.in_importation
.direct_greaters
718 for nim
in nmodule
.n_imports
do
719 if not nim
isa AStdImport then continue
721 if im
== null then continue
722 if directs
.has
(im
) then continue
723 # This generates so much noise that it is simpler to just comment it
724 #warning(nim, "Warning: possible useless importation of {im}")
728 # All the loaded modules
729 var nmodules
= new Array[AModule]
731 # Register the nmodule associated to each mmodule
732 # FIXME: why not refine the `MModule` class with a nullable attribute?
733 var mmodule2nmodule
= new HashMap[MModule, AModule]
735 # Helper function to display an error on a node.
736 # Alias for `self.toolcontext.error(n.hot_location, text)`
737 fun error
(n
: ANode, text
: String)
739 self.toolcontext
.error
(n
.hot_location
, text
)
742 # Helper function to display a warning on a node.
743 # Alias for: `self.toolcontext.warning(n.hot_location, text)`
744 fun warning
(n
: ANode, tag
, text
: String)
746 self.toolcontext
.warning
(n
.hot_location
, tag
, text
)
749 # Helper function to display an advice on a node.
750 # Alias for: `self.toolcontext.advice(n.hot_location, text)`
751 fun advice
(n
: ANode, tag
, text
: String)
753 self.toolcontext
.advice
(n
.hot_location
, tag
, text
)
756 # Force to get the primitive method named `name` on the type `recv` or do a fatal error on `n`
757 fun force_get_primitive_method
(n
: nullable ANode, name
: String, recv
: MClass, mmodule
: MModule): MMethod
759 var res
= mmodule
.try_get_primitive_method
(name
, recv
)
762 if n
!= null then l
= n
.hot_location
763 self.toolcontext
.fatal_error
(l
, "Fatal Error: {recv} must have a property named {name}.")
770 # placeholder to a module file identified but not always loaded in a project
771 private class ModulePath
772 # The name of the module
773 # (it's the basename of the filepath)
776 # The human path of the module
779 # The group (and the project) of the possible module
782 # The loaded module (if any)
783 var mmodule
: nullable MModule = null
785 redef fun to_s
do return filepath
789 # modules paths associated with the group
790 private var module_paths
= new Array[ModulePath]
793 redef class AStdImport
794 # The imported module once determined
795 var mmodule
: nullable MModule = null
799 # The associated MModule once build by a `ModelBuilder`
800 var mmodule
: nullable MModule
801 # Flag that indicate if the importation is already completed
802 var is_importation_done
: Bool = false
805 redef class AVisibility
806 # The visibility level associated with the AST node class
807 fun mvisibility
: MVisibility is abstract
809 redef class AIntrudeVisibility
810 redef fun mvisibility
do return intrude_visibility
812 redef class APublicVisibility
813 redef fun mvisibility
do return public_visibility
815 redef class AProtectedVisibility
816 redef fun mvisibility
do return protected_visibility
818 redef class APrivateVisibility
819 redef fun mvisibility
do return private_visibility
823 private var mdoc_cache
: nullable MDoc
827 if res
!= null then return res
829 for c
in n_comment
do
831 if text
.length
< 2 then
835 assert text
.chars
[0] == '#'
836 if text
.chars
[1] == ' ' then
837 text
= text
.substring_from
(2) # eat starting `#` and space
839 text
= text
.substring_from
(1) # eat atarting `#` only
841 if text
.chars
.last
== '\n' then text
= text
.substring
(0, text
.length-1
) # drop \n
842 res
.content
.add
(text
)