A group of annotation on a node

This same class is used for the 3 kind of annotations:

  • is annotations. eg module foo is bar.
  • at annotations. eg foo@bar or foo@(bar,baz).
  • class annotations, defined in classes.

Introduced properties

private var _n_at: nullable TAt

nitc :: AAnnotations :: _n_at

The @ symbol, for at annotations
private var _n_cpar: nullable TCpar

nitc :: AAnnotations :: _n_cpar

The closing parenthesis in at annotations
private var _n_items: ANodes[AAnnotation]

nitc :: AAnnotations :: _n_items

The list of annotations
private var _n_kwend: nullable TKwend

nitc :: AAnnotations :: _n_kwend

The end keyword, for is annotations
private var _n_kwis: nullable TKwis

nitc :: AAnnotations :: _n_kwis

The is keyword, for is annotations
private var _n_opar: nullable TOpar

nitc :: AAnnotations :: _n_opar

The opening parenthesis in at annotations
init init_aannotations(n_kwis: nullable TKwis, n_at: nullable TAt, n_opar: nullable TOpar, n_items: Collection[Object], n_cpar: nullable TCpar, n_kwend: nullable TKwend)

nitc :: AAnnotations :: init_aannotations

fun n_at: nullable TAt

nitc :: AAnnotations :: n_at

The @ symbol, for at annotations
fun n_at=(n_at: nullable TAt)

nitc :: AAnnotations :: n_at=

The @ symbol, for at annotations
fun n_cpar: nullable TCpar

nitc :: AAnnotations :: n_cpar

The closing parenthesis in at annotations
fun n_cpar=(n_cpar: nullable TCpar)

nitc :: AAnnotations :: n_cpar=

The closing parenthesis in at annotations
fun n_items: ANodes[AAnnotation]

nitc :: AAnnotations :: n_items

The list of annotations
protected fun n_items=(n_items: ANodes[AAnnotation])

nitc :: AAnnotations :: n_items=

The list of annotations
fun n_kwend: nullable TKwend

nitc :: AAnnotations :: n_kwend

The end keyword, for is annotations
fun n_kwend=(n_kwend: nullable TKwend)

nitc :: AAnnotations :: n_kwend=

The end keyword, for is annotations
fun n_kwis: nullable TKwis

nitc :: AAnnotations :: n_kwis

The is keyword, for is annotations
fun n_kwis=(n_kwis: nullable TKwis)

nitc :: AAnnotations :: n_kwis=

The is keyword, for is annotations
fun n_opar: nullable TOpar

nitc :: AAnnotations :: n_opar

The opening parenthesis in at annotations
fun n_opar=(n_opar: nullable TOpar)

nitc :: AAnnotations :: n_opar=

The opening parenthesis in at annotations

Redefined properties

redef type SELF: AAnnotations

nitc $ AAnnotations :: SELF

Type of this instance, automatically specialized in every class
redef fun accept_pretty_printer(v: PrettyPrinterVisitor)

nitc :: pretty $ AAnnotations :: accept_pretty_printer

Start visit of self using a PrettyPrinterVisitor
redef fun is_inlinable: Bool

nitc :: pretty $ AAnnotations :: is_inlinable

Is self printable in one line?
redef fun n_at=(node: nullable TAt)

nitc :: parser_prod $ AAnnotations :: n_at=

The @ symbol, for at annotations
redef fun n_cpar=(node: nullable TCpar)

nitc :: parser_prod $ AAnnotations :: n_cpar=

The closing parenthesis in at annotations
redef fun n_kwend=(node: nullable TKwend)

nitc :: parser_prod $ AAnnotations :: n_kwend=

The end keyword, for is annotations
redef fun n_kwis=(node: nullable TKwis)

nitc :: parser_prod $ AAnnotations :: n_kwis=

The is keyword, for is annotations
redef fun n_opar=(node: nullable TOpar)

nitc :: parser_prod $ AAnnotations :: n_opar=

