Markdown document renderer to Manpage

Introduced properties

fun add(string: String)

markdown2 :: ManRenderer :: add

Add string to man
fun add_code(code: String)

markdown2 :: ManRenderer :: add_code

Add code that need to be escaped
fun add_line

markdown2 :: ManRenderer :: add_line

Add a blank line to the output

Redefined properties

redef type SELF: ManRenderer

markdown2 $ ManRenderer :: SELF

Type of this instance, automatically specialized in every class
redef fun render(node: MdNode): String

markdown2 $ ManRenderer :: render

Render node as Markdown
redef fun visit(node: MdNode)

markdown2 $ ManRenderer :: visit

Visit node

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
fun add(string: String)

markdown2 :: ManRenderer :: add

Add string to man
fun add_code(code: String)

markdown2 :: ManRenderer :: add_code

Add code that need to be escaped
fun add_line

markdown2 :: ManRenderer :: add_line

Add a blank line to the output
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun enter_visit(node: MdNode)

markdown2 :: MdVisitor :: enter_visit

Start visiting node
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
abstract fun render(node: MdNode): String

markdown2 :: MdRenderer :: render

Render node
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
protected abstract fun visit(node: MdNode)

markdown2 :: MdVisitor :: visit

Visit node
package_diagram markdown2::ManRenderer ManRenderer markdown2::MdRenderer MdRenderer markdown2::ManRenderer->markdown2::MdRenderer markdown2::MdVisitor MdVisitor markdown2::MdRenderer->markdown2::MdVisitor ...markdown2::MdVisitor ... ...markdown2::MdVisitor->markdown2::MdVisitor

Ancestors

interface MdVisitor

markdown2 :: MdVisitor

A visitor for Markdown AST
interface Object

core :: Object

The root of the class hierarchy.

Parents

interface MdRenderer

markdown2 :: MdRenderer

Common interface for all markdown renderer

Class definitions

markdown2 $ ManRenderer
# Markdown document renderer to Manpage
class ManRenderer
	super MdRenderer

	# Output under construction
	private var man: Buffer is noinit

	# Render `node` as Markdown
	redef fun render(node) do
		man = new Buffer
		enter_visit(node)
		return man.write_to_string
	end

	redef fun visit(node) do node.render_man(self)

	# Add `string` to `man`
	fun add(string: String) do
		man.append(string.replace("-", "\\-"))
	end

	# Add code that need to be escaped
	fun add_code(code: String) do
		add code.replace(" ", "\\ ")
	end

	# Add a blank line to the output
	fun add_line do
		add "\n"
	end
end
lib/markdown2/markdown_man_rendering.nit:22,1--52,3