# This file is part of NIT ( http://www.nitlanguage.org ).
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# HTML templates for Nit model MEntities.
module html_model
import doc_base
import doc_down
import html_components
import html::bootstrap
import ordered_tree
redef class MEntity
# ID used as a HTML unique ID and in file names.
#
# **Must** match the following (POSIX ERE) regular expression:
#
# ~~~POSIX ERE
# ^[A-Za-z_][A-Za-z0-9._-]*$
# ~~~
#
# That way, the ID is always a valid URI component and a valid XML name.
fun nitdoc_id: String is abstract
# URL of this entity’s Nitdoc page.
fun nitdoc_url: String is abstract
# Returns the mentity name without short signature.
#
# * MProject: `foo`
# * MGroup: `foo`
# * MModule: `foo`
# * MClass: `Foo[E]`
# * MClassDef: `Foo[E]`
# * MProperty: `foo(e)`
# * MPropdef: `foo(e)`
var html_name: String is lazy do return name.html_escape
# Returns a Link to the mentity `html_url`.
#
# Example: `html_short_name
var html_link: Link is lazy do
var tpl = new Link(nitdoc_url, html_name)
var mdoc = mdoc_or_fallback
if mdoc != null then
tpl.title = mdoc.short_comment
end
return tpl
end
# Returns a Link to the mentity `nitdoc_id`.
#
# Example: `html_short_name
fun html_link_to_anchor: Link do
var tpl = new Link("#{nitdoc_id}", html_name)
var mdoc = mdoc_or_fallback
if mdoc != null then
tpl.title = mdoc.short_comment
end
return tpl
end
# Returns the list of keyword used in `self` declaration.
fun html_modifiers: Array[String] is abstract
# Returns the complete MEntity declaration decorated with HTML.
#
# * MProject: `project foo`
# * MGroup: `group foo`
# * MModule: `module foo`
# * MClass: `private abstract class Foo[E: Object]`
# * MClassDef: `redef class Foo[E]`
# * MProperty: `private fun foo(e: Object): Int`
# * MPropdef: `redef fun foo(e)`
fun html_declaration: Template do
var tpl = new Template
tpl.add ""
tpl.add html_modifiers.join(" ")
tpl.add " "
tpl.add html_link
tpl.add ""
return tpl
end
# Returns `self` namespace decorated with HTML links.
#
# * MProject: `mproject`
# * MGroup: `mproject(::group)`
# * MModule: `mgroup::mmodule`
# * MClass: `mproject::mclass`
# * MClassDef: `mmodule::mclassdef`
# * MProperty: `mclass::mprop`
# * MPropdef: `mclassdef:mpropdef`
fun html_namespace: Template is abstract
# Returns the comment of this MEntity formatted as HTML.
var html_comment: nullable Writable is lazy do
var mdoc = mdoc_or_fallback
if mdoc == null then return null
return mdoc.tpl_comment
end
# Returns the comment of this MEntity formatted as HTML.
var html_short_comment: nullable Writable is lazy do
var mdoc = mdoc_or_fallback
if mdoc == null then return null
return mdoc.tpl_short_comment
end
end
redef class MProject
redef var nitdoc_id = name.to_cmangle is lazy
redef fun nitdoc_url do return root.nitdoc_url
redef var html_modifiers = ["project"]
redef fun html_namespace do return html_link
end
redef class MGroup
redef var nitdoc_id is lazy do
if parent != null then
return "{parent.nitdoc_id}__{name.to_cmangle}"
end
return name.to_cmangle
end
redef fun nitdoc_url do return "group_{nitdoc_id}.html"
redef var html_modifiers = ["group"]
# Depends if `self` is root or not.
#
# * If root `mproject`.
# * Else `mproject::self`.
redef fun html_namespace do
var tpl = new Template
tpl.add mproject.html_namespace
if mproject.root != self then
tpl.add "::"
tpl.add html_link
end
return tpl
end
end
redef class MModule
redef var nitdoc_id is lazy do
if mgroup != null then
if mgroup.mmodules.length == 1 then
return "{mgroup.nitdoc_id}-"
else
return "{mgroup.nitdoc_id}__{name.to_cmangle}"
end
end
return name.to_cmangle
end
redef fun nitdoc_url do return "module_{nitdoc_id}.html"
redef var html_modifiers = ["module"]
# Depends if `self` belongs to a MGroup.
#
# * If mgroup `mgroup::self`.
# * Else `self`.
redef fun html_namespace do
var tpl = new Template
if mgroup != null then
tpl.add mgroup.html_namespace
tpl.add "::"
end
tpl.add html_link
return tpl
end
end
redef class MClass
redef var nitdoc_id = "{intro_mmodule.nitdoc_id}__{name.to_cmangle}" is lazy
redef fun nitdoc_url do return "class_{nitdoc_id}.html"
redef fun mdoc_or_fallback do return intro.mdoc
# Format: `Foo[E]`
redef var html_name is lazy do
var tpl = new Template
tpl.add name.html_escape
if arity > 0 then
tpl.add "["
var parameter_names = new Array[String]
for p in mparameters do
parameter_names.add(p.html_name)
end
tpl.add parameter_names.join(", ")
tpl.add "]"
end
return tpl.write_to_string
end
redef fun html_modifiers do return intro.html_modifiers
redef fun html_declaration do return intro.html_declaration
# Returns `mproject::self`.
redef fun html_namespace do
var tpl = new Template
tpl.add intro_mmodule.mgroup.mproject.html_namespace
tpl.add "::"
tpl.add html_link
tpl.add ""
return tpl
end
# Returns `intro.html_short_signature`.
fun html_short_signature: Template do return intro.html_short_signature
# Returns `intro.html_signature`.
fun html_signature: Template do return intro.html_signature
end
redef class MClassDef
redef var nitdoc_id = "{mmodule.nitdoc_id}__{name.to_cmangle}" is lazy
redef fun nitdoc_url do return "{mclass.nitdoc_url}#{nitdoc_id}"
redef fun mdoc_or_fallback do return mdoc or else mclass.mdoc_or_fallback
# Depends if `self` is an intro or not.
#
# * If intro contains the visibility and kind.
# * If redef contains the `redef` keyword and kind.
redef fun html_modifiers do
var res = new Array[String]
if not is_intro then
res.add "redef"
else
if mclass.visibility != public_visibility then
res.add mclass.visibility.to_s
end
end
res.add mclass.kind.to_s
return res
end
# Depends if `self` is an intro or not.
#
# For intro: `private abstract class Foo[E: Object]`
# For redef: `redef class Foo[E]`
# TODO change the implementation to correspond to the comment.
redef fun html_declaration do
var tpl = new Template
tpl.add ""
tpl.add html_modifiers.join(" ")
tpl.add " "
tpl.add html_link
tpl.add html_signature
tpl.add ""
return tpl
end
# Returns `mmodule::self`
redef fun html_namespace do
var tpl = new Template
tpl.add mmodule.html_namespace
tpl.add "::"
tpl.add mclass.html_link
tpl.add ""
return tpl
end
# Returns the MClassDef generic signature without static bounds.
fun html_short_signature: Template do
var tpl = new Template
var mparameters = mclass.mparameters
if not mparameters.is_empty then
tpl.add "["
for i in [0..mparameters.length[ do
tpl.add mparameters[i].html_name
if i < mparameters.length - 1 then tpl.add ", "
end
tpl.add "]"
end
return tpl
end
# Returns the MClassDef generic signature with static bounds.
fun html_signature: Template do
var tpl = new Template
var mparameters = mclass.mparameters
if not mparameters.is_empty then
tpl.add "["
for i in [0..mparameters.length[ do
tpl.add "{mparameters[i].html_name}: "
tpl.add bound_mtype.arguments[i].html_signature
if i < mparameters.length - 1 then tpl.add ", "
end
tpl.add "]"
end
return tpl
end
end
redef class MProperty
redef var nitdoc_id = "{intro_mclassdef.mclass.nitdoc_id}__{name.to_cmangle}" is lazy
redef fun nitdoc_url do return "property_{nitdoc_id}.html"
redef fun mdoc_or_fallback do return intro.mdoc
redef fun html_modifiers do return intro.html_modifiers
redef fun html_declaration do return intro.html_declaration
# Returns `mclass::self`.
redef fun html_namespace do
var tpl = new Template
tpl.add intro_mclassdef.mclass.html_namespace
tpl.add "::"
tpl.add intro.html_link
tpl.add ""
return tpl
end
# Returns `intro.html_short_signature`.
fun html_short_signature: Template do return intro.html_short_signature
# Returns `intro.html_signature`.
fun html_signature: Template do return intro.html_signature
end
redef class MPropDef
redef var nitdoc_id = "{mclassdef.nitdoc_id}__{name.to_cmangle}" is lazy
redef fun nitdoc_url do return "{mproperty.nitdoc_url}#{nitdoc_id}"
redef fun mdoc_or_fallback do return mdoc or else mproperty.mdoc_or_fallback
# Depends if `self` is an intro or not.
#
# * If intro contains the visibility and kind.
# * If redef contains the `redef` keyword and kind.
redef fun html_modifiers do
var res = new Array[String]
if not is_intro then
res.add "redef"
else
if mproperty.visibility != public_visibility then
res.add mproperty.visibility.to_s
end
end
return res
end
# Depends if `self` is an intro or not.
#
# For intro: `private fun foo(e: Object): Bar is abstract`
# For redef: `redef fun foo(e) is cached`
# TODO change the implementation to correspond to the comment.
redef fun html_declaration do
var tpl = new Template
tpl.add ""
tpl.add html_modifiers.join(" ")
tpl.add " "
tpl.add html_link
tpl.add html_signature
tpl.add ""
return tpl
end
# Returns `mclassdef::self`
redef fun html_namespace do
var tpl = new Template
tpl.add mclassdef.html_namespace
tpl.add "::"
tpl.add html_link
return tpl
end
# Returns the MPropdDef signature without static types.
fun html_short_signature: Template is abstract
# Returns the MPropDef signature with static types.
fun html_signature: Template is abstract
end
redef class MAttributeDef
redef fun html_modifiers do
var res = super
res.add "var"
return res
end
redef fun html_short_signature do return new Template
redef fun html_signature do
var tpl = new Template
if static_mtype != null then
tpl.add ": "
tpl.add static_mtype.html_signature
end
return tpl
end
end
redef class MMethodDef
# FIXME annotation should be handled in their own way
redef fun html_modifiers do
var res = super
if is_abstract then
res.add "abstract"
else if is_intern then
res.add "intern"
end
if mproperty.is_init then
res.add "init"
else
res.add "fun"
end
return res
end
redef fun html_short_signature do return msignature.html_short_signature
redef fun html_signature do return msignature.html_signature
end
redef class MVirtualTypeProp
redef fun html_link do return mvirtualtype.html_link
end
redef class MVirtualTypeDef
redef fun html_modifiers do
var res = super
res.add "type"
return res
end
redef fun html_short_signature do return new Template
redef fun html_signature do
var tpl = new Template
if bound == null then return tpl
tpl.add ": "
tpl.add bound.html_signature
return tpl
end
end
redef class MType
# Returns the signature of this type whithout bounds.
fun html_short_signature: Template is abstract
# Returns the signature of this type.
fun html_signature: Template is abstract
end
redef class MClassType
redef fun html_link do return mclass.html_link
redef fun html_short_signature do return html_link
redef fun html_signature do return html_link
end
redef class MNullableType
redef fun html_short_signature do
var tpl = new Template
tpl.add "nullable "
tpl.add mtype.html_short_signature
return tpl
end
redef fun html_signature do
var tpl = new Template
tpl.add "nullable "
tpl.add mtype.html_signature
return tpl
end
end
redef class MGenericType
redef fun html_short_signature do
var lnk = html_link
var tpl = new Template
tpl.add new Link.with_title(lnk.href, mclass.name.html_escape, lnk.title)
tpl.add "["
for i in [0..arguments.length[ do
tpl.add arguments[i].html_short_signature
if i < arguments.length - 1 then tpl.add ", "
end
tpl.add "]"
return tpl
end
redef fun html_signature do
var lnk = html_link
var tpl = new Template
tpl.add new Link.with_title(lnk.href, mclass.name.html_escape, lnk.title)
tpl.add "["
for i in [0..arguments.length[ do
tpl.add arguments[i].html_signature
if i < arguments.length - 1 then tpl.add ", "
end
tpl.add "]"
return tpl
end
end
redef class MParameterType
redef fun html_link do
return new Link.with_title("{mclass.nitdoc_url}#FT_{name.to_cmangle}", name, "formal type")
end
redef fun html_short_signature do return html_link
redef fun html_signature do return html_link
end
redef class MVirtualType
redef fun html_link do return mproperty.intro.html_link
redef fun html_signature do return html_link
end
redef class MSignature
redef fun html_short_signature do
var tpl = new Template
if not mparameters.is_empty then
tpl.add "("
for i in [0..mparameters.length[ do
tpl.add mparameters[i].html_short_signature
if i < mparameters.length - 1 then tpl.add ", "
end
tpl.add ")"
end
return tpl
end
redef fun html_signature do
var tpl = new Template
if not mparameters.is_empty then
tpl.add "("
for i in [0..mparameters.length[ do
tpl.add mparameters[i].html_signature
if i < mparameters.length - 1 then tpl.add ", "
end
tpl.add ")"
end
if return_mtype != null then
tpl.add ": "
tpl.add return_mtype.html_signature
end
return tpl
end
end
redef class MParameter
# Returns `self` name and ellipsys if any.
fun html_short_signature: Template do
var tpl = new Template
tpl.add name
if is_vararg then tpl.add "..."
return tpl
end
# Returns `self` name with it's static type and ellipsys if any.
fun html_signature: Template do
var tpl = new Template
tpl.add "{name}: "
tpl.add mtype.html_signature
if is_vararg then tpl.add "..."
return tpl
end
end
################################################################################
# Additions to `model_ext`.
redef class MRawType
redef fun html_signature do
var tpl = new Template
for part in parts do
if part.target != null then
tpl.add part.target.as(not null).html_link
else
tpl.add part.text.html_escape
end
end
return tpl
end
end
redef class MInnerClass
redef fun nitdoc_url do return inner.nitdoc_url
redef fun html_signature do return inner.html_signature
end
redef class MInnerClassDef
redef fun nitdoc_url do return inner.nitdoc_url
redef fun html_link_to_anchor do return inner.html_link_to_anchor
redef fun html_link do return inner.html_link
redef fun html_signature do return inner.html_signature
end