Introducing ref_typespec, parallel to ref_obj for referencing typespecs

scope::Typespecs are cloned from non-elaborated tree to the elaborated tree.
However, at the moment, this collection doesn't have all the typespecs in the
non-elaborated tree.

This solves a few different problems -

* Avoids too many duplicates in the elaborated tree.
* For functions like $size and $bits, the parameter binding doesn't work
  because the parameter is a type and not an object. ref_typespec solves
  that binding problem.
* ref_typespec will hold the type location information in parameter
  declaration.

Known Issues -

* Need to collect all typespecs in the scope subtree to populate
  scope::Typespecs
* Though the typespecs are cloned, elaborated tree is still using the ones
  from the non-elaborated tree. The tree is still complete but typespecs are
  crossing the boundary between elaborated and non-elaborated. Need to fix
  this during binding.

model/array_typespec.yaml

@@ -39,12 +39,12 @@
   - class_ref: index_typespec
     name: index typespec
     vpi: vpiIndexTypespec
-    type: typespec
+    type: ref_typespec
     card: 1
   - class_ref: elem_typespec
     name: elem typespec
     vpi: vpiElemTypespec
-    type: typespec
+    type: ref_typespec
     card: 1
   - obj_ref: resolution_func
     name: resolution func

model/bit_typespec.yaml

@@ -24,7 +24,7 @@
   - obj_ref: bit_typespec
     name: bit typespec
     vpi: vpiElemTypespec
-    type: bit_typespec
+    type: ref_typespec
     card: 1
   - obj_ref: ranges
     name: ranges
@@ -44,7 +44,7 @@
   - class_ref: typespec
     name: typespec
     vpi: vpiIndexTypespec
-    type: typespec
+    type: ref_typespec
     card: 1
   - property: sign
     name: sign

model/class_obj.yaml

@@ -24,7 +24,7 @@
   - obj_ref: class_typespec
     name: class typespec
     vpi: vpiClassTypespec
-    type: class_typespec
+    type: ref_typespec
     card: 1
   - obj_ref: threads
     name: threads
@@ -47,6 +47,3 @@
     type: constraint
     card: any
 
-
-
-

model/class_typespec.yaml

@@ -27,11 +27,11 @@
     vpi: vpiAutomatic
     type: bool
     card: 1
-  - obj_ref: class_typespec
-    name: class typespec
+  - obj_ref: extends
+    name: extends
     vpi: vpiExtends
-    type: class_typespec
-    card: 1    
+    type: ref_typespec
+    card: 1
   - class_ref: variables
     name: variables
     vpi: vpiVariables
@@ -55,7 +55,7 @@
   - obj_ref: param_assigns
     vpi: vpiParamAssign
     type: param_assign
-    card: any     
+    card: any
   - obj_ref: virtual_interface_vars
     name: virtual interface vars
     vpi: vpiVirtualInterfaceVar
@@ -70,12 +70,12 @@
     name: named event arrays
     vpi: vpiNamedEventArray
     type: named_event_array
-    card: any    
+    card: any
   - class_ref: scopes
     name: scopes
     vpi: vpiInternalScope
     type: scope
-    card: any    
+    card: any
   - obj_ref: class_defn
     name: class defn
     vpi: vpiClassDefn

model/enum_typespec.yaml

@@ -19,7 +19,7 @@
   - class_ref: base_typespec
     name: base typespec
     vpi: vpiBaseTypespec
-    type: typespec
+    type: ref_typespec
     card: 1
   - obj_ref: enum_consts
     name: enum consts

model/expr.yaml

@@ -33,5 +33,5 @@
   - class_ref: typespec
     name: typespec
     vpi: vpiTypespec
-    type: typespec
+    type: ref_typespec
     card: 1

model/extends.yaml

@@ -18,7 +18,7 @@
   - obj_ref: class_typespec
     name: class typespec
     vpi: vpiClassTypespec
-    type: class_typespec
+    type: ref_typespec
     card: 1
  - class_ref: arguments
     name: arguments

model/instance_array.yaml

@@ -63,7 +63,7 @@
   - class_ref: elem_typespec
     name: elem typespec
     vpi: vpiElemTypespec
-    type: typespec
+    type: ref_typespec
     card: 1
   - obj_ref: ports
     vpi: vpiPort

model/io_decl.yaml

@@ -73,5 +73,5 @@
   - class_ref: typespec
     name: typespec
     vpi: vpiTypedef
-    type: typespec
+    type: ref_typespec
     card: 1

model/logic_typespec.yaml

