--- /dev/null
+# This file is part of NIT ( http://www.nitlanguage.org ).
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Main frontend phases plus code generation phases
+module code_gen
+
+import frontend
+import actors_generation_phase
+import serialization_code_gen_phase
# limitations under the License.
# Collect and orchestration of main frontend phases
+#
+# Import `frontend::code_gen` to also include code generation modules.
module frontend
import no_warning
import modelize
import semantize
import div_by_zero
-import serialization_phase
+import serialization_model_phase
import deriving
import check_annotation
import parse_annotations
import parallelization_phase
import i18n_phase
import regex_phase
-import actors_generation_phase
import actors_injection_phase
redef class ToolContext
--- /dev/null
+# This file is part of NIT ( http://www.nitlanguage.org ).
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Phase generating methods (code) to serialize Nit objects
+module serialization_code_gen_phase
+
+intrude import serialization_model_phase
+
+redef class ToolContext
+
+ # The second phase of the serialization
+ var serialization_phase_post_model: Phase = new SerializationPhasePostModel(self,
+ [modelize_property_phase, serialization_phase_pre_model])
+end
+
+private class SerializationPhasePostModel
+ super Phase
+
+ # Fill the deserialization init `from_deserializer` and `Deserializer.deserialize_class_intern`
+ redef fun process_nmodule(nmodule)
+ do
+ for npropdef in nmodule.inits_to_retype do
+ var nclassdef = npropdef.parent
+ assert nclassdef isa AStdClassdef
+
+ var serialize_by_default = nclassdef.how_serialize
+ assert serialize_by_default != null
+
+ var per_attribute = not serialize_by_default
+ fill_deserialization_init(nclassdef, npropdef, per_attribute)
+ end
+
+ # collect all classes
+ var auto_serializable_nclassdefs = nmodule.auto_serializable_nclassdefs
+ if not auto_serializable_nclassdefs.is_empty then
+ fill_deserialization_method(nmodule, auto_serializable_nclassdefs)
+ end
+ end
+
+ # Fill the constructor to the generated `init_npropdef` of `nclassdef`
+ fun fill_deserialization_init(nclassdef: AClassdef, init_npropdef: AMethPropdef, per_attribute: Bool)
+ do
+ var code = new Array[String]
+ code.add """
+redef init from_deserializer(v: Deserializer)
+do
+ super
+ v.notify_of_creation self
+"""
+
+ for attribute in nclassdef.n_propdefs do
+ if not attribute isa AAttrPropdef then continue
+
+ # Is `attribute` to be skipped?
+ if (per_attribute and not attribute.is_serialize) or
+ attribute.is_noserialize then continue
+
+ var mtype = attribute.mtype
+ if mtype == null then continue
+ var type_name = mtype.to_s
+ var name = attribute.name
+
+ var resolved_type_name = type_name
+ var mclassdef = nclassdef.mclassdef
+ if mclassdef != null then
+ var bound_mtype = mclassdef.bound_mtype
+ var resolved_mtype = mtype.resolve_for(bound_mtype, bound_mtype, mclassdef.mmodule, true)
+ resolved_type_name = resolved_mtype.name
+
+ # TODO Use something like `V.class_name` to get the precise runtime type of virtual types.
+ # We currently use the upper bound of virtual types as static type in generated code
+ # for type suggestion and to prevent loading unexected types.
+ # This leaves a security issue when, for example, `DefaultMap::default_value`
+ # is bound to `nullable Object` and would allow any object to be loaded.
+ end
+
+ if type_name == "nullable Object" then
+ # Don't type check
+ code.add """
+ self.{{{name}}} = v.deserialize_attribute("{{{attribute.serialize_name}}}", "{{{resolved_type_name}}}")
+"""
+ else
+ code.add """
+ var {{{name}}} = v.deserialize_attribute("{{{attribute.serialize_name}}}", "{{{resolved_type_name}}}")
+ if v.deserialize_attribute_missing then
+"""
+ # What to do when an attribute is missing?
+ if attribute.has_value then
+ # Leave it to the default value
+ else if mtype isa MNullableType then
+ code.add """
+ self.{{{name}}} = null"""
+ else code.add """
+ v.errors.add new Error("Deserialization Error: attribute `{class_name}::{{{name}}}` missing from JSON object")"""
+
+ code.add """
+ else if not {{{name}}} isa {{{type_name}}} then
+ v.errors.add new AttributeTypeError(self, "{{{attribute.serialize_name}}}", {{{name}}}, "{{{resolved_type_name}}}")
+ if v.keep_going == false then return
+ else
+ self.{{{name}}} = {{{name}}}
+ end
+"""
+ end
+ end
+
+ code.add "end"
+
+ # Replace the body of the constructor
+ var npropdef = toolcontext.parse_propdef(code.join("\n")).as(AMethPropdef)
+ init_npropdef.n_block = npropdef.n_block
+
+ # Run the literal phase on the generated code
+ var v = new LiteralVisitor(toolcontext)
+ v.enter_visit(npropdef.n_block)
+ end
+
+ # Fill the abstract serialization service
+ fun fill_deserialization_method(nmodule: AModule, nclassdefs: Array[AStdClassdef])
+ do
+ var deserializer_nclassdef = nmodule.deserializer_nclassdef
+ if deserializer_nclassdef == null then return
+ var deserializer_npropdef = deserializer_nclassdef.deserializer_npropdef
+ if deserializer_npropdef == null then return
+
+ # Collect local types expected to be deserialized
+ var types_to_deserialize = new Set[String]
+
+ ## Local serializable standard class without parameters
+ for nclassdef in nclassdefs do
+ var mclass = nclassdef.mclass
+ if mclass == null then continue
+
+ if mclass.arity == 0 and mclass.kind == concrete_kind then
+ types_to_deserialize.add mclass.name
+ end
+ end
+
+ ## Static parametized types on serializable attributes
+ for nclassdef in nmodule.n_classdefs do
+ if not nclassdef isa AStdClassdef then continue
+
+ for attribute in nclassdef.n_propdefs do
+ if not attribute isa AAttrPropdef then continue
+
+ var serialize_by_default = nclassdef.how_serialize
+ if serialize_by_default == null then continue
+ var per_attribute = not serialize_by_default
+
+ # Is `attribute` to be skipped?
+ if (per_attribute and not attribute.is_serialize) or
+ attribute.is_noserialize then continue
+
+ var mtype = attribute.mtype
+ if mtype == null then continue
+ if mtype isa MNullableType then mtype = mtype.mtype
+
+ if mtype isa MClassType and mtype.mclass.arity > 0 and
+ mtype.mclass.kind == concrete_kind and not mtype.need_anchor then
+
+ # Check is a `Serializable`
+ var mmodule = nmodule.mmodule
+ if mmodule == null then continue
+
+ var greaters = mtype.mclass.in_hierarchy(mmodule).greaters
+ var is_serializable = false
+ for sup in greaters do if sup.name == "Serializable" then
+ is_serializable = true
+ break
+ end
+
+ if is_serializable then types_to_deserialize.add mtype.to_s
+ end
+ end
+ end
+
+ # Build implementation code
+ var code = new Array[String]
+ code.add "redef fun deserialize_class_intern(name)"
+ code.add "do"
+
+ for name in types_to_deserialize do
+ code.add " if name == \"{name}\" then return new {name}.from_deserializer(self)"
+ end
+
+ code.add " return super"
+ code.add "end"
+
+ # Replace the body of the constructor
+ var npropdef = toolcontext.parse_propdef(code.join("\n")).as(AMethPropdef)
+ deserializer_npropdef.n_block = npropdef.n_block
+
+ # Run the literal phase on the generated code
+ var v = new LiteralVisitor(toolcontext)
+ v.enter_visit(npropdef.n_block)
+ end
+end
# See the License for the specific language governing permissions and
# limitations under the License.
-# Phase generating methods to serialize Nit objects to different formats
-module serialization_phase
+# Phase generating methods (model-only) to serialize Nit objects
+module serialization_model_phase
private import parser_util
import modelize
# Generate serialization and deserialization methods on `auto_serializable` annotated classes.
var serialization_phase_pre_model: Phase = new SerializationPhasePreModel(self,
[serialization_phase_rename])
-
- # The second phase of the serialization
- var serialization_phase_post_model: Phase = new SerializationPhasePostModel(self,
- [modelize_property_phase, serialization_phase_pre_model])
end
redef class ANode
end
end
-private class SerializationPhasePostModel
- super Phase
-
- # Fill the deserialization init `from_deserializer` and `Deserializer.deserialize_class_intern`
- redef fun process_nmodule(nmodule)
- do
- for npropdef in nmodule.inits_to_retype do
- var nclassdef = npropdef.parent
- assert nclassdef isa AStdClassdef
-
- var serialize_by_default = nclassdef.how_serialize
- assert serialize_by_default != null
-
- var per_attribute = not serialize_by_default
- fill_deserialization_init(nclassdef, npropdef, per_attribute)
- end
-
- # collect all classes
- var auto_serializable_nclassdefs = nmodule.auto_serializable_nclassdefs
- if not auto_serializable_nclassdefs.is_empty then
- fill_deserialization_method(nmodule, auto_serializable_nclassdefs)
- end
- end
-
- # Fill the constructor to the generated `init_npropdef` of `nclassdef`
- fun fill_deserialization_init(nclassdef: AClassdef, init_npropdef: AMethPropdef, per_attribute: Bool)
- do
- var code = new Array[String]
- code.add """
-redef init from_deserializer(v: Deserializer)
-do
- super
- v.notify_of_creation self
-"""
-
- for attribute in nclassdef.n_propdefs do
- if not attribute isa AAttrPropdef then continue
-
- # Is `attribute` to be skipped?
- if (per_attribute and not attribute.is_serialize) or
- attribute.is_noserialize then continue
-
- var mtype = attribute.mtype
- if mtype == null then continue
- var type_name = mtype.to_s
- var name = attribute.name
-
- var resolved_type_name = type_name
- var mclassdef = nclassdef.mclassdef
- if mclassdef != null then
- var bound_mtype = mclassdef.bound_mtype
- var resolved_mtype = mtype.resolve_for(bound_mtype, bound_mtype, mclassdef.mmodule, true)
- resolved_type_name = resolved_mtype.name
-
- # TODO Use something like `V.class_name` to get the precise runtime type of virtual types.
- # We currently use the upper bound of virtual types as static type in generated code
- # for type suggestion and to prevent loading unexected types.
- # This leaves a security issue when, for example, `DefaultMap::default_value`
- # is bound to `nullable Object` and would allow any object to be loaded.
- end
-
- if type_name == "nullable Object" then
- # Don't type check
- code.add """
- self.{{{name}}} = v.deserialize_attribute("{{{attribute.serialize_name}}}", "{{{resolved_type_name}}}")
-"""
- else
- code.add """
- var {{{name}}} = v.deserialize_attribute("{{{attribute.serialize_name}}}", "{{{resolved_type_name}}}")
- if v.deserialize_attribute_missing then
-"""
- # What to do when an attribute is missing?
- if attribute.has_value then
- # Leave it to the default value
- else if mtype isa MNullableType then
- code.add """
- self.{{{name}}} = null"""
- else code.add """
- v.errors.add new Error("Deserialization Error: attribute `{class_name}::{{{name}}}` missing from JSON object")"""
-
- code.add """
- else if not {{{name}}} isa {{{type_name}}} then
- v.errors.add new AttributeTypeError(self, "{{{attribute.serialize_name}}}", {{{name}}}, "{{{resolved_type_name}}}")
- if v.keep_going == false then return
- else
- self.{{{name}}} = {{{name}}}
- end
-"""
- end
- end
-
- code.add "end"
-
- # Replace the body of the constructor
- var npropdef = toolcontext.parse_propdef(code.join("\n")).as(AMethPropdef)
- init_npropdef.n_block = npropdef.n_block
-
- # Run the literal phase on the generated code
- var v = new LiteralVisitor(toolcontext)
- v.enter_visit(npropdef.n_block)
- end
-
- # Fill the abstract serialization service
- fun fill_deserialization_method(nmodule: AModule, nclassdefs: Array[AStdClassdef])
- do
- var deserializer_nclassdef = nmodule.deserializer_nclassdef
- if deserializer_nclassdef == null then return
- var deserializer_npropdef = deserializer_nclassdef.deserializer_npropdef
- if deserializer_npropdef == null then return
-
- # Collect local types expected to be deserialized
- var types_to_deserialize = new Set[String]
-
- ## Local serializable standard class without parameters
- for nclassdef in nclassdefs do
- var mclass = nclassdef.mclass
- if mclass == null then continue
-
- if mclass.arity == 0 and mclass.kind == concrete_kind then
- types_to_deserialize.add mclass.name
- end
- end
-
- ## Static parametized types on serializable attributes
- for nclassdef in nmodule.n_classdefs do
- if not nclassdef isa AStdClassdef then continue
-
- for attribute in nclassdef.n_propdefs do
- if not attribute isa AAttrPropdef then continue
-
- var serialize_by_default = nclassdef.how_serialize
- if serialize_by_default == null then continue
- var per_attribute = not serialize_by_default
-
- # Is `attribute` to be skipped?
- if (per_attribute and not attribute.is_serialize) or
- attribute.is_noserialize then continue
-
- var mtype = attribute.mtype
- if mtype == null then continue
- if mtype isa MNullableType then mtype = mtype.mtype
-
- if mtype isa MClassType and mtype.mclass.arity > 0 and
- mtype.mclass.kind == concrete_kind and not mtype.need_anchor then
-
- # Check is a `Serializable`
- var mmodule = nmodule.mmodule
- if mmodule == null then continue
-
- var greaters = mtype.mclass.in_hierarchy(mmodule).greaters
- var is_serializable = false
- for sup in greaters do if sup.name == "Serializable" then
- is_serializable = true
- break
- end
-
- if is_serializable then types_to_deserialize.add mtype.to_s
- end
- end
- end
-
- # Build implementation code
- var code = new Array[String]
- code.add "redef fun deserialize_class_intern(name)"
- code.add "do"
-
- for name in types_to_deserialize do
- code.add " if name == \"{name}\" then return new {name}.from_deserializer(self)"
- end
-
- code.add " return super"
- code.add "end"
-
- # Replace the body of the constructor
- var npropdef = toolcontext.parse_propdef(code.join("\n")).as(AMethPropdef)
- deserializer_npropdef.n_block = npropdef.n_block
-
- # Run the literal phase on the generated code
- var v = new LiteralVisitor(toolcontext)
- v.enter_visit(npropdef.n_block)
- end
-end
-
redef class AAttrPropdef
private fun name: String do return n_id2.text
module nit
import interpreter
-import frontend
+import frontend::code_gen
import parser_util
import vm
# A Nit compiler
module nitc
-import frontend
+import frontend::code_gen
import compiler
import transform
# A program that collects various metrics on nit programs and libraries
module nitmetrics
-import frontend
+import frontend::code_gen
import metrics
# Create a tool context to handle options and paths
module nitvm
import vm
-import frontend
+import frontend::code_gen
# Create a tool context to handle options and paths
var toolcontext = new ToolContext