Markdown Github mode

Enables:

  • strike processing: ~strike~
  • super processing: ^super^

TODO table

TODO todo lists

Introduced classes

class MdStrike

markdown2 :: MdStrike

Striked text
class MdStrikeProcessor

markdown2 :: MdStrikeProcessor

Strike processor
class MdSuper

markdown2 :: MdSuper

Super text
class MdSuperProcessor

markdown2 :: MdSuperProcessor

Super processor

Redefined classes

redef class MdInlineParser

markdown2 :: markdown_github $ MdInlineParser

Parser for inline content (text, links, emphasis, etc)
redef class MdParser

markdown2 :: markdown_github $ MdParser

Markdown parser

All class definitions

redef class MdInlineParser

markdown2 :: markdown_github $ MdInlineParser

Parser for inline content (text, links, emphasis, etc)
redef class MdParser

markdown2 :: markdown_github $ MdParser

Markdown parser
class MdStrike

markdown2 $ MdStrike

Striked text
class MdStrikeProcessor

markdown2 $ MdStrikeProcessor

Strike processor
class MdSuper

markdown2 $ MdSuper

Super text
class MdSuperProcessor

markdown2 $ MdSuperProcessor

Super processor
package_diagram markdown2::markdown_github markdown_github markdown2::markdown_block_parsing markdown_block_parsing markdown2::markdown_github->markdown2::markdown_block_parsing markdown2::markdown_inline_parsing markdown_inline_parsing markdown2::markdown_block_parsing->markdown2::markdown_inline_parsing ...markdown2::markdown_inline_parsing ... ...markdown2::markdown_inline_parsing->markdown2::markdown_inline_parsing markdown2::markdown_html_rendering markdown_html_rendering markdown2::markdown_html_rendering->markdown2::markdown_github markdown2::markdown_latex_rendering markdown_latex_rendering markdown2::markdown_latex_rendering->markdown2::markdown_github markdown2::markdown_man_rendering markdown_man_rendering markdown2::markdown_man_rendering->markdown2::markdown_github markdown2::markdown_md_rendering markdown_md_rendering markdown2::markdown_md_rendering->markdown2::markdown_github markdown2::markdown2 markdown2 markdown2::markdown2->markdown2::markdown_html_rendering markdown2::nitmd nitmd markdown2::nitmd->markdown2::markdown_html_rendering markdown2::nitmd->markdown2::markdown_latex_rendering markdown2::nitmd->markdown2::markdown_man_rendering markdown2::nitmd->markdown2::markdown_md_rendering markdown2::test_markdown test_markdown markdown2::test_markdown->markdown2::markdown_html_rendering markdown2::markdown2... ... markdown2::markdown2...->markdown2::markdown2 markdown2::nitmd... ... markdown2::nitmd...->markdown2::nitmd markdown2::test_markdown... ... markdown2::test_markdown...->markdown2::test_markdown

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 array

core :: array

This module introduces the standard array structure.
module bitset

core :: bitset

Services to handle BitSet
module bytes

core :: bytes

Services for byte streams and arrays
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 core

core :: core

Standard classes and methods used by default by Nit programs and libraries.
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 gc

core :: gc

Access to the Nit internal garbage collection mechanism
module hash_collection

core :: hash_collection

Introduce HashMap and HashSet.
module iso8859_1

core :: iso8859_1

Codec for ISO8859-1 I/O
module kernel

core :: kernel

Most basic classes and methods.
module list

core :: list

This module handle double linked lists
module markdown_ast

markdown2 :: markdown_ast

Markdown AST representation
module markdown_inline_parsing

markdown2 :: markdown_inline_parsing

Parser for inline markdown
module math

core :: math

Mathematical operations
module native

core :: native

Native structures for text and bytes
module numeric

core :: numeric

Advanced services for Numeric types
module protocol

core :: protocol

module queue

core :: queue

Queuing data structures and wrappers
module range

core :: range

Module for range of discrete objects.
module re

core :: re

Regular expression support for all services based on Pattern
module ropes

core :: ropes

Tree-based representation of a String.
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 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 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

Parents

module markdown_block_parsing

markdown2 :: markdown_block_parsing

Markdown blocks parsing

Children

module markdown_html_rendering

markdown2 :: markdown_html_rendering

HTML rendering of Markdown documents
module markdown_latex_rendering

markdown2 :: markdown_latex_rendering

LaTeX rendering of Markdown documents
module markdown_man_rendering

markdown2 :: markdown_man_rendering

Manpages rendering of Markdown documents
module markdown_md_rendering

markdown2 :: markdown_md_rendering

Markdown rendering of Markdown documents

Descendants

module a_star-m

a_star-m

module nitmd

markdown2 :: nitmd

A Markdown parser for Nit.
module test_markdown

markdown2 :: test_markdown

Test suites for module markdown
# Markdown Github mode
#
# Enables:
# * strike processing: ~strike~
# * super processing: ^super^
#
# TODO table
# TODO todo lists
module markdown_github

intrude import markdown_inline_parsing
intrude import markdown_block_parsing

redef class MdParser

	# Enable Github mode
	var github_mode = false is writable

	redef var inline_parser is lazy do
		var parser = super
		parser.github_mode = github_mode
		return parser
	end
end

redef class MdInlineParser

	# Enable Github mode
	private var github_mode = false

	redef var delimiter_processors is lazy do
		var delimiters = super
		if github_mode then
			delimiters.add new MdStrikeProcessor
			delimiters.add new MdSuperProcessor
		end
		return delimiters
	end
end

# Strike processor
class MdStrikeProcessor
	super MdEmphasisDelimiterProcessor
	noautoinit

	redef var delimiter_char = '~'
	redef var min_length = 1
	redef fun delimiter_use(opener, closer) do return opener.original_length

	redef fun process(opener, closer, delimiter_use) do
		var node = new MdStrike(
				new MdLocation(
					opener.location.line_start,
					opener.location.column_start,
					closer.location.line_end,
					closer.location.column_end),
			opening_delimiter.to_s * delimiter_use)
		var tmp = opener.next
		while tmp != null and tmp != closer do
			var next = tmp.next
			node.append_child(tmp)
			tmp = next
		end
		opener.insert_after(node)
	end
end

#  Striked text
class MdStrike
	super MdDelimited
end

# Super processor
class MdSuperProcessor
	super MdEmphasisDelimiterProcessor
	noautoinit

	redef var delimiter_char = '^'
	redef var min_length = 1
	redef fun delimiter_use(opener, closer) do return opener.original_length

	redef fun process(opener, closer, delimiter_use) do
		var node = new MdSuper(
			new MdLocation(
				opener.location.line_start,
				opener.location.column_start,
				closer.location.line_end,
				closer.location.column_end),
			opening_delimiter.to_s * delimiter_use)
		var tmp = opener.next
		while tmp != null and tmp != closer do
			var next = tmp.next
			node.append_child(tmp)
			tmp = next
		end
		opener.insert_after(node)
	end
end

# Super text
class MdSuper
	super MdDelimited
end
lib/markdown2/markdown_github.nit:15,1--117,3