Render commands results as HTML

Introduced classes

class CmdDecorator

nitc :: CmdDecorator

Custom Markdown processor able to process doc commands
class CmdHtmlightVisitor

nitc :: CmdHtmlightVisitor

Custom HtmlightVisitor for commands
class CmdInlineDecorator

nitc :: CmdInlineDecorator

Same as InlineDecorator but with wikilink commands handling
class CmdMarkdownProcessor

nitc :: CmdMarkdownProcessor

Custom MarkdownEmitter for commands

Redefined classes

redef class CmdAncestors

nitc :: html_commands $ CmdAncestors

MEntity ancestors command
redef class CmdCall

nitc :: html_commands $ CmdCall

Retrieve all the mproperties that call mentity
redef class CmdChildren

nitc :: html_commands $ CmdChildren

MEntity children command
redef abstract class CmdCode

nitc :: html_commands $ CmdCode

Abstract command that returns source-code pieces
redef class CmdComment

nitc :: html_commands $ CmdComment

Retrieve the MDoc related to a MEntity
redef class CmdDescendants

nitc :: html_commands $ CmdDescendants

MEntity descendants command
redef abstract class CmdEntities

nitc :: html_commands $ CmdEntities

A list of mentities
redef class CmdEntity

nitc :: html_commands $ CmdEntity

A command about a MEntity
redef abstract class CmdEntityFile

nitc :: html_commands $ CmdEntityFile

redef abstract class CmdError

nitc :: html_commands $ CmdError

Command Error
redef class CmdFeatures

nitc :: html_commands $ CmdFeatures

MEntity feature list
redef abstract class CmdGraph

nitc :: html_commands $ CmdGraph

An abstract command that returns a dot graph
redef class CmdIniCloneCommand

nitc :: html_commands $ CmdIniCloneCommand

Cmd that finds the git clone command related to an mentity
redef class CmdIniContributors

nitc :: html_commands $ CmdIniContributors

Cmd that finds the contributors list of an mentity
redef class CmdIniDescription

nitc :: html_commands $ CmdIniDescription

Cmd that finds the ini description related to an mentity
redef class CmdIniGitUrl

nitc :: html_commands $ CmdIniGitUrl

Cmd that finds the clone url related to an mentity
redef class CmdIniIssuesUrl

nitc :: html_commands $ CmdIniIssuesUrl

Cmd that finds the issues link related to an mentity
redef class CmdIniLicense

nitc :: html_commands $ CmdIniLicense

Cmd that finds the license related to an mentity
redef class CmdIniMaintainer

nitc :: html_commands $ CmdIniMaintainer

Cmd that finds the maintainer name of an mentity
redef class CmdLinearization

nitc :: html_commands $ CmdLinearization

Linearization command
redef class CmdMainCompile

nitc :: html_commands $ CmdMainCompile

Cmd that finds the nitc command related to an mentity
redef class CmdMains

nitc :: html_commands $ CmdMains

Cmd that finds the mains of an mentity
redef abstract class CmdMessage

nitc :: html_commands $ CmdMessage

Command message
redef class CmdNew

nitc :: html_commands $ CmdNew

Retrieve all the mproperties that initialize mentity
redef class CmdParam

nitc :: html_commands $ CmdParam

Retrieve all the mproperties using mentity as a type for its parameters
redef class CmdParents

nitc :: html_commands $ CmdParents

MEntity parents command
redef class CmdReturn

nitc :: html_commands $ CmdReturn

Retrieve all the mproperties that return somethinf of the mentity type.
redef class CmdTesting

nitc :: html_commands $ CmdTesting

Cmd that finds the nitunit command related to an mentity
redef abstract class CmdWarning

nitc :: html_commands $ CmdWarning

Command Warning
redef abstract class DocCommand

nitc :: html_commands $ DocCommand

Documentation command
redef abstract class Text

nitc :: html_commands $ Text

High-level abstraction for all text representations

All class definitions

redef class CmdAncestors

nitc :: html_commands $ CmdAncestors

MEntity ancestors command
redef class CmdCall

nitc :: html_commands $ CmdCall

Retrieve all the mproperties that call mentity
redef class CmdChildren

nitc :: html_commands $ CmdChildren

MEntity children command
redef abstract class CmdCode

nitc :: html_commands $ CmdCode

Abstract command that returns source-code pieces
redef class CmdComment

