class MarkdownMetrics

nitc :: MarkdownMetrics

A Markdown decorator that collects metrics about a Readme content

Introduced properties

private var _headings_counter: Counter[Int]

nitc :: MarkdownMetrics :: _headings_counter

Count heading levels
private var _nodes_counter: Counter[String]

nitc :: MarkdownMetrics :: _nodes_counter

Count nodes
fun headings_counter: Counter[Int]

nitc :: MarkdownMetrics :: headings_counter

Count heading levels
protected fun headings_counter=(headings_counter: Counter[Int])

nitc :: MarkdownMetrics :: headings_counter=

Count heading levels
protected fun nodes_counter=(nodes_counter: Counter[String])

nitc :: MarkdownMetrics :: nodes_counter=

Count nodes

Redefined properties

redef type SELF: MarkdownMetrics

nitc $ MarkdownMetrics :: SELF

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

nitc $ MarkdownMetrics :: 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
private var _headings_counter: Counter[Int]

nitc :: MarkdownMetrics :: _headings_counter

Count heading levels
private var _nodes_counter: Counter[String]

nitc :: MarkdownMetrics :: _nodes_counter

Count nodes
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.
fun headings_counter: Counter[Int]

nitc :: MarkdownMetrics :: headings_counter

Count heading levels
protected fun headings_counter=(headings_counter: Counter[Int])

nitc :: MarkdownMetrics :: headings_counter=

Count heading levels
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.
private intern fun native_class_name: CString

core :: Object :: native_class_name

The class name of the object in CString format.
protected fun nodes_counter=(nodes_counter: Counter[String])

nitc :: MarkdownMetrics :: nodes_counter=

Count nodes
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).
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 nitc::MarkdownMetrics MarkdownMetrics markdown2::MdVisitor MdVisitor nitc::MarkdownMetrics->markdown2::MdVisitor core::Object Object markdown2::MdVisitor->core::Object ...core::Object ... ...core::Object->core::Object

Ancestors

interface Object

core :: Object

The root of the class hierarchy.

Parents

interface MdVisitor

markdown2 :: MdVisitor

A visitor for Markdown AST

Class definitions

nitc $ MarkdownMetrics 
# A Markdown decorator that collects metrics about a Readme content
class MarkdownMetrics
	super MdVisitor

	# Count nodes
	var nodes_counter = new Counter[String]

	# Count heading levels
	var headings_counter = new Counter[Int]

	redef fun visit(node) do
		nodes_counter.inc node.class_name
		if node isa MdHeading then
			headings_counter.inc node.level
		end
		node.visit_all self
	end
end
src/metrics/readme_metrics.nit:49,1--66,3
Nit tools. Version .