The opening parenthesis in at annotations
redef fun replace_child(old_child: ANode, new_child: nullable ANode)

nitc :: parser_prod $ AAnnotations :: replace_child

Replace a child with an other node in the AST
redef fun visit_all(v: Visitor)

nitc :: parser_prod $ AAnnotations :: visit_all

Visit all nodes in order.

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 _first_location: nullable Location

nitc :: Prod :: _first_location

Location on the first token after the start of a production
private var _first_token: nullable Token

nitc :: Prod :: _first_token

The first token of the production in the AST
private var _force_block: Bool

nitc :: ANode :: _force_block

Force self to be rendered as a block.
private var _force_inline: Bool

nitc :: ANode :: _force_inline

Force self to be rendered as a line.
private var _is_broken: Bool

nitc :: ANode :: _is_broken

The indication that the node did not pass some semantic verifications.
private var _last_token: nullable Token

nitc :: Prod :: _last_token

The last token of the production in the AST
private var _location: Location

nitc :: ANode :: _location

Location is set during AST building. Once built, location can not be null.
private var _n_annotations: nullable AAnnotations

nitc :: Prod :: _n_annotations

All the annotations attached directly to the node
private var _n_at: nullable TAt

nitc :: AAnnotations :: _n_at

The @ symbol, for at annotations
private var _n_cpar: nullable TCpar

nitc :: AAnnotations :: _n_cpar

The closing parenthesis in at annotations
private var _n_items: ANodes[AAnnotation]

nitc :: AAnnotations :: _n_items

The list of annotations
private var _n_kwend: nullable TKwend

nitc :: AAnnotations :: _n_kwend

The end keyword, for is annotations
private var _n_kwis: nullable TKwis

nitc :: AAnnotations :: _n_kwis

The is keyword, for is annotations
private var _n_opar: nullable TOpar

nitc :: AAnnotations :: _n_opar

The opening parenthesis in at annotations
private var _parent: nullable ANode

nitc :: ANode :: _parent

Parent of the node in the AST
fun accept_forward_analysis(v: ForwardAnalysis)

nitc :: ANode :: accept_forward_analysis

Apply the forward analysis v to self.
private abstract fun accept_pretty_printer(v: PrettyPrinterVisitor)

nitc :: ANode :: accept_pretty_printer

Start visit of self using a PrettyPrinterVisitor
fun accept_reaching_defs(v: ReachingDefsAnalysis)

nitc :: ANode :: accept_reaching_defs

Apply a ReachingDefsAnalysis to self.
private fun bad_expr_message(child: AExpr): nullable String

nitc :: ANode :: bad_expr_message

An additional information message to explain the role of a child expression.
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.
abstract fun clone: SELF

core :: Cloneable :: clone

Duplicate self
fun collect_annotations_by_name(name: String): Array[AAnnotation]

nitc :: ANode :: collect_annotations_by_name

Do a deep search and return an array of node that are annotated
private fun collect_comments: Array[TComment]

nitc :: Prod :: collect_comments

Collect all TComment contained in the production
private abstract fun collect_length: Int

nitc :: ANode :: collect_length

Collect the length (in Char) of the node.
fun collect_text: String

nitc :: Prod :: collect_text

Join the text of all visited tokens
fun collect_tokens_by_text(text: String): Array[Token]

nitc :: ANode :: collect_tokens_by_text

Do a deep search and return an array of tokens that match a given text
fun common_parent(other: ANode): nullable ANode

nitc :: ANode :: common_parent

The most specific common parent between self and other
fun debug(message: String)

nitc :: ANode :: debug

Display a message for the colored location of the node
protected fun decorate_tag(v: HtmlightVisitor, res: HTMLTag, token: Token): nullable HInfoBox

nitc :: ANode :: decorate_tag

Add aditionnal information on a child-token and return an additionnal HInfoBox on it
fun depth: Int

nitc :: ANode :: depth

Number of nodes between self and the root of the AST
fun detach

nitc :: ANode :: detach

