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 module nitx
  22
  23 import modelbuilder
  24 import doc::doc_phases::doc_console
  25
  26 redef class ToolContext
  27
  28         # Nittx generation phase.
  29         var docx: Phase = new NitxPhase(self, null)
  30
  31         # Used to shortcut the prompt and display directly the result in console.
  32         var opt_query = new OptionString("Nitx query to perform", "-q", "--query")
  33
  34         init do option_context.add_option opt_query
  35 end
  36
  37 # Nitx phase explores the model and prepares the console rendering.
  38 private class NitxPhase
  39         super Phase
  40         redef fun process_mainmodule(mainmodule, mmodules)
  41         do
  42                 var doc = new DocModel(mainmodule.model, mainmodule)
  43
  44                 var phases = [
  45                         new ExtractionPhase(toolcontext, doc),
  46                         new MakePagePhase(toolcontext, doc),
  47                         new ConcernsPhase(toolcontext, doc),
  48                         new StructurePhase(toolcontext, doc): DocPhase]
  49
  50                 for phase in phases do
  51                         toolcontext.info("# {phase.class_name}", 1)
  52                         phase.apply
  53                 end
  54
  55                 # start nitx
  56                 var nitx = new Nitx(toolcontext, doc)
  57                 var q = toolcontext.opt_query.value
  58                 if q != null then # shortcut prompt
  59                         print ""
  60                         nitx.do_query(q)
  61                         return
  62                 end
  63                 nitx.start
  64         end
  65 end
  66
  67 # build toolcontext
  68 var toolcontext = new ToolContext
  69 var tpl = new Template
  70 tpl.add "Usage: nitx [OPTION]... <file.nit>... [query]\n"
  71 tpl.add "Displays specific pieces of API information from Nit source files."
  72 toolcontext.tooldescription = tpl.write_to_string
  73
  74 # process options
  75 toolcontext.process_options(args)
  76 var arguments = toolcontext.option_context.rest
  77
  78 # build model
  79 var model = new Model
  80 var mbuilder = new ModelBuilder(model, toolcontext)
  81 var mmodules = mbuilder.parse_full(arguments)
  82
  83 # process
  84 if mmodules.is_empty then return
  85 mbuilder.run_phases
  86 toolcontext.run_global_phases(mmodules)