Introduced properties

private var _declared_annotations: MModuleMultiData[String]

nitc :: CheckAnnotationPhase :: _declared_annotations

The map of all declared user annotation
private var _mmodule: nullable MModule

nitc :: CheckAnnotationPhase :: _mmodule

The current module.
private var _primtives_annotations: HashSet[String]

nitc :: CheckAnnotationPhase :: _primtives_annotations

Efficient set build from primtives_annotations_list
private var _primtives_annotations_list: String

nitc :: CheckAnnotationPhase :: _primtives_annotations_list

Raw new-line separated list of primitive annotation
private var _user_annotations: HashMap[MModule, HashSet[String]]

nitc :: CheckAnnotationPhase :: _user_annotations

All user-declared annotations for each mmodule
private fun declared_annotations: MModuleMultiData[String]

nitc :: CheckAnnotationPhase :: declared_annotations

The map of all declared user annotation
private fun declared_annotations=(declared_annotations: MModuleMultiData[String])

nitc :: CheckAnnotationPhase :: declared_annotations=

The map of all declared user annotation
init defaultinit(toolcontext: ToolContext, depends: nullable Collection[Phase])

nitc :: CheckAnnotationPhase :: defaultinit

private fun mmodule: nullable MModule

nitc :: CheckAnnotationPhase :: mmodule

The current module.
private fun mmodule=(mmodule: nullable MModule)

nitc :: CheckAnnotationPhase :: mmodule=

The current module.
private fun primtives_annotations: HashSet[String]

nitc :: CheckAnnotationPhase :: primtives_annotations

Efficient set build from primtives_annotations_list
private fun primtives_annotations=(primtives_annotations: HashSet[String])

nitc :: CheckAnnotationPhase :: primtives_annotations=

Efficient set build from primtives_annotations_list
private fun primtives_annotations_list: String

nitc :: CheckAnnotationPhase :: primtives_annotations_list

Raw new-line separated list of primitive annotation
private fun primtives_annotations_list=(primtives_annotations_list: String)

nitc :: CheckAnnotationPhase :: primtives_annotations_list=

Raw new-line separated list of primitive annotation
private fun user_annotations: HashMap[MModule, HashSet[String]]

nitc :: CheckAnnotationPhase :: user_annotations

All user-declared annotations for each mmodule
private fun user_annotations=(user_annotations: HashMap[MModule, HashSet[String]])

nitc :: CheckAnnotationPhase :: user_annotations=

All user-declared annotations for each mmodule

Redefined properties

redef type SELF: CheckAnnotationPhase

nitc $ CheckAnnotationPhase :: SELF

Type of this instance, automatically specialized in every class
redef fun process_annotated_node(node: ANode, nat: AAnnotation)

nitc $ CheckAnnotationPhase :: process_annotated_node

Specific actions to execute on annotated nodes
redef fun process_nmodule(nmodule: AModule)

nitc $ CheckAnnotationPhase :: process_nmodule

Specific actions to execute on the whole tree of a module

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 _declared_annotations: MModuleMultiData[String]

nitc :: CheckAnnotationPhase :: _declared_annotations

The map of all declared user annotation
private var _depends: nullable Collection[Phase]

nitc :: Phase :: _depends

The explicit dependences, used to initialize in_importation
private var _disabled: Bool

nitc :: Phase :: _disabled

Is the phase globally disabled?
private var _in_hierarchy: POSetElement[Phase]

nitc :: Phase :: _in_hierarchy

The dependence relation of the phase with the other phases
private var _mmodule: nullable MModule

nitc :: CheckAnnotationPhase :: _mmodule

The current module.
private var _primtives_annotations: HashSet[String]

nitc :: CheckAnnotationPhase :: _primtives_annotations

Efficient set build from primtives_annotations_list
private var _primtives_annotations_list: String

nitc :: CheckAnnotationPhase :: _primtives_annotations_list

Raw new-line separated list of primitive annotation
private var _toolcontext: ToolContext

nitc :: Phase :: _toolcontext

The toolcontext instance attached to the phase
private var _user_annotations: HashMap[MModule, HashSet[String]]

nitc :: CheckAnnotationPhase :: _user_annotations

All user-declared annotations for each mmodule
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 declared_annotations: MModuleMultiData[String]

nitc :: CheckAnnotationPhase :: declared_annotations

The map of all declared user annotation
private fun declared_annotations=(declared_annotations: MModuleMultiData[String])

nitc :: CheckAnnotationPhase :: declared_annotations=

The map of all declared user annotation
init defaultinit(toolcontext: ToolContext, depends: nullable Collection[Phase])

nitc :: CheckAnnotationPhase :: defaultinit

init defaultinit(toolcontext: ToolContext, depends: nullable Collection[Phase])

nitc :: Phase :: defaultinit

fun depends: nullable Collection[Phase]

nitc :: Phase :: depends

The explicit dependences, used to initialize in_importation
protected fun depends=(depends: nullable Collection[Phase])

nitc :: Phase :: depends=

The explicit dependences, used to initialize in_importation
fun disabled: Bool

nitc :: Phase :: disabled

Is the phase globally disabled?
fun disabled=(disabled: Bool)

nitc :: Phase :: disabled=

Is the phase globally disabled?
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 in_hierarchy: POSetElement[Phase]

nitc :: Phase :: in_hierarchy

The dependence relation of the phase with the other phases
protected fun in_hierarchy=(in_hierarchy: POSetElement[Phase])

nitc :: Phase :: in_hierarchy=

The dependence relation of the phase with the other phases
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".
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 mmodule: nullable MModule

nitc :: CheckAnnotationPhase :: mmodule

The current module.
private fun mmodule=(mmodule: nullable MModule)