Detach a node from its parent
private fun do_cloneable(v: CloneVisitor)

nitc :: ANode :: do_cloneable

fun dump_info(v: ASTDump): String

nitc :: ANode :: dump_info

Information to display on a node
fun dump_tree(display_structural: nullable Bool, display_line: nullable Bool)

nitc :: ANode :: dump_tree

Write the subtree on stdout.
fun fatal(v: NaiveInterpreter, message: String)

nitc :: ANode :: fatal

Aborts the program with a message
fun first_location: nullable Location

nitc :: Prod :: first_location

Location on the first token after the start of a production
protected fun first_location=(first_location: nullable Location)

nitc :: Prod :: first_location=

Location on the first token after the start of a production
fun first_token: nullable Token

nitc :: Prod :: first_token

The first token of the production in the AST
protected fun first_token=(first_token: nullable Token)

nitc :: Prod :: first_token=

The first token of the production in the AST
private fun force_block: Bool

nitc :: ANode :: force_block

Force self to be rendered as a block.
private fun force_block=(force_block: Bool)

nitc :: ANode :: force_block=

Force self to be rendered as a block.
private fun force_inline: Bool

nitc :: ANode :: force_inline

Force self to be rendered as a line.
private fun force_inline=(force_inline: Bool)

nitc :: ANode :: force_inline=

Force self to be rendered as a line.
fun get_annotations(name: String): Array[AAnnotation]

nitc :: Prod :: get_annotations

Return all its annotations of a given name in the order of their declaration
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun get_single_annotation(name: String, modelbuilder: ModelBuilder): nullable AAnnotation

nitc :: Prod :: get_single_annotation

Try to get its single annotation with a given name
fun hash: Int

core :: Object :: hash

The hash code of the object.
fun hot_location: Location

nitc :: ANode :: hot_location

The location of the important part of the node (identifier or whatever)
fun infobox(v: HtmlightVisitor): nullable HInfoBox

nitc :: ANode :: infobox

Return a optional infobox
init init

core :: Object :: init

init init_aannotations(n_kwis: nullable TKwis, n_at: nullable TAt, n_opar: nullable TOpar, n_items: Collection[Object], n_cpar: nullable TCpar, n_kwend: nullable TKwend)

nitc :: AAnnotations :: init_aannotations

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_block: Bool

nitc :: Prod :: is_block

Is the production contained in full block of line?
fun is_broken: Bool

nitc :: ANode :: is_broken

The indication that the node did not pass some semantic verifications.
fun is_broken=(is_broken: Bool)

nitc :: ANode :: is_broken=

The indication that the node did not pass some semantic verifications.
private fun is_inlinable: Bool

nitc :: ANode :: is_inlinable

Is self printable in one line?
private fun is_noserialize: Bool

nitc :: ANode :: is_noserialize

Is this node annotated to not be made serializable?
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_serialize: Bool

nitc :: ANode :: is_serialize

Is this node annotated to be made serializable?
fun is_span: Bool

nitc :: Prod :: is_span

Is the production a part of a single line (without being a block)
fun is_structural: Bool

nitc :: ANode :: is_structural

Is self a token or a pure-structural production like AQId?
fun last_token: nullable Token

nitc :: Prod :: last_token

The last token of the production in the AST
protected fun last_token=(last_token: nullable Token)

nitc :: Prod :: last_token=

The last token of the production in the AST
fun location: Location

nitc :: ANode :: location

Location is set during AST building. Once built, location can not be null.
fun location=(location: Location)

nitc :: ANode :: location=

Location is set during AST building. Once built, location can not be null.
protected fun make_tag(v: HtmlightVisitor): nullable HTMLTag

nitc :: ANode :: make_tag

Optionally creates a tag that encapsulate the AST element on HTML rendering
private fun must_be_block: Bool

nitc :: ANode :: must_be_block

Does self have to be rendered as a block?
private fun must_be_inline: Bool

nitc :: ANode :: must_be_inline

