nit: Added link to `CONTRIBUTING.md` from the README
[nit.git] / src / nitweb.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 # Runs a webserver based on nitcorn that render things from model.
16 module nitweb
17
18 import frontend
19 import web
20
21 redef class ToolContext
22
23 # Host name to bind on.
24 var opt_host = new OptionString("Host to bind the server on", "--host")
25
26 # Port number to bind on.
27 var opt_port = new OptionInt("Port number to use", 3000, "--port")
28
29 # Web rendering phase.
30 var webphase: Phase = new NitwebPhase(self, null)
31
32 init do
33 super
34 option_context.add_option(opt_host, opt_port)
35 end
36 end
37
38 # Phase that builds the model and wait for http request to serve pages.
39 private class NitwebPhase
40 super Phase
41 redef fun process_mainmodule(mainmodule, mmodules)
42 do
43 var model = mainmodule.model
44 var modelbuilder = toolcontext.modelbuilder
45
46 # Run the server
47 var host = toolcontext.opt_host.value or else "localhost"
48 var port = toolcontext.opt_port.value
49
50 var app = new App
51 app.use("/random", new RandomAction(model))
52 app.use("/doc/:namespace", new DocAction(model, modelbuilder))
53 app.use("/code/:namespace", new CodeAction(model, modelbuilder))
54 app.use("/search/:namespace", new SearchAction(model))
55 app.use("/uml/:namespace", new UMLDiagramAction(model, mainmodule))
56 app.use("/", new TreeAction(model))
57
58 app.listen(host, port.to_i)
59 end
60 end
61
62 # build toolcontext
63 var toolcontext = new ToolContext
64 var tpl = new Template
65 tpl.add "Usage: nitweb [OPTION]... <file.nit>...\n"
66 tpl.add "Run a webserver based on nitcorn that serve pages about model."
67 toolcontext.tooldescription = tpl.write_to_string
68
69 # process options
70 toolcontext.process_options(args)
71 var arguments = toolcontext.option_context.rest
72
73 # build model
74 var model = new Model
75 var mbuilder = new ModelBuilder(model, toolcontext)
76 var mmodules = mbuilder.parse_full(arguments)
77
78 # process
79 if mmodules.is_empty then return
80 mbuilder.run_phases
81 toolcontext.run_global_phases(mmodules)