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
19 private import literal
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}")
38 # Return all its annotations of a given name in the order of their declaration
39 # Retun an empty array if no such an annotation.
40 fun get_annotations
(name
: String): Array[AAnnotation]
42 var res
= new Array[AAnnotation]
43 var nas
= n_annotations
44 if nas
== null then return res
45 for na
in nas
.n_items
do
46 if na
.name
!= name
then continue
53 redef class AAnnotation
54 # The name of the annotation
57 return n_atid
.n_id
.text
60 # Get the single argument of `self` as a `String`.
61 # Raise error and return null on any inconsistency.
62 fun arg_as_string
(modelbuilder
: ModelBuilder): nullable String
65 if args
.length
== 1 then
66 var arg
= args
.first
.as_string
67 if arg
!= null then return arg
70 modelbuilder
.error
(self, "Annotation error: \"{name}\
" expects a single String as argument.")
74 # Get the single argument of `self` as an `Int`.
75 # Raise error and return null on any inconsistency.
76 fun arg_as_int
(modelbuilder
: ModelBuilder): nullable Int
79 if args
.length
== 1 then
80 var arg
= args
.first
.as_int
81 if arg
!= null then return arg
84 modelbuilder
.error
(self, "Annotation error: \"{name}\
" expects a single Int as argument.")
88 # Get the single argument of `self` as an identifier.
89 # Raise error and return null on any inconsistency.
90 fun arg_as_id
(modelbuilder
: ModelBuilder): nullable String
93 if args
.length
== 1 then
94 var arg
= args
.first
.as_id
95 if arg
!= null then return arg
98 modelbuilder
.error
(self, "Annotation error: \"{name}\
" expects a single identifier as argument.")
104 # Get `self` as a `String`.
105 # Return null if not a string.
106 fun as_string
: nullable String
108 if not self isa AStringFormExpr then return null
109 return self.value
.as(not null)
112 # Get `self` as an `Int`.
113 # Return null if not an integer.
114 fun as_int
: nullable Int
116 if not self isa AIntExpr then return null
117 return self.value
.as(not null)
120 # Get `self` as a single identifier.
121 # Return null if not a single identifier.
122 fun as_id
: nullable String
124 if self isa AMethidExpr then
125 return self.collect_text
127 if not self isa ACallExpr then return null
128 if not self.n_expr
isa AImplicitSelfExpr then return null
129 if not self.n_args
.n_exprs
.is_empty
then return null
130 return self.n_id
.text
134 redef class ModelBuilder
135 # Collect all annotations by `name` assocated to `mmodule` and its imported modules.
136 # Note that visibility is not considered.
137 fun collect_annotations_on_modules
(name
: String, mmodule
: MModule): Array[AAnnotation]
139 var annotations
= new Array[AAnnotation]
140 for mmod
in mmodule
.in_importation
.greaters
do
141 if not mmodule2nmodule
.keys
.has
(mmod
) then continue
142 var amod
= mmodule2nmodule
[mmod
]
143 var module_decl
= amod
.n_moduledecl
144 if module_decl
== null then continue
145 var aas
= module_decl
.get_annotations
(name
)
146 annotations
.add_all aas
151 # Return the single annotation `name` locally assocated to `mmodule`, if any.
152 # Obviously, if there is no ast associated to `mmodule`, then nothing is returned.
153 fun get_mmodule_annotation
(name
: String, mmodule
: MModule): nullable AAnnotation
155 if not mmodule2nmodule
.keys
.has
(mmodule
) then return null
156 var amod
= mmodule2nmodule
[mmodule
]
157 var module_decl
= amod
.n_moduledecl
158 if module_decl
== null then return null
159 var res
= module_decl
.get_single_annotation
(name
, self)
163 private var collect_annotations_data_cache
= new HashMap[String, MModuleData[AAnnotation]]
165 # Collect all annotations by `name` in `mmodule` and its importations (direct and indirect)
166 # Note that visibility is not considered.
167 fun collect_annotations_data
(name
: String, mmodule
: MModule): MModuleData[AAnnotation]
169 var res
= collect_annotations_data_cache
.get_or_null
(name
)
171 res
= new MModuleData[AAnnotation](model
)
172 collect_annotations_data_cache
[name
] = res
175 for mmod
in mmodule
.in_importation
.greaters
do
176 if res
.has_mmodule
(mmod
) then continue
177 var ass
= get_mmodule_annotation
(name
, mmod
)
178 if ass
== null then continue
184 # Get an annotation by name from `mmodule` and its super modules. Will recursively search
185 # in imported module to find the "latest" declaration and detects priority conflicts.
186 fun lookup_annotation_on_modules
(name
: String, mmodule
: MModule): nullable AAnnotation
188 var data
= collect_annotations_data
(name
, mmodule
)
189 var annotations
= data
.lookup_values
(mmodule
, none_visibility
)
190 if annotations
.is_empty
then return null
191 if annotations
.length
> 1 then
192 var locs
= new Array[Location]
193 for annot
in annotations
do locs
.add
(annot
.location
)
195 toolcontext
.error
(mmodule
.location
,
196 "Priority conflict on annotation {name}, it has been defined in: {locs.join(", ")}")
198 return annotations
.first