Does self have be rendered as a line?
fun n_annotations: nullable AAnnotations

nitc :: Prod :: n_annotations

All the annotations attached directly to the node
fun n_annotations=(n_annotations: nullable AAnnotations)

nitc :: Prod :: n_annotations=

All the annotations attached directly to the node
fun n_at: nullable TAt

nitc :: AAnnotations :: n_at

The @ symbol, for at annotations
fun n_at=(n_at: nullable TAt)

nitc :: AAnnotations :: n_at=

The @ symbol, for at annotations
fun n_cpar: nullable TCpar

nitc :: AAnnotations :: n_cpar

The closing parenthesis in at annotations
fun n_cpar=(n_cpar: nullable TCpar)

nitc :: AAnnotations :: n_cpar=

The closing parenthesis in at annotations
fun n_items: ANodes[AAnnotation]

nitc :: AAnnotations :: n_items

The list of annotations
protected fun n_items=(n_items: ANodes[AAnnotation])

nitc :: AAnnotations :: n_items=

The list of annotations
fun n_kwend: nullable TKwend

nitc :: AAnnotations :: n_kwend

The end keyword, for is annotations
fun n_kwend=(n_kwend: nullable TKwend)

nitc :: AAnnotations :: n_kwend=

The end keyword, for is annotations
fun n_kwis: nullable TKwis

nitc :: AAnnotations :: n_kwis

The is keyword, for is annotations
fun n_kwis=(n_kwis: nullable TKwis)

nitc :: AAnnotations :: n_kwis=

The is keyword, for is annotations
fun n_opar: nullable TOpar

nitc :: AAnnotations :: n_opar

The opening parenthesis in at annotations
fun n_opar=(n_opar: nullable TOpar)

nitc :: AAnnotations :: n_opar=

The opening parenthesis in at annotations
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 parent: nullable ANode

nitc :: ANode :: parent

Parent of the node in the AST
protected fun parent=(parent: nullable ANode)

nitc :: ANode :: parent=

Parent of the node in the AST
fun parentize_tokens

nitc :: ANode :: parentize_tokens

Visit the AST and computes advanced AST attributes on Tokens and Prod
private abstract fun replace_child(old_child: ANode, new_child: nullable ANode)

nitc :: ANode :: replace_child

Replace a child with an other node in the AST
fun replace_clone

nitc :: ANode :: replace_clone

Create a new clone of self
fun replace_with(node: ANode)

nitc :: ANode :: replace_with

Replace itself with an other node in the AST
fun root: ANode

nitc :: ANode :: root

The topmost ancestor of the element
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
private fun start_token: nullable Token

nitc :: Prod :: start_token

The token where the production really start (skipping ADoc).
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 to_xml: HTMLTag

nitc :: Prod :: to_xml

A XML representation of the AST
fun validate

nitc :: ANode :: validate

Recursively validate a AST node.
abstract fun visit_all(v: Visitor)

nitc :: ANode :: visit_all

Visit all nodes in order.
private abstract fun was_inline: Bool

nitc :: ANode :: was_inline

Does self was written in one line before transformation?
package_diagram nitc::AAnnotations AAnnotations nitc::Prod Prod nitc::AAnnotations->nitc::Prod nitc::ANode ANode nitc::Prod->nitc::ANode ...nitc::ANode ... ...nitc::ANode->nitc::ANode

Ancestors

abstract class ANode

nitc :: ANode

Root of the AST class-hierarchy
interface Cloneable

core :: Cloneable

Something that can be cloned
interface Object

core :: Object

The root of the class hierarchy.

Parents

abstract class Prod

nitc :: Prod

Ancestor of all productions

Class definitions