nitc :: html_commands $ CmdComment

Retrieve the MDoc related to a MEntity
class CmdDecorator

nitc $ CmdDecorator

Custom Markdown processor able to process doc commands
redef class CmdDescendants

nitc :: html_commands $ CmdDescendants

MEntity descendants command
redef abstract class CmdEntities

nitc :: html_commands $ CmdEntities

A list of mentities
redef class CmdEntity

nitc :: html_commands $ CmdEntity

A command about a MEntity
redef abstract class CmdEntityFile

nitc :: html_commands $ CmdEntityFile

redef abstract class CmdError

nitc :: html_commands $ CmdError

Command Error
redef class CmdFeatures

nitc :: html_commands $ CmdFeatures

MEntity feature list
redef abstract class CmdGraph

nitc :: html_commands $ CmdGraph

An abstract command that returns a dot graph
class CmdHtmlightVisitor

nitc $ CmdHtmlightVisitor

Custom HtmlightVisitor for commands
redef class CmdIniCloneCommand

nitc :: html_commands $ CmdIniCloneCommand

Cmd that finds the git clone command related to an mentity
redef class CmdIniContributors

nitc :: html_commands $ CmdIniContributors

Cmd that finds the contributors list of an mentity
redef class CmdIniDescription

nitc :: html_commands $ CmdIniDescription

Cmd that finds the ini description related to an mentity
redef class CmdIniGitUrl

nitc :: html_commands $ CmdIniGitUrl

Cmd that finds the clone url related to an mentity
redef class CmdIniIssuesUrl

nitc :: html_commands $ CmdIniIssuesUrl

Cmd that finds the issues link related to an mentity
redef class CmdIniLicense

nitc :: html_commands $ CmdIniLicense

Cmd that finds the license related to an mentity
redef class CmdIniMaintainer

nitc :: html_commands $ CmdIniMaintainer

Cmd that finds the maintainer name of an mentity
class CmdInlineDecorator

nitc $ CmdInlineDecorator

Same as InlineDecorator but with wikilink commands handling
redef class CmdLinearization

nitc :: html_commands $ CmdLinearization

Linearization command
redef class CmdMainCompile

nitc :: html_commands $ CmdMainCompile

Cmd that finds the nitc command related to an mentity
redef class CmdMains

nitc :: html_commands $ CmdMains

Cmd that finds the mains of an mentity
class CmdMarkdownProcessor

nitc $ CmdMarkdownProcessor

Custom MarkdownEmitter for commands
redef abstract class CmdMessage

nitc :: html_commands $ CmdMessage

Command message
redef class CmdNew

nitc :: html_commands $ CmdNew

Retrieve all the mproperties that initialize mentity
redef class CmdParam

nitc :: html_commands $ CmdParam

Retrieve all the mproperties using mentity as a type for its parameters
redef class CmdParents

nitc :: html_commands $ CmdParents

MEntity parents command
redef class CmdReturn

nitc :: html_commands $ CmdReturn

Retrieve all the mproperties that return somethinf of the mentity type.
redef class CmdTesting

nitc :: html_commands $ CmdTesting

Cmd that finds the nitunit command related to an mentity
redef abstract class CmdWarning

nitc :: html_commands $ CmdWarning

Command Warning
redef abstract class DocCommand

nitc :: html_commands $ DocCommand

Documentation command
redef abstract class Text

nitc :: html_commands $ Text

