Template of a Nit module to generate Nit code

Introduced properties

fun annotations: Array[Writable]

gen_nit :: NitModule :: annotations

Annotations on the module declaration
protected fun annotations=(annotations: Array[Writable])

gen_nit :: NitModule :: annotations=

Annotations on the module declaration
fun content: Array[Writable]

gen_nit :: NitModule :: content

Main content of this module
protected fun content=(content: Array[Writable])

gen_nit :: NitModule :: content=

Main content of this module
fun header: nullable Writable

gen_nit :: NitModule :: header

Header on top of the module, usually the documentation
fun header=(header: nullable Writable)

gen_nit :: NitModule :: header=

Header on top of the module, usually the documentation
fun imports: Set[Writable]

gen_nit :: NitModule :: imports

Importation declarations
protected fun imports=(imports: Set[Writable])

gen_nit :: NitModule :: imports=

Importation declarations
fun name: Writable

gen_nit :: NitModule :: name

The module's name
fun name=(name: Writable)

gen_nit :: NitModule :: name=

The module's name

Redefined properties

redef type SELF: NitModule

gen_nit $ NitModule :: SELF

Type of this instance, automatically specialized in every class
redef fun rendering

gen_nit $ NitModule :: rendering

Service used to render the content of the template.

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(element: Writable)

template :: Template :: add

Append an element (String, other Template, etc.) at the end of the template.
fun add_all(elements: Collection[Writable])

template :: Template :: add_all

Append a bunch of elements at the end of the template.
fun add_list(elements: Collection[Writable], sep: Writable, last_sep: Writable)

template :: Template :: add_list

Append a bunch of elements at the end of the template with separations.
fun addn(element: Writable)

template :: Template :: addn

Append element and the end of the template then append a "\n".
fun annotations: Array[Writable]

gen_nit :: NitModule :: annotations

Annotations on the module declaration
protected fun annotations=(annotations: Array[Writable])

gen_nit :: NitModule :: annotations=

Annotations on the module declaration
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 content: Array[Writable]

gen_nit :: NitModule :: content

Main content of this module
protected fun content=(content: Array[Writable])

gen_nit :: NitModule :: content=

Main content of this module
fun force_render

template :: Template :: force_render

Call rendering, if not already done
fun freeze

template :: Template :: freeze

Disable further modification: no more add is allowed
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 header: nullable Writable

gen_nit :: NitModule :: header

Header on top of the module, usually the documentation
fun header=(header: nullable Writable)

gen_nit :: NitModule :: header=

Header on top of the module, usually the documentation
fun imports: Set[Writable]

gen_nit :: NitModule :: imports

Importation declarations
protected fun imports=(imports: Set[Writable])

gen_nit :: NitModule :: imports=

Importation declarations
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".
fun is_frozen: Bool

template :: Template :: is_frozen

Is the template allowing more modification (add)
protected fun is_frozen=(is_frozen: Bool)

template :: Template :: is_frozen=

Is the template allowing more modification (add)
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 name: Writable

gen_nit :: NitModule :: name

The module's name
fun name=(name: Writable)

gen_nit :: NitModule :: name=

The module's name
fun new_sub: Template

template :: Template :: new_sub

Return a new basic template that is automatically added in self (using add)
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).
protected fun rendering

template :: Template :: rendering

Service used to render the content of the template.
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.
abstract fun write_to(stream: Writer)

core :: Writable :: write_to

Write itself to a stream
fun write_to_bytes: Bytes

core :: Writable :: write_to_bytes

Like write_to but return a new Bytes (may be quite large)
fun write_to_file(filepath: String)

core :: Writable :: write_to_file

Like write_to but take care of creating the file
fun write_to_string: String

core :: Writable :: write_to_string

Like write_to but return a new String (may be quite large).
package_diagram gen_nit::NitModule NitModule template::Template Template gen_nit::NitModule->template::Template core::Writable Writable template::Template->core::Writable ...core::Writable ... ...core::Writable->core::Writable

Ancestors

interface Object

core :: Object

The root of the class hierarchy.
interface Writable

core :: Writable

Things that can be efficienlty written to a Writer

Parents

class Template

template :: Template

Templates are simple hierarchical pieces of text used for efficient stream writing.

Class definitions

gen_nit $ NitModule
# Template of a Nit module to generate Nit code
class NitModule
	super Template

	# Header on top of the module, usually the documentation
	var header: nullable Writable = null is writable

	# The module's name
	var name: Writable is writable

	# Annotations on the module declaration
	var annotations = new Array[Writable]

	# Importation declarations
	#
	# Accepts two formats:
	# * Module name only, short or qualified: `json`, `gamnit::flat`, etc.
	# * Full importation declaration: `import json`, `private import gamnit::flat`, etc.
	var imports = new Set[Writable]

	# Main content of this module
	var content = new Array[Writable]

	redef fun rendering
	do
		var header = header
		if header != null then add header

		var name = name
		if annotations.is_empty then
			add "module {name}\n\n"
		else
			add "module {name} is\n"
			for annotation in annotations do add "\t{annotation}\n"
			add "end\n\n"
		end

		for i in imports do
			if i.to_s.has("import ") then
				add i
			else
				add "import "
				add i
			end
			add "\n"
		end
		add "\n"

		for l in content do
			add l
			add "\n"
		end
	end
end
lib/gen_nit/gen_nit.nit:45,1--98,3