@@ -21,10 +21,10 @@
     vpi: vpiVector
     type: bool
     card: 1
-  - obj_ref: logic_typespec
-    name: logic typespec
+  - obj_ref: elem_typespec
+    name: elem typespec
     vpi: vpiElemTypespec
-    type: logic_typespec
+    type: ref_typespec
     card: 1
   - obj_ref: ranges
     name: ranges
@@ -41,10 +41,10 @@
     vpi: vpiRightRange
     type: expr
     card: 1
-  - class_ref: typespec
-    name: typespec
+  - class_ref: index_typespec
+    name: index typespec
     vpi: vpiIndexTypespec
-    type: typespec
+    type: ref_typespec
     card: 1
   - property: sign
     name: sign

model/named_event.yaml

@@ -48,7 +48,7 @@
   - obj_ref: event_typespec
     name: event typespec
     vpi: vpiTypespec
-    type: event_typespec
+    type: ref_typespec
     card: 1
   - obj_ref: threads
     name: threads

model/packed_array_typespec.yaml

@@ -36,18 +36,18 @@
     vpi: vpiRightRange
     type: expr
     card: 1
-  - group_ref: elem_typespec
+  - class_ref: elem_typespec
     name: elem typespec
     vpi: vpiElemTypespec
-    type: enum_struct_union_packed_array_typespec_group
+    type: ref_typespec
     card: 1
   - class_ref: typespec
     name: typespec
     vpi: vpiIndexTypespec
-    type: typespec
+    type: ref_typespec
     card: 1
   - obj_ref: resolution_func
     name: resolution func
     vpi: vpiFunction
     type: function
-    card: 1    
+    card: 1

model/ports.yaml

@@ -73,7 +73,7 @@
   - class_ref: typespec
     name: typespec
     vpi: vpiTypedef
-    type: typespec
+    type: ref_typespec
     card: 1
   - class_ref: instance
     name: instance

model/prop_formal_decl.yaml

@@ -33,5 +33,5 @@
   - class_ref: typespec
     name: typespec
     vpi: vpiTypespec
-    type: typespec
+    type: ref_typespec
     card: 1

model/ref_obj.yaml

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 # Universal Hardware Data Model (UHDM) "ref_obj" formal description
- 
+
 - obj_def: ref_obj
   - extends: simple_expr
   - property: name
@@ -30,12 +30,12 @@
     name: definition name
     vpi: vpiDefName
     type: string
-    card: 1  
+    card: 1
   - property: generic
     name: generic
     vpi: vpiGeneric
     type: bool
-    card: 1 
+    card: 1
   - group_ref: actual_group
     name: actual group
     vpi: vpiActual
@@ -46,4 +46,4 @@
     name: is struct member
     vpi: vpiStructMember
     type: bool
-    card: 1    
+    card: 1

model/ref_typespec.yaml

@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Universal Hardware Data Model (UHDM) "ref_obj" formal description
- 
+# Universal Hardware Data Model (UHDM) "ref_typespec" formal description
+
 - obj_def: ref_typespec
   - extends: simple_expr
   - property: name
@@ -30,9 +30,9 @@
     name: definition name
     vpi: vpiDefName
     type: string
-    card: 1  
+    card: 1
   - class_ref: actual_typespec
     name: actual typespec
     vpi: vpiActual
     type: typespec
-    card: 1
+    card: 1

model/seq_formal_decl.yaml

@@ -38,6 +38,6 @@
   - class_ref: typespec
     name: typespec
     vpi: vpiTypespec
-    type: typespec
+    type: ref_typespec
     card: 1
 

model/tagged_pattern.yaml

@@ -28,5 +28,5 @@
   - class_ref: typespec
     name: typespec
     vpi: vpiTypespec
-    type: typespec
+    type: ref_typespec
     card: 1

model/type_parameter.yaml

@@ -29,12 +29,12 @@
   - class_ref: typespec
     name: typespec
     vpi: vpiTypespec
-    type: typespec
+    type: ref_typespec
     card: 1
   - class_ref: expr
     name: expr 
     vpi: vpiExpr
-    type: typespec
+    type: ref_typespec
     card: 1
 # Not standard, name of the package it is imported from     
   - property: imported

model/typespec.yaml

@@ -23,7 +23,7 @@
   - class_ref: typedef_alias
     name: typedef alias
     vpi: vpiTypedefAlias
-    type: typespec
+    type: ref_typespec
     card: 1
   - class_ref: instance
     name: instance

model/typespec_member.yaml

