private class TemplateMacro

template :: TemplateMacro

A macro is a special text command that is replaced by other content in a TemplateString.

Introduced properties

private var _end_pos: Int

template :: TemplateMacro :: _end_pos

Macro ending position in template.
private var _name: String

template :: TemplateMacro :: _name

Macro name as found in the template.
private var _replacement: nullable Writable

template :: TemplateMacro :: _replacement

Macro replacement if any.
private var _start_pos: Int

template :: TemplateMacro :: _start_pos

Macro starting position in template.
init defaultinit(name: String, start_pos: Int, end_pos: Int)

template :: TemplateMacro :: defaultinit

private fun end_pos: Int

template :: TemplateMacro :: end_pos

Macro ending position in template.
private fun end_pos=(end_pos: Int)

template :: TemplateMacro :: end_pos=

Macro ending position in template.
private fun is_replaced: Bool

template :: TemplateMacro :: is_replaced

Does self already have a replacement?
private fun location: String

template :: TemplateMacro :: location

Human readable location.
private fun name: String

template :: TemplateMacro :: name

Macro name as found in the template.
private fun name=(name: String)

template :: TemplateMacro :: name=

Macro name as found in the template.
private fun replacement: nullable Writable

template :: TemplateMacro :: replacement

Macro replacement if any.
private fun replacement=(replacement: nullable Writable)

template :: TemplateMacro :: replacement=

Macro replacement if any.
private fun start_pos: Int

template :: TemplateMacro :: start_pos

Macro starting position in template.
private fun start_pos=(start_pos: Int)

template :: TemplateMacro :: start_pos=

Macro starting position in template.

Redefined properties

redef type SELF: TemplateMacro

template $ TemplateMacro :: SELF

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

template $ TemplateMacro :: rendering

Render replacement or else name.

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 _content: Array[Writable]

template :: Template :: _content

Each sub-elements
private var _end_pos: Int

template :: TemplateMacro :: _end_pos

Macro ending position in template.
private var _is_frozen: Bool

template :: Template :: _is_frozen

Is the template allowing more modification (add)
private var _is_writing: Bool

template :: Template :: _is_writing

Flag to avoid infinite recursivity if a template contains itself
private var _name: String

template :: TemplateMacro :: _name

Macro name as found in the template.
private var _render_done: Bool

template :: Template :: _render_done

Flag to avoid multiple rendering
private var _replacement: nullable Writable

template :: TemplateMacro :: _replacement

Macro replacement if any.
private var _start_pos: Int

template :: TemplateMacro :: _start_pos

Macro starting position in template.
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".
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.
private fun content: Array[Writable]

template :: Template :: content

Each sub-elements
private fun content=(content: Array[Writable])

template :: Template :: content=

Each sub-elements
init defaultinit(name: String, start_pos: Int, end_pos: Int)

template :: TemplateMacro :: defaultinit

private fun end_pos: Int

template :: TemplateMacro :: end_pos

Macro ending position in template.
private fun end_pos=(end_pos: Int)

template :: TemplateMacro :: end_pos=

Macro ending position in template.
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.
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)
private fun is_replaced: Bool

template :: TemplateMacro :: is_replaced

Does self already have a replacement?
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 fun is_writing: Bool

template :: Template :: is_writing

Flag to avoid infinite recursivity if a template contains itself
private fun is_writing=(is_writing: Bool)

template :: Template :: is_writing=

Flag to avoid infinite recursivity if a template contains itself
private fun location: String

template :: TemplateMacro :: location

Human readable location.
private fun name: String

template :: TemplateMacro :: name

Macro name as found in the template.
private fun name=(name: String)

template :: TemplateMacro :: name=

Macro name as found in the template.
private intern fun native_class_name: CString

core :: Object :: native_class_name

The class name of the object in CString format.
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).
private fun render_done: Bool

template :: Template :: render_done

Flag to avoid multiple rendering
private fun render_done=(render_done: Bool)

template :: Template :: render_done=

Flag to avoid multiple rendering
protected fun rendering

template :: Template :: rendering

Service used to render the content of the template.
private fun replacement: nullable Writable

template :: TemplateMacro :: replacement

Macro replacement if any.
private fun replacement=(replacement: nullable Writable)

template :: TemplateMacro :: replacement=

Macro replacement if any.
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
private fun start_pos: Int

template :: TemplateMacro :: start_pos

Macro starting position in template.
private fun start_pos=(start_pos: Int)

template :: TemplateMacro :: start_pos=

Macro starting position in template.
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 template::macro::TemplateMacro TemplateMacro template::Template Template template::macro::TemplateMacro->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

template $ TemplateMacro 
# A macro is a special text command that is replaced by other content in a `TemplateString`.
private class TemplateMacro
	super Template
	# Macro name as found in the template.
	var name: String

	# Macro starting position in template.
	var start_pos: Int

	# Macro ending position in template.
	var end_pos: Int

	# Macro replacement if any.
	var replacement: nullable Writable = null

	# Does `self` already have a `replacement`?
	fun is_replaced: Bool do return replacement != null

	# Render `replacement` or else `name`.
	redef fun rendering do
		if is_replaced then
			add replacement.as(not null)
		else
			add "%{name}%"
		end
	end

	# Human readable location.
	fun location: String do return "({start_pos}:{end_pos})"
end
lib/template/macro.nit:276,1--305,3
Nit tools. Version .