ni_nitdoc: fixed broken search with special caracters in JS
[nit.git] / src / ni_nitdoc.nit
index f4e54cd..f502981 100644 (file)
@@ -109,7 +109,7 @@ class Nitdoc
                        fullindex
                        modules
                        classes
-                       #quicksearch_list
+                       quicksearch_list
                end
        end
 
@@ -142,25 +142,31 @@ class Nitdoc
                var file = new OFStream.open("{output_dir.to_s}/quicksearch-list.js")
                var content = new Buffer
                content.append("var entries = \{ ")
-               for prop in model.mproperties do
-                       if not prop isa MMethod then continue
-                       content.append("\"{prop.name}\": [")
-                       for propdef in prop.mpropdefs do
-                               content.append("\{txt: \"{propdef.mproperty.full_name}\", url:\"{propdef.url}\" \}")
-                               if not propdef is prop.mpropdefs.last then content.append(", ")
-                       end
-                       content.append("]")
-                       content.append(", ")
-               end
 
+               for mmodule in model.mmodules do
+                       content.append("\"{mmodule.name}\": [")
+                       content.append("\{txt: \"{mmodule.name}\", url:\"{mmodule.url}\" \},")
+                       content.append("],")
+               end
                for mclass in model.mclasses do
+                       if mclass.visibility <= none_visibility then continue
                        content.append("\"{mclass.name}\": [")
-                       for mclassdef in mclass.mclassdefs do
-                               content.append("\{txt: \"{mclassdef.mclass.full_name}\", url:\"{mclass.url}\" \}")
-                               if not mclassdef is mclass.mclassdefs.last then content.append(", ")
+                       content.append("\{txt: \"{mclass.name}\", url:\"{mclass.url}\" \},")
+                       content.append("],")
+               end
+               var name2mprops = new HashMap[String, Set[MPropDef]]
+               for mproperty in model.mproperties do
+                       if mproperty.visibility <= none_visibility then continue
+                       if mproperty isa MAttribute then continue
+                       if not name2mprops.has_key(mproperty.name) then name2mprops[mproperty.name] = new HashSet[MPropDef]
+                       name2mprops[mproperty.name].add_all(mproperty.mpropdefs)
+               end
+               for mproperty, mpropdefs in name2mprops do
+                       content.append("\"{mproperty}\": [")
+                       for mpropdef in mpropdefs do
+                               content.append("\{txt: \"{mpropdef.full_name}\", url:\"{mpropdef.url}\" \},")
                        end
-                       content.append("]")
-                       if not mclass is model.mclasses.last then content.append(", ")
+                       content.append("],")
                end
 
                content.append(" \};")
@@ -862,7 +868,7 @@ class NitdocClass
                        # formal types
                        if mclass.arity > 0 and nclass isa AStdClassdef then
                                for ft, bound in mclass.parameter_types do
-                                       append("<article id='{ft}'>")
+                                       append("<article id='FT_{ft}'>")
                                        append("<h3 class='signature'>{ft}: {bound.link(mbuilder)}</h3>")
                                        append("<div class=\"info\">formal generic type</div>")
                                        append("</article>")
@@ -893,9 +899,9 @@ class NitdocClass
                                        var nowner = mbuilder.mmodule2nmodule[owner]
                                        append("<h3 class=\"concern-toplevel\">Methods refined in {owner.link(mbuilder)}</h3>")
                                        if nowner.short_comment.is_empty then
-                                               append("<p class=\"concern-doc\">{owner.name}</p>")
+                                               append("<p class=\"concern-doc\">{owner.link(mbuilder)}</p>")
                                        else
-                                               append("<p class=\"concern-doc\">{owner.name}: {nowner.short_comment}</p>")
+                                               append("<p class=\"concern-doc\">{owner.link(mbuilder)}: {nowner.short_comment}</p>")
                                        end
                                end
                                if concern2meths.has_key(owner) then
@@ -908,9 +914,9 @@ class NitdocClass
                                        var nmodule = mbuilder.mmodule2nmodule[mmodule]
                                        if mmodule != mclass.intro_mmodule and mmodule != mclass.public_owner then
                                                if nmodule.short_comment.is_empty then
-                                                       append("<p class=\"concern-doc\">{mmodule.name}</p>")
+                                                       append("<p class=\"concern-doc\">{mmodule.link(mbuilder)}</p>")
                                                else
-                                                       append("<p class=\"concern-doc\">{mmodule.name}: {nmodule.short_comment}</p>")
+                                                       append("<p class=\"concern-doc\">{mmodule.link(mbuilder)}: {nmodule.short_comment}</p>")
                                                end
                                        end
                                        var mmethods = concern2meths[mmodule]
@@ -1165,12 +1171,6 @@ redef class MProperty
                return "{intro_mclassdef.mclass.html_namespace(mbuilder)}::<span>{intro.link(mbuilder)}</span>"
        end
 
-       # Return the property signature decorated with html
-       fun html_signature(mbuilder: ModelBuilder): String do
-               var nprop = mbuilder.mpropdef2npropdef[intro]
-               return "{name}{nprop.html_signature(mbuilder)}"
-       end
-
        # Escape name for html output
        redef fun name do return super.html_escape
 end
@@ -1187,6 +1187,30 @@ redef class MNullableType
        redef fun link(mbuilder) do return "nullable {mtype.link(mbuilder)}"
 end
 
