1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Management and utilities on annotations
20 import model
::mmodule_data
25 # Try to get its single annotation with a given name
26 # If there is no such an annotation, null is returned.
27 # If there is more than one annotation, a error message is printed and the first annotation is returned
28 fun get_single_annotation
(name
: String, modelbuilder
: ModelBuilder): nullable AAnnotation
30 var res
= get_annotations
(name
)
31 if res
.is_empty
then return null
32 if res
.length
> 1 then
33 modelbuilder
.error
(res
[1], "Error: multiple annotation `{name}`. A previous one is defined line {res[0].location.line_start}")
39 redef class AAnnotation
40 # Get the single argument of `self` as a `String`.
41 # Raise error and return null on any inconsistency.
42 fun arg_as_string
(modelbuilder
: ModelBuilder): nullable String
45 if args
.length
== 1 then
46 var arg
= args
.first
.as_string
47 if arg
!= null then return arg
50 modelbuilder
.error
(self, "Annotation error: \"{name}\
" expects a single String as argument.")
54 # Get the single argument of `self` as an `Int`.
55 # Raise error and return null on any inconsistency.
56 fun arg_as_int
(modelbuilder
: ModelBuilder): nullable Int
59 if args
.length
== 1 then
60 var arg
= args
.first
.as_int
61 if arg
!= null then return arg
64 modelbuilder
.error
(self, "Annotation error: \"{name}\
" expects a single Int as argument.")
68 # Get the single argument of `self` as an identifier.
69 # Raise error and return null on any inconsistency.
70 fun arg_as_id
(modelbuilder
: ModelBuilder): nullable String
73 if args
.length
== 1 then
74 var arg
= args
.first
.as_id
75 if arg
!= null then return arg
78 modelbuilder
.error
(self, "Annotation error: \"{name}\
" expects a single identifier as argument.")
83 redef class ModelBuilder
84 # Collect all annotations by `name` assocated to `mmodule` and its imported modules.
85 # Note that visibility is not considered.
86 fun collect_annotations_on_modules
(name
: String, mmodule
: MModule): Array[AAnnotation]
88 var annotations
= new Array[AAnnotation]
89 for mmod
in mmodule
.in_importation
.greaters
do
90 if not mmodule2nmodule
.keys
.has
(mmod
) then continue
91 var amod
= mmodule2nmodule
[mmod
]
92 var module_decl
= amod
.n_moduledecl
93 if module_decl
== null then continue
94 var aas
= module_decl
.get_annotations
(name
)
95 annotations
.add_all aas
100 # Return the single annotation `name` locally assocated to `mmodule`, if any.
101 # Obviously, if there is no ast associated to `mmodule`, then nothing is returned.
102 fun get_mmodule_annotation
(name
: String, mmodule
: MModule): nullable AAnnotation
104 if not mmodule2nmodule
.keys
.has
(mmodule
) then return null
105 var amod
= mmodule2nmodule
[mmodule
]
106 var module_decl
= amod
.n_moduledecl
107 if module_decl
== null then return null
108 var res
= module_decl
.get_single_annotation
(name
, self)
112 private var collect_annotations_data_cache
= new HashMap[String, MModuleData[AAnnotation]]
114 # Collect all annotations by `name` in `mmodule` and its importations (direct and indirect)
115 # Note that visibility is not considered.
116 fun collect_annotations_data
(name
: String, mmodule
: MModule): MModuleData[AAnnotation]
118 var res
= collect_annotations_data_cache
.get_or_null
(name
)
120 res
= new MModuleData[AAnnotation](model
)
121 collect_annotations_data_cache
[name
] = res
124 for mmod
in mmodule
.in_importation
.greaters
do
125 if res
.has_mmodule
(mmod
) then continue
126 var ass
= get_mmodule_annotation
(name
, mmod
)
127 if ass
== null then continue
133 # Get an annotation by name from `mmodule` and its super modules. Will recursively search
134 # in imported module to find the "latest" declaration and detects priority conflicts.
135 fun lookup_annotation_on_modules
(name
: String, mmodule
: MModule): nullable AAnnotation
137 var data
= collect_annotations_data
(name
, mmodule
)
138 var annotations
= data
.lookup_values
(mmodule
, none_visibility
)
139 if annotations
.is_empty
then return null
140 if annotations
.length
> 1 then
141 var locs
= new Array[Location]
142 for annot
in annotations
do locs
.add
(annot
.location
)
144 toolcontext
.error
(mmodule
.location
,
145 "Priority conflict on annotation {name}, it has been defined in: {locs.join(", ")}")
147 return annotations
.first