nitweb: allow options in graph card
[nit.git] / src / web / api_docdown.nit
index 7e410ad..a5ca012 100644 (file)
@@ -58,11 +58,36 @@ class NitwebDecorator
        # Modelbuilder used to access code
        var modelbuilder: ModelBuilder
 
+       redef fun add_span_code(v, buffer, from, to) do
+               var text = new FlatBuffer
+               buffer.read(text, from, to)
+               var name = text.write_to_string
+               name = name.replace("nullable ", "")
+               var mentity = try_find_mentity(view, name)
+               if mentity == null then
+                       super
+               else
+                       v.add "<code>"
+                       v.write_mentity_link(mentity, text.write_to_string)
+                       v.add "</code>"
+               end
+       end
+
+       private fun try_find_mentity(view: ModelView, text: String): nullable MEntity do
+               var mentity = view.mentity_by_full_name(text)
+               if mentity != null then return mentity
+
+               var mentities = view.mentities_by_name(text)
+               if mentities.is_empty then
+                       return null
+               else if mentities.length > 1 then
+                       # TODO smart resolve conflicts
+               end
+               return mentities.first
+       end
+
        redef fun add_wikilink(v, token) do
-               var link = token.link
-               if link == null then return
-               var cmd = new DocCommand(link.write_to_string)
-               cmd.render(v, token, view)
+               v.render_wikilink(token, view)
        end
 end
 
@@ -77,20 +102,51 @@ class NitwebInlineDecorator
        var modelbuilder: ModelBuilder
 
        redef fun add_wikilink(v, token) do
-               var link = token.link
-               if link == null then return
-               var cmd = new DocCommand(link.write_to_string)
-               cmd.render(v, token, view)
+               v.render_wikilink(token, view)
        end
 end
 
 redef class MarkdownEmitter
+
+       # Parser used to process doc commands
+       var parser = new DocCommandParser
+
+       # Render a wikilink
+       fun render_wikilink(token: TokenWikiLink, model: ModelView) do
+               var link = token.link
+               if link == null then return
+               var name = token.name
+               if name != null then link = "{name} | {link}"
+               var cmd = parser.parse(link.write_to_string)
+               if cmd == null then
+                       var full_name = if token.link != null then token.link.as(not null).write_to_string.trim else null
+                       if full_name == null or full_name.is_empty then
+                               write_error("empty wikilink")
+                               return
+                       end
+                       var mentity = find_mentity(model, full_name)
+                       if mentity == null then return
+                       name = if token.name != null then token.name.as(not null).to_s else null
+                       write_mentity_link(mentity, name)
+                       return
+               else
+                       for message in parser.errors do
+                               if message.level == 1 then
+                                       write_error(message.message)
+                               else if message.level > 1 then
+                                       write_warning(message.message)
+                               end
+                       end
+               end
+               cmd.render(self, token, model)
+       end
+
        # Find the MEntity that matches `name`.
        #
        # Write an error if the entity is not found
        fun find_mentity(model: ModelView, name: nullable String): nullable MEntity do
                if name == null then
-                       write_error("No MEntity found")
+                       write_error("no MEntity found")
                        return null
                end
                # Lookup by full name
@@ -101,7 +157,7 @@ redef class MarkdownEmitter
                if mentities.is_empty then
                        var suggest = model.find(name, 3)
                        var msg = new Buffer
-                       msg.append "No MEntity found for name `{name}`"
+                       msg.append "no MEntity found for name `{name}`"
                        if suggest.not_empty then
                                msg.append " (suggestions: "
                                var i = 0
@@ -116,7 +172,7 @@ redef class MarkdownEmitter
                        return null
                else if mentities.length > 1 then
                        var msg = new Buffer
-                       msg.append "Conflicts for name `{name}`"
+                       msg.append "conflicts for name `{name}`"
                        msg.append " (conflicts: "
                        var i = 0
                        for s in mentities do
@@ -141,9 +197,9 @@ redef class MarkdownEmitter
        end
 
        # Write a link to a mentity in the output
-       fun write_mentity_link(mentity: MEntity) do
+       fun write_mentity_link(mentity: MEntity, text: nullable String) do
                var link = mentity.web_url
-               var name = mentity.name
+               var name = text or else mentity.name
                var mdoc = mentity.mdoc_or_fallback
                var comment = null
                if mdoc != null then comment = mdoc.synopsis
@@ -167,76 +223,44 @@ redef class MarkdownEmitter
        end
 end
 
-redef interface DocCommand
+redef class DocCommand
 
        # Emit the HTML related to the execution of this doc command
        fun render(v: MarkdownEmitter, token: TokenWikiLink, model: ModelView) do
