A class definition

While most definitions are AStdClassdefs, there are 2 special cases of class definitions.

Introduced properties

private var _all_defs: nullable Array[AClassdef]

nitc :: AClassdef :: _all_defs

All (self and other) definitions for the same mclassdef
private var _build_properties_is_done: Bool

nitc :: AClassdef :: _build_properties_is_done

Marker used in ModelBuilder::build_properties
private var _mclass: nullable MClass

nitc :: AClassdef :: _mclass

The associated MClass once build by a ModelBuilder
private var _mclassdef: nullable MClassDef

nitc :: AClassdef :: _mclassdef

The associated MClassDef once build by a ModelBuilder
private var _n_propdefs: ANodes[APropdef]

nitc :: AClassdef :: _n_propdefs

All the declared properties (including the main method)
fun all_defs: nullable Array[AClassdef]

nitc :: AClassdef :: all_defs

All (self and other) definitions for the same mclassdef
protected fun all_defs=(all_defs: nullable Array[AClassdef])

nitc :: AClassdef :: all_defs=

All (self and other) definitions for the same mclassdef
private fun build_properties_is_done: Bool

nitc :: AClassdef :: build_properties_is_done

Marker used in ModelBuilder::build_properties
private fun build_properties_is_done=(build_properties_is_done: Bool)

nitc :: AClassdef :: build_properties_is_done=

Marker used in ModelBuilder::build_properties
private fun call(v: NaiveInterpreter, mpropdef: MMethodDef, arguments: Array[Instance]): nullable Instance

nitc :: AClassdef :: call

Execute an implicit mpropdef associated with the current node.
fun mclass: nullable MClass

nitc :: AClassdef :: mclass

The associated MClass once build by a ModelBuilder
protected fun mclass=(mclass: nullable MClass)

nitc :: AClassdef :: mclass=

The associated MClass once build by a ModelBuilder
fun mclassdef: nullable MClassDef

nitc :: AClassdef :: mclassdef

The associated MClassDef once build by a ModelBuilder
protected fun mclassdef=(mclassdef: nullable MClassDef)

nitc :: AClassdef :: mclassdef=

The associated MClassDef once build by a ModelBuilder
fun n_propdefs: ANodes[APropdef]

nitc :: AClassdef :: n_propdefs

All the declared properties (including the main method)
protected fun n_propdefs=(n_propdefs: ANodes[APropdef])

nitc :: AClassdef :: n_propdefs=

All the declared properties (including the main method)

Redefined properties

redef type SELF: AClassdef

nitc $ AClassdef :: SELF

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

nitc :: pretty $ AClassdef :: accept_pretty_printer

Start visit of self using a PrettyPrinterVisitor

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 _all_defs: nullable Array[AClassdef]

nitc :: AClassdef :: _all_defs

All (self and other) definitions for the same mclassdef
private var _build_properties_is_done: Bool

nitc :: AClassdef :: _build_properties_is_done

Marker used in ModelBuilder::build_properties
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 _mclass: nullable MClass

nitc :: AClassdef :: _mclass

The associated MClass once build by a ModelBuilder
private var _mclassdef: nullable MClassDef

nitc :: AClassdef :: _mclassdef

The associated MClassDef once build by a ModelBuilder
private var _n_annotations: nullable AAnnotations

nitc :: Prod :: _n_annotations

All the annotations attached directly to the node
private var _n_propdefs: ANodes[APropdef]

nitc :: AClassdef :: _n_propdefs

All the declared properties (including the main method)
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.
fun all_defs: nullable Array[AClassdef]

nitc :: AClassdef :: all_defs

All (self and other) definitions for the same mclassdef
protected fun all_defs=(all_defs: nullable Array[AClassdef])

nitc :: AClassdef :: all_defs=

All (self and other) definitions for the same mclassdef
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.
private fun build_properties_is_done: Bool

nitc :: AClassdef :: build_properties_is_done

Marker used in ModelBuilder::build_properties
private fun build_properties_is_done=(build_properties_is_done: Bool)

nitc :: AClassdef :: build_properties_is_done=

Marker used in ModelBuilder::build_properties
private fun call(v: NaiveInterpreter, mpropdef: MMethodDef, arguments: Array[Instance]): nullable Instance

nitc :: AClassdef :: call

Execute an implicit mpropdef associated with the current node.
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

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
fun mclass: nullable MClass

nitc :: AClassdef :: mclass

The associated MClass once build by a ModelBuilder
protected fun mclass=(mclass: nullable MClass)

nitc :: AClassdef :: mclass=

The associated MClass once build by a ModelBuilder
fun mclassdef: nullable MClassDef

nitc :: AClassdef :: mclassdef

The associated MClassDef once build by a ModelBuilder
protected fun mclassdef=(mclassdef: nullable MClassDef)

nitc :: AClassdef :: mclassdef=

The associated MClassDef once build by a ModelBuilder
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_propdefs: ANodes[APropdef]

nitc :: AClassdef :: n_propdefs

All the declared properties (including the main method)
protected fun n_propdefs=(n_propdefs: ANodes[APropdef])

nitc :: AClassdef :: n_propdefs=

