1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # `nitx`, is a command tool that displays useful informations about the code.
19 # * Display comment from name/namespace
20 # * Display documentation page from Nitdoc in console
21 # * Find type usage in parameters, returns and news.
22 # * Find usage of a specific property.
23 # * Find source code related to class/property by its name.
27 import doc
::doc_phases
::doc_console
29 redef class ToolContext
31 # Nittx generation phase.
32 var docx
: Phase = new NitxPhase(self, null)
34 # Used to shortcut the prompt and display directly the result in console.
35 var opt_command
= new OptionString("Nitx command to perform", "-c", "--command")
37 init do option_context
.add_option opt_command
40 # Nitx phase explores the model and prepares the console rendering.
41 private class NitxPhase
43 redef fun process_mainmodule
(mainmodule
, mmodules
)
45 var doc
= new DocModel(mainmodule
.model
, mainmodule
)
48 new ExtractionPhase(toolcontext
, doc
),
49 new MakePagePhase(toolcontext
, doc
),
50 new ConcernsPhase(toolcontext
, doc
),
51 new StructurePhase(toolcontext
, doc
),
52 new POSetPhase(toolcontext
, doc
): DocPhase]
54 for phase
in phases
do
55 toolcontext
.info
("# {phase.class_name}", 1)
60 var nitx
= new Nitx(toolcontext
, doc
)
61 var q
= toolcontext
.opt_command
.value
62 if q
!= null then # shortcut prompt
72 var toolcontext
= new ToolContext
73 var tpl
= new Template
74 tpl
.add
"Usage: nitx [OPTION]... <file.nit>... [query]\n"
75 tpl
.add
"Displays specific pieces of API information from Nit source files."
76 toolcontext
.tooldescription
= tpl
.write_to_string
79 toolcontext
.process_options
(args
)
80 var arguments
= toolcontext
.option_context
.rest
84 var mbuilder
= new ModelBuilder(model
, toolcontext
)
85 var mmodules
= mbuilder
.parse_full
(arguments
)
88 if mmodules
.is_empty
then return
90 toolcontext
.run_global_phases
(mmodules
)