+redef class MGenericType
+       redef fun link(mbuilder) do
+               var res = new Buffer
+               res.append("<a href='{mclass.url}'>{mclass.name}</a>[")
+               for i in [0..arguments.length[ do
+                       res.append(arguments[i].link(mbuilder))
+                       if i < arguments.length - 1 then res.append(", ")
+               end
+               res.append("]")
+               return res.to_s
+       end
+end
+
+redef class MParameterType
+       redef fun link(mbuilder) do
+               var name = mclass.intro.parameter_names[rank]
+               return "<a href='{mclass.url}#FT_{name}' title='formal type'>{name}</a>"
+       end
+end
+
+redef class MVirtualType
+       redef fun link(mbuilder) do return mproperty.intro.link(mbuilder)
+end
+
 redef class MClassDef
        # Return the classdef namespace decorated with html
        fun html_namespace(mbuilder: ModelBuilder): String do
@@ -1250,6 +1274,10 @@ redef class MPropDef
 
        fun html_full_desc(page: NitdocClass): String is abstract
        fun html_info(page: NitdocClass): String is abstract
+
+       fun full_name: String do
+               return "{mclassdef.mclass.public_owner.name}::{mclassdef.mclass.name}::{mproperty.name}"
+       end
 end
 
 redef class MMethodDef
@@ -1273,7 +1301,16 @@ redef class MMethodDef
                        classes.add("public")
                end
                res.append("<article class='{classes.join(" ")}' id='{anchor}'>")
-               res.append("<h3 class='signature'>{mprop.html_signature(page.mbuilder)}</h3>")
+               if nprop isa AAttrPropdef then
+                       if nprop.mreadpropdef == self then
+                               res.append("<h3 class='signature'>{mprop.name}: {nprop.html_signature(page.mbuilder)}</h3>")
+                       else
+                               res.append("<h3 class='signature'>{mprop.name}(value: {nprop.html_signature(page.mbuilder)})</h3>")
+                       end
+               else
+                       var intro_nprop = page.mbuilder.mpropdef2npropdef[mprop.intro]
+                       res.append("<h3 class='signature'>{mprop.name}{intro_nprop.html_signature(page.mbuilder)}</h3>")
+               end
                res.append(html_info(page))
                res.append("<div class='description'>")
                if nprop.comment == "" then
@@ -1283,7 +1320,7 @@ redef class MMethodDef
                end
                res.append("<textarea id=\"fileContent\" class=\"edit\" cols=\"76\" rows=\"1\" style=\"display: none;\"></textarea><a id=\"cancelBtn\" style=\"display: none;\">Cancel</a><a id=\"commitBtn\" style=\"display: none;\">Commit</a><pre id=\"preSave\" class=\"text_label\" type=\"2\"></pre>")
                # definitions block
-               res.append("<p>")
+               res.append("<p class='info'>")
                page.nitdoc.mainmodule.linearize_mpropdefs(mprop.mpropdefs)
                var previous_defs = new Array[MMethodDef]
                var next_defs = new Array[MMethodDef]
@@ -1370,7 +1407,7 @@ redef class MVirtualTypeDef
                end
                res.append("<textarea id=\"fileContent\" class=\"edit\" cols=\"76\" rows=\"1\" style=\"display: none;\"></textarea><a id=\"cancelBtn\" style=\"display: none;\">Cancel</a><a id=\"commitBtn\" style=\"display: none;\">Commit</a><pre id=\"preSave\" class=\"text_label\" type=\"2\"></pre>")
                # definitions block
-               res.append("<p>")
+               res.append("<p class='info'>")
                page.nitdoc.mainmodule.linearize_mpropdefs(mprop.mpropdefs)
                var previous_defs = new Array[MVirtualTypeDef]
                var next_defs = new Array[MVirtualTypeDef]
@@ -1486,9 +1523,8 @@ redef class AAttrPropdef
        end
 
        redef fun html_signature(mbuilder) do
-               var res = ""
-               if n_type != null and n_type.to_html != "" then res += ": {n_type.to_html}"
-               return res
+               if n_type != null then return n_type.mtype.link(mbuilder)
+               return ""
        end
 end
 
@@ -1508,7 +1544,7 @@ redef class AMethPropdef
        end
 
        redef fun html_signature(mbuilder) do
-               if n_signature != null then return n_signature.to_html
+               if n_signature != null then return n_signature.to_html(mbuilder)
                return ""
        end
 end
@@ -1534,39 +1570,33 @@ redef class ATypePropdef
 end
 
 redef class ASignature
-       fun to_html: String do
+       fun to_html(mbuilder: ModelBuilder): String do
                #TODO closures
-               var ret = ""
+               var res = new Buffer
                if not n_params.is_empty then
-                       ret = "{ret}({n_params.join(", ")})"
+                       res.append("(")
+                       for i in [0..n_params.length[ do
+                               res.append(n_params[i].to_html(mbuilder))
+                               if i < n_params.length - 1 then res.append(", ")
+                       end
+                       res.append(")")
                end
-               if n_type != null and n_type.to_html != "" then ret += ": {n_type.to_html}"
-               return ret
+               if n_type != null and n_type.mtype.link(mbuilder) != "" then res.append(": {n_type.mtype.link(mbuilder)}")
+               return res.to_s
        end
 end
 
 redef class AParam
-       redef fun to_s do
+       fun to_html(mbuilder: ModelBuilder): String do
                var ret = "{n_id.text}"
                if n_type != null then
-                       ret = "{ret}: {n_type.to_html}"
+                       ret = "{ret}: {n_type.mtype.link(mbuilder)}"
                        if n_dotdotdot != null then ret = "{ret}..."
                end
                return ret
        end
 end
 
-redef class AType
-       fun to_html: String do
-               var ret = "<a href=\"{n_id.text}.html\">{n_id.text}</a>"
-               if n_kwnullable != null then ret = "nullable {ret}"
-               if not n_types.is_empty then ret = "{ret}[{n_types.join(", ")}]"
-               return ret
-       end
-
-       fun name: String do return n_id.text.html_escape
-end
-
 # Create a tool context to handle options and paths
 var toolcontext = new ToolContext