1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2008 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 # The main module of the nitdoc program
25 # Store knowledge and facilities to generate files
27 special AbstractCompiler
28 # Destination directory
29 readable writable attr _dir
: String
31 # Content of a generated file
32 attr _stage_context
: StageContext = new StageContext(null)
34 # Add a string in the content
35 meth add
(s
: String) do
36 _stage_context
.content
.add
(s
)
37 _stage_context
.validate
= true
40 # Add a string in the content iff some other string are added
41 meth stage
(s
: String) do _stage_context
.content
.add
(s
)
43 # Create a new stage in the content
44 meth open_stage
do _stage_context
= new StageContext(_stage_context
)
46 # Close the current stage in the content
49 var s
= _stage_context
.parent
50 if _stage_context
.validate
then
51 s
.content
.add_all
(_stage_context
.content
)
57 # Write the content to a new file
58 meth write_to
(filename
: String)
60 print
"Generate {filename}"
61 var f
= new OFStream.open
(filename
)
62 for s
in _stage_context
.content
do
68 # Currently computed module
69 readable attr _module
: MMSrcModule
71 # Is the current directory module computed as a simple modude ?
72 readable writable attr _inside_mode
: Bool
74 # Is the current module computed as a intruded one ?
75 readable writable attr _intrude_mode
: Bool
77 # Compued introducing entities (for the index)
78 attr _entities
: Array[MMEntity] = new Array[MMEntity]
80 # Register an entity (for the index)
81 meth register
(e
: MMEntity)
84 if e
isa MMSrcModule then
92 _stage_context
= new StageContext(null)
95 # Generate common files (frames, index, overview)
96 meth extract_other_doc
102 add
("<html><body>\n")
103 add
("<a href=\"overview
.html\
" target=\"mainFrame\
">Overview</a><br/>\n")
104 add
("<a href=\"index-1
.html\
" target=\"mainFrame\
">Index</a><br/>\n")
105 var modules
= modules
.to_a
108 var rootdirs
= new Array[MMDirectory]
111 if md
.parent
== null and not rootdirs
.has
(md
) then
116 var done
= new Array[MMModule]
117 for root
in rootdirs
do
118 var dirstack
= [root
]
120 add
("{root.name}<br/>\n")
121 var indent
= " "
122 while not dirstack
.is_empty
do
125 if done
.has
(m
) then continue
127 if md
.owner
== m
and md
.parent
== curdir
then
128 # It's a directory module
129 add
("{indent}<a href=\"{m}.html\
" target=\"mainFrame\
">{m}</a><br/>\n")
131 dirstack
.push
(curdir
)
132 indent
= "  " * dirstack
.length
134 break # restart to preserve alphabetic order
135 else if md
== curdir
then
136 if md
.owner
== m
then
137 add
("{indent}<a href=\"{m}_
.html\
" target=\"mainFrame\
">{m}</a><br/>\n")
139 add
("{indent}<a href=\"{m}.html\
" target=\"mainFrame\
">{m}</a><br/>\n")
147 if not dirstack
.is_empty
then
148 curdir
= dirstack
[dirstack
.length-1
]
149 indent
= "  " * dirstack
.length
154 add
("</body></html>\n")
155 write_to
("{dir}/menu-frame.html")
161 for e
in _entities
do
162 add
("<dt><b>{e.html_link(self)}</b> - {e.prototype_head(self)} <b>{e}</b>{e.prototype_body(self)} {e.locate(self)}<dd>{e.short_doc}\n")
164 add
("</dl></body></html>\n")
165 write_to
("{dir}/index-1.html")
168 add_header
("Overview")
169 add
("<table border=\"1\
" width=\"100%\
" cellpadding=\"3\
" cellspacing=\"0\
">\n")
170 add
("<tr bgcolor=\"#CCCCFF\"><th colspan=\"2\"><big>Overview of all Modules</big></th><tr>\n")
172 add
("<tr><td width=\"20%\
" align=\"right\
">{m.html_link(self)}</td><td>{m.short_doc}</td><tr>\n")
174 add
("</table></body></html>\n")
175 write_to
("{dir}/overview.html")
178 add
("<html>\n<frameset cols=\"20%,80%\
">\n<frame src=\"menu-frame
.html\
" name=\"menuFrame\
" title=\"Menu\
">\n<frame src=\"overview
.html\
" name=\"mainFrame\
" title=\"Main\
" scrolling=\"yes\
">\n</frameset></html>\n")
179 write_to
("{dir}/index.html")
182 meth add_header
(title
: String)
184 add
("<html><head><title>{title}</title></head>\n<body>\n")
185 add
("<table border=\"0\
" width=\"100%\
" cellpadding=\"1\
" cellspacing=\"0\
"><tr><td bgcolor=\"#eeeeff\">\n")
186 add
("<a href=\"overview
.html\
"><b>Overview</b></a> <a href=\"index-1
.html\
"><b>Index</b></a> <a href=\"index
.html\
" target=\"_top\
"><b>With Frames</b></a>\n")
187 add
("</td></tr></table>")
189 if (not inside_mode
and not intrude_mode
) or module == null then
190 add
("<b>Public</b> ")
192 add
("<a href=\"{module}.html\
"><b>Public</b></a> ")
194 if inside_mode
or module == null then
195 add
("<b>Inside</b> ")
196 else if module.directory
.owner
!= module then
197 add
("<strike><b>Inside</b></strike> ")
199 add
("<a href=\"{module}_
.html\
"><b>Inside</b></a> ")
201 if intrude_mode
or module == null then
202 add
("<b>Intrude</b> ")
204 add
("<a href=\"{module}__
.html\
"><b>Intrude</b></a> ")
209 # Sorter of entities in alphabetical order
210 attr _sorter
: AlphaSorter[MMEntity] = new AlphaSorter[MMEntity]
212 # Sort entities in the alphabetical order
213 meth sort
(array
: Array[MMEntity])
218 readable writable attr _owned_modules
: Array[MMModule]
220 # Return the known_owner for current module
221 # if inside_mode is set, it could be a different result
222 meth known_owner_of
(m
: MMModule): MMModule
224 if module == null then return m
225 var res
= module.known_owner_of
(m
)
226 if not inside_mode
and not intrude_mode
and res
.directory
.owner
== module then
233 readable attr _opt_dir
: OptionString = new OptionString("Directory where doc is generated", "-d", "--dir")
235 redef meth perform_work
(mods
)
239 for mod
in modules
do
240 assert mod
isa MMSrcModule
241 mod
.extract_module_doc
(self)
243 self.extract_other_doc
249 option_context
.add_option
(opt_dir
)
252 redef meth process_options
256 if dir
== null then dir
= "."
260 # Conditionnal part of the text content of a DocContext
262 # Content of the current stage
263 readable attr _content
: Array[String] = new Array[String]
265 # Is a normal string already added?
266 readable writable attr _validate
: Bool
268 # Parent stage is any
269 readable attr _parent
: StageContext
271 init(parent
: StageContext) do _parent
= parent
275 # Efficiently sort object with their to_s method
276 class AlphaSorter[E
: Object]
277 special AbstractSorter[E
]
278 redef meth compare
(a
, b
)
298 # Keep track of to_s values
299 attr _dico
: HashMap[Object, String] = new HashMap[Object, String]
304 # Generalization of metamodel entities
307 meth html_link
(dctx
: DocContext): String is abstract
309 # Is the entity should appear in the generaed doc
310 meth need_doc
(dctx
: DocContext): Bool is abstract
312 # Return a one liner description
313 meth short_doc
: String do return " "
315 # The doc node from the AST
316 # Return null is none
317 meth doc
: ADoc do return null
319 # Human redable location of the entity (module/class/property)
320 meth locate
(dctx
: DocContext): String do return ""
322 # Part of the prototype before the name (kind, modifiers, qualifier)
323 meth prototype_head
(dctx
: DocContext): String is abstract
325 # Part of the property after the name (signature, modifiers)
326 meth prototype_body
(dctx
: DocContext): String do return ""
331 redef meth html_link
(dctx
) do
332 if dctx
.module == self then
335 return "<a href=\"{self}.html\
">{self}</a>"
338 redef meth need_doc
(dctx
) do return true
339 redef meth prototype_head
(dctx
) do return "module "
341 attr _known_owner_of_cache
: Map[MMModule, MMModule] = new HashMap[MMModule, MMModule]
342 meth known_owner_of
(module: MMModule): MMModule
344 if _known_owner_of_cache
.has_key
(module) then return _known_owner_of_cache
[module]
346 if mhe
< module and visibility_for
(module) != 0 then
347 res
= known_owner_of_intern
(module, self, false)
349 res
= module.owner
(self)
351 _known_owner_of_cache
[module] = res
355 # Return the most general module that own self
356 meth owner
(from
: MMModule): MMModule
360 while d
!= null and d
!= from
.directory
do
362 if o
!= null and o
.mhe
<= res
then res
= o
368 private meth known_owner_of_intern
(module: MMModule, from
: MMModule, as_owner
: Bool): MMModule
370 if module == self then return self
371 var candidates
= new Array[MMModule]
372 for m
in explicit_imported_modules
do
373 if from
.visibility_for
(m
) == 0 then continue
374 if not m
.mhe
<= module then continue
375 candidates
.add
(m
.known_owner_of_intern
(module, from
, true))
377 assert not candidates
.is_empty
378 var max
= candidates
.first
379 for m
in candidates
do
380 if max
.mhe
< m
then max
= m
382 if as_owner
and max
.directory
.owner
== self then
391 redef class MMLocalProperty
393 # Anchor of the property description in the module html file
394 meth html_anchor
: String
396 return "PROP_{local_class}_{cmangle(name)}"
399 redef meth html_link
(dctx
)
402 if not need_doc
(dctx
) then m
= global
.intro
.module
403 var m
= dctx
.known_owner_of
(m
)
404 if m
== dctx
.module then
405 return "<a href=\"#{html_anchor}\">{self}</a>"
407 return "<a href=\"{m}.html
#{html_anchor}\">{self}</a>"
411 # Kind of property (meth, attr, etc.)
412 meth kind
: String is abstract
414 redef meth locate
(dctx
)
416 return "in {module.html_link(dctx)}::{local_class.html_link(dctx)}"
419 meth known_intro_class
(dctx
: DocContext): MMLocalClass
421 var mod
= dctx
.known_owner_of
(global
.intro
.local_class
.module)
422 var cla
= mod
[global
.intro
.local_class
.global
]
426 redef meth prototype_head
(dctx
)
429 var intro_class
= known_intro_class
(dctx
)
430 var is_redef
= local_class
!= intro_class
432 if is_redef
then res
.append
("redef ")
433 if global
.visibility_level
== 2 then
434 res
.append
("protected ")
435 else if global
.visibility_level
== 3 then
436 res
.append
("private ")
440 var gp
= global
.intro
441 if intro_class
.global
!= local_class
.global
then
442 res
.append
(" {module[intro_class.global].html_link(dctx)}::")
443 else if intro_class
.module != module then
444 res
.append
(" {intro_class.module.html_link(dctx)}::")
450 redef meth prototype_body
(dctx
)
452 var res
= signature
.to_html
(dctx
)
454 if s
.node
!= null then
455 if s
.node
isa ADeferredMethPropdef then
456 res
.append
(" is abstract")
457 else if s
.node
isa AInternMethPropdef then
458 res
.append
(" is intern")
464 redef meth need_doc
(dctx
)
466 if global
.visibility_level
>= 3 or self isa MMAttribute then
467 if not dctx
.intrude_mode
then return false
468 if dctx
.module.visibility_for
(module) == 0 then return false
470 if global
.intro
== self then
481 else if global
.intro
== self then
484 return global
.intro
.short_doc
491 if not node
isa PPropdef then
494 assert n
isa PPropdef
500 if d
.n_comment
.is_empty
then
508 redef meth kind
do return if global
.is_init
then "init" else "meth"
510 redef class MMAttribute
511 redef meth kind
do return "attr"
513 redef class MMTypeProperty
514 redef meth kind
do return "type"
517 redef class MMSrcModule
518 # Extract and generate html file for the module
519 meth extract_module_doc
(dctx
: DocContext)
524 extract_module_doc_inside
(dctx
)
525 dctx
.write_to
("{dctx.dir}/{name}.html")
527 dctx
.intrude_mode
= true
529 extract_module_doc_inside
(dctx
)
530 dctx
.write_to
("{dctx.dir}/{name}__.html")
531 dctx
.intrude_mode
= false
533 if directory
.owner
== self then
534 dctx
.inside_mode
= true
536 extract_module_doc_inside
(dctx
)
537 dctx
.write_to
("{dctx.dir}/{name}_.html")
538 dctx
.inside_mode
= false
542 meth extract_module_doc_inside
(dctx
: DocContext)
544 dctx
.add_header
("Module {self}")
545 dctx
.add
("<h1>Module {self}</h1>\n<dl>")
549 if d
.owner
!= null and (d
.owner
!= self or dctx
.inside_mode
or dctx
.intrude_mode
) then
550 s
= "{d.owner.html_link(dctx)}::{s}"
554 dctx
.add
("{s}<br/>{prototype_head(dctx)}<b>{self}</b>{prototype_body(dctx)}<br/>\n")
556 var strs
= new Array[String]
557 var intrude_modules
= new Array[MMModule]
558 var public_modules
= new Array[MMModule]
559 var private_modules
= new Array[MMModule]
560 var owned_modules
= new Array[MMModule]
561 dctx
.owned_modules
= owned_modules
562 for m
in mhe
.greaters
do
563 var v
= visibility_for
(m
)
564 if not dctx
.inside_mode
and not dctx
.intrude_mode
and m
.directory
.owner
== self then
565 if v
>= 2 then owned_modules
.add
(m
)
569 intrude_modules
.add
(m
)
571 public_modules
.add
(m
)
573 private_modules
.add
(m
)
576 if not intrude_modules
.is_empty
then
577 var mods
= mhe
.order
.select_smallests
(intrude_modules
)
578 for i
in mods
do strs
.add
(i
.html_link
(dctx
))
579 dctx
.add
("<dt>Intruded modules: <dd>{strs.join(", ")}\n")
581 if not public_modules
.is_empty
then
583 var mods
= mhe
.order
.select_smallests
(public_modules
)
584 for i
in mods
do strs
.add
(i
.html_link
(dctx
))
585 dctx
.add
("<dt>Imported modules: <dd>{strs.join(", ")}\n")
587 if not private_modules
.is_empty
then
589 var mods
= mhe
.order
.select_smallests
(private_modules
)
590 for i
in mods
do strs
.add
(i
.html_link
(dctx
))
591 dctx
.add
("<dt>Privatly imported modules: <dd>{strs.join(", ")}\n")
596 if doc
!= null then dctx
.add
("<pre>{doc.to_html}</pre>\n")
598 var new_classes
= new Array[MMLocalClass]
599 for c
in local_classes
do
600 if c
.need_doc
(dctx
) then
602 if c
.global
.intro
== c
then
606 for m
in owned_modules
do
608 if mc
!= null and mc
.need_doc
(dctx
) then
616 if not new_classes
.is_empty
then
617 dctx
.sort
(new_classes
)
618 dctx
.add
("<table border=\"1\
" width=\"100%\
" cellpadding=\"3\
" cellspacing=\"0\
">\n")
619 dctx
.add
("<tr bgcolor=\"#CCCCFF\"><th colspan=\"2\"><big>Class Summary of {self}</big></th><tr>\n")
620 for c
in new_classes
do
621 dctx
.add
("<tr><td width=\"20%\
" align=\"right\
">{c.prototype_head(dctx)}</td><td><b>{c.html_link(dctx)}</b>{c.prototype_body(dctx)}<br/>{c.short_doc}</td><tr>\n")
623 dctx
.add
("</table><br/>\n")
626 if not new_classes
.is_empty
then
627 dctx
.add
("<table border=\"1\
" width=\"100%\
" cellpadding=\"3\
" cellspacing=\"0\
">\n")
628 dctx
.add
("<tr bgcolor=\"#CCCCFF\"><th><big>Class Detail of {self}</big></th><tr>\n")
629 dctx
.add
("</table>\n")
631 for c
in new_classes
do
632 c
.extract_class_doc
(dctx
)
636 dctx
.add
("</body></html>\n")
652 if not n
isa AModule then
656 if n
.n_packagedecl
== null then
659 var np
= n
.n_packagedecl
660 assert np
isa APackagedecl
666 if d
.n_comment
.is_empty
then
675 # Html transcription of the doc
679 for c
in n_comment
do
680 res
.append
(c
.text
.substring_from
(1))
685 # Oneliner transcription of the doc
688 return n_comment
.first
.text
.substring_from
(1)
692 redef class MMLocalClass
694 # Anchor of the class description in the module html file
695 meth html_anchor
: String do return "CLASS_{self}"
697 redef meth html_link
(dctx
)
700 if not need_doc
(dctx
) then m
= global
.module
701 var m
= dctx
.known_owner_of
(m
)
702 if m
== dctx
.module then
703 return "<a href=\"#{html_anchor}\">{self}</a>"
705 return "<a href=\"{m}.html
#{html_anchor}\">{self}</a>"
709 redef meth short_doc
do return global
.intro
.short_doc
711 redef meth doc
do return global
.intro
.doc
713 redef meth need_doc
(dctx
) do
714 if module == dctx
.module then
715 for m
in dctx
.owned_modules
do
717 if c
!= null and c
.need_doc
(dctx
) then return true
723 redef meth locate
(dctx
) do return "in {module.html_link(dctx)}"
725 meth known_intro
(dctx
: DocContext): MMLocalClass do return dctx
.known_owner_of
(global
.intro
.module)[global
]
727 redef meth prototype_head
(dctx
)
730 var ki
= known_intro
(dctx
)
731 var is_redef
= ki
!= self
732 if is_redef
then res
.append
("redef ")
733 if global
.visibility_level
== 3 then res
.append
("private ")
735 if is_redef
then res
.append
("{ki.module.html_link(dctx)}::")
739 redef meth prototype_body
(dctx
)
744 for i
in [0..arity
[ do
745 var t
= get_formal
(i
)
746 res
.append
(t
.name
.to_s
)
748 res
.append
(t
.bound
.html_link
(dctx
))
755 # Extract the doc of a class
756 meth extract_class_doc
(dctx
: DocContext)
758 dctx
.add
("<a name=\"{html_anchor}\
"></a><h2>{self}</h2><small>{module.html_link(dctx)}::</small><br/>{prototype_head(dctx)}<b>{self}</b>{prototype_body(dctx)}\n")
759 dctx
.add
("<blockquote>\n")
762 var sup2
= new Array[String]
763 var intro_module
= dctx
.known_owner_of
(global
.module)
764 if intro_module
!= module then
765 dctx
.add
("<dt>Refine {self} from: <dd>{intro_module.html_link(dctx)}\n")
767 var mods
= new Array[MMModule]
768 for c
in crhe
.greaters
do
769 if c
.need_doc
(dctx
) then
770 var km
= dctx
.known_owner_of
(c
.module)
771 if km
!= module and km
!= intro_module
and not mods
.has
(km
) then
776 for c
in crhe
.linear_extension
do
777 if mods
.has
(c
.module) then sup2
.add
(c
.module.html_link
(dctx
))
779 if not sup2
.is_empty
then dctx
.add
("<dt>Previous refinements in: <dd>{sup2.join(", ")}\n")
781 if not cshe
.greaters
.is_empty
then
783 var clas
= new Array[MMLocalClass]
784 for c
in cshe
.direct_greaters
do
785 sup2
.add
(c
.html_link
(dctx
))
787 dctx
.add
("<dt>Direct superclasses: <dd>{sup2.join(", ")}\n")
789 for c
in cshe
.linear_extension
do
790 if c
!= self then sup2
.add
(c
.html_link
(dctx
))
792 dctx
.add
("<dt>All superclasses: <dd>{sup2.join(", ")}\n")
794 if not cshe
.direct_smallers
.is_empty
then
796 for c
in cshe
.direct_smallers
do
797 sup2
.add
(c
.html_link
(dctx
))
799 dctx
.add
("<dt>Direct subclasses: <dd>{sup2.join(", ")}\n")
802 for c
in crhe
.smallers
do
803 c
.compute_super_classes
804 for c2
in c
.module.local_classes
do
805 if not c2
isa MMConcreteClass then continue
806 c2
.compute_super_classes
808 c2
.inherit_global_properties
810 for c2
in c
.cshe
.direct_smallers
do
811 if c2
.global
.intro
== c2
then
812 sup2
.add
("{c2.html_link(dctx)}")
816 if not sup2
.is_empty
then
817 dctx
.add
("<dt>Other direct subclasses in known modules: <dd>{sup2.join(", ")}\n")
820 for c
in crhe
.order
do
821 if not module.mhe
<= c
.module and c
.need_doc
(dctx
) then
822 sup2
.add
(c
.module.html_link
(dctx
))
825 if not sup2
.is_empty
then
826 dctx
.add
("<dt>Refinements in known modules: <dd>{sup2.join(", ")}\n")
832 dctx
.add
("<pre>{doc.to_html}</pre>\n")
835 var details
= new Array[Array[MMLocalProperty]]
836 for i
in [0..4[ do details
.add
(property_summary
(dctx
, i
))
837 for i
in [0..4[ do property_detail
(dctx
, i
, details
[i
])
839 dctx
.add
("</blockquote><hr/>\n")
842 meth pass_name
(pass
: Int): String
844 var names
= once
["Virtual Types", "Consructors", "Methods", "Attributes"]
848 meth accept_prop
(p
: MMLocalProperty, pass
: Int): Bool
851 return p
isa MMTypeProperty
852 else if pass
== 1 then
853 return p
.global
.is_init
854 else if pass
== 2 then
855 return p
isa MMMethod and not p
.global
.is_init
856 else if pass
== 3 then
857 return p
isa MMAttribute
862 meth property_summary
(dctx
: DocContext, pass
: Int): Array[MMLocalProperty]
864 var passname
= pass_name
(pass
)
866 dctx
.stage
("<table border=\"1\
" width=\"100%\
" cellpadding=\"3\
" cellspacing=\"0\
">\n")
867 dctx
.stage
("<tr bgcolor=\"#CCCCFF\"><th colspan=\"2\">{passname} Summary of {self}</th></tr>\n")
869 var new_props
= new Array[MMLocalProperty]
870 for g
in global_properties
do
871 if not accept_prop
(g
.intro
, pass
) then continue
872 if module.visibility_for
(g
.intro
.module) < g
.visibility_level
then continue
874 if p
.local_class
!= self or not p
.need_doc
(dctx
) then
875 var cla
= new Array[MMLocalClass]
876 for m
in dctx
.owned_modules
do
878 if c
== null or not c
isa MMConcreteClass then continue
880 if p2
== null or p2
.local_class
!= c
or not p2
.need_doc
(dctx
) then continue
883 if cla
.is_empty
then continue
884 cla
= crhe
.order
.select_smallests
(cla
)
888 if p
.global
.intro
== p
then
893 for p
in new_props
do
894 dctx
.add
("<tr><td width=\"20%\
" align=\"right\
">{p.prototype_head(dctx)}</td><td><b>{p.html_link(dctx)}</b>{p.prototype_body(dctx)}<br/> {p.short_doc}</td></tr>\n")
896 dctx
.stage
("</table><br/>\n")
899 dctx
.stage
("<table border=\"1\
" width=\"100%\
" cellpadding=\"3\
" cellspacing=\"0\
">\n")
901 # skip pass 1 because constructors are not inherited
902 var cmap
= new HashMap[MMLocalClass, Array[MMLocalProperty]]
903 var mmap
= new HashMap[MMModule, Array[MMLocalProperty]]
904 var props
= new Array[MMLocalClass]
905 for c
in che
.greaters
do
906 if c
isa MMSrcLocalClass then
907 var km
= dctx
.known_owner_of
(c
.module)
908 var kc
= km
[c
.global
]
909 if kc
== self or not c
isa MMConcreteClass then continue
910 var props
: Array[MMLocalProperty]
912 if cmap
.has_key
(kc
) then
915 props
= new Array[MMLocalProperty]
919 if mmap
.has_key
(km
) then
922 props
= new Array[MMLocalProperty]
926 for g
in c
.global_properties
do
928 if p
.local_class
== c
and p
.need_doc
(dctx
) and accept_prop
(p
, pass
) then
935 dctx
.stage
("<tr bgcolor=\"#EEEEFF\"><th colspan=\"2\"><small>Inherited {passname}</small></th><tr>\n")
936 for c
in cshe
.linear_extension
do
937 if not cmap
.has_key
(c
) then continue
939 if props
.is_empty
then continue
941 var properties
= new Array[String]
942 for p
in props
do properties
.add
(p
.html_link
(dctx
))
943 dctx
.add
("<tr><td width=\"20%\
"><small>from {c.html_link(dctx)}</small></td><td><small>{properties.join(", ")}</small></td><tr>\n")
948 dctx
.stage
("<tr bgcolor=\"#EEEEFF\"><th colspan=\"2\"><small>Imported {passname}</small></th><tr>\n")
949 for m
in module.mhe
.linear_extension
do
950 if not mmap
.has_key
(m
) then continue
952 if props
.is_empty
then continue
954 var properties
= new Array[String]
955 for p
in props
do properties
.add
(p
.html_link
(dctx
))
956 dctx
.add
("<tr><td width=\"20%\
"><small>from {m.html_link(dctx)}</small></td><td><small>{properties.join(", ")}</small></td><tr>\n")
961 var mmap
= new HashMap[MMModule, Array[MMLocalProperty]]
962 var props
= new Array[MMLocalClass]
963 for c
in crhe
.order
do
964 if module.mhe
<= c
.module or dctx
.owned_modules
.has
(c
.module) or not c
isa MMSrcLocalClass then continue
965 var km
= dctx
.known_owner_of
(c
.module)
966 if module.mhe
<= km
then continue
967 var kc
= km
[c
.global
]
968 var props
: Array[MMLocalProperty]
969 if mmap
.has_key
(km
) then
972 props
= new Array[MMLocalProperty]
975 for g
in c
.global_properties
do
977 if p
.local_class
== c
and p
.need_doc
(dctx
) and accept_prop
(p
, pass
) then
979 if not props
.has
(kp
) then props
.add
(kp
)
982 # c.properties_inherited_from(dctx, self, pass)
985 dctx
.stage
("<tr bgcolor=\"#EEEEFF\"><th colspan=\"2\"><small>Added {passname} in known modules</small></th><tr>\n")
986 for c
in crhe
.order
do
988 if not mmap
.has_key
(m
) then continue
990 if props
.is_empty
then continue
992 var properties
= new Array[String]
993 for p
in props
do properties
.add
(p
.html_link
(dctx
))
994 dctx
.add
("<tr><td width=\"20%\
"><small>in {m.html_link(dctx)}</small></td><td><small>{properties.join(", ")}</small></td><tr>\n")
997 dctx
.stage
("</table><br/><br/>\n")
1004 meth property_detail
(dctx
: DocContext, pass
: Int, new_props
: Array[MMLocalProperty])
1006 var passname
= pass_name
(pass
)
1008 dctx
.stage
("<table border=\"1\
" width=\"100%\
" cellpadding=\"3\
" cellspacing=\"0\
">\n")
1009 dctx
.stage
("<tr bgcolor=\"#CCCCFF\"><th>{passname} Detail of {self}</th><tr>\n")
1010 dctx
.stage
("</table>\n")
1013 for p
in new_props
do
1014 dctx
.add
("<a name=\"{p.html_anchor}\
"></a><h3>{p}</h3><p><small>{p.module.html_link(dctx)}::{p.local_class.html_link(dctx)}::</small><br/>{p.prototype_head(dctx)} <b>{p.name}</b>{p.prototype_body(dctx)}</p>\n")
1015 dctx
.add
("<blockquote>")
1018 dctx
.add
("<pre>{doc.to_html}</pre>\n")
1020 dctx
.stage
("</blockquote>\n")
1024 dctx
.stage
("<hr/>\n")
1031 # Add rows for properties inheriterd to some heirs
1032 meth properties_inherited_from
(dctx
: DocContext, heir
: MMLocalClass, pass
: Int)
1034 var properties
= new Array[String]
1035 for g
in global_properties
do
1037 if p
.local_class
== self and p
.need_doc
(dctx
) and accept_prop
(p
, pass
) then
1038 properties
.add
(p
.html_link
(dctx
))
1041 if not properties
.is_empty
then
1043 if heir
.global
== global
then
1044 s
= module.html_link
(dctx
)
1046 s
= self.html_link
(dctx
)
1048 dctx
.add
("<tr><td width=\"20%\
"><small>in {s}</small></td><td><small>{properties.join(", ")}</small></td><tr>\n")
1053 redef class MMSrcLocalClass
1054 redef meth short_doc
1059 else if global
.intro
== self then
1062 var bc
= global
.intro
1070 if not n
isa AClassdef then
1073 assert n
isa AClassdef
1079 if d
.n_comment
.is_empty
then
1086 redef meth need_doc
(dctx
)
1088 if global
.visibility_level
>= 3 then
1089 if not dctx
.intrude_mode
then return false
1090 if dctx
.module.visibility_for
(module) == 0 then return false
1092 if global
.intro
== self then
1095 for p
in src_local_properties
do
1096 if p
.need_doc
(dctx
) then
1104 redef class MMSignature
1105 # Htlm transcription of the signature (with nested links)
1106 meth to_html
(dctx
: DocContext): String
1108 var res
= new String
1111 res
.append
(self[0].html_link
(dctx
))
1112 for i
in [1..arity
[ do
1114 res
.append
(self[i
].html_link
(dctx
))
1118 if return_type
!= null then
1120 res
.append
(return_type
.html_link
(dctx
))
1127 # Htlm transcription of the type (with nested links)
1128 meth html_link
(dctx
: DocContext): String do return to_s
1131 redef class MMTypeSimpleClass
1132 redef meth html_link
(dctx
) do return local_class
.html_link
(dctx
)
1135 redef class MMTypeGeneric
1136 redef meth html_link
(dctx
)
1138 var res
= local_class
.html_link
(dctx
)
1140 res
.append
(params
[0].html_link
(dctx
))
1141 for i
in [1..params
.length
[ do
1143 res
.append
(params
[i
].html_link
(dctx
))
1150 var c
= new DocContext