NitlightVisitor

Introduced properties

private var _current_module: MModule

nitc :: NitlightVisitor :: _current_module

The current highlight module

private var _mmodules: Collection[MModule]

nitc :: NitlightVisitor :: _mmodules

List of all highlighted modules

fun current_module: MModule

nitc :: NitlightVisitor :: current_module

The current highlight module

protected fun current_module=(current_module: MModule)

nitc :: NitlightVisitor :: current_module=

The current highlight module

init defaultinit(current_module: MModule, mmodules: Collection[MModule])

nitc :: NitlightVisitor :: defaultinit

fun mmodules: Collection[MModule]

nitc :: NitlightVisitor :: mmodules

List of all highlighted modules

protected fun mmodules=(mmodules: Collection[MModule])

nitc :: NitlightVisitor :: mmodules=

List of all highlighted modules

Redefined properties

redef type SELF: NitlightVisitor

nitc $ NitlightVisitor :: SELF

Type of this instance, automatically specialized in every class

redef fun hrefto(entity: MEntity): nullable String

nitc $ NitlightVisitor :: hrefto

A reference to an entity used in generated <a> elements.

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 _current_module: MModule

nitc :: NitlightVisitor :: _current_module

The current highlight module

private var _first_line: nullable Int

nitc :: AbstractHighlightVisitor :: _first_line

The first line to generate, null if start at the first line

private var _html: HTMLTag

nitc :: HtmlightVisitor :: _html

The root of the HTML hierarchy

private var _include_loose_tokens: Bool

nitc :: AbstractHighlightVisitor :: _include_loose_tokens

When highlighting a node, also consider the loose tokens around it.

private var _include_whole_lines: Bool

nitc :: AbstractHighlightVisitor :: _include_whole_lines

When highlighting a node, the first and the last lines are fully included.

private var _last_line: nullable Int

nitc :: AbstractHighlightVisitor :: _last_line

The last line to generate, null if finish at the last line

private var _line_id_prefix: String

nitc :: HtmlightVisitor :: _line_id_prefix

Prefixes used in generated IDs for line <span> elements.

private var _mmodules: Collection[MModule]

nitc :: NitlightVisitor :: _mmodules

List of all highlighted modules

private var _show_infobox: Bool

nitc :: HtmlightVisitor :: _show_infobox

When highlighting a node, attach a full popupable infobox, if any.

private var _show_messages: Bool

nitc :: AbstractHighlightVisitor :: _show_messages

When highlighting a node, show its messages (errors, warnings), if any.

private var _with_ast: Bool

nitc :: HtmlightVisitor :: _with_ast

Should the HTML include a nested <span class"{type_of_node}"> element for each ANode of the AST?

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 css_content: String

nitc :: HtmlightVisitor :: css_content

Return a default CSS content related to CSS classes used in the html tree.

fun current_module: MModule

nitc :: NitlightVisitor :: current_module

The current highlight module

protected fun current_module=(current_module: MModule)

nitc :: NitlightVisitor :: current_module=

The current highlight module

init defaultinit

nitc :: HtmlightVisitor :: defaultinit

init defaultinit

core :: Object :: defaultinit

init defaultinit(current_module: MModule, mmodules: Collection[MModule])

nitc :: NitlightVisitor :: defaultinit

init defaultinit

nitc :: AbstractHighlightVisitor :: defaultinit

protected abstract fun do_highlight(first_token: Token, last_token: nullable Token)

nitc :: AbstractHighlightVisitor :: do_highlight

Low-level highlighting between 2 tokens

fun first_line: nullable Int

nitc :: AbstractHighlightVisitor :: first_line

The first line to generate, null if start at the first line

fun first_line=(first_line: nullable Int)

nitc :: AbstractHighlightVisitor :: first_line=

The first line to generate, null if start at the first line

fun foot_content: String

nitc :: HtmlightVisitor :: foot_content

Additional content to inject just before the closing </body> tag

private fun full_tag(anode: ANode): nullable HTMLTag

nitc :: HtmlightVisitor :: full_tag

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 head_content: String

nitc :: HtmlightVisitor :: head_content

Additional content to inject in the <head> tag

fun highlight_node(n: ANode)

