src/nitx.nit

   1 # This file is part of NIT ( http://www.nitlanguage.org ).
   2 #
   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
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   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.
  14
  15 # `nitx`, is a command tool that displays useful informations about the code.
  16 #
  17 # Features:
  18 #
  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.
  24 module nitx
  25
  26 import modelbuilder
  27 import doc::doc_phases::doc_console
  28
  29 redef class ToolContext
  30
  31         # Nittx generation phase.
  32         var docx: Phase = new NitxPhase(self, null)
  33
  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")
  36
  37         init do option_context.add_option opt_command
  38 end
  39
  40 # Nitx phase explores the model and prepares the console rendering.
  41 private class NitxPhase
  42         super Phase
  43         redef fun process_mainmodule(mainmodule, mmodules)
  44         do
  45                 var doc = new DocModel(mainmodule.model, mainmodule)
  46
  47                 var phases = [
  48                         new MakePagePhase(toolcontext, doc),
  49                         new ConcernsPhase(toolcontext, doc),
  50                         new StructurePhase(toolcontext, doc),
  51                         new POSetPhase(toolcontext, doc): DocPhase]
  52
  53                 for phase in phases do
  54                         toolcontext.info("# {phase.class_name}", 1)
  55                         phase.apply
  56                 end
  57
  58                 # start nitx
  59                 var nitx = new Nitx(toolcontext, doc)
  60                 var q = toolcontext.opt_command.value
  61                 if q != null then # shortcut prompt
  62                         print ""
  63                         nitx.do_query(q)
  64                         return
  65                 end
  66                 nitx.start
  67         end
  68 end
  69
  70 # build toolcontext
  71 var toolcontext = new ToolContext
  72 var tpl = new Template
  73 tpl.add "Usage: nitx [OPTION]... <file.nit>... [query]\n"
  74 tpl.add "Displays specific pieces of API information from Nit source files."
  75 toolcontext.tooldescription = tpl.write_to_string
  76
  77 # process options
  78 toolcontext.process_options(args)
  79 var arguments = toolcontext.option_context.rest
  80
  81 # build model
  82 var model = new Model
  83 var mbuilder = new ModelBuilder(model, toolcontext)
  84 var mmodules = mbuilder.parse_full(arguments)
  85
  86 # process
  87 if mmodules.is_empty then return
  88 mbuilder.run_phases
  89 toolcontext.run_global_phases(mmodules)