-               v.write_error("Not yet implemented command `{token.link or else "null"}`")
+               v.write_error("not yet implemented command `{token.link or else "null"}`")
        end
 end
 
-redef class UnknownCommand
-       redef fun render(v, token, model) do
-               var link = token.link
-               if link == null then
-                       v.write_error("Empty command")
-                       return
-               end
-               var full_name = link.write_to_string
-               var mentity = v.find_mentity(model, full_name)
-               if mentity == null then return
-               v.write_mentity_link(mentity)
-       end
-end
-
-redef class ArticleCommand
+redef class CommentCommand
        redef fun render(v, token, model) do
-               if args.is_empty then
-                       v.write_error("Expected one arg: the MEntity name")
-                       return
-               end
-               var name = args.first
+               var name = arg
                var mentity = v.find_mentity(model, name)
                if mentity == null then return
                var mdoc = mentity.mdoc_or_fallback
                if mdoc == null then
-                       v.write_warning("No MDoc for mentity `{name}`")
+                       v.write_warning("no MDoc for mentity `{name}`")
                        return
                end
                v.add "<h3>"
-               v.write_mentity_link(mentity)
-               v.add " - "
-               v.emit_text mdoc.synopsis
-               v.add "</h3>"
-               v.add v.processor.process(mdoc.comment).write_to_string
-       end
-end
-
-redef class CommentCommand
-       redef fun render(v, token, model) do
-               if args.is_empty then
-                       v.write_error("Expected one arg: the MEntity name")
-                       return
+               if not opts.has_key("no-link") then
+                       v.write_mentity_link(mentity)
                end
-               var name = args.first
-               var mentity = v.find_mentity(model, name)
-               if mentity == null then return
-               var mdoc = mentity.mdoc_or_fallback
-               if mdoc == null then
-                       v.write_warning("No MDoc for mentity `{name}`")
-                       return
+               if not opts.has_key("no-link") and not opts.has_key("no-synopsis") then
+                       v.add " - "
+               end
+               if not opts.has_key("no-synopsis") then
+                       v.emit_text mdoc.html_synopsis.write_to_string
+               end
+               v.add "</h3>"
+               if not opts.has_key("no-comment") then
+                       v.add v.processor.process(mdoc.comment).write_to_string
                end
-               v.add v.processor.process(mdoc.comment).write_to_string
        end
 end
 
 redef class ListCommand
        redef fun render(v, token, model) do
-               if args.is_empty then
-                       v.write_error("Expected one arg: the MEntity name")
-                       return
-               end
-               var name = args.first
+               var name = arg
                var mentity = v.find_mentity(model, name)
                if mentity == null then return
                if mentity isa MPackage then
@@ -255,25 +279,21 @@ redef class ListCommand
                else if mentity isa MProperty then
                        v.write_mentity_list(mentity.mpropdefs)
                else
-                       v.write_error("No list found for name `{name}`")
+                       v.write_error("no list found for name `{name}`")
                end
        end
 end
 
 redef class CodeCommand
        redef fun render(v, token, model) do
-               if args.is_empty then
-                       v.write_error("Expected one arg: the MEntity name")
-                       return
-               end
-               var name = args.first
+               var name = arg
                var mentity = v.find_mentity(model, name)
                if mentity == null then return
                if mentity isa MClass then mentity = mentity.intro
                if mentity isa MProperty then mentity = mentity.intro
                var source = render_source(mentity, v.decorator.as(NitwebDecorator).modelbuilder)
                if source == null then
-                       v.write_error("No source for MEntity `{name}`")
+                       v.write_error("no source for MEntity `{name}`")
                        return
                end
                v.add "<pre>"
@@ -293,14 +313,27 @@ end
 
 redef class GraphCommand
        redef fun render(v, token, model) do
-               if args.is_empty then
-                       v.write_error("Expected one arg: the MEntity name")
-                       return
-               end
-               var name = args.first
+               var name = arg
                var mentity = v.find_mentity(model, name)
                if mentity == null then return
                var g = new InheritanceGraph(mentity, model)
-               v.add g.draw(3, 3).to_svg
+               var pdepth = if opts.has_key("pdepth") and opts["pdepth"].is_int then
+                       opts["pdepth"].to_i else 3
+               var cdepth = if opts.has_key("cdepth") and opts["cdepth"].is_int then
+                       opts["cdepth"].to_i else 3
+               v.add g.draw(pdepth, cdepth).to_svg
+       end
+end
+
+redef class Text
+       # Read `self` between `nstart` and `nend` (excluded) and writte chars to `out`.
+       private fun read(out: FlatBuffer, nstart, nend: Int): Int do
+               var pos = nstart
+               while pos < length and pos < nend do
+                       out.add self[pos]
+                       pos += 1
+               end
+               if pos == length then return -1
+               return pos
        end
 end