nitc :: AbstractHighlightVisitor :: highlight_node

Highlight a AST element.

fun highlight_source(source: SourceFile)

nitc :: AbstractHighlightVisitor :: highlight_source

Highlight a full lexed source file.

fun highlightcode(content: String, print_errors: nullable Bool): HLCode

nitc :: HtmlightVisitor :: highlightcode

Fully process content as a Nit source file.

fun hrefto(entity: MEntity): nullable String

nitc :: HtmlightVisitor :: hrefto

A reference to an entity used in generated <a> elements.

fun html: HTMLTag

nitc :: HtmlightVisitor :: html

The root of the HTML hierarchy

protected fun html=(html: HTMLTag)

nitc :: HtmlightVisitor :: html=

The root of the HTML hierarchy

fun include_loose_tokens: Bool

nitc :: AbstractHighlightVisitor :: include_loose_tokens

When highlighting a node, also consider the loose tokens around it.

fun include_loose_tokens=(include_loose_tokens: Bool)

nitc :: AbstractHighlightVisitor :: include_loose_tokens=

When highlighting a node, also consider the loose tokens around it.

fun include_whole_lines: Bool

nitc :: AbstractHighlightVisitor :: include_whole_lines

When highlighting a node, the first and the last lines are fully included.

fun include_whole_lines=(include_whole_lines: Bool)

nitc :: AbstractHighlightVisitor :: include_whole_lines=

When highlighting a node, the first and the last lines are fully included.

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.

fun last_line: nullable Int

nitc :: AbstractHighlightVisitor :: last_line

The last line to generate, null if finish at the last line

fun last_line=(last_line: nullable Int)

nitc :: AbstractHighlightVisitor :: last_line=

The last line to generate, null if finish at the last line

fun line_id_prefix: String

nitc :: HtmlightVisitor :: line_id_prefix

Prefixes used in generated IDs for line <span> elements.

fun line_id_prefix=(line_id_prefix: String)

nitc :: HtmlightVisitor :: line_id_prefix=

Prefixes used in generated IDs for line <span> elements.

fun mmodules: Collection[MModule]

nitc :: NitlightVisitor :: mmodules

List of all highlighted modules

protected fun mmodules=(mmodules: Collection[MModule])

nitc :: NitlightVisitor :: mmodules=

List of all highlighted modules

private intern fun native_class_name: CString

core :: Object :: native_class_name

The class name of the object in CString format.

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

fun show_infobox: Bool

nitc :: HtmlightVisitor :: show_infobox

When highlighting a node, attach a full popupable infobox, if any.

fun show_infobox=(show_infobox: Bool)

nitc :: HtmlightVisitor :: show_infobox=

When highlighting a node, attach a full popupable infobox, if any.

fun show_messages: Bool

nitc :: AbstractHighlightVisitor :: show_messages

When highlighting a node, show its messages (errors, warnings), if any.

fun show_messages=(show_messages: Bool)

nitc :: AbstractHighlightVisitor :: show_messages=

When highlighting a node, show its messages (errors, warnings), if any.

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.

fun with_ast: Bool

nitc :: HtmlightVisitor :: with_ast

Should the HTML include a nested <span class"{type_of_node}"> element for each ANode of the AST?

fun with_ast=(with_ast: Bool)

nitc :: HtmlightVisitor :: with_ast=

Should the HTML include a nested <span class"{type_of_node}"> element for each ANode of the AST?

Ancestors

class AbstractHighlightVisitor

nitc :: AbstractHighlightVisitor

Visitor used to produce a HTML tree based on a AST on a Source

interface Object

The root of the class hierarchy.

Parents

class HtmlightVisitor

nitc :: HtmlightVisitor

Visitor used to produce a HTML tree based on a AST on a Source

Class definitions

nitc $ NitlightVisitor

class NitlightVisitor
	super HtmlightVisitor

	# The current highlight module
	#
	# It is used to know when to use anchored local links
	var current_module: MModule

	# List of all highlighted modules
	#
	# It is used to have links that only targets highlighted entities
	#
	# Entities outside these modules will not be linked.
	var mmodules: Collection[MModule]

	redef fun hrefto(entity) do return entity.href(self)
end

src/nitlight.nit:20,1--36,3