All the declared properties (including the main method)
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::AClassdef AClassdef nitc::Prod Prod nitc::AClassdef->nitc::Prod nitc::ANode ANode nitc::Prod->nitc::ANode ...nitc::ANode ... ...nitc::ANode->nitc::ANode nitc::AStdClassdef AStdClassdef nitc::AStdClassdef->nitc::AClassdef nitc::ATopClassdef ATopClassdef nitc::ATopClassdef->nitc::AClassdef nitc::AMainClassdef AMainClassdef nitc::AMainClassdef->nitc::AClassdef

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

Children

class AMainClassdef

nitc :: AMainClassdef

The implicit class definition of the top-level methods
class AStdClassdef

nitc :: AStdClassdef

A standard class definition with a name, superclasses and properties
class ATopClassdef

nitc :: ATopClassdef

The implicit class definition of the implicit main method

Class definitions

nitc $ AClassdef
# A class definition
#
# While most definitions are `AStdClassdef`s,
# there are 2 special cases of class definitions.
abstract class AClassdef
	super Prod
	# All the declared properties (including the main method)
	var n_propdefs = new ANodes[APropdef](self)
end
src/parser/parser_nodes.nit:1237,1--1245,3

nitc :: modelize_class $ AClassdef
redef class AClassdef
	# The associated MClass once build by a `ModelBuilder`
	var mclass: nullable MClass
	# The associated MClassDef once build by a `ModelBuilder`
	var mclassdef: nullable MClassDef
	# All (self and other) definitions for the same mclassdef
	var all_defs: nullable Array[AClassdef]
end
src/modelize/modelize_class.nit:513,1--520,3

nitc :: modelize_property $ AClassdef
redef class AClassdef
	# Marker used in `ModelBuilder::build_properties`
	private var build_properties_is_done = false
end
src/modelize/modelize_property.nit:517,1--520,3

nitc :: pretty $ AClassdef
redef class AClassdef
	redef fun accept_pretty_printer(v) do
		for n_propdef in n_propdefs do
			v.catch_up n_propdef

			if n_propdef.n_doc != null or not v.can_inline(n_propdef) then
				if v.skip_empty and n_propdef != n_propdefs.first then v.addn
				v.visit n_propdef
				if v.skip_empty and n_propdef != n_propdefs.last then v.addn
			else
				v.visit n_propdef
			end
		end
	end
end
src/pretty.nit:667,1--681,3

nitc :: naive_interpreter $ AClassdef
redef class AClassdef
	# Execute an implicit `mpropdef` associated with the current node.
	private fun call(v: NaiveInterpreter, mpropdef: MMethodDef, arguments: Array[Instance]): nullable Instance
	do
		if mpropdef.mproperty.is_root_init then
			assert arguments.length == 1
			if not mpropdef.is_intro then
				# standard call-next-method
				var superpd = mpropdef.lookup_next_definition(v.mainmodule, arguments.first.mtype)
				v.call(superpd, arguments)
			end
			return null
		else if mclassdef.default_init == mpropdef then
			var recv = arguments.first
			var initializers = mpropdef.initializers
			var no_init = false
			if not initializers.is_empty and not mpropdef.is_old_style_init then
				var i = 1
				for p in initializers do
					if p isa MMethod then
						var args = [recv]
						for x in p.intro.msignature.mparameters do
							args.add arguments[i]
							i += 1
						end
						v.send(p, args)
						if p.intro.is_calling_init then no_init = true
					else if p isa MAttribute then
						assert recv isa MutableInstance
						v.write_attribute(p, recv, arguments[i])
						i += 1
					else abort
				end
				assert i == arguments.length
			end
			if not no_init then v.send(mclass.the_root_init_mmethod.as(not null), [recv])
			return null
		else
			abort
		end
	end
end
src/interpreter/naive_interpreter.nit:1626,1--1667,3

nitc :: abstract_compiler $ AClassdef
redef class AClassdef
	private fun compile_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
	do
		if mpropdef.mproperty.is_root_init then
			assert arguments.length == 1
			if not mpropdef.is_intro then
				v.supercall(mpropdef, arguments.first.mtype.as(MClassType), arguments)
			end
			return
		else if mclassdef.default_init == mpropdef then
			var recv = arguments.first
			var initializers = mpropdef.initializers
			var no_init = false
			if not initializers.is_empty and not mpropdef.is_old_style_init then
				var i = 1
				for p in initializers do
					if p isa MMethod then
						var args = [recv]
						for x in p.intro.msignature.mparameters do
							args.add arguments[i]
							i += 1
						end
						v.send(p, args)
						if p.intro.is_calling_init then no_init = true
					else if p isa MAttribute then
						v.write_attribute(p, recv, arguments[i])
						i += 1
					else abort
				end
				assert i == arguments.length

			end
			if not no_init then v.send(mclass.the_root_init_mmethod.as(not null), [recv])
			return
		else
			abort
		end
	end
end
src/compiler/abstract_compiler.nit:3681,1--3719,3

nitc :: java_compiler $ AClassdef
redef class AClassdef
	private fun compile_to_java(v: JavaCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable]) do
		if mpropdef.mproperty.is_root_init then
			if not mpropdef.is_intro then
				v.supercall(mpropdef, arguments.first.mtype.as(MClassType), arguments)
			end
		else
			abort
		end
	end
end
src/compiler/java_compiler.nit:1483,1--1493,3