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 # Run `process_mainmodule` on all phases
57 fun run_global_phases
(mmodules
: Array[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
, new Location(mmodules
.first
.location
.file
, 0, 0, 0, 0))
66 mainmodule
.is_fictive
= true
67 mainmodule
.set_imported_mmodules
(mmodules
)
69 for phase
in phases_list
do
70 if phase
.disabled
then continue
71 phase
.process_mainmodule
(mainmodule
, mmodules
)
77 # Specific action to execute on the whole program.
78 # Called by the `ToolContext::run_global_phases`.
80 # `mainmodule` is the main module of the program.
81 # It could be an implicit module (called like the first given_mmodules).
83 # `given_modules` is the list of explicitely requested modules.
84 # from the command-line for instance.
86 # REQUIRE: `not given_modules.is_empty`
87 # REQUIRE: `(given_modules.length == 1) == (mainmodule == given_modules.first)`
90 fun process_mainmodule
(mainmodule
: MModule, given_mmodules
: SequenceRead[MModule]) do end
94 # A model builder knows how to load nit source files and build the associated model
96 # The model where new modules, classes and properties are added
99 # The toolcontext used to control the interaction with the user (getting options and displaying messages)
100 var toolcontext
: ToolContext
102 # Run phases on all loaded modules
105 var mmodules
= model
.mmodules
.to_a
106 model
.mmodule_importation_hierarchy
.sort
(mmodules
)
107 var nmodules
= new Array[AModule]
108 for mm
in mmodules
do
109 nmodules
.add
(mmodule2nmodule
[mm
])
111 toolcontext
.run_phases
(nmodules
)
113 if toolcontext
.opt_only_metamodel
.value
then
114 self.toolcontext
.info
("*** ONLY METAMODEL", 1)
119 # Instantiate a modelbuilder for a model and a toolcontext
120 # Important, the options of the toolcontext must be correctly set (parse_option already called)
121 init(model
: Model, toolcontext
: ToolContext)
124 self.toolcontext
= toolcontext
125 assert toolcontext
.modelbuilder_real
== null
126 toolcontext
.modelbuilder_real
= self
128 # Setup the paths value
129 paths
.append
(toolcontext
.opt_path
.value
)
131 var path_env
= "NIT_PATH".environ
132 if not path_env
.is_empty
then
133 paths
.append
(path_env
.split_with
(':'))
136 var nit_dir
= toolcontext
.nit_dir
137 if nit_dir
!= null then
138 var libname
= "{nit_dir}/lib"
139 if libname
.file_exists
then paths
.add
(libname
)
143 # Load a bunch of modules.
144 # `modules` can contains filenames or module names.
145 # Imported modules are automatically loaded and modelized.
146 # The result is the corresponding model elements.
147 # Errors and warnings are printed with the toolcontext.
149 # Note: class and property model element are not analysed.
150 fun parse
(modules
: Sequence[String]): Array[MModule]
153 # Parse and recursively load
154 self.toolcontext
.info
("*** PARSE ***", 1)
155 var mmodules
= new ArraySet[MModule]
157 var nmodule
= self.load_module
(a
)
158 if nmodule
== null then continue # Skip error
159 mmodules
.add
(nmodule
.mmodule
.as(not null))
162 self.toolcontext
.info
("*** END PARSE: {time1-time0} ***", 2)
164 self.toolcontext
.check_errors
166 if toolcontext
.opt_only_parse
.value
then
167 self.toolcontext
.info
("*** ONLY PARSE...", 1)
174 # Return a class named `name` visible by the module `mmodule`.
175 # Visibility in modules is correctly handled.
176 # If no such a class exists, then null is returned.
177 # If more than one class exists, then an error on `anode` is displayed and null is returned.
178 # FIXME: add a way to handle class name conflict
179 fun try_get_mclass_by_name
(anode
: ANode, mmodule
: MModule, name
: String): nullable MClass
181 var classes
= model
.get_mclasses_by_name
(name
)
182 if classes
== null then
186 var res
: nullable MClass = null
187 for mclass
in classes
do
188 if not mmodule
.in_importation
<= mclass
.intro_mmodule
then continue
189 if not mmodule
.is_visible
(mclass
.intro_mmodule
, mclass
.visibility
) then continue
193 error
(anode
, "Ambigous class name '{name}'; conflict between {mclass.full_name} and {res.full_name}")
200 # Return a property named `name` on the type `mtype` visible in the module `mmodule`.
201 # Visibility in modules is correctly handled.
202 # Protected properties are returned (it is up to the caller to check and reject protected properties).
203 # If no such a property exists, then null is returned.
204 # If more than one property exists, then an error on `anode` is displayed and null is returned.
205 # FIXME: add a way to handle property name conflict
206 fun try_get_mproperty_by_name2
(anode
: ANode, mmodule
: MModule, mtype
: MType, name
: String): nullable MProperty
208 var props
= self.model
.get_mproperties_by_name
(name
)
209 if props
== null then
213 var cache
= self.try_get_mproperty_by_name2_cache
[mmodule
, mtype
, name
]
214 if cache
!= null then return cache
216 var res
: nullable MProperty = null
217 var ress
: nullable Array[MProperty] = null
218 for mprop
in props
do
219 if not mtype
.has_mproperty
(mmodule
, mprop
) then continue
220 if not mmodule
.is_visible
(mprop
.intro_mclassdef
.mmodule
, mprop
.visibility
) then continue
226 # Two global properties?
227 # First, special case for init, keep the most specific ones
228 if res
isa MMethod and mprop
isa MMethod and res
.is_init
and mprop
.is_init
then
229 var restype
= res
.intro_mclassdef
.bound_mtype
230 var mproptype
= mprop
.intro_mclassdef
.bound_mtype
231 if mproptype
.is_subtype
(mmodule
, null, restype
) then
232 # found a most specific constructor, so keep it
238 # Ok, just keep all prop in the ress table
240 ress
= new Array[MProperty]
247 if ress
!= null and res
isa MMethod and res
.is_init
then
248 # special case forinit again
249 var restype
= res
.intro_mclassdef
.bound_mtype
250 var ress2
= new Array[MProperty]
252 var mproptype
= mprop
.intro_mclassdef
.bound_mtype
253 if not restype
.is_subtype
(mmodule
, null, mproptype
) then
255 else if not mprop
isa MMethod or not mprop
.is_init
then
259 if ress2
.is_empty
then
268 assert ress
.length
> 1
269 var s
= new Array[String]
270 for mprop
in ress
do s
.add mprop
.full_name
271 self.error
(anode
, "Ambigous property name '{name}' for {mtype}; conflict between {s.join(" and ")}")
274 self.try_get_mproperty_by_name2_cache
[mmodule
, mtype
, name
] = res
278 private var try_get_mproperty_by_name2_cache
= new HashMap3[MModule, MType, String, nullable MProperty]
281 # Alias for try_get_mproperty_by_name2(anode, mclassdef.mmodule, mclassdef.mtype, name)
282 fun try_get_mproperty_by_name
(anode
: ANode, mclassdef
: MClassDef, name
: String): nullable MProperty
284 return try_get_mproperty_by_name2
(anode
, mclassdef
.mmodule
, mclassdef
.bound_mtype
, name
)
287 # The list of directories to search for top level modules
288 # The list is initially set with :
289 # * the toolcontext --path option
290 # * the NIT_PATH environment variable
291 # * `toolcontext.nit_dir`
292 # Path can be added (or removed) by the client
293 var paths
= new Array[String]
295 # Like (an used by) `get_mmodule_by_name` but just return the ModulePath
296 private fun search_mmodule_by_name
(anode
: ANode, mgroup
: nullable MGroup, name
: String): nullable ModulePath
298 # First, look in groups
301 var dirname
= c
.filepath
302 if dirname
== null then break # virtual group
303 if dirname
.has_suffix
(".nit") then break # singleton project
305 # Second, try the directory to find a file
306 var try_file
= dirname
+ "/" + name
+ ".nit"
307 if try_file
.file_exists
then
308 var res
= self.identify_file
(try_file
.simplify_path
)
313 # Third, try if the requested module is itself a group
314 try_file
= dirname
+ "/" + name
+ "/" + name
+ ".nit"
315 if try_file
.file_exists
then
316 var res
= self.identify_file
(try_file
.simplify_path
)
324 # Look at some known directories
325 var lookpaths
= self.paths
327 # Look in the directory of the group project also (even if not explicitely in the path)
328 if mgroup
!= null then
329 # path of the root group
330 var dirname
= mgroup
.mproject
.root
.filepath
331 if dirname
!= null then
332 dirname
= dirname
.join_path
("..").simplify_path
333 if not lookpaths
.has
(dirname
) and dirname
.file_exists
then
334 lookpaths
= lookpaths
.to_a
335 lookpaths
.add
(dirname
)
340 var candidate
= search_module_in_paths
(anode
.hot_location
, name
, lookpaths
)
342 if candidate
== null then
343 if mgroup
!= null then
344 error
(anode
, "Error: cannot find module {name} from {mgroup.name}. tried {lookpaths.join(", ")}")
346 error
(anode
, "Error: cannot find module {name}. tried {lookpaths.join(", ")}")
353 # Get a module by its short name; if required, the module is loaded, parsed and its hierarchies computed.
354 # If `mgroup` is set, then the module search starts from it up to the top level (see `paths`);
355 # if `mgroup` is null then the module is searched in the top level only.
356 # If no module exists or there is a name conflict, then an error on `anode` is displayed and null is returned.
357 fun get_mmodule_by_name
(anode
: ANode, mgroup
: nullable MGroup, name
: String): nullable MModule
359 var path
= search_mmodule_by_name
(anode
, mgroup
, name
)
360 if path
== null then return null # Forward error
361 var res
= self.load_module
(path
.filepath
)
362 if res
== null then return null # Forward error
363 return res
.mmodule
.as(not null)
366 # Search a module `name` from path `lookpaths`.
367 # If found, the path of the file is returned
368 private fun search_module_in_paths
(location
: nullable Location, name
: String, lookpaths
: Collection[String]): nullable ModulePath
370 var candidate
: nullable String = null
371 for dirname
in lookpaths
do
372 var try_file
= (dirname
+ "/" + name
+ ".nit").simplify_path
373 if try_file
.file_exists
then
374 if candidate
== null then
376 else if candidate
!= try_file
then
377 # try to disambiguate conflicting modules
378 var abs_candidate
= module_absolute_path
(candidate
)
379 var abs_try_file
= module_absolute_path
(try_file
)
380 if abs_candidate
!= abs_try_file
then
381 toolcontext
.error
(location
, "Error: conflicting module file for {name}: {candidate} {try_file}")
385 try_file
= (dirname
+ "/" + name
+ "/" + name
+ ".nit").simplify_path
386 if try_file
.file_exists
then
387 if candidate
== null then
389 else if candidate
!= try_file
then
390 # try to disambiguate conflicting modules
391 var abs_candidate
= module_absolute_path
(candidate
)
392 var abs_try_file
= module_absolute_path
(try_file
)
393 if abs_candidate
!= abs_try_file
then
394 toolcontext
.error
(location
, "Error: conflicting module file for {name}: {candidate} {try_file}")
399 if candidate
== null then return null
400 return identify_file
(candidate
)
403 # cache for `identify_file` by realpath
404 private var identified_files
= new HashMap[String, nullable ModulePath]
406 # Identify a source file
407 # Load the associated project and groups if required
408 private fun identify_file
(path
: String): nullable ModulePath
410 # special case for not a nit file
411 if path
.file_extension
!= "nit" then
412 # search in known -I paths
413 var res
= search_module_in_paths
(null, path
, self.paths
)
414 if res
!= null then return res
416 # Found nothins? maybe it is a group...
418 if path
.file_exists
then
419 var mgroup
= get_mgroup
(path
)
420 if mgroup
!= null then
421 var owner_path
= mgroup
.filepath
.join_path
(mgroup
.name
+ ".nit")
422 if owner_path
.file_exists
then candidate
= owner_path
426 if candidate
== null then
427 toolcontext
.error
(null, "Error: cannot find module `{path}`.")
433 # Fast track, the path is already known
434 var pn
= path
.basename
(".nit")
435 var rp
= module_absolute_path
(path
)
436 if identified_files
.has_key
(rp
) then return identified_files
[rp
]
439 var mgrouppath
= path
.join_path
("..").simplify_path
440 var mgroup
= get_mgroup
(mgrouppath
)
442 if mgroup
== null then
444 var mproject
= new MProject(pn
, model
)
445 mgroup
= new MGroup(pn
, mproject
, null) # same name for the root group
446 mgroup
.filepath
= path
447 mproject
.root
= mgroup
448 toolcontext
.info
("found project `{pn}` at {path}", 2)
451 var res
= new ModulePath(pn
, path
, mgroup
)
452 mgroup
.module_paths
.add
(res
)
454 identified_files
[rp
] = res
459 private var mgroups
= new HashMap[String, nullable MGroup]
461 # return the mgroup associated to a directory path
462 # if the directory is not a group null is returned
463 private fun get_mgroup
(dirpath
: String): nullable MGroup
465 var rdp
= module_absolute_path
(dirpath
)
466 if mgroups
.has_key
(rdp
) then
470 # Hack, a group is determined by:
471 # * the presence of a honomymous nit file
472 # * the fact that the directory is named `src`
473 var pn
= rdp
.basename
(".nit")
474 var mp
= dirpath
.join_path
(pn
+ ".nit").simplify_path
476 var dirpath2
= dirpath
477 if not mp
.file_exists
then
479 # With a src directory, the group name is the name of the parent directory
480 dirpath2
= rdp
.dirname
481 pn
= dirpath2
.basename
("")
487 # check parent directory
488 var parentpath
= dirpath
.join_path
("..").simplify_path
489 var parent
= get_mgroup
(parentpath
)
492 if parent
== null then
493 # no parent, thus new project
494 var mproject
= new MProject(pn
, model
)
495 mgroup
= new MGroup(pn
, mproject
, null) # same name for the root group
496 mproject
.root
= mgroup
497 toolcontext
.info
("found project `{mproject}` at {dirpath}", 2)
499 mgroup
= new MGroup(pn
, parent
.mproject
, parent
)
500 toolcontext
.info
("found sub group `{mgroup.full_name}` at {dirpath}", 2)
502 var readme
= dirpath2
.join_path
("README.md")
503 if not readme
.file_exists
then readme
= dirpath2
.join_path
("README")
504 if readme
.file_exists
then
506 var s
= new IFStream.open
(readme
)
508 mdoc
.content
.add
(s
.read_line
)
511 mdoc
.original_mentity
= mgroup
513 mgroup
.filepath
= dirpath
514 mgroups
[rdp
] = mgroup
518 # Transform relative paths (starting with '../') into absolute paths
519 private fun module_absolute_path
(path
: String): String do
520 return getcwd
.join_path
(path
).simplify_path
523 # Try to load a module AST using a path.
524 # Display an error if there is a problem (IO / lexer / parser) and return null
525 fun load_module_ast
(filename
: String): nullable AModule
527 if filename
.file_extension
!= "nit" then
528 self.toolcontext
.error
(null, "Error: file {filename} is not a valid nit module.")
531 if not filename
.file_exists
then
532 self.toolcontext
.error
(null, "Error: file {filename} not found.")
536 self.toolcontext
.info
("load module {filename}", 2)
539 var file
= new IFStream.open
(filename
)
540 var lexer
= new Lexer(new SourceFile(filename
, file
))
541 var parser
= new Parser(lexer
)
542 var tree
= parser
.parse
545 # Handle lexer and parser error
546 var nmodule
= tree
.n_base
547 if nmodule
== null then
548 var neof
= tree
.n_eof
549 assert neof
isa AError
550 error
(neof
, neof
.message
)
557 # Try to load a module and its imported modules using a path.
558 # Display an error if there is a problem (IO / lexer / parser / importation) and return null
559 # Note: usually, you do not need this method, use `get_mmodule_by_name` instead.
560 fun load_module
(filename
: String): nullable AModule
562 # Look for the module
563 var file
= identify_file
(filename
)
564 if file
== null then return null # forward error
566 # Already known and loaded? then return it
567 var mmodule
= file
.mmodule
568 if mmodule
!= null then
569 return mmodule2nmodule
[mmodule
]
573 var nmodule
= load_module_ast
(file
.filepath
)
574 if nmodule
== null then return null # forward error
576 # build the mmodule and load imported modules
577 mmodule
= build_a_mmodule
(file
.mgroup
, file
.name
, nmodule
)
579 if mmodule
== null then return null # forward error
581 # Update the file information
582 file
.mmodule
= mmodule
584 # Load imported module
585 build_module_importation
(nmodule
)
590 # Injection of a new module without source.
591 # Used by the interpreted
592 fun load_rt_module
(parent
: nullable MModule, nmodule
: AModule, mod_name
: String): nullable AModule
597 if parent
!= null then mgroup
= parent
.mgroup
598 var mmodule
= new MModule(model
, mgroup
, mod_name
, nmodule
.location
)
599 nmodule
.mmodule
= mmodule
600 nmodules
.add
(nmodule
)
601 self.mmodule2nmodule
[mmodule
] = nmodule
603 if parent
!= null then
604 var imported_modules
= new Array[MModule]
605 imported_modules
.add
(parent
)
606 mmodule
.set_visibility_for
(parent
, intrude_visibility
)
607 mmodule
.set_imported_mmodules
(imported_modules
)
609 build_module_importation
(nmodule
)
615 # Visit the AST and create the `MModule` object
616 private fun build_a_mmodule
(mgroup
: nullable MGroup, mod_name
: String, nmodule
: AModule): nullable MModule
618 # Check the module name
619 var decl
= nmodule
.n_moduledecl
621 #warning(nmodule, "Warning: Missing 'module' keyword") #FIXME: NOT YET FOR COMPATIBILITY
623 var decl_name
= decl
.n_name
.n_id
.text
624 if decl_name
!= mod_name
then
625 error
(decl
.n_name
, "Error: module name missmatch; declared {decl_name} file named {mod_name}")
630 var mmodule
= new MModule(model
, mgroup
, mod_name
, nmodule
.location
)
631 nmodule
.mmodule
= mmodule
632 nmodules
.add
(nmodule
)
633 self.mmodule2nmodule
[mmodule
] = nmodule
636 var ndoc
= decl
.n_doc
638 var mdoc
= ndoc
.to_mdoc
640 mdoc
.original_mentity
= mmodule
642 advice
(decl
, "missing-doc", "Documentation warning: Undocumented module `{mmodule}`")
649 # Analysis the module importation and fill the module_importation_hierarchy
650 private fun build_module_importation
(nmodule
: AModule)
652 if nmodule
.is_importation_done
then return
653 nmodule
.is_importation_done
= true
654 var mmodule
= nmodule
.mmodule
.as(not null)
656 var imported_modules
= new Array[MModule]
657 for aimport
in nmodule
.n_imports
do
659 if not aimport
isa AStdImport then
662 var mgroup
= mmodule
.mgroup
663 if aimport
.n_name
.n_quad
!= null then mgroup
= null # Start from top level
664 for grp
in aimport
.n_name
.n_path
do
665 var path
= search_mmodule_by_name
(grp
, mgroup
, grp
.text
)
666 if path
== null then return # Skip error
669 var mod_name
= aimport
.n_name
.n_id
.text
670 var sup
= self.get_mmodule_by_name
(aimport
.n_name
, mgroup
, mod_name
)
671 if sup
== null then continue # Skip error
672 aimport
.mmodule
= sup
673 imported_modules
.add
(sup
)
674 var mvisibility
= aimport
.n_visibility
.mvisibility
675 if mvisibility
== protected_visibility
then
676 error
(aimport
.n_visibility
, "Error: only properties can be protected.")
679 if sup
== mmodule
then
680 error
(aimport
.n_name
, "Error: Dependency loop in module {mmodule}.")
682 if sup
.in_importation
< mmodule
then
683 error
(aimport
.n_name
, "Error: Dependency loop between modules {mmodule} and {sup}.")
686 mmodule
.set_visibility_for
(sup
, mvisibility
)
689 var mod_name
= "standard"
690 var sup
= self.get_mmodule_by_name
(nmodule
, null, mod_name
)
691 if sup
!= null then # Skip error
692 imported_modules
.add
(sup
)
693 mmodule
.set_visibility_for
(sup
, public_visibility
)
696 self.toolcontext
.info
("{mmodule} imports {imported_modules.join(", ")}", 3)
697 mmodule
.set_imported_mmodules
(imported_modules
)
699 # TODO: Correctly check for useless importation
701 var directs
= mmodule
.in_importation
.direct_greaters
702 for nim
in nmodule
.n_imports
do
703 if not nim
isa AStdImport then continue
705 if im
== null then continue
706 if directs
.has
(im
) then continue
707 # This generates so much noise that it is simpler to just comment it
708 #warning(nim, "Warning: possible useless importation of {im}")
712 # All the loaded modules
713 var nmodules
= new Array[AModule]
715 # Register the nmodule associated to each mmodule
716 # FIXME: why not refine the `MModule` class with a nullable attribute?
717 var mmodule2nmodule
= new HashMap[MModule, AModule]
719 # Helper function to display an error on a node.
720 # Alias for `self.toolcontext.error(n.hot_location, text)`
721 fun error
(n
: ANode, text
: String)
723 self.toolcontext
.error
(n
.hot_location
, text
)
726 # Helper function to display a warning on a node.
727 # Alias for: `self.toolcontext.warning(n.hot_location, text)`
728 fun warning
(n
: ANode, tag
, text
: String)
730 self.toolcontext
.warning
(n
.hot_location
, tag
, text
)
733 # Helper function to display an advice on a node.
734 # Alias for: `self.toolcontext.advice(n.hot_location, text)`
735 fun advice
(n
: ANode, tag
, text
: String)
737 self.toolcontext
.advice
(n
.hot_location
, tag
, text
)
740 # Force to get the primitive method named `name` on the type `recv` or do a fatal error on `n`
741 fun force_get_primitive_method
(n
: ANode, name
: String, recv
: MClass, mmodule
: MModule): MMethod
743 var res
= mmodule
.try_get_primitive_method
(name
, recv
)
745 self.toolcontext
.fatal_error
(n
.hot_location
, "Fatal Error: {recv} must have a property named {name}.")
752 # placeholder to a module file identified but not always loaded in a project
753 private class ModulePath
754 # The name of the module
755 # (it's the basename of the filepath)
758 # The human path of the module
761 # The group (and the project) of the possible module
764 # The loaded module (if any)
765 var mmodule
: nullable MModule = null
767 redef fun to_s
do return filepath
771 # modules paths associated with the group
772 private var module_paths
= new Array[ModulePath]
775 redef class AStdImport
776 # The imported module once determined
777 var mmodule
: nullable MModule = null
781 # The associated MModule once build by a `ModelBuilder`
782 var mmodule
: nullable MModule
783 # Flag that indicate if the importation is already completed
784 var is_importation_done
: Bool = false
787 redef class AVisibility
788 # The visibility level associated with the AST node class
789 fun mvisibility
: MVisibility is abstract
791 redef class AIntrudeVisibility
792 redef fun mvisibility
do return intrude_visibility
794 redef class APublicVisibility
795 redef fun mvisibility
do return public_visibility
797 redef class AProtectedVisibility
798 redef fun mvisibility
do return protected_visibility
800 redef class APrivateVisibility
801 redef fun mvisibility
do return private_visibility
805 private var mdoc_cache
: nullable MDoc
809 if res
!= null then return res
811 for c
in n_comment
do
813 if text
.length
< 2 then
817 assert text
.chars
[0] == '#'
818 if text
.chars
[1] == ' ' then
819 text
= text
.substring_from
(2) # eat starting `#` and space
821 text
= text
.substring_from
(1) # eat atarting `#` only
823 if text
.chars
.last
== '\n' then text
= text
.substring
(0, text
.length-1
) # drop \n
824 res
.content
.add
(text
)