Tool that produces highlighting for Nit programs

Introduced classes

Redefined classes

redef class MClass

nitc :: nitlight $ MClass

A named class
redef class MClassDef

nitc :: nitlight $ MClassDef

A definition (an introduction or a refinement) of a class in a module
redef abstract class MEntity

nitc :: nitlight $ MEntity

A named and possibly documented entity in the model.
redef class MModule

nitc :: nitlight $ MModule

A Nit module is usually associated with a Nit source file.
redef abstract class MPropDef

nitc :: nitlight $ MPropDef

A definition of a property (local property)
redef abstract class MProperty

nitc :: nitlight $ MProperty

A service (global property) that generalize method, attribute, etc.
redef class Sys

nitc :: nitlight $ Sys

The main class of the program.

All class definitions

redef class MClass

nitc :: nitlight $ MClass

A named class
redef class MClassDef

nitc :: nitlight $ MClassDef

A definition (an introduction or a refinement) of a class in a module
redef abstract class MEntity

nitc :: nitlight $ MEntity

A named and possibly documented entity in the model.
redef class MModule

nitc :: nitlight $ MModule

A Nit module is usually associated with a Nit source file.
redef abstract class MPropDef

nitc :: nitlight $ MPropDef

A definition of a property (local property)
redef abstract class MProperty

nitc :: nitlight $ MProperty

A service (global property) that generalize method, attribute, etc.
redef class Sys

nitc :: nitlight $ Sys

The main class of the program.
package_diagram nitc::nitlight nitlight nitc::htmlight htmlight nitc::nitlight->nitc::htmlight nitc::highlight highlight nitc::htmlight->nitc::highlight pipeline pipeline nitc::htmlight->pipeline ...nitc::highlight ... ...nitc::highlight->nitc::highlight ...pipeline ... ...pipeline->pipeline a_star-m a_star-m a_star-m->nitc::nitlight

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 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 bitset

core :: bitset

Services to handle BitSet
module bytes

core :: bytes

Services for byte streams and arrays
module caching

serialization :: caching

Services for caching serialization engines
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 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 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 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 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 math

core :: math

Mathematical operations
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 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 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 typing

nitc :: typing

Intraprocedural resolution of static types and OO-services
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 htmlight

nitc :: htmlight

Highlighting of Nit AST with HTML

Children

module a_star-m

a_star-m

# Tool that produces highlighting for Nit programs
module nitlight

import htmlight

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

redef class MEntity
	private fun href(v: NitlightVisitor): nullable String do return null
end

redef class MModule
	redef fun href(v)
	do
		if self == v.current_module then return ""
		if not v.mmodules.has(self) then return null
		return c_name + ".html"
	end
end

redef class MClass
	redef fun href(v)
	do
		# Because we only have code, just link to the introduction
		return intro.href(v)
	end
end

redef class MClassDef
	redef fun href(v)
	do
		var m = mmodule.href(v)
		if m == null then return null
		return m + "#" + to_s
	end
end

redef class MProperty
	redef fun href(v)
	do
		# Because we only have code, just link to the introduction
		return intro.href(v)
	end
end

redef class MPropDef
	redef fun href(v)
	do
		var m = mclassdef.mmodule.href(v)
		if m == null then return null
		return m + "#" + to_s
	end
end

var toolcontext = new ToolContext

# Try to colorize, even if programs are non valid
toolcontext.keep_going = true

var opt_fragment = new OptionBool("Omit document header and footer", "-f", "--fragment")
var opt_line_id_prefix = new OptionString("Prefix of the id of each line `<span>` element", "--line-id-prefix")
var opt_first_line = new OptionInt("Start the source file at this line (default: 1)", 0, "--first-line")
var opt_last_line = new OptionInt("End the source file at this line (default: to the end)", 0, "--last-line")
var opt_dir = new OptionString("Output html files in a specific directory (required if more than one module)", "-d", "--dir")
var opt_full = new OptionBool("Process also imported modules", "--full")
var opt_ast = new OptionBool("Generate specific HTML elements for each Node of the AST", "--ast")
var opt_noinfobox = new OptionBool("Disable the generation of infoboxes", "--no-infobox")
var opt_txt = new OptionBool("Generate text with ANSI coloring escape sequences", "--txt")
toolcontext.option_context.add_option(opt_fragment, opt_line_id_prefix, opt_first_line, opt_last_line, opt_dir, opt_full, opt_ast, opt_txt, opt_noinfobox)
toolcontext.tooldescription = "Usage: nitlight [OPTION]... <file.nit>...\nGenerates HTML of highlited code from Nit source files."
toolcontext.process_options(args)

var model = new Model
var modelbuilder = new ModelBuilder(model, toolcontext)

var args = toolcontext.option_context.rest

var mmodules = modelbuilder.parse_full(args)
modelbuilder.run_phases

if opt_full.value then mmodules = modelbuilder.parsed_modules

var dir = opt_dir.value
if dir != null then
	dir.mkdir
else if mmodules.length > 1 then
	print "More than one module to render, use option -d"
	return
end

if opt_txt.value then
	for mm in mmodules do
		var v = new AnsiHighlightVisitor
		v.include_loose_tokens = true
		v.include_whole_lines = true

		if opt_first_line.value != 0 then v.first_line = opt_first_line.value
		if opt_last_line.value != 0 then v.last_line = opt_last_line.value
		var m = modelbuilder.mmodule2node(mm)
		assert m != null

		v.highlight_node(m)
		var page = v.result

		if dir != null then
			page.write_to_file("{dir}/{mm.c_name}.txt")
		else
			page.write_to(stdout)
		end
	end
	return
end

for mm in mmodules do
	if dir != null then toolcontext.info("write {dir}/{mm.c_name}.html", 1)

	var v = new NitlightVisitor(mm, mmodules)
	var prefix = opt_line_id_prefix.value
	if prefix != null then
		v.line_id_prefix = prefix.trim
	end
	v.include_loose_tokens = true
	v.include_whole_lines = true

	if opt_first_line.value != 0 then v.first_line = opt_first_line.value
	if opt_last_line.value != 0 then v.last_line = opt_last_line.value
	if opt_ast.value then v.with_ast = true
	if opt_noinfobox.value then v.show_infobox = false
	var page = null
	var m = modelbuilder.mmodule2node(mm)
	assert m != null
	if not opt_fragment.value then
		page = new HTMLTag("html")
		page.add_raw_html """<head>
		<meta charset="utf-8">
		<title>file {{{m.location.file.filename}}}</title>"""
		if dir == null then
			page.add_raw_html """
			<style type="text/css">
			{{{v.css_content}}}
			</style>
			"""
		else
			page.add_raw_html """<link rel="stylesheet" type="text/css" href="style.css" />"""
		end
		page.add_raw_html v.head_content
		page.add_raw_html "</head><body><pre class='nit_code'>"
	end
	v.highlight_node(m)
	if not opt_fragment.value then
		page.add(v.html)
		page.add_raw_html "</pre>"
		page.add_raw_html v.foot_content
		page.add_raw_html "</body>"
	else
		page = v.html
	end

	if dir != null then
		page.write_to_file("{dir}/{mm.c_name}.html")
	else
		page.write_to(stdout)
	end
end

if dir != null then
	toolcontext.info("write {dir}/index.html", 1)

	var page = new HTMLTag("html")
	page.add_raw_html """<head>
	<meta charset="utf-8">
	</head><body><ul>
	"""
	for mm in mmodules do
		var n = new HTMLTag("li")
		var n2 = new HTMLTag("a")
		page.add n
		n.add n2
		n2.attr("href", "{mm.c_name}.html")
		n2.text(mm.full_name)
	end
	page.add_raw_html "</li></body>"
	page.write_to_file("{dir}/index.html")

	var v = new HtmlightVisitor
	toolcontext.info("write {dir}/style.css", 1)
	var f = new FileWriter.open("{dir}/style.css")
	f.write v.css_content
	f.close
end
src/nitlight.nit:15,1--220,3