Merge pull request diffblue#1636 from svorenova/inner_classes_tg1190_part2

[TG-1190] Specialisation for implicitly generic classes

Author: Matthias Güdemann

src/java_bytecode/generate_java_generic_type.cpp

@@ -36,24 +36,25 @@ symbolt generate_java_generic_typet::operator()(
   INVARIANT(
     pointer_subtype.id()==ID_struct, "Only pointers to classes in java");
   INVARIANT(
-    is_java_generic_class_type(pointer_subtype),
+    is_java_generic_class_type(pointer_subtype) ||
+      is_java_implicitly_generic_class_type(pointer_subtype),
     "Generic references type must be a generic class");
 
-  const java_generic_class_typet &generic_class_definition =
-    to_java_generic_class_type(to_java_class_type(pointer_subtype));
+  const java_class_typet &class_definition =
+    to_java_class_type(pointer_subtype);
 
   const irep_idt generic_name =
-    build_generic_name(existing_generic_type, generic_class_definition);
+    build_generic_name(existing_generic_type, class_definition);
   struct_union_typet::componentst replacement_components =
-    generic_class_definition.components();
+    class_definition.components();
 
   // Small auxiliary function, to perform the inplace
   // modification of the generic fields.
   auto replace_type_for_generic_field =
     [&](struct_union_typet::componentt &component) {
 
       component.type() = substitute_type(
-        component.type(), generic_class_definition, existing_generic_type);
+        component.type(), class_definition, existing_generic_type);
 
       return component;
     };
@@ -66,16 +67,15 @@ symbolt generate_java_generic_typet::operator()(
     replacement_components.end(),
     replace_type_for_generic_field);
 
-  std::size_t after_modification_size =
-    generic_class_definition.components().size();
+  std::size_t after_modification_size = class_definition.components().size();
 
   INVARIANT(
     pre_modification_size==after_modification_size,
     "All components in the original class should be in the new class");
 
   const java_specialized_generic_class_typet new_java_class{
     generic_name,
-    generic_class_definition.get_tag(),
+    class_definition.get_tag(),
     replacement_components,
     existing_generic_type.generic_type_arguments()};
 
@@ -110,7 +110,7 @@ symbolt generate_java_generic_typet::operator()(
 /// there are none to replace, the original type.
 typet generate_java_generic_typet::substitute_type(
   const typet &parameter_type,
-  const java_generic_class_typet &generic_class,
+  const java_class_typet &class_definition,
   const java_generic_typet &generic_reference) const
 {
   if(is_java_generic_parameter(parameter_type))
@@ -119,8 +119,28 @@ typet generate_java_generic_typet::substitute_type(
                                   .type_variable()
                                   .get_identifier();
 
-    optionalt<size_t> results =
-      java_generics_get_index_for_subtype(generic_class, component_identifier);
+    // see if it is a generic parameter introduced by this class
+    optionalt<size_t> results;
+    if(is_java_generic_class_type(class_definition))
+    {
+      const java_generic_class_typet &generic_class =
+        to_java_generic_class_type(class_definition);
+
+      results = java_generics_get_index_for_subtype(
+        generic_class.generic_types(), component_identifier);
+    }
+    // see if it is an implicit generic parameter introduced by an outer class
+    if(!results.has_value())
+    {
+      INVARIANT(
+        is_java_implicitly_generic_class_type(class_definition),
+        "The parameter must either be a generic type or implicit generic type");
+      const java_implicitly_generic_class_typet &implicitly_generic_class =
+        to_java_implicitly_generic_class_type(class_definition);
+      results = java_generics_get_index_for_subtype(
+        implicitly_generic_class.implicit_generic_types(),
+        component_identifier);
+    }
 
     INVARIANT(results.has_value(), "generic component type not found");
     return generic_reference.generic_type_arguments()[*results];
@@ -142,7 +162,7 @@ typet generate_java_generic_typet::substitute_type(
         [&](const reference_typet &generic_param) -> reference_typet
         {
           const typet &replacement_type =
-            substitute_type(generic_param, generic_class, generic_reference);
+            substitute_type(generic_param, class_definition, generic_reference);
 
           // This code will be simplified when references aren't considered to
           // be generic parameters
@@ -172,8 +192,8 @@ typet generate_java_generic_typet::substitute_type(
         const typet &array_element_type =
           java_array_element_type(array_subtype);
 
-        const typet &new_array_type =
-          substitute_type(array_element_type, generic_class, generic_reference);
+        const typet &new_array_type = substitute_type(
+          array_element_type, class_definition, generic_reference);
 
         typet replacement_array_type = java_array_type('a');
         replacement_array_type.subtype().set(ID_C_element_type, new_array_type);
@@ -184,51 +204,173 @@ typet generate_java_generic_typet::substitute_type(
   return parameter_type;
 }
 
-/// Build a unique tag for the generic to be instantiated.
+/// Creates a name for an argument that is an array, e.g., for an array of
+/// Integers it returns a string `array[reference]of_java::java.lang.Integer`
+/// \param id argument of type array
+/// \param generic_argument_p array reference type
+/// \return name as a string
+static irep_idt build_name_for_array_argument(
+  const irep_idt &id,
+  const reference_typet &generic_argument_p)
+{
+  PRECONDITION(is_java_array_tag(id));
+  std::ostringstream name_buffer;
+  name_buffer << pretty_print_java_type(id2string(id));
+  const typet &element_type =
+    java_array_element_type(to_symbol_type(generic_argument_p.subtype()));
+
+  // If this is an array of references then we will specialize its
+  // identifier using the type of the objects in the array. Else, there
+  // can be a problem with the same symbols for different instantiations
+  // using arrays with different types.
+  if(element_type.id() == ID_pointer)
+  {
+    const symbol_typet element_symbol = to_symbol_type(element_type.subtype());
+    name_buffer << "of_" + id2string(element_symbol.get_identifier());
+  }
+  return name_buffer.str();
+}
+
+/// Build a generic name for a generic class, from given generic arguments.
+/// For example, given a class `Class` with two generic type parameters
+/// `java::Class::T` and `java::Class::U`, and two arguments
+/// `java::java.lang.Integer` and `java::Outer$Inner`, the returned string is
+/// `<java::java.lang.Integer, java::Outer$Inner>`.
+/// \param generic_argument_p iterator over generic arguments
+/// \param generic_type_p iterator over generic types, starts with types for
+/// the given class, may continue with generic types of its inner classes
+/// \param generic_types_end end of the vector of generic types
+/// \param class_name name of the class for which the tag is being built
+/// \return name as a string of the form `<*, *, ..., *>`
+static irep_idt build_generic_name_for_class_arguments(
+  std::vector<reference_typet>::const_iterator &generic_argument_p,
+  std::vector<java_generic_parametert>::const_iterator &generic_type_p,
+  const std::vector<java_generic_parametert>::const_iterator &generic_types_end,
+  const std::string &class_name)
+{
+  std::ostringstream name_buffer;
+  bool first = true;
+  std::string parameter_class_name =
+    (*generic_type_p).get_parameter_class_name();
+  PRECONDITION(parameter_class_name == class_name);
+
+  while(parameter_class_name == class_name)
+  {
+    if(first)
+    {
+      name_buffer << "<";
+      first = false;
+    }
+    else
+    {
+      name_buffer << ", ";
+    }
+
+    const irep_idt &id(
+      id2string((*generic_argument_p).subtype().get(ID_identifier)));
+    if(is_java_array_tag(id))
+    {
+      name_buffer << build_name_for_array_argument(id, *generic_argument_p);
+    }
+    else
+    {
+      name_buffer << id2string(id);
+    }
+
+    ++generic_argument_p;
+    ++generic_type_p;
+    if(generic_type_p != generic_types_end)
+    {
+      parameter_class_name = (*generic_type_p).get_parameter_class_name();
+    }
+    else
+    {
+      break;
+    }
+  }
+  name_buffer << ">";
+  return name_buffer.str();
+}
+
+/// Build a unique name for the generic to be instantiated.
 /// \param existing_generic_type The type we want to concretise
 /// \param original_class
-/// \return A tag for the new generic we want a unique tag for.
+/// \return A name for the new generic we want a unique name for.
 irep_idt generate_java_generic_typet::build_generic_name(
   const java_generic_typet &existing_generic_type,
   const java_class_typet &original_class) const
 {
-  std::ostringstream new_tag_buffer;
-  new_tag_buffer << original_class.get_tag();
-  new_tag_buffer << "<";
-  bool first=true;
-  for(const typet &type_argument : existing_generic_type
-    .generic_type_arguments())
+  std::ostringstream generic_name_buffer;
+  const std::string &original_class_name = original_class.get_tag().c_str();
+  auto generic_argument_p =
+    existing_generic_type.generic_type_arguments().begin();
+
+  // if the original class is implicitly generic, add tags for all generic
+  // outer classes
+  // NOTE here we assume that the implicit generic types are ordered from the
+  // outermost outer class inwards, this is currently guaranteed by the way
+  // this vector is constructed in
+  // java_bytecode_convert_class:mark_java_implicitly_generic_class_type
+  if(is_java_implicitly_generic_class_type(original_class))
   {
-    if(!first)
-      new_tag_buffer << ", ";
-    first=false;
+    const java_implicitly_generic_class_typet
+      &implicitly_generic_original_class =
+        to_java_implicitly_generic_class_type(original_class);
 
     INVARIANT(
-      !is_java_generic_parameter(type_argument),
-      "Only create full concretized generic types");
-    const irep_idt &id(id2string(type_argument.subtype().get(ID_identifier)));
-    new_tag_buffer << pretty_print_java_type(id2string(id));
-    if(is_java_array_tag(id))
+      existing_generic_type.generic_type_arguments().size() >=
+        implicitly_generic_original_class.implicit_generic_types().size(),
+      "All implicit generic types must be concretised");
+    auto implicit_generic_type_p =
+      implicitly_generic_original_class.implicit_generic_types().begin();
+    const auto &implicit_generic_types_end =
+      implicitly_generic_original_class.implicit_generic_types().end();
+    std::string current_outer_class_name;
+
+    while(implicit_generic_type_p != implicit_generic_types_end)
     {
-      const typet &element_type =
-        java_array_element_type(to_symbol_type(type_argument.subtype()));
-
-      // If this is an array of references then we will specialize its
-      // identifier using the type of the objects in the array. Else, there can
-      // be a problem with the same symbols for different instantiations using
-      // arrays with different types.
-      if(element_type.id() == ID_pointer)
-      {
-        const symbol_typet element_symbol =
-          to_symbol_type(element_type.subtype());
-        new_tag_buffer << "of_" << id2string(element_symbol.get_identifier());
-      }
+      current_outer_class_name =
+        (*implicit_generic_type_p).get_parameter_class_name();
+      generic_name_buffer << current_outer_class_name;
+      generic_name_buffer << build_generic_name_for_class_arguments(
+        generic_argument_p,
+        implicit_generic_type_p,
+        implicit_generic_types_end,
+        current_outer_class_name);
     }
+    generic_name_buffer << original_class_name.substr(
+      current_outer_class_name.length(), std::string::npos);
+  }
+  else
+  {
+    generic_name_buffer << original_class_name;
   }
 
-  new_tag_buffer << ">";
+  // if the original class is generic, add tag for the class itself
+  if(is_java_generic_class_type(original_class))
+  {
+    const java_generic_class_typet &generic_original_class =
+      to_java_generic_class_type(original_class);
 
-  return new_tag_buffer.str();
+    INVARIANT(
+      std::distance(
+        generic_argument_p,
+        existing_generic_type.generic_type_arguments().end()) ==
+        static_cast<int>(generic_original_class.generic_types().size()),
+      "All generic types must be concretised");
+    auto generic_type_p = generic_original_class.generic_types().begin();
+
+    generic_name_buffer << build_generic_name_for_class_arguments(
+      generic_argument_p,
+      generic_type_p,
+      generic_original_class.generic_types().end(),
+      original_class_name);
+  }
+
+  INVARIANT(
+    generic_argument_p == existing_generic_type.generic_type_arguments().end(),
+    "All type arguments must have been added to the name");
+  return generic_name_buffer.str();
 }
 
 /// Construct the symbol to be moved into the symbol table

src/java_bytecode/generate_java_generic_type.h

@@ -29,7 +29,7 @@ class generate_java_generic_typet
 
   typet substitute_type(
     const typet &parameter_type,
-    const java_generic_class_typet &replacement_type,
+    const java_class_typet &replacement_type,
     const java_generic_typet &generic_reference) const;
 
   type_symbolt build_symbol_from_specialised_class(

src/java_bytecode/java_types.h

@@ -116,6 +116,17 @@ class java_generic_parametert:public reference_typet
     return const_cast<type_variablet &>(type_variables().front());
   }
 
+  const std::string get_parameter_class_name() const
+  {
+    const std::string &parameter_name =
+      type_variable().get_identifier().c_str();
+    PRECONDITION(has_prefix(parameter_name, "java::"));
+    int prefix_length = std::string("java::").length();
+    const std::string name = parameter_name.substr(
+      prefix_length, parameter_name.rfind("::") - prefix_length);
+    return name;
+  }
+
 private:
   typedef std::vector<type_variablet> type_variablest;
   const type_variablest &type_variables() const
@@ -410,21 +421,18 @@ inline typet java_type_from_string_with_exception(
 /// \param identifier The string identifier of the type of the component.
 /// \return Optional with the size if the identifier was found.
 inline const optionalt<size_t> java_generics_get_index_for_subtype(
-  const java_generic_class_typet &t,
+  const std::vector<java_generic_parametert> &gen_types,
   const irep_idt &identifier)
 {
-  const std::vector<java_generic_parametert> &gen_types=
-    t.generic_types();
-
   const auto iter = std::find_if(
     gen_types.cbegin(),
     gen_types.cend(),
     [&identifier](const java_generic_parametert &ref)
     {
-      return ref.type_variable().get_identifier()==identifier;
+      return ref.type_variable().get_identifier() == identifier;
     });
 
-  if(iter==gen_types.cend())
+  if(iter == gen_types.cend())
   {
     return {};
   }