High-level abstraction for all text representations
package_diagram nitc::html_commands html_commands nitc::commands_docdown commands_docdown nitc::html_commands->nitc::commands_docdown nitc::commands_parser commands_parser nitc::html_commands->nitc::commands_parser nitc::html_model html_model nitc::html_commands->nitc::html_model markdown::wikilinks wikilinks nitc::html_commands->markdown::wikilinks nitc::md_commands md_commands nitc::commands_docdown->nitc::md_commands markdown markdown nitc::commands_docdown->markdown nitc::commands_catalog commands_catalog nitc::commands_parser->nitc::commands_catalog nitc::commands_graph commands_graph nitc::commands_parser->nitc::commands_graph nitc::commands_ini commands_ini nitc::commands_parser->nitc::commands_ini nitc::commands_main commands_main nitc::commands_parser->nitc::commands_main nitc::commands_usage commands_usage nitc::commands_parser->nitc::commands_usage nitc::html_model->markdown nitc::model_collect model_collect nitc::html_model->nitc::model_collect nitc\>catalog\> catalog nitc::html_model->nitc\>catalog\> nitc::htmlight htmlight nitc::html_model->nitc::htmlight html::bootstrap bootstrap nitc::html_model->html::bootstrap markdown::wikilinks->markdown ...nitc::md_commands ... ...nitc::md_commands->nitc::md_commands ...markdown ... ...markdown->markdown ...nitc::commands_catalog ... ...nitc::commands_catalog->nitc::commands_catalog ...nitc::commands_graph ... ...nitc::commands_graph->nitc::commands_graph ...nitc::commands_ini ... ...nitc::commands_ini->nitc::commands_ini ...nitc::commands_main ... ...nitc::commands_main->nitc::commands_main ...nitc::commands_usage ... ...nitc::commands_usage->nitc::commands_usage ...nitc::model_collect ... ...nitc::model_collect->nitc::model_collect ...nitc\>catalog\> ... ...nitc\>catalog\>->nitc\>catalog\> ...nitc::htmlight ... ...nitc::htmlight->nitc::htmlight ...html::bootstrap ... ...html::bootstrap->html::bootstrap nitc::static_cards static_cards nitc::static_cards->nitc::html_commands nitc::api_base api_base nitc::api_base->nitc::html_commands nitc::static_base static_base nitc::static_base->nitc::static_cards nitc::static_base... ... nitc::static_base...->nitc::static_base nitc::api_auth api_auth nitc::api_auth->nitc::api_base nitc::api_model api_model nitc::api_model->nitc::api_base nitc::api_metrics api_metrics nitc::api_metrics->nitc::api_base nitc::api_feedback api_feedback nitc::api_feedback->nitc::api_base nitc::api_light api_light nitc::api_light->nitc::api_base nitc::api_auth... ... nitc::api_auth...->nitc::api_auth nitc::api_model... ... nitc::api_model...->nitc::api_model nitc::api_metrics... ... nitc::api_metrics...->nitc::api_metrics nitc::api_feedback... ... nitc::api_feedback...->nitc::api_feedback nitc::api_light... ... nitc::api_light...->nitc::api_light

Ancestors

module abstract_collection

core :: abstract_collection

Abstract collection classes and services.
module abstract_text

core :: abstract_text

Abstract class for manipulation of sequences of characters
module abstract_tree

trees :: abstract_tree

Introduce tree structures abstraction
module actors_injection_phase

nitc :: actors_injection_phase

Injects model for the classes annotated with "is actor" so
module annotation

nitc :: annotation

Management and utilities on annotations
module array

core :: array

This module introduces the standard array structure.
module astbuilder

nitc :: astbuilder

Instantiation and transformation of semantic nodes in the AST of expressions and statements
module astutil

nitc :: astutil

Additional features on Nit AST
module auto_super_init

nitc :: auto_super_init

Computing of super-constructors that must be implicitly called at the begin of constructors.
module bintree

trees :: bintree

Binary Tree data-structure
module bitset

core :: bitset

Services to handle BitSet
module bktree

trees :: bktree

Implementation of BKTree
module bootstrap

html :: bootstrap

HTML templates for Bootstrap components.
module bytes

core :: bytes

Services for byte streams and arrays
module caching

serialization :: caching

Services for caching serialization engines
module catalog

nitc :: catalog

Basic catalog generator for Nit packages
module check_annotation

nitc :: check_annotation

Check that annotation present in the AST are either primitive or user-declared
module circular_array

core :: circular_array

Efficient data structure to access both end of the sequence.
module codec_base

core :: codec_base

Base for codecs to use with streams
module codecs

core :: codecs

Group module for all codec-related manipulations
module collection

core :: collection

This module define several collection classes.
module commands_base

nitc :: commands_base

Documentation commands
module commands_catalog

nitc :: commands_catalog

Commands to retrieve Catalog related data
module commands_graph

nitc :: commands_graph

Graph commands
module commands_model

nitc :: commands_model

Doc commands about a Model or a MEntity
module commands_usage

nitc :: commands_usage

Commands about how mentities are used
module console

console :: console

Defines some ANSI Terminal Control Escape Sequences.
module core

core :: core

Standard classes and methods used by default by Nit programs and libraries.
module counter

counter :: counter

Simple numerical statistical analysis and presentation
module deriving

