1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2013 Jean-Philippe Caissy <jpcaissy@piji.ca>
4 # Copyright 2013 Guillaume Auger <jeho@resist.ca>
5 # Copyright 2014 Alexis Laferrière <alexis.laf@xymus.net>
7 # Licensed under the Apache License, Version 2.0 (the "License");
8 # you may not use this file except in compliance with the License.
9 # You may obtain a copy of the License at
11 # http://www.apache.org/licenses/LICENSE-2.0
13 # Unless required by applicable law or agreed to in writing, software
14 # distributed under the License is distributed on an "AS IS" BASIS,
15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 # See the License for the specific language governing permissions and
17 # limitations under the License.
19 # Phase generating methods to serialize Nit objects to different formats
20 module serialization_phase
22 private import parser_util
24 private import annotation
25 intrude import literal
27 redef class ToolContext
29 # Apply the annotation `serialize_as`
30 var serialization_phase_rename
: Phase = new SerializationPhaseRename(self, null)
32 # Generate serialization and deserialization methods on `auto_serializable` annotated classes.
33 var serialization_phase_pre_model
: Phase = new SerializationPhasePreModel(self,
34 [serialization_phase_rename
])
36 # The second phase of the serialization
37 var serialization_phase_post_model
: Phase = new SerializationPhasePostModel(self,
38 [modelize_property_phase
, serialization_phase_pre_model
])
42 # Is this node annotated to be made serializable?
43 private fun is_serialize
: Bool do return false
45 # Is this node annotated to not be made serializable?
46 private fun is_noserialize
: Bool do return false
49 redef class ADefinition
51 redef fun is_serialize
do
52 return get_annotations
("serialize").not_empty
or
53 get_annotations
("auto_serializable").not_empty
56 redef fun is_noserialize
do
57 return get_annotations
("noserialize").not_empty
61 private class SerializationPhaseRename
64 redef fun process_annotated_node
(node
, nat
)
66 var text
= nat
.n_atid
.n_id
.text
67 if text
!= "serialize_as" then return
69 if not node
isa AAttrPropdef then
70 toolcontext
.error
(node
.location
,
71 "Syntax Error: annotation `{text}` applies only to attributes.")
75 # Can't use `arg_as_string` because it needs the literal phase
77 if args
.length
!= 1 or not args
.first
isa AStringFormExpr then
78 toolcontext
.error
(node
.location
,
79 "Syntax Error: annotation `{text}` expects a single string literal as argument.")
83 var t
= args
.first
.collect_text
84 var val
= t
.substring
(1, t
.length-2
)
85 node
.serialize_name
= val
89 private class SerializationPhasePreModel
92 redef fun process_annotated_node
(node
, nat
)
94 # Skip if we are not interested
95 var text
= nat
.n_atid
.n_id
.text
96 var serialize
= text
== "auto_serializable" or text
== "serialize"
97 var noserialize
= text
== "noserialize"
98 if not (serialize
or noserialize
) then return
100 # Check legality of annotation
101 if node
isa AModuledecl then
102 if noserialize
then toolcontext
.error
(node
.location
, "Syntax Error: superfluous use of `{text}`, by default a module is `{text}`")
104 else if not (node
isa AStdClassdef or node
isa AAttrPropdef) then
105 toolcontext
.error
(node
.location
,
106 "Syntax Error: only a class, a module or an attribute can be annotated with `{text}`.")
108 else if serialize
and node
.is_noserialize
then
109 toolcontext
.error
(node
.location
,
110 "Syntax Error: an entity cannot be both `{text}` and `noserialize`.")
112 else if node
.as(Prod).get_annotations
(text
).length
> 1 then
113 toolcontext
.warning
(node
.location
, "useless-{text}",
114 "Warning: duplicated annotation `{text}`.")
117 # Check the `serialize` state of the parent
118 if not node
isa AModuledecl then
119 var up_serialize
= false
120 var up
: nullable ANode = node
125 else if up
.is_serialize
then
128 else if up
.is_noserialize
then
133 # Check for useless double declarations
134 if serialize
and up_serialize
then
135 toolcontext
.warning
(node
.location
, "useless-serialize",
136 "Warning: superfluous use of `{text}`.")
137 else if noserialize
and not up_serialize
then
138 toolcontext
.warning
(node
.location
, "useless-noserialize",
139 "Warning: superfluous use of `{text}`.")
144 redef fun process_nclassdef
(nclassdef
)
146 if not nclassdef
isa AStdClassdef then return
148 var serialize_by_default
= nclassdef
.how_serialize
150 if serialize_by_default
!= null then
152 # Add `super Serializable`
153 var sc
= toolcontext
.parse_superclass
("Serializable")
154 sc
.location
= nclassdef
.location
155 nclassdef
.n_propdefs
.add sc
158 var per_attribute
= not serialize_by_default
159 generate_serialization_method
(nclassdef
, per_attribute
)
160 generate_deserialization_init
(nclassdef
)
164 redef fun process_nmodule
(nmodule
)
166 # Clear the cache of constructors to review before adding to it
167 nmodule
.inits_to_retype
.clear
169 # collect all classes
170 var auto_serializable_nclassdefs
= new Array[AStdClassdef]
171 for nclassdef
in nmodule
.n_classdefs
do
172 if nclassdef
isa AStdClassdef and nclassdef
.how_serialize
!= null then
173 auto_serializable_nclassdefs
.add nclassdef
177 if not auto_serializable_nclassdefs
.is_empty
then
178 generate_deserialization_method
(nmodule
, auto_serializable_nclassdefs
)
182 fun generate_serialization_method
(nclassdef
: AClassdef, per_attribute
: Bool)
184 var npropdefs
= nclassdef
.n_propdefs
186 var code
= new Array[String]
187 code
.add
"redef fun core_serialize_to(v)"
191 for attribute
in npropdefs
do if attribute
isa AAttrPropdef then
193 # Is `attribute` to be skipped?
194 if (per_attribute
and not attribute
.is_serialize
) or
195 attribute
.is_noserialize
then continue
197 code
.add
" v.serialize_attribute(\"{attribute.serialize_name}\
", {attribute.name})"
202 # Create method Node and add it to the AST
203 npropdefs
.push
(toolcontext
.parse_propdef
(code
.join
("\n")))
206 # Add an empty constructor to the automated nclassdef
208 # Will be filled by `SerializationPhasePostModel`.
209 fun generate_deserialization_init
(nclassdef
: AClassdef)
211 var npropdefs
= nclassdef
.n_propdefs
213 # Do not insert a `from_deserializer` if it already exists
214 for npropdef
in npropdefs
do
215 if npropdef
isa AMethPropdef then
216 var methid
= npropdef
.n_methid
217 if methid
!= null and methid
.collect_text
== "from_deserializer" then
224 redef init from_deserializer(v: Deserializer) do abort"""
226 var npropdef
= toolcontext
.parse_propdef
(code
).as(AMethPropdef)
227 npropdefs
.add npropdef
228 nclassdef
.parent
.as(AModule).inits_to_retype
.add npropdef
231 # Added to the abstract serialization service
232 fun generate_deserialization_method
(nmodule
: AModule, nclassdefs
: Array[AStdClassdef])
234 var code
= new Array[String]
236 var deserializer_nclassdef
= nmodule
.deserializer_nclassdef
237 var deserializer_npropdef
238 if deserializer_nclassdef
== null then
240 code
.add
"redef class Deserializer"
241 deserializer_npropdef
= null
243 deserializer_npropdef
= deserializer_nclassdef
.deserializer_npropdef
246 if deserializer_npropdef
== null then
247 # create the property
248 code
.add
" redef fun deserialize_class_intern(name)"
251 toolcontext
.error
(deserializer_npropdef
.location
, "Error: `Deserializer::deserialize_class_intern` is generated and must not be defined, use `deserialize_class` instead.")
255 for nclassdef
in nclassdefs
do
256 var n_qid
= nclassdef
.n_qid
257 if n_qid
== null then continue
258 var name
= n_qid
.n_id
.text
259 if nclassdef
.n_formaldefs
.is_empty
and
260 nclassdef
.n_classkind
isa AConcreteClasskind then
262 code
.add
" if name == \"{name}\
" then return new {name}.from_deserializer(self)"
266 code
.add
" return super"
269 if deserializer_nclassdef
== null then
271 nmodule
.n_classdefs
.add toolcontext
.parse_classdef
(code
.join
("\n"))
273 deserializer_nclassdef
.n_propdefs
.add
(toolcontext
.parse_propdef
(code
.join
("\n")))
278 private class SerializationPhasePostModel
281 redef fun process_nmodule
(nmodule
)
283 for npropdef
in nmodule
.inits_to_retype
do
284 var nclassdef
= npropdef
.parent
285 assert nclassdef
isa AStdClassdef
287 var serialize_by_default
= nclassdef
.how_serialize
288 assert serialize_by_default
!= null
290 var per_attribute
= not serialize_by_default
291 fill_deserialization_init
(nclassdef
, npropdef
, per_attribute
)
295 # Fill the constructor to the generated `init_npropdef` of `nclassdef`
296 fun fill_deserialization_init
(nclassdef
: AClassdef, init_npropdef
: AMethPropdef, per_attribute
: Bool)
298 var code
= new Array[String]
300 redef init from_deserializer(v: Deserializer)
303 v.notify_of_creation self
306 for attribute
in nclassdef
.n_propdefs
do
307 if not attribute
isa AAttrPropdef then continue
309 # Is `attribute` to be skipped?
310 if (per_attribute
and not attribute
.is_serialize
) or
311 attribute
.is_noserialize
then continue
313 var mtype
= attribute
.mtype
314 if mtype
== null then continue
315 var type_name
= mtype
.to_s
316 var name
= attribute
.name
318 if type_name
== "nullable Object" then
321 var {{{name}}} = v.deserialize_attribute("{{{attribute.serialize_name}}}", "{{{type_name}}}")
324 var {{{name}}} = v.deserialize_attribute("{{{attribute.serialize_name}}}", "{{{type_name}}}")
325 if not {{{name}}} isa {{{type_name}}} then
326 # Check if it was a subjectent error
327 v.errors.add new AttributeTypeError(self, "{{{attribute.serialize_name}}}", {{{name}}}, "{{{type_name}}}")
329 # Clear subjacent error
330 if v.keep_going == false then return
332 self.{{{name}}} = {{{name}}}
339 # Replace the body of the constructor
340 var npropdef
= toolcontext
.parse_propdef
(code
.join
("\n")).as(AMethPropdef)
341 init_npropdef
.n_block
= npropdef
.n_block
343 # Run the literal phase on the generated code
344 var v
= new LiteralVisitor(toolcontext
)
345 v
.enter_visit
(npropdef
.n_block
)
349 redef class AAttrPropdef
350 private fun name
: String do return n_id2
.text
352 # Name of this attribute in the serialized format
353 private var serialize_name
: String = name
is lazy
357 private fun type_name
: String
359 var name
= n_qid
.n_id
.text
361 if n_kwnullable
!= null then name
= "nullable {name}"
364 if not types
.is_empty
then
365 var params
= new Array[String]
366 for t
in types
do params
.add
(t
.type_name
)
367 return "{name}[{params.join(", ")}]"
373 private fun deserializer_nclassdef
: nullable AStdClassdef
375 for nclassdef
in n_classdefs
do
376 if not nclassdef
isa AStdClassdef then continue
377 var n_qid
= nclassdef
.n_qid
378 if n_qid
!= null and n_qid
.n_id
.text
== "Deserializer" then return nclassdef
384 private var inits_to_retype
= new Array[AMethPropdef]
386 redef fun is_serialize
388 var n_moduledecl
= n_moduledecl
389 return n_moduledecl
!= null and n_moduledecl
.is_serialize
393 redef class AStdClassdef
394 private fun deserializer_npropdef
: nullable AMethPropdef
396 for npropdef
in n_propdefs
do if npropdef
isa AMethPropdef then
397 var id
= npropdef
.n_methid
398 if id
isa AIdMethid and id
.n_id
.text
== "deserialize_class_intern" then
406 # Is this classed marked `serialize`? in part or fully?
408 # This method returns 3 possible values:
409 # * `null`, this class is not to be serialized.
410 # * `true`, the attributes of this class are to be serialized by default.
411 # * `false`, the attributes of this class are to be serialized on demand only.
412 fun how_serialize
: nullable Bool
414 # Is there a declaration on the classdef or the module?
415 var serialize
= is_serialize
417 if not serialize
and not is_noserialize
then
418 # Is the module marked serialize?
419 serialize
= parent
.as(AModule).is_serialize
422 if serialize
then return true
424 if not serialize
then
425 # Is there an attribute marked serialize?
426 for npropdef
in n_propdefs
do
427 if npropdef
.is_serialize
then