nitc :: CheckAnnotationPhase :: mmodule=

The current module.
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).
private fun primtives_annotations: HashSet[String]

nitc :: CheckAnnotationPhase :: primtives_annotations

Efficient set build from primtives_annotations_list
private fun primtives_annotations=(primtives_annotations: HashSet[String])

nitc :: CheckAnnotationPhase :: primtives_annotations=

Efficient set build from primtives_annotations_list
private fun primtives_annotations_list: String

nitc :: CheckAnnotationPhase :: primtives_annotations_list

Raw new-line separated list of primitive annotation
private fun primtives_annotations_list=(primtives_annotations_list: String)

nitc :: CheckAnnotationPhase :: primtives_annotations_list=

Raw new-line separated list of primitive annotation
fun process_annotated_node(node: ANode, nat: AAnnotation)

nitc :: Phase :: process_annotated_node

Specific actions to execute on annotated nodes
fun process_mainmodule(mainmodule: MModule, given_mmodules: SequenceRead[MModule])

nitc :: Phase :: process_mainmodule

Specific action to execute on the whole program.
fun process_nclassdef(nclassdef: AClassdef)

nitc :: Phase :: process_nclassdef

Specific actions to execute on the tree of a class definition
fun process_nmodule(nmodule: AModule)

nitc :: Phase :: process_nmodule

Specific actions to execute on the whole tree of a module
fun process_nmodule_after(nmodule: AModule)

nitc :: Phase :: process_nmodule_after

Specific actions to execute on the whole tree of a module
fun process_npropdef(npropdef: APropdef)

nitc :: Phase :: process_npropdef

Specific actions to execute on the tree of a property
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.
fun toolcontext: ToolContext

nitc :: Phase :: toolcontext

The toolcontext instance attached to the phase
protected fun toolcontext=(toolcontext: ToolContext)

nitc :: Phase :: toolcontext=

The toolcontext instance attached to the phase
private fun user_annotations: HashMap[MModule, HashSet[String]]

nitc :: CheckAnnotationPhase :: user_annotations

All user-declared annotations for each mmodule
private fun user_annotations=(user_annotations: HashMap[MModule, HashSet[String]])

nitc :: CheckAnnotationPhase :: user_annotations=

All user-declared annotations for each mmodule
package_diagram nitc::check_annotation::CheckAnnotationPhase CheckAnnotationPhase nitc::Phase Phase nitc::check_annotation::CheckAnnotationPhase->nitc::Phase core::Object Object nitc::Phase->core::Object ...core::Object ... ...core::Object->core::Object

Ancestors

interface Object

core :: Object

The root of the class hierarchy.

Parents

abstract class Phase

nitc :: Phase

Abstraction of steps in the analysis/processing of Nit programs

Class definitions

nitc $ CheckAnnotationPhase
private class CheckAnnotationPhase
	super Phase

	# The map of all declared user annotation
	# note: lazy because toolcontex is set in the init
	var declared_annotations = new MModuleMultiData[String](toolcontext.modelbuilder.model) is lazy

	# The current module.
	var mmodule: nullable MModule = null

	redef fun process_nmodule(nmodule)
	do
		# Get the mmodule
		var mmodule = nmodule.mmodule
		if mmodule == null then return
		self.mmodule = mmodule

		# If no decl block then quit
		var nmoduledecl = nmodule.n_moduledecl
		if nmoduledecl == null then return

		var modelbuilder = toolcontext.modelbuilder

		# Get all the new annotations
		var annots = nmoduledecl.get_annotations("new_annotation")

		var super_mmodules = declared_annotations.lookup_all_modules(mmodule, private_visibility)

		# Add each new annotations in the map
		for annot in annots do
			var name = annot.arg_as_id(modelbuilder)
			if name == null then continue

			for m in super_mmodules do
				if declared_annotations[m].has(name) then
					modelbuilder.warning(annot, "multiple-annotation-declarations", "Warning: an annotation `{name}` is already declared in module `{m}`.")
					break label
				end
			end

			declared_annotations[mmodule].add(name)
			#annot.debug "add {mmodule}: {name}"
		end label
	end

	# Raw new-line separated list of primitive annotation
	# Note: empty-lines will be ignored since there is no annotation named by the empty string.
	var primtives_annotations_list = """
new_annotation

conditional

deprecated
fixed
lazy
noinit
readonly
writable
optional
autoinit
noautoinit
lateinit
nosuper
old_style_init
abstract
intern
extern
no_warning
generated

auto_inspect

pkgconfig
cflags
ldflags
light_ffi

platform

test
before
before_all
after
after_all
example

expect
ensure
no_contract
"""

	# Efficient set build from `primtives_annotations_list`
	var primtives_annotations = new HashSet[String].from(primtives_annotations_list.split("\n"))

	# All user-declared annotations for each mmodule
	var user_annotations = new HashMap[MModule, HashSet[String]]

	redef fun process_annotated_node(node, nat)
	do
		var name = nat.name
		if primtives_annotations.has(name) then return

		var mmodule = self.mmodule
		if mmodule == null then return

		# Lazily build the full user-list
		var annots = user_annotations.get_or_null(mmodule)
		if annots == null then
			annots = new HashSet[String]
			annots.add_all(declared_annotations.lookup_joined_values(mmodule, private_visibility))
			user_annotations[mmodule] = annots
		end
		#nat.debug "for {mmodule}: {annots.join(" ")}"

		if annots.has(name) then return

		toolcontext.modelbuilder.warning(nat, "unknown-annotation", "Warning: unknown annotation `{name}`.")

		annots.add(name) # to avoid multiple errors on the same name
	end
end
src/frontend/check_annotation.nit:29,1--149,3