nitc :: deriving

Injection of automatic method definitions for standard methods, based on the attributes of the classes
module digraph

graph :: digraph

Implementation of directed graphs, also called digraphs.
module div_by_zero

nitc :: div_by_zero

Detection of divisions by zero in obvious cases
module dot

dot :: dot

Dot rendering library
module engine_tools

serialization :: engine_tools

Advanced services for serialization engines
module environ

core :: environ

Access to the environment variables of the process
module error

core :: error

Standard error-management infrastructure.
module exec

core :: exec

Invocation and management of operating system sub-processes.
module file

core :: file

File manipulations (create, read, write, etc.)
module fixed_ints

core :: fixed_ints

Basic integers of fixed-precision
module fixed_ints_text

core :: fixed_ints_text

Text services to complement fixed_ints
module flat

core :: flat

All the array-based text representations
module flow

nitc :: flow

Intraprocedural static flow.
module frontend

nitc :: frontend

Collect and orchestration of main frontend phases
module gc

core :: gc

Access to the Nit internal garbage collection mechanism
module glsl_validation

nitc :: glsl_validation

Check shader code within Nit modules using the tool glslangValidator
module hash_collection

core :: hash_collection

Introduce HashMap and HashSet.
module highlight

nitc :: highlight

Highlighting of Nit AST
module html

html :: html

HTML output facilities
module htmlight

nitc :: htmlight

Highlighting of Nit AST with HTML
module i18n_phase

nitc :: i18n_phase

Basic support of internationalization through the generation of id-to-string tables
module ini

ini :: ini

Read and write INI configuration files
module inspect

serialization :: inspect

Refine Serializable::inspect to show more useful information
module iso8859_1

core :: iso8859_1

Codec for ISO8859-1 I/O
module kernel

core :: kernel

Most basic classes and methods.
module lexer

nitc :: lexer

Lexer and its tokens.
module lexer_work

nitc :: lexer_work

Internal algorithm and data structures for the Nit lexer
module list

core :: list

This module handle double linked lists
module literal

nitc :: literal

Parsing of literal values in the abstract syntax tree.
module loader

nitc :: loader

Loading of Nit source files
module local_var_init

nitc :: local_var_init

Verify that local variables are initialized before their usage
module location

nitc :: location

Nit source-file and locations in source-file
module markdown

markdown :: markdown

Markdown parsing.
module math

core :: math

Mathematical operations
module md5

md5 :: md5

Native MD5 digest implementation as Text::md5
module md_commands

nitc :: md_commands

Render commands results as Markdown
module mdoc

nitc :: mdoc

Documentation of model entities
module meta

meta :: meta

Simple user-defined meta-level to manipulate types of instances as object.
module mmodule

nitc :: mmodule

modules and module hierarchies in the metamodel
module mmodule_data

nitc :: mmodule_data

Define and retrieve data in modules
module model

nitc :: model

Classes, types and properties
module model_base

nitc :: model_base

The abstract concept of model and related common things
module model_collect

nitc :: model_collect

Collect things from the model.
module model_examples

nitc :: model_examples

Examples for Model entities
module model_index

nitc :: model_index

Search things from the Model
module modelbuilder_base

nitc :: modelbuilder_base

Load nit source files and build the associated model
module modelize

nitc :: modelize

Create a model from nit source files
module modelize_class

nitc :: modelize_class

Analysis and verification of class definitions to instantiate model element
module modelize_property

nitc :: modelize_property

Analysis and verification of property definitions to instantiate model element
module more_collections

more_collections :: more_collections

Highly specific, but useful, collections-related classes.
module mpackage

nitc :: mpackage

Modelisation of a Nit package
module native

core :: native

Native structures for text and bytes
module nitpm_shared

nitc :: nitpm_shared

Services related to the Nit package manager
module no_warning

nitc :: no_warning

Fill toolcontext information about blacklisting of warnings.
module numeric

core :: numeric

Advanced services for Numeric types
module opts

opts :: opts

Management of options on the command line
module ordered_tree

ordered_tree :: ordered_tree

Manipulation and presentation of ordered trees.
module parallelization_phase

nitc :: parallelization_phase

Phase generating threads for functions annotated with threaded annotation
module parse_annotations

nitc :: parse_annotations

Simple annotation parsing
module parser

nitc :: parser

Parser.
module parser_nodes

nitc :: parser_nodes

