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.
20 import abstract_compiler
24 private var toolcontext
: ToolContext
25 private var model
: Model
26 private var modelbuilder
: ModelBuilder
27 private var mainmodule
: MModule
28 private var arguments
: Array[String]
29 private var destinationdir
: nullable String
30 private var sharedir
: nullable String
31 private var source
: nullable String
33 private var opt_dir
= new OptionString("Directory where doc is generated", "-d", "--dir")
34 private var opt_source
= new OptionString("What link for source (%f for filename, %l for first line, %L for last line)", "--source")
35 private var opt_sharedir
= new OptionString("Directory containing the nitdoc files", "--sharedir")
36 private var opt_nodot
= new OptionBool("Do not generate graphes with graphiviz", "--no-dot")
38 init(toolcontext
: ToolContext) do
39 # We need a model to collect stufs
40 self.toolcontext
= toolcontext
41 self.arguments
= toolcontext
.option_context
.rest
42 toolcontext
.option_context
.options
.clear
43 toolcontext
.option_context
.add_option
(opt_dir
)
44 toolcontext
.option_context
.add_option
(opt_source
)
45 toolcontext
.option_context
.add_option
(opt_sharedir
)
46 toolcontext
.option_context
.add_option
(opt_nodot
)
47 toolcontext
.process_options
50 if arguments
.length
< 1 then
51 toolcontext
.option_context
.usage
56 modelbuilder
= new ModelBuilder(model
, toolcontext
)
58 # Here we load an process std modules
59 var mmodules
= modelbuilder
.parse_and_build
([arguments
.first
])
60 if mmodules
.is_empty
then return
61 modelbuilder
.full_propdef_semantic_analysis
62 assert mmodules
.length
== 1
63 self.mainmodule
= mmodules
.first
66 private fun process_options
do
67 if not opt_dir
.value
is null then
68 destinationdir
= opt_dir
.value
70 destinationdir
= "nitdoc_directory"
72 if not opt_sharedir
.value
is null then
73 sharedir
= opt_sharedir
.value
75 var dir
= "NIT_DIR".environ
77 dir
= "{sys.program_name.dirname}/../share/nitdoc"
79 dir
= "{dir}/share/nitdoc"
82 if sharedir
is null then
83 print
"Error: Cannot locate nitdoc share files. Uses --sharedir or envvar NIT_DIR"
86 dir
= "{sharedir.to_s}/scripts/js-facilities.js"
87 if sharedir
is null then
88 print
"Error: Invalid nitdoc share files. Check --sharedir or envvar NIT_DIR"
92 if not opt_source
.value
is null then
95 source
= opt_source
.value
100 if arguments
.length
== 1 then
101 # Create destination dir if it's necessary
102 if not destinationdir
.file_exists
then destinationdir
.mkdir
103 sys
.system
("cp -r {sharedir.to_s}/* {destinationdir.to_s}/")
113 var overviewpage
= new NitdocOverview.with
(modelbuilder
.nmodules
, self.opt_nodot
.value
, destinationdir
.to_s
)
114 overviewpage
.save
("{destinationdir.to_s}/index.html")
118 var fullindex
= new NitdocFullindex.with
(model
.mmodules
)
119 fullindex
.save
("{destinationdir.to_s}/full-index.html")
123 for mod
in modelbuilder
.nmodules
do
124 var modulepage
= new NitdocModules.with
(mod
)
125 modulepage
.save
("{destinationdir.to_s}/{mod.mmodule.name}.html")
130 for amodule
in modelbuilder
.nmodules
do
131 for mclass
, aclassdef
in amodule
.mclass2nclassdef
do
132 mclass
.amodule
(modelbuilder
.mmodule2nmodule
)
133 mclass
.mmethod
(aclassdef
.mprop2npropdef
)
134 var classpage
= new NitdocMClasses.with
(mclass
, aclassdef
, source
)
135 classpage
.save
("{destinationdir.to_s}/{mclass.name}.html")
140 # Generate QuickSearch file
141 fun quicksearch_list
do
142 var file
= new OFStream.open
("{destinationdir.to_s}/quicksearch-list.js")
143 var content
= new Buffer
144 content
.append
("var entries = \{ ")
145 for prop
in model
.mproperties
do
146 if not prop
isa MMethod then continue
147 content
.append
("\"{prop.name}\
": [")
148 for propdef
in prop
.mpropdefs
do
149 content
.append
("\{txt: \"{propdef.mproperty.full_name}\", url
:\
"{propdef.mproperty.link_anchor}\" \
}")
150 if not propdef is prop.mpropdefs.last then content.append(", ")
156 for mclass in model.mclasses do
157 content.append("\
"{mclass.name}\": [")
158 for mclassdef in mclass.mclassdefs do
159 content.append("\
{txt: \"{mclassdef.mclass.full_name}\
", url:\"{mclass.link_anchor}\
" \}")
160 if not mclassdef
is mclass
.mclassdefs
.last
then content
.append
(", ")
163 if not mclass
is model
.mclasses
.last
then content
.append
(", ")
166 content
.append
(" \};")
167 file
.write
(content
.to_s
)
176 var amodules
: Array[AModule]
178 # Init with Array[AModule] to get all ifnormations about each MModule containt in a program
179 # opt_nodot to inform about the graph gen
180 # destination: to know where will be saved dot files
181 init with
(modules
: Array[AModule], opt_nodot
: Bool, destination
: String) do
182 self.amodules
= modules
183 self.opt_nodot
= opt_nodot
184 self.destinationdir
= destination
189 add
("title").text
("Overview | Nit Standard Library")
194 open
("nav").add_class
("main")
196 add
("li").add_class
("current").text
("Overview")
198 add_html
("<a href=\"full-index
.html\
">Full Index</a>")
200 open
("li").attr
("id", "liGitHub")
201 open
("a").add_class
("btn").attr
("id", "logGitHub")
202 add
("img").attr
("id", "imgGitHub").attr
("src", "resources/icons/github-icon.png")
204 open
("div").add_class
("popover bottom")
205 add
("div").add_class
("arrow").text
(" ")
206 open
("div").add_class
("githubTitle")
207 add
("h3").text
("Github Sign In")
210 add
("label").attr
("id", "lbloginGit").text
("Username")
211 add
("input").attr
("id", "loginGit").attr
("name", "login").attr
("type", "text")
212 open
("label").attr
("id", "logginMessage").text
("Hello ")
213 open
("a").attr
("id", "githubAccount")
214 add
("strong").attr
("id", "nickName").text
(" ")
219 add
("label").attr
("id", "lbpasswordGit").text
("Password")
220 add
("input").attr
("id", "passwordGit").attr
("name", "password").attr
("type", "password")
221 open
("div").attr
("id", "listBranches")
222 add
("label").attr
("id", "lbBranches").text
("Branch")
223 add
("select").add_class
("dropdown").attr
("id", "dropBranches").attr
("name", "dropBranches").attr
("tabindex", "1").text
(" ")
227 add
("label").attr
("id", "lbrepositoryGit").text
("Repository")
228 add
("input").attr
("id", "repositoryGit").attr
("name", "repository").attr
("type", "text")
231 add
("label").attr
("id", "lbbranchGit").text
("Branch")
232 add
("input").attr
("id", "branchGit").attr
("name", "branch").attr
("type", "text")
235 add
("a").attr
("id", "signIn").text
("Sign In")
246 open
("div").add_class
("page")
247 open
("div").add_class
("content fullpage")
248 add
("h1").text
("Nit Standard Library")
249 open
("article").add_class
("overview")
250 add_html
("<p>Documentation for the standard library of Nit<br />Version jenkins-component=stdlib-19<br />Date: TODAY</p>")
252 open
("article").add_class
("overview")
253 add
("h2").text
("Modules")
261 add
("footer").text
("Nit standard library. Version jenkins-component=stdlib-19.")
265 var ls
= new List[nullable MModule]
266 for amodule
in amodules
do
267 var mmodule
= amodule
.mmodule
.public_owner
268 if mmodule
!= null and not ls
.has
(mmodule
) then
270 add
("a").attr
("href", "{mmodule.name}.html").text
("{mmodule.to_s} ")
271 add_html
(amodule
.comment
)
278 fun process_generate_dot
do
280 op
.append
("digraph dep \{ rankdir=BT; node[shape=none,margin=0,width=0,height=0,fontsize=10]; edge[dir=none,color=gray]; ranksep=0.2; nodesep=0.1;\n")
281 for amodule
in amodules
do
282 op
.append
("\"{amodule.mmodule.name}\
"[URL=\"{amodule.mmodule.name}.html\
"];\n")
283 for mmodule2
in amodule
.mmodule
.in_importation
.direct_greaters
do
284 op
.append
("\"{amodule.mmodule.name}\
"->\"{mmodule2.name}\
";\n")
288 generate_dot
(op
.to_s
, "dep", "Modules hierarchy")
293 class NitdocFullindex
296 var mmodules
: Array[MModule]
298 init with
(mmodules
: Array[MModule]) do
299 self.mmodules
= mmodules
306 add
("title").text
("Full Index | Nit Standard Library")
311 open
("nav").add_class
("main")
314 add_html
("<a href=\"index
.html\
">Overview</a>")
316 add
("li").add_class
("current").text
("Full Index")
317 open
("li").attr
("id", "liGitHub")
318 open
("a").add_class
("btn").attr
("id", "logGitHub")
319 add
("img").attr
("id", "imgGitHub").attr
("src", "resources/icons/github-icon.png")
321 open
("div").add_class
("popover bottom")
322 add
("div").add_class
("arrow").text
(" ")
323 open
("div").add_class
("githubTitle")
324 add
("h3").text
("Github Sign In")
327 add
("label").attr
("id", "lbloginGit").text
("Username")
328 add
("input").attr
("id", "loginGit").attr
("name", "login").attr
("type", "text")
329 open
("label").attr
("id", "logginMessage").text
("Hello ")
330 open
("a").attr
("id", "githubAccount")
331 add
("strong").attr
("id", "nickName").text
(" ")
336 add
("label").attr
("id", "lbpasswordGit").text
("Password")
337 add
("input").attr
("id", "passwordGit").attr
("name", "password").attr
("type", "password")
338 open
("div").attr
("id", "listBranches")
339 add
("label").attr
("id", "lbBranches").text
("Branch")
340 add
("select").add_class
("dropdown").attr
("id", "dropBranches").attr
("name", "dropBranches").attr
("tabindex", "1").text
(" ")
344 add
("label").attr
("id", "lbrepositoryGit").text
("Repository")
345 add
("input").attr
("id", "repositoryGit").attr
("name", "repository").attr
("type", "text")
348 add
("label").attr
("id", "lbbranchGit").text
("Branch")
349 add
("input").attr
("id", "branchGit").attr
("name", "branch").attr
("type", "text")
352 add
("a").attr
("id", "signIn").text
("Sign In")
363 open
("div").add_class
("page")
364 open
("div").add_class
("content fullpage")
365 add
("h1").text
("Full Index")
369 add
("footer").text
("Nit standard library. Version jenkins-component=stdlib-19.")
378 # Add to content modules column
380 var ls
= new List[nullable MModule]
381 var sorted
= mmodules
382 var sorterp
= new ComparableSorter[MModule]
384 open
("article").add_class
("modules filterable")
385 add
("h2").text
("Modules")
387 for mmodule
in sorted
do
388 if mmodule
.public_owner
!= null and not ls
.has
(mmodule
.public_owner
) then
389 ls
.add
(mmodule
.public_owner
)
391 add
("a").attr
("href", "{mmodule.public_owner.name}.html").text
(mmodule
.public_owner
.name
)
399 # Add to content classes modules
400 fun classes_column
do
401 var sorted
= mmodules
.first
.imported_mclasses
.to_a
402 var sorterp
= new ComparableSorter[MClass]
404 open
("article").add_class
("classes filterable")
405 add
("h2").text
("Classes")
408 for mclass
in sorted
do
410 add
("a").attr
("href", "{mclass.name}.html").text
(mclass
.name
)
418 # Insert the properties column of fullindex page
419 fun properties_column
do
420 open
("article").add_class
("properties filterable")
421 add
("h2").text
("Properties")
423 var sorted_imported
= mmodules
.first
.imported_methods
.to_a
424 var sorted_redef
= mmodules
.first
.redef_methods
.to_a
425 var sorterp
= new ComparableSorter[MProperty]
426 sorterp
.sort
(sorted_imported
)
427 sorterp
.sort
(sorted_redef
)
429 for method
in sorted_imported
do
430 if method
.visibility
is none_visibility
or method
.visibility
is intrude_visibility
then continue
431 open
("li").add_class
("intro")
432 add
("span").attr
("title", "introduction").text
("I")
434 add
("a").attr
("href", "{method.local_class.name}.html").attr
("title", "").text
("{method.name} ({method.local_class.name})")
438 for method
in sorted_redef
do
439 if method
.visibility
is none_visibility
or method
.visibility
is intrude_visibility
then continue
440 open
("li").add_class
("redef")
441 add
("span").attr
("title", "redefinition").text
("R")
443 add
("a").attr
("href", "{method.local_class.name}.html").attr
("title", "").text
("{method.name} ({method.local_class.name})")
457 var modulename
: String
458 init with
(amodule
: AModule) do
459 self.amodule
= amodule
460 self.modulename
= self.amodule
.mmodule
.name
467 add
("title").text
("{modulename} module | {amodule.short_comment}")
472 open
("nav").add_class
("main")
475 add_html
("<a href=\"index
.html\
">Overview</a>")
477 add
("li").add_class
("current").text
(modulename
)
479 add_html
("<a href=\"full-index
.html\
" >Full Index</a>")
481 open
("li").attr
("id", "liGitHub")
482 open
("a").add_class
("btn").attr
("id", "logGitHub")
483 add
("img").attr
("id", "imgGitHub").attr
("src", "resources/icons/github-icon.png")
485 open
("div").add_class
("popover bottom")
486 add
("div").add_class
("arrow").text
(" ")
487 open
("div").add_class
("githubTitle")
488 add
("h3").text
("Github Sign In")
491 add
("label").attr
("id", "lbloginGit").text
("Username")
492 add
("input").attr
("id", "loginGit").attr
("name", "login").attr
("type", "text")
493 open
("label").attr
("id", "logginMessage").text
("Hello ")
494 open
("a").attr
("id", "githubAccount")
495 add
("strong").attr
("id", "nickName").text
(" ")
500 add
("label").attr
("id", "lbpasswordGit").text
("Password")
501 add
("input").attr
("id", "passwordGit").attr
("name", "password").attr
("type", "password")
502 open
("div").attr
("id", "listBranches")
503 add
("label").attr
("id", "lbBranches").text
("Branch")
504 add
("select").add_class
("dropdown").attr
("id", "dropBranches").attr
("name", "dropBranches").attr
("tabindex", "1").text
(" ")
508 add
("label").attr
("id", "lbrepositoryGit").text
("Repository")
509 add
("input").attr
("id", "repositoryGit").attr
("name", "repository").attr
("type", "text")
512 add
("label").attr
("id", "lbbranchGit").text
("Branch")
513 add
("input").attr
("id", "branchGit").attr
("name", "branch").attr
("type", "text")
516 add
("a").attr
("id", "signIn").text
("Sign In")
527 open
("div").add_class
("page")
531 add
("footer").text
("Nit standard library. Version jenkins-component=stdlib-19.")
534 # Insert all tags in content part
536 open
("div").add_class
("content")
537 add
("h1").text
(modulename
)
538 add
("div").add_class
("subtitle").text
("module {modulename}")
545 # Insert module comment in the content
546 fun module_comment
do
547 var doc
= amodule
.comment
548 open
("div").attr
("id", "description")
549 add
("pre").add_class
("text_label").text
(doc
)
550 add
("textarea").add_class
("edit").attr
("rows", "1").attr
("cols", "76").attr
("id", "fileContent").text
(" ")
551 add
("a").attr
("id", "cancelBtn").text
("Cancel")
552 add
("a").attr
("id", "commitBtn").text
("Commit")
553 add
("pre").add_class
("text_label").attr
("id", "preSave").attr
("type", "2")
558 var mmodule
= amodule
.mmodule
559 open
("div").add_class
("menu")
561 add
("h3").text
("Module Hierarchy").attr
("style","cursor: pointer;")
562 if mmodule
.in_importation
.direct_greaters
.length
> 0 then
563 add_html
("<h4>All dependencies</h4><ul>")
564 var sorted
= mmodule
.in_importation
.direct_greaters
.to_a
565 var sorterp
= new ComparableSorter[MModule]
568 if m
== mmodule
or mmodule
== m
.public_owner
then continue
570 add
("a").attr
("href", "{m.name}.html").text
(m
.name
)
575 if mmodule
.in_importation
.greaters
.length
> 0 then
576 add_html
("<h4>All clients</h4><ul>")
577 var sorted
= mmodule
.in_importation
.greaters
.to_a
578 var sorterp
= new ComparableSorter[MModule]
581 if m
== mmodule
then continue
583 add
("a").attr
("href", "{m.name}.html").text
(m
.name
)
589 if mmodule
.in_nesting
.direct_greaters
.length
> 0 then
590 var sorted
= mmodule
.in_nesting
.direct_greaters
.to_a
591 var sorterp
= new ComparableSorter[MModule]
594 add
("h3").text
("Nested Modules").attr
("style","cursor: pointer;")
598 add
("a").attr
("href", "{m.name}.html").text
(m
.name
)
609 var sorted
= new Array[MClass]
610 sorted
.add_all
(amodule
.mmodule
.mclasses
.keys
)
611 var sorterp
= new ComparableSorter[MClass]
613 open
("div").add_class
("module")
614 open
("article").add_class
("classes filterable")
615 add
("h2").text
("Classes")
618 var state
= amodule
.mmodule
.mclasses
[c
]
620 if state
== c_is_intro
or state
== c_is_imported
then
621 open
("li").add_class
("intro")
622 add
("span").attr
("title", "introduced in this module").text
("I ")
624 open
("li").add_class
("redef")
625 add
("span").attr
("title", "refined in this module").text
("R ")
627 add
("a").attr
("href", "{name}.html").text
(name
)
636 var sorted_imported
= amodule
.mmodule
.imported_methods
.to_a
637 var sorted_redef
= amodule
.mmodule
.redef_methods
.to_a
638 var sorterp
= new ComparableSorter[MProperty]
639 sorterp
.sort
(sorted_imported
)
640 sorterp
.sort
(sorted_redef
)
641 open
("article").add_class
("properties filterable")
642 add_html
("<h2>Properties</h2>")
644 for method
in sorted_imported
do
645 if method
.visibility
is none_visibility
or method
.visibility
is intrude_visibility
then continue
646 open
("li").add_class
("intro")
647 add
("span").attr
("title", "introduction").text
("I")
649 add
("a").attr
("href", "{method.local_class.name}.html").attr
("title", "").text
("{method.name} ({method.local_class.name})")
653 for method
in sorted_redef
do
654 if method
.visibility
is none_visibility
or method
.visibility
is intrude_visibility
then continue
655 open
("li").add_class
("redef")
656 add
("span").attr
("title", "redefinition").text
("R")
658 add
("a").attr
("href", "{method.local_class.name}.html").attr
("title", "").text
("{method.name} ({method.local_class.name})")
668 # Nit Standard Library
673 var aclassdef
: AClassdef
674 var stdclassdef
: nullable AStdClassdef
675 var public_owner
: nullable MModule
677 init with
(mclass
: MClass, aclassdef
: AClassdef, source
: nullable String) do
679 self.aclassdef
= aclassdef
680 if aclassdef
isa AStdClassdef then self.stdclassdef
= aclassdef
681 self.public_owner
= mclass
.intro_mmodule
.public_owner
689 add
("title").text
("{self.mclass.name} class | Nit Standard Library")
694 open
("nav").add_class
("main")
697 add_html
("<a href=\"index
.html\
">Overview</a>")
700 if public_owner
is null then
701 add_html
("<a href=\"{mclass.intro_mmodule.name}.html\
">{mclass.intro_mmodule.name}</a>")
703 add_html
("<a href=\"{public_owner.name}.html\
">{public_owner.name}</a>")
706 add
("li").add_class
("current").text
(mclass
.name
)
708 add_html
("<a href=\"full-index
.html\
" >Full Index</a>")
710 open
("li").attr
("id", "liGitHub")
711 open
("a").add_class
("btn").attr
("id", "logGitHub")
712 add
("img").attr
("id", "imgGitHub").attr
("src", "resources/icons/github-icon.png")
714 open
("div").add_class
("popover bottom")
715 add
("div").add_class
("arrow").text
(" ")
716 open
("div").add_class
("githubTitle")
717 add
("h3").text
("Github Sign In")
720 add
("label").attr
("id", "lbloginGit").text
("Username")
721 add
("input").attr
("id", "loginGit").attr
("name", "login").attr
("type", "text")
722 open
("label").attr
("id", "logginMessage").text
("Hello ")
723 open
("a").attr
("id", "githubAccount")
724 add
("strong").attr
("id", "nickName").text
(" ")
729 add
("label").attr
("id", "lbpasswordGit").text
("Password")
730 add
("input").attr
("id", "passwordGit").attr
("name", "password").attr
("type", "password")
731 open
("div").attr
("id", "listBranches")
732 add
("label").attr
("id", "lbBranches").text
("Branch")
733 add
("select").add_class
("dropdown").attr
("id", "dropBranches").attr
("name", "dropBranches").attr
("tabindex", "1").text
(" ")
737 add
("label").attr
("id", "lbrepositoryGit").text
("Repository")
738 add
("input").attr
("id", "repositoryGit").attr
("name", "repository").attr
("type", "text")
741 add
("label").attr
("id", "lbbranchGit").text
("Branch")
742 add
("input").attr
("id", "branchGit").attr
("name", "branch").attr
("type", "text")
745 add
("a").attr
("id", "signIn").text
("Sign In")
756 open
("div").add_class
("page")
759 add
("footer").text
("Nit standard library. Version jenkins-component=stdlib-19.")
762 # Insert all tags in content part
764 open
("div").add_class
("menu")
768 open
("div").add_class
("content")
773 fun properties_column
do
774 open
("nav").add_class
("properties filterable")
775 add
("h3").text
("Properties")
777 if mclass
.virtual_types
.length
> 0 then
778 add
("h4").text
("Virtual Types")
780 for prop
in mclass
.virtual_types
do
781 add_html
("<li class=\"redef\
"><span title=\"Redefined\
">R</span><a href=\"{prop.link_anchor}\
">{prop.name}</a></li>")
785 if mclass
.constructors
.length
> 0 then
786 add
("h4").text
("Constructors")
788 for prop
in mclass
.constructors
do
789 add_html
("<li class=\"intro\
"><span title=\"Introduced\
">I</span><a href=\"{prop.link_anchor}\
">{prop.name}</a></li>")
793 add
("h4").text
("Methods")
795 if mclass
.intro_methods
.length
> 0 then
796 for prop
in mclass
.intro_methods
do
797 if prop
.visibility
is public_visibility
or prop
.visibility
is protected_visibility
then add_html
("<li class=\"intro\
"><span title=\"Introduced\
">I</span><a href=\"{prop.link_anchor}\
">{prop.name}</a></li>")
800 if mclass
.inherited_methods
.length
> 0 then
801 for prop
in mclass
.inherited_methods
do
802 if prop
.visibility
is public_visibility
or prop
.visibility
is protected_visibility
then add_html
("<li class=\"inherit\
"><span title=\"Inherited\
">H</span><a href=\"{prop.link_anchor}\
">{prop.name}</a></li>")
805 if mclass
.redef_methods
.length
> 0 then
806 for prop
in mclass
.redef_methods
do
807 if prop
.visibility
is public_visibility
or prop
.visibility
is protected_visibility
then add_html
("<li class=\"redef\
"><span title=\"Refined\
">R</span><a href=\"{prop.link_anchor}\
">{prop.name}</a></li>")
814 fun inheritance_column
do
816 add
("h3").text
("Inheritance")
817 if mclass
.parents
.length
> 0 then
818 add
("h4").text
("Superclasses")
820 for sup
in mclass
.parents
do add_html
("<li><a href=\"{sup.name}.html\
">{sup.name}</a></li>")
824 if mclass
.descendants
.length
is 0 then
825 add
("h4").text
("No Known Subclasses")
826 else if mclass
.descendants
.length
<= 100 then
827 add
("h4").text
("Subclasses")
829 for sub
in mclass
.descendants
do add_html
("<li><a href=\"{sub.name}\
">{sub.name}</a></li>")
831 else if mclass
.children
.length
<= 100 then
832 add
("h4").text
("Direct Subclasses Only")
834 for sub
in mclass
.children
do add_html
("<li><a href=\"{sub.name}\
">{sub.name}</a></li>")
837 add
("h4").text
("Too much Subclasses to list")
844 var lmmodule
= new List[MModule]
845 # Insert the subtitle part
846 add
("h1").text
(mclass
.name
)
847 open
("div").add_class
("subtitle")
848 if mclass
.visibility
is none_visibility
then subtitle
+= "private "
849 subtitle
+= "{mclass.kind} <a href=\"{mclass.public_owner.name}.html\
">{mclass.public_owner.name}</a>::{mclass.name}"
852 add_html
("<div style=\"float
: right
;\
"><a id=\"lblDiffCommit\
"></a></div>")
853 # We add the class description
854 open
("section").add_class
("description")
855 if not stdclassdef
is null and not stdclassdef
.comment
.is_empty
then add_html
("<pre class=\"text_label\
" title=\"122\
" name=\"\
" tag=\"{mclass.mclassdefs.first.location.to_s}\
" type=\"2\
">{stdclassdef.comment} </pre><textarea id=\"fileContent\
" class=\"edit\
" cols=\"76\
" rows=\"1\
" style=\"display
: none
;\
"></textarea><a id=\"cancelBtn\
" style=\"display
: none
;\
">Cancel</a><a id=\"commitBtn\
" style=\"display
: none
;\
">Commit</a><pre id=\"preSave\
" class=\"text_label\
" type=\"2\
"></pre>")
857 open
("section").add_class
("concerns")
858 add
("h2").add_class
("section-header").text
("Concerns")
860 for owner
, childs
in mclass
.concerns
do
862 add_html
("<a href=\"#MOD_{owner.name}\">{owner.name}</a>: {owner.amodule.short_comment}")
863 if not childs
is null then
865 for child
in childs
.as(not null) do add_html
("<li><a href=\"#MOD_{child.name}\">{child.name}</a>: {child.amodule.short_comment} </li>")
872 # Insert virtual types if there is almost one
873 if mclass
.virtual_types
.length
> 0 or (stdclassdef
!= null and stdclassdef
.n_formaldefs
.length
> 0) then
874 open
("section").add_class
("types")
875 add
("h2").text
("Formal and Virtual Types")
876 if mclass
.virtual_types
.length
> 0 then for prop
in mclass
.virtual_types
do description
(prop
)
877 if stdclassdef
.n_formaldefs
.length
> 0 then
878 for prop
in stdclassdef
.n_formaldefs
do
879 open
("article").attr
("id", "FT_Object_{prop.collect_text}")
880 open
("h3").add_class
("signature").text
("{prop.collect_text}: nullable ")
881 add_html
("<a title=\"The root of the
class hierarchy
.\
" href=\"Object.html\
">Object</a>")
883 add_html
("<div class=\"info\
">formal generic type</div>")
889 # Insert constructors if there is almost one
890 if mclass
.constructors
.length
> 0 then
891 open
("section").add_class
("constructors")
892 add
("h2").add_class
("section-header").text
("Constructors")
893 for prop
in mclass
.constructors
do description
(prop
)
896 open
("section").add_class
("methods")
897 add
("h2").add_class
("section-header").text
("Methods")
898 for mmodule
, mmethods
in mclass
.all_methods
do
899 add_html
("<a id=\"MOD_{mmodule.name}\
"></a>")
900 if mmodule
!= mclass
.intro_mmodule
and mmodule
!= mclass
.public_owner
then
901 if mclass
.has_mmodule
(mmodule
) then
902 add_html
("<p class=\"concern-doc\
">{mmodule.name}: {mmodule.amodule.short_comment}</p>")
904 add_html
("<h3 class=\"concern-toplevel\
">Methods refined in <a href=\"{mmodule.name}.html\
">{mmodule.name}</a></h3><p class=\"concern-doc\
">{mmodule.name}: {mmodule.amodule.short_comment}</p>")
907 for prop
in mmethods
do description
(prop
)
909 # Insert inherited methods
910 if mclass
.inherited_methods
.length
> 0 then
911 add
("h3").text
("Inherited Methods")
912 for i_mclass
, methods
in mclass
.inherited
do
914 add_html
("Defined in <a href=\"{i_mclass.name}.html\
">{i_mclass.name}</a>: ")
915 for method
in methods
do
916 add_html
("<a href=\"{method.link_anchor}\
">{method.name}</a>")
917 if method
!= methods
.last
then add_html
(", ")
925 # Insert description tags for 'prop'
926 fun description
(prop
: MProperty) do
927 open
("article").add_class
("fun public {if prop.is_redef then "redef" else ""}").attr
("id", "{prop.anchor}")
929 if prop
.apropdef
!= null then sign
+= prop
.apropdef
.signature
930 add_html
("<h3 class=\"signature\
">{sign}</h3>")
931 add_html
("<div class=\"info\
">{if prop.is_redef then "redef" else ""} fun {prop.intro_mclassdef.namespace(mclass)}::{prop.name}</div><div style=\"float
: right
;\
"><a id=\"lblDiffCommit\
"></a></div>")
933 open
("div").add_class
("description")
934 if prop
.apropdef
is null or prop
.apropdef
.comment
== "" then
935 add_html
("<a class=\"newComment\
" title=\"32\
" tag=\"\
">New Comment</a>")
937 add_html
("<pre class=\"text_label\
" title=\"\
" name=\"\
" tag=\"\
" type=\"1\
">{prop.apropdef.comment}</pre>")
939 add_html
("<textarea id=\"fileContent\
" class=\"edit\
" cols=\"76\
" rows=\"1\
" style=\"display
: none
;\
"></textarea><a id=\"cancelBtn\
" style=\"display
: none
;\
">Cancel</a><a id=\"commitBtn\
" style=\"display
: none
;\
">Commit</a><pre id=\"preSave\
" class=\"text_label\
" type=\"2\
"></pre>")
941 if prop
.local_class
!= mclass
then add_html
("inherited from {prop.local_class.intro_mmodule.name} ")
942 #TODO display show code if doc github
943 add_html
("defined by the module <a href=\"{prop.intro_mclassdef.mmodule.name}.html\
">{prop.intro_mclassdef.mmodule.name}</a> {if prop.apropdef is null then "" else show_source(prop.apropdef.location)}.")
945 for parent
in mclass
.parents
do
946 if prop
isa MMethod then if parent
.constructors
.has
(prop
) then add_html
(" Previously defined by: <a href=\"{parent.intro_mmodule.name}.html\
">{parent.intro_mmodule.name}</a> for <a href=\"{parent.name}.html\
">{parent.name}</a>.")
960 var destinationdir
: String
961 var source
: nullable String
964 add
("meta").attr
("charset", "utf-8")
965 add
("script").attr
("type", "text/javascript").attr
("src", "scripts/jquery-1.7.1.min.js")
966 add
("script").attr
("type", "text/javascript").attr
("src", "quicksearch-list.js")
967 add
("script").attr
("type", "text/javascript").attr
("src", "scripts/js-facilities.js")
968 add
("link").attr
("rel", "stylesheet").attr
("href", "styles/main.css").attr
("type", "text/css").attr
("media", "screen")
971 redef fun body
do header
974 # Generate a clickable graphviz image using a dot content
975 fun generate_dot
(dot
: String, name
: String, alt
: String) do
976 if opt_nodot
then return
977 var file
= new OFStream.open
("{self.destinationdir}/{name}.dot")
980 sys
.system
("\{ test -f {self.destinationdir}/{name}.png && test -f {self.destinationdir}/{name}.s.dot && diff {self.destinationdir}/{name}.dot {self.destinationdir}/{name}.s.dot >/dev/null 2>&1 ; \} || \{ cp {self.destinationdir}/{name}.dot {self.destinationdir}/{name}.s.dot && dot -Tpng -o{self.destinationdir}/{name}.png -Tcmapx -o{self.destinationdir}/{name}.map {self.destinationdir}/{name}.s.dot ; \}")
981 open
("article").add_class
("graph")
982 add
("img").attr
("src", "{name}.png").attr
("usemap", "#{name}").attr
("style", "margin:auto").attr
("alt", "{alt}")
984 var fmap
= new IFStream.open
("{self.destinationdir}/{name}.map")
985 add_html
(fmap
.read_all
)
989 # Add a (source) link fo a given location
990 fun show_source
(l
: Location): String
992 if source
== null then
993 return "({l.file.filename.simplify_path})"
995 # THIS IS JUST UGLY ! (but there is no replace yet)
996 var x
= source
.split_with
("%f")
997 source
= x
.join
(l
.file
.filename
.simplify_path
)
998 x
= source
.split_with
("%l")
999 source
= x
.join
(l
.line_start
.to_s
)
1000 x
= source
.split_with
("%L")
1001 source
= x
.join
(l
.line_end
.to_s
)
1002 return " (<a href=\"{source.to_s}\
">show code</a>)"
1009 private fun comment
: String do
1011 if n_moduledecl
is null or n_moduledecl
.n_doc
is null then ret
1012 if n_moduledecl
.n_doc
is null then return ""
1013 for t
in n_moduledecl
.n_doc
.n_comment
do
1014 ret
+= "{t.text.replace("# ", "")}"
1019 private fun short_comment
: String do
1021 if n_moduledecl
!= null and n_moduledecl
.n_doc
!= null then
1022 var txt
= n_moduledecl
.n_doc
.n_comment
.first
.text
1023 txt
= txt
.replace
("# ", "")
1024 txt
= txt
.replace
("\n", "")
1034 redef type OTHER: MModule
1035 redef fun <(other
: OTHER): Bool do return self.name
< other
.name
1037 var amodule
: nullable AModule
1039 # Get the list of all methods in a module
1040 fun imported_methods
: Set[MMethod] do
1041 var methods
= new HashSet[MMethod]
1042 for mclass
in imported_mclasses
do
1043 for method
in mclass
.intro_methods
do
1050 # Get the list aof all refined methods in a module
1051 fun redef_methods
: Set[MMethod] do
1052 var methods
= new HashSet[MMethod]
1053 for mclass
in redef_mclasses
do
1054 for method
in mclass
.intro_methods
do
1062 redef class MProperty
1065 redef type OTHER: MProperty
1066 redef fun <(other
: OTHER): Bool do return self.name
< other
.name
1069 var apropdef
: nullable APropdef
1071 redef init(intro_mclassdef
: MClassDef, name
: String, visibility
: MVisibility)
1077 fun local_class
: MClass do
1078 var classdef
= self.intro_mclassdef
1079 return classdef
.mclass
1082 fun class_text
: String do
1083 return local_class
.name
1086 fun link_anchor
: String do
1087 return "{class_text}.html#{anchor}"
1090 fun anchor
: String do
1091 return "PROP_{c_name}"
1099 redef type OTHER: MClass
1100 redef fun <(other
: OTHER): Bool do return self.name
< other
.name
1102 # Associate all MMethods to each MModule concerns
1103 fun all_methods
: HashMap[MModule, Set[MMethod]] do
1104 var hm
= new HashMap[MModule, Set[MMethod]]
1105 for mmodule
, childs
in concerns
do
1106 if not hm
.has_key
(mmodule
) then hm
[mmodule
] = new HashSet[MMethod]
1107 for prop
in intro_methods
do
1108 if mmodule
== prop
.intro_mclassdef
.mmodule
then
1109 prop
.is_redef
= false
1110 hm
[mmodule
].add
(prop
)
1113 for prop
in redef_methods
do
1114 if mmodule
== prop
.intro_mclassdef
.mmodule
then
1115 prop
.is_redef
= true
1116 hm
[mmodule
].add
(prop
)
1120 if childs
!= null then
1121 for child
in childs
do
1122 if not hm
.has_key
(child
) then hm
[child
] = new HashSet[MMethod]
1123 for prop
in intro_methods
do
1124 if child
== prop
.intro_mclassdef
.mmodule
then
1125 prop
.is_redef
= false
1129 for prop
in redef_methods
do
1130 if child
== prop
.intro_mclassdef
.mmodule
then
1131 prop
.is_redef
= true
1141 fun public_owner
: MModule do
1142 var owner
= intro_mmodule
1143 if owner
.public_owner
is null then
1146 return owner
.public_owner
.as(not null)
1150 # Associate Amodule to all MModule concern by 'self'
1151 fun amodule
(amodules
: HashMap[MModule, AModule]) do
1152 for owner
, childs
in concerns
do
1153 if childs
!= null then for child
in childs
do child
.amodule
= amodules
[child
]
1154 owner
.amodule
= amodules
[owner
]
1158 # Associate MClass to all MMethod include in 'inherited_methods'
1159 fun inherited
: HashMap[MClass, Set[MMethod]] do
1160 var hm
= new HashMap[MClass, Set[MMethod]]
1161 for method
in inherited_methods
do
1162 var mclass
= method
.intro_mclassdef
.mclass
1163 if not hm
.has_key
(mclass
) then hm
[mclass
] = new HashSet[MMethod]
1164 hm
[mclass
].add
(method
)
1169 # Return true if MModule concern contain subMModule
1170 fun has_mmodule
(sub
: MModule): Bool do
1171 for mmodule
, childs
in concerns
do
1172 if childs
is null then continue
1173 if childs
.has
(sub
) then return true
1178 fun mmethod
(mprop2npropdef
: Map[MProperty, APropdef]) do
1179 for const
in constructors
do
1180 if mprop2npropdef
.has_key
(const
)then
1181 const
.apropdef
= mprop2npropdef
[const
].as(AMethPropdef)
1185 for intro
in intro_methods
do
1186 if mprop2npropdef
.has_key
(intro
)then
1187 if mprop2npropdef
[intro
] isa AMethPropdef then intro
.apropdef
= mprop2npropdef
[intro
].as(AMethPropdef)
1191 for rd
in redef_methods
do
1192 if mprop2npropdef
.has_key
(rd
)then
1193 if mprop2npropdef
[rd
] isa AMethPropdef then rd
.apropdef
= mprop2npropdef
[rd
].as(AMethPropdef)
1198 fun link_anchor
: String do
1199 return "{name}.html"
1204 redef class AStdClassdef
1205 private fun comment
: String do
1207 if n_doc
!= null then
1208 for t
in n_doc
.n_comment
do
1209 var txt
= t
.text
.replace
("# ", "")
1210 txt
= txt
.replace
("#", "")
1217 private fun short_comment
: String do
1219 if n_doc
!= null then
1220 var txt
= n_doc
.n_comment
.first
.text
1221 txt
= txt
.replace
("# ", "")
1222 txt
= txt
.replace
("\n", "")
1229 redef class ASignature
1233 if not n_params
.is_empty
then
1234 ret
= "{ret}({n_params.join(", ")})"
1236 if n_type
!= null and n_type
.to_s
!= "" then ret
+= " {n_type.to_s}"
1243 var ret
= "{n_id.text}"
1244 if n_type
!= null then
1245 ret
= "{ret}: {n_type.to_s}"
1246 if n_dotdotdot
!= null then ret
= "{ret}..."
1254 var ret
= "<a href=\"{n_id.text}.html\
">{n_id.text}</a>"
1255 if n_kwnullable
!= null then ret
= "nullable {ret}"
1256 if not n_types
.is_empty
then ret
= "{ret}[{n_types.join(", ")}]"
1261 redef class APropdef
1262 private fun short_comment
: String is abstract
1263 private fun signature
: String is abstract
1264 private fun comment
: String is abstract
1267 redef class AAttrPropdef
1268 redef fun short_comment
do
1270 if n_doc
!= null then
1271 var txt
= n_doc
.n_comment
.first
.text
1272 txt
= txt
.replace
("# ", "")
1273 txt
= txt
.replace
("\n", "")
1280 redef class AMethPropdef
1281 redef fun short_comment
do
1283 if n_doc
!= null then
1284 var txt
= n_doc
.n_comment
.first
.text
1285 txt
= txt
.replace
("# ", "")
1286 txt
= txt
.replace
("\n", "")
1292 redef fun signature
: String do
1294 if n_signature
!= null then sign
= " {n_signature.to_s}"
1298 redef private fun comment
: String do
1300 if n_doc
!= null then
1301 for t
in n_doc
.n_comment
do
1302 var txt
= t
.text
.replace
("# ", "")
1303 txt
= txt
.replace
("#", "")
1311 redef class MClassDef
1312 private fun namespace
(mclass
: MClass): String do
1314 if mmodule
.public_owner
is null then
1315 return "{mmodule.full_name}::{mclass.name}"
1316 else if mclass
is self.mclass
then
1317 return "{mmodule.public_owner.name}::{mclass.name}"
1319 return "{mmodule.public_owner.name}::<a href=\"{mclass.name}.html\
">{mclass.name}</a>"
1326 return to_a
[length-1
]
1330 # Create a tool context to handle options and paths
1331 var toolcontext
= new ToolContext
1333 # Here we launch the nit index
1334 var nitdoc
= new Nitdoc(toolcontext
)