nitc $ AAnnotations
# A group of annotation on a node
#
# This same class is used for the 3 kind of annotations:
#
# * *is* annotations. eg `module foo is bar`.
# * *at* annotations. eg `foo@bar` or `foo@(bar,baz)`.
# * *class* annotations, defined in classes.
class AAnnotations
	super Prod

	# The `is` keyword, for *is* annotations
	var n_kwis: nullable TKwis = null is writable

	# The `@` symbol, for *at* annotations
	var n_at: nullable TAt = null is writable

	# The opening parenthesis in *at* annotations
	var n_opar: nullable TOpar = null is writable

	# The list of annotations
	var n_items = new ANodes[AAnnotation](self)

	# The closing parenthesis in *at* annotations
	var n_cpar: nullable TCpar = null is writable

	# The `end` keyword, for *is* annotations
	var n_kwend: nullable TKwend = null is writable
end
src/parser/parser_nodes.nit:3048,1--3075,3

nitc :: parser_prod $ AAnnotations
redef class AAnnotations
	init init_aannotations (
		n_kwis: nullable TKwis,
		n_at: nullable TAt,
		n_opar: nullable TOpar,
		n_items: Collection[Object], # Should be Collection[AAnnotation]
		n_cpar: nullable TCpar,
		n_kwend: nullable TKwend
	)
	do
		_n_kwis = n_kwis
		if n_kwis != null then n_kwis.parent = self
		_n_at = n_at
		if n_at != null then n_at.parent = self
		_n_opar = n_opar
		if n_opar != null then n_opar.parent = self
		self.n_items.unsafe_add_all(n_items)
		_n_cpar = n_cpar
		if n_cpar != null then n_cpar.parent = self
		_n_kwend = n_kwend
		if n_kwend != null then n_kwend.parent = self
	end

	redef fun replace_child(old_child: ANode, new_child: nullable ANode)
	do
		if _n_kwis == old_child then
			n_kwis = new_child.as(nullable TKwis)
			return
		end
		if _n_at == old_child then
			n_at = new_child.as(nullable TAt)
			return
		end
		if _n_opar == old_child then
			n_opar = new_child.as(nullable TOpar)
			return
		end
		if n_items.replace_child(old_child, new_child) then return
		if _n_cpar == old_child then
			n_cpar = new_child.as(nullable TCpar)
			return
		end
		if _n_kwend == old_child then
			n_kwend = new_child.as(nullable TKwend)
			return
		end
	end

	redef fun n_kwis=(node)
	do
		_n_kwis = node
		if node != null then node.parent = self
	end
	redef fun n_at=(node)
	do
		_n_at = node
		if node != null then node.parent = self
	end
	redef fun n_opar=(node)
	do
		_n_opar = node
		if node != null then node.parent = self
	end
	redef fun n_cpar=(node)
	do
		_n_cpar = node
		if node != null then node.parent = self
	end
	redef fun n_kwend=(node)
	do
		_n_kwend = node
		if node != null then node.parent = self
	end


	redef fun visit_all(v: Visitor)
	do
		v.enter_visit(_n_kwis)
		v.enter_visit(_n_at)
		v.enter_visit(_n_opar)
		n_items.visit_all(v)
		v.enter_visit(_n_cpar)
		v.enter_visit(_n_kwend)
	end
end
src/parser/parser_prod.nit:8613,1--8697,3

nitc :: pretty $ AAnnotations
redef class AAnnotations
	redef fun accept_pretty_printer(v) do
		v.adds
		v.consume "is"
		if v.can_inline(self) then
			v.adds
			for n_item in n_items do
				v.visit n_item
				if n_item != n_items.last then
					v.add ", "
				end
			end
			if not was_inline then
				v.finish_line
				if v.current_token isa TKwend then v.skip
			end
		else
			v.forcen
			v.indent += 1
			for n_item in n_items do
				v.addt
				v.visit n_item
				v.finish_line
				if n_item != n_items.last then
					if was_inline then
						v.forcen
					else
						v.addn
					end
				end
			end
			v.indent -= 1
		end
	end

	redef fun is_inlinable do
		if not super then return false
		for annot in n_items do if not annot.is_inlinable then return false
		return true
	end
end
src/pretty.nit:493,1--533,3