AST nodes of the Nit language
module parser_prod

nitc :: parser_prod

Production AST nodes full definition.
module parser_util

nitc :: parser_util

Utils and tools related to parsers and AST
module parser_work

nitc :: parser_work

Internal algorithm and data structures for the Nit parser
module phase

nitc :: phase

Phases of the processing of nit programs
module pipeline

pipeline :: pipeline

Pipelined filters and operations on iterators.
module poset

poset :: poset

Pre order sets and partial order set (ie hierarchies)
module protocol

core :: protocol

module queue

core :: queue

Queuing data structures and wrappers
module range

core :: range

Module for range of discrete objects.
module rbtree

trees :: rbtree

A red–black tree is a data structure which is a type of self-balancing binary search tree.
module re

core :: re

Regular expression support for all services based on Pattern
module regex_phase

nitc :: regex_phase

Check for error in regular expressions from string literals
module ropes

core :: ropes

Tree-based representation of a String.
module scope

nitc :: scope

Identification and scoping of local variables and labels.
module semantize

nitc :: semantize

Process bodies of methods in regard with the model.
module serialization

serialization :: serialization

General serialization services
module serialization_core

serialization :: serialization_core

Abstract services to serialize Nit objects to different formats
module serialization_model_phase

nitc :: serialization_model_phase

Phase generating methods (model-only) to serialize Nit objects
module simple_misc_analysis

nitc :: simple_misc_analysis

Simple vavious processing on a AST
module sorter

core :: sorter

This module contains classes used to compare things and sorts arrays.
module stream

core :: stream

Input and output streams of characters
module tables

nitc :: tables

Module that interfaces the parsing tables.
module template

template :: template

Basic template system
module text

core :: text

All the classes and methods related to the manipulation of text entities
module time

core :: time

Management of time and dates
module toolcontext

nitc :: toolcontext

Common command-line tool infrastructure than handle options and error messages
module trees

trees :: trees

General module for tree data structures
module trie

trees :: trie

A trie (or prefix tree) is a datastructure used to perform prefix searches.
module typing

nitc :: typing

Intraprocedural resolution of static types and OO-services
module uml

nitc :: uml

Group head module for UML generation services
module uml_base

nitc :: uml_base

Exposes the base class for UML generation of a Model
module uml_class

nitc :: uml_class

Provides facilities of exporting a Model to a UML class diagram
module uml_module

nitc :: uml_module

Services for generation of a UML package diagram based on a Model
module union_find

core :: union_find

union–find algorithm using an efficient disjoint-set data structure
module utf8

core :: utf8

Codec for UTF-8 I/O
module version

nitc :: version

This file was generated by git-gen-version.sh

Parents

module commands_docdown

nitc :: commands_docdown

Doc down related queries
module commands_parser

nitc :: commands_parser

A parser that create DocCommand from a string
module html_model

nitc :: html_model

Translate mentities to html blocks.

Children

module api_base

nitc :: api_base

Base classes used by nitweb.
module static_cards

nitc :: static_cards

Cards templates for the static documentation

Descendants

module a_star-m

a_star-m

module api

nitc :: api

Components required to build a web server about the nit model.
module api_auth

nitc :: api_auth

module api_docdown

nitc :: api_docdown

Nitdoc specific Markdown format handling for Nitweb
module api_feedback

nitc :: api_feedback

Feedback related features
module api_light

nitc :: api_light

Highlight and collect messages from a piece of code
module api_model

nitc :: api_model

module nitdoc

nitc :: nitdoc

Generator of static API documentation for the Nit language
module nitweb

nitc :: nitweb

Runs a webserver based on nitcorn that render things from model.
module static

nitc :: static

Nitdoc generation framework
module static_base

nitc :: static_base

Base entities shared by all the nitdoc code
module static_html

nitc :: static_html

Render documentation pages as HTML
module static_index

nitc :: static_index

Manage indexing of Nit model for Nitdoc QuickSearch.
module static_structure

nitc :: static_structure

Composes the pages of the static documentation
# Render commands results as HTML
module html_commands

import commands_catalog
import commands_docdown
import commands_graph
import commands_ini
import commands_main
import commands_parser
import commands_usage

import templates::html_model
intrude import markdown::wikilinks

redef class DocCommand

	# Render results as a HTML string
	fun to_html: Writable do return "<p class='text-danger'>Not yet implemented</p>"
end

redef class CmdMessage

	# Render the message as a HTML string
	fun to_html: Writable is abstract
end

redef class CmdError
	redef fun to_html do return "<p class='text-danger'>Error: {to_s}</p>"
end

redef class CmdWarning
	redef fun to_html do return "<p class='text-warning'>Warning: {to_s}</p>"
end

# Model commands

redef class CmdEntity
	redef fun to_html do
		var mentity = self.mentity
		if mentity == null then return ""
		return mentity.html_link.write_to_string
	end
end

redef class CmdEntities
	redef fun to_html do
		var mentities = self.results
		if mentities == null then return ""

		var tpl = new Template
		tpl.add "<ul>"
		for mentity in mentities do
			var mdoc = mentity.mdoc_or_fallback
			tpl.add "<li>"
			tpl.add mentity.html_link
			if mdoc != null then
				tpl.add " - "
				tpl.add mdoc.html_synopsis
			end
			tpl.add "</li>"
		end
		tpl.add "</ul>"
		return tpl.write_to_string
	end
end

redef class CmdComment
	redef fun to_html do
		var mentity = self.mentity
		if mentity == null then return ""

		var mdoc = self.mdoc
		var tpl = new Template
		tpl.add "<h3>"
		# FIXME comments left here until I figure out what to do about the presentation options
		# if not opts.has_key("no-link") then
			tpl.add mentity.html_link
		# end
		if mdoc != null then
			# if not opts.has_key("no-link") and not opts.has_key("no-synopsis") then
				tpl.add " - "
			# end
			# if not opts.has_key("no-synopsis") then
				tpl.add mdoc.html_synopsis
			# end
		end
		tpl.add "</h3>"
		if mdoc != null then
			# if not opts.has_key("no-comment") then
				tpl.add mdoc.html_comment
			# end
		end
		return tpl.write_to_string
	end

	redef fun render_comment do
		var mdoc = self.mdoc
		if mdoc == null then return null

		if format == "html" then
			if full_doc then return mdoc.html_documentation
			return mdoc.html_synopsis
		end
		return super
	end
end

redef class CmdEntityLink
	redef fun to_html do
		var mentity = self.mentity
		if mentity == null then return ""
		return mentity.html_link(text, title).write_to_string
	end
end

redef class CmdCode
	redef fun to_html do
		var node = self.node
		if node == null then return ""

		var code = render_code(node)
		return "<pre>{code.write_to_string}</pre>"
	end

	redef fun render_code(node) do
		if format == "html" then
			var hl = new CmdHtmlightVisitor
			hl.show_infobox = false
			hl.highlight_node node
			return hl.html
		end
		return super
	end
end

# Custom HtmlightVisitor for commands
#
# We create a new subclass so its behavior can be refined in clients without
# breaking the main implementation.
class CmdHtmlightVisitor
	super HtmlightVisitor

	redef fun hrefto(mentity) do
		if mentity isa MClassDef then return mentity.mclass.html_url
		if mentity isa MPropDef then return mentity.mproperty.html_url
		return mentity.html_url
	end
end

redef class CmdAncestors
	redef fun to_html do return super # FIXME lin
end

redef class CmdParents
	redef fun to_html do return super # FIXME lin
end

redef class CmdChildren
	redef fun to_html do return super # FIXME lin
end

redef class CmdDescendants
	redef fun to_html do return super # FIXME lin
end

redef class CmdFeatures
	redef fun to_html do return super # FIXME lin
end

redef class CmdLinearization
	redef fun to_html do return super # FIXME lin
end

# Usage commands

redef class CmdNew
	redef fun to_html do return super # FIXME lin
end

redef class CmdCall
	redef fun to_html do return super # FIXME lin
end

redef class CmdReturn
	redef fun to_html do return super # FIXME lin
end

redef class CmdParam
	redef fun to_html do return super # FIXME lin
end

# Graph commands

redef class CmdGraph
	redef fun to_html do
		var output = render
		if output == null then return ""
		return output.write_to_string
	end
end

# Ini commands

redef class CmdIniDescription
	redef fun to_html do
		var desc = self.desc
		if desc == null then return ""

		return "<p>{desc}</p>"
	end
end

redef class CmdIniGitUrl
	redef fun to_html do
		var url = self.url
		if url == null then return ""

		return "<a href=\"{url}\">{url}</a>"
	end
end

redef class CmdIniCloneCommand
	redef fun to_html do
		var command = self.command
		if command == null then return ""

		return "<pre>{command}</pre>"
	end
end

redef class CmdIniIssuesUrl
	redef fun to_html do
		var url = self.url
		if url == null then return ""

		return "<a href=\"{url}\">{url}</a>"
	end
end

redef class CmdIniMaintainer
	redef fun to_html do
		var name = self.maintainer
		if name == null then return ""

		return "<b>{name.html_escape}</b>"
	end
end

redef class CmdIniContributors
	redef fun to_html do
		var names = self.contributors
		if names == null or names.is_empty then return ""

		var tpl = new Template
		tpl.add "<ul>"
		for name in names do
			tpl.add "<li><b>{name.html_escape}</b></li>"
		end
		tpl.add "</ul>"
		return tpl.write_to_string
	end
end

redef class CmdIniLicense
	redef fun to_html do
		var license = self.license
		if license == null then return ""

		return "<a href=\"https://opensource.org/licenses/{license}\">{license}</a>"
	end
end

redef class CmdEntityFile
	redef fun to_html do
		var file = self.file
		if file == null then return ""

		return "<a href=\"{file_url or else ""}\">{file.basename}</a>"
	end
end

redef class CmdEntityFileContent
	redef fun to_html do
		var content = self.content
		if content == null then return ""

		return "<pre>{content}</pre>"
	end
end

# Main commands

redef class CmdMains
	redef fun to_html do return super # FIXME lin
end

redef class CmdMainCompile
	redef fun to_html do
		var command = self.command
		if command == null then return ""

		return "<pre>{command}</pre>"
	end
end

redef class CmdManSynopsis
	redef fun to_html do
		var synopsis = self.synopsis
		if synopsis == null then return ""

		return "<pre>{synopsis}</pre>"
	end
end

redef class CmdManOptions
	redef fun to_html do
		var options = self.options
		if options == null or options.is_empty then return ""

		var tpl = new Template
		tpl.addn "<pre>"
		tpl.addn "<table width='100%'>"
		for opt, desc in options do
			tpl.addn "<tr>"
			tpl.addn "<th valign='top' width='30%'>{opt}</th>"
			tpl.addn "<td width='70%'>{desc}</td>"
			tpl.addn "</tr>"
		end
		tpl.addn "</table>"
		tpl.addn "</pre>"

		return tpl.write_to_string
	end
end

redef class CmdTesting
	redef fun to_html do
		var command = self.command
		if command == null then return ""

		return "<pre>{command}</pre>"
	end
end

# MDoc

# Custom Markdown processor able to process doc commands
class CmdDecorator
	super NitdocDecorator

	redef type PROCESSOR: CmdMarkdownProcessor

	# Model used by wikilink commands to find entities
	var model: Model

	# Filter to apply if any
	var filter: nullable ModelFilter

	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(name)
		if mentity == null then
			super
		else
			v.add "<code>"
			v.emit_text mentity.html_link.write_to_string
			v.add "</code>"
		end
	end

	private fun try_find_mentity(text: String): nullable MEntity do
		var mentity = model.mentity_by_full_name(text, filter)
		if mentity != null then return mentity

		var mentities = model.mentities_by_name(text, filter)
		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
		v.render_wikilink(token, model)
	end
end

# Same as `InlineDecorator` but with wikilink commands handling
class CmdInlineDecorator
	super InlineDecorator

	redef type PROCESSOR: CmdMarkdownProcessor

	# Model used by wikilink commands to find entities
	var model: Model

	redef fun add_wikilink(v, token) do
		v.render_wikilink(token, model)
	end
end

# Custom MarkdownEmitter for commands
class CmdMarkdownProcessor
	super MarkdownProcessor

	# Parser used to process doc commands
	var parser: CommandParser

	# Render a wikilink
	fun render_wikilink(token: TokenWikiLink, model: Model) do
		var link = token.link
		if link == null then return
		var name = token.name
		if name != null then link = "{name} | {link}"

		var command = parser.parse(link.write_to_string)
		var error = parser.error

		if error isa CmdError then
			emit_text error.to_html.write_to_string
			return
		end
		if error isa CmdWarning then
			emit_text error.to_html.write_to_string
		end
		add command.as(not null).to_html
	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
src/doc/templates/html_commands.nit:15,1--459,3