@@ -28,7 +28,7 @@
   - class_ref: typespec
     name: typespec
     vpi: vpiTypespec
-    type: typespec
+    type: ref_typespec
     card: 1
   - class_ref: default_value
     name: default value

python/swig_test.cpp

@@ -46,7 +46,10 @@ std::vector<vpiHandle> buildTestTypedef(UHDM::Serializer* s){
   members->push_back(member1);
 
   bit_typespec* btps = s->MakeBit_typespec();
-  member1->Typespec(btps);
+
+  ref_typespec* btps_rt = s->MakeRef_typespec();
+  btps_rt->Actual_typespec(btps);
+  member1->Typespec(btps_rt);
 
   VectorOfrange* ranges = s->MakeRangeVec();
   btps->VpiParent(member1);
@@ -76,7 +79,10 @@ std::vector<vpiHandle> buildTestTypedef(UHDM::Serializer* s){
   members->push_back(member2);
 
   btps = s->MakeBit_typespec();
-  member2->Typespec(btps);
+
+  btps_rt = s->MakeRef_typespec();
+  btps_rt->Actual_typespec(btps);
+  member2->Typespec(btps_rt);
 
   ranges = s->MakeRangeVec();
   btps->VpiParent(member2);

scripts/classes.py

@@ -180,6 +180,15 @@ def _get_DeepClone_implementation(model, models):
                     content.append(f'  if (!clone->{method}()) clone->{method}(elaboratorContext->m_elaborator.bindAny(VpiName()));')
                     content.append(f'  if (!clone->{method}()) clone->{method}((any*) {method}());')
 
+                elif (classname in ['ref_typespec']) and (method == 'Actual_typespec'):
+                    includes.add('ElaboratorListener')
+                    includes.add('typespec')
+                    content.append( '  if (elaboratorContext->m_elaborator.uniquifyTypespec()) {')
+                    content.append(f'    if (auto obj = {method}()) clone->{method}(obj->DeepClone(clone, context));')
+                    content.append( '  } else {')
+                    content.append(f'    if (auto obj = {method}()) clone->{method}((typespec*) obj);')
+                    content.append( '  }')
+
                 elif (classname == 'udp') and (method == 'Udp_defn'):
                     includes.add('ElaboratorListener')
                     content.append(f'  if (!clone->{method}()) clone->{method}((udp_defn*) elaboratorContext->m_elaborator.bindAny(VpiDefName()));')
@@ -235,31 +244,18 @@ def _get_DeepClone_implementation(model, models):
                     includes.add('module_inst')
                     content.append(f'  if (auto obj = {method}()) clone->{method}((interface_inst*) obj);')
 
-                elif method == 'Typespec':
-                    includes.add('typespec')
-                    content.append( '  if (elaboratorContext->m_elaborator.uniquifyTypespec()) {')
-                    content.append(f'    if (auto obj = {method}()) clone->{method}(obj->DeepClone(clone, context));')
-                    content.append( '  } else {')
-                    content.append(f'    if (auto obj = {method}()) clone->{method}((typespec*) obj);')
-                    content.append( '  }')
-
                 else:
                     content.append(f'  if (auto obj = {method}()) clone->{method}(obj->DeepClone(clone, context));')
 
             elif (classname == 'module_inst') and (method == 'Ref_modules'):
                 pass # No cloning
 
             elif method == 'Typespecs':
+                # Don't deep clone
                 content.append(f'  if (auto vec = {method}()) {{')
                 content.append(f'    auto clone_vec = context->m_serializer->Make{Cast}Vec();')
                 content.append(f'    clone->{method}(clone_vec);')
-                content.append( '    for (auto obj : *vec) {')
-                content.append( '      if (elaboratorContext->m_elaborator.uniquifyTypespec()) {')
-                content.append( '        clone_vec->push_back(obj->DeepClone(clone, context));')
-                content.append( '      } else {')
-                content.append( '        clone_vec->push_back(obj);')
-                content.append( '      }')
-                content.append( '    }')
+                content.append( '    clone_vec->insert(clone_vec->cend(), vec->cbegin(), vec->cend());')
                 content.append( '  }')
 
             elif (classname == 'class_defn') and (method == 'Deriveds'):
@@ -279,6 +275,7 @@ def _get_DeepClone_implementation(model, models):
                 content.append( '      clone_vec->push_back(obj->DeepClone(clone, context));')
                 content.append( '    }')
                 content.append( '  }')
+
     if modeltype != 'class_def':
         content.append(f'  elaboratorContext->m_elaborator.leave{Classname}(clone, nullptr);')