Merge pull request #7998 from osamahammad21/odb-codegen-edits

odb: minor edits and relieving the templates a bit

Author: maliberty

src/odb/src/codeGenerator/gen.py

@@ -58,6 +58,8 @@ def make_parent_field(parent, relation):
     field["flags"] = ["cmp", "serial", "diff", "no-set", "get"] + relation.get(
         "flags", []
     )
+    if "page_size" in relation:
+        field["page_size"] = relation["page_size"]
     if "schema" in relation:
         field["schema"] = relation["schema"]
 
@@ -262,6 +264,31 @@ def generate_relations(schema):
             make_child_next_field(child, relation)
 
 
+def preprocess_klass(klass):
+    klass["declared_classes"].insert(0, "dbIStream")
+    klass["declared_classes"].insert(1, "dbOStream")
+    if klass["name"] != "dbDatabase":
+        klass["declared_classes"].insert(2, "_dbDatabase")
+        klass["cpp_includes"].append("dbDatabase.h")
+    klass["h_includes"].insert(0, "dbCore.h")
+    klass["h_includes"].insert(1, "odb/odb.h")
+    name = klass["name"]
+    klass["cpp_includes"].extend(["dbTable.h", "dbTable.hpp", "odb/db.h", f"{name}.h"])
+    if klass["hasBitFields"]:
+        klass["cpp_sys_includes"].extend(["cstdint", "cstring"])
+    for field in klass["fields"]:
+        if field.get("table", False):
+            page_size_part = f", {field['page_size']}" if "page_size" in field else ""
+            # setting default value for table fields
+            this_or_db = "this" if klass["name"] == "dbDatabase" else "db"
+            field["default"] = (
+                f"new dbTable<_{field['type']}{page_size_part}>({this_or_db}, this, (GetObjTbl_t) &_{klass['name']}::getObjectTable, {field['type']}Obj)"
+            )
+            # setting table identifier for table fields
+            field["table_base_type"] = field["type"]
+            field["type"] = f"dbTable<_{field['type']}{page_size_part}>*"
+
+
 def generate(schema, env, includeDir, srcDir, keep_empty):
     """Generate generate code based on the schema and templates"""
     print("###################Code Generation Begin###################")
@@ -326,7 +353,7 @@ def generate(schema, env, includeDir, srcDir, keep_empty):
             )
         hash_dict[hash_value] = klass["name"]
         klass["hash"] = f"0x{hash_value:08X}"
-
+        preprocess_klass(klass)
         # Generating files
         for template_file in ["impl.h", "impl.cpp"]:
             template = env.get_template(template_file)

src/odb/src/codeGenerator/helper.py

@@ -3,6 +3,7 @@
 
 _comparable = [
     "Point",
+    "Point3D",
     "Rect",
     "Polygon",
     "Line",
@@ -23,6 +24,7 @@
     "string",
     "uint",
     "unint_32t",
+    "uint8_t",
 ]
 std = [
     "bool",
@@ -42,6 +44,7 @@
     "string",
     "uint",
     "unint_32t",
+    "uint8_t",
 ]
 
 _removable = ["const", "static", "unsigned"]

src/odb/src/codeGenerator/templates/impl.cpp

@@ -3,28 +3,18 @@
 // Copyright (c) 2019-2025, The OpenROAD Authors
 
 // Generator Code Begin Cpp
-#include "{{klass.name}}.h"
-#include "odb/db.h"
-#include "dbDatabase.h"
-#include "dbTable.h"
-#include "dbTable.hpp"
-
-{% if klass.hasBitFields %}
-  #include <cstring>
-  #include <cstdint>
-{% endif %}
-
 {% for include in klass.cpp_sys_includes %}
   #include <{{include}}>
 {% endfor %}
-
 {% for include in klass.cpp_includes %}
   #include "{{include}}"
 {% endfor %}
 // User Code Begin Includes
 // User Code End Includes
 namespace odb {
   template class dbTable<_{{klass.name}}>; 
+  // User Code Begin Static
+  // User Code End Static
 
   bool _{{klass.name}}::operator==(const _{{klass.name}}& rhs) const
   {
@@ -97,8 +87,6 @@ namespace odb {
     {% for field in klass.fields %}
       {% if field.bitFields %}
         {{field.name}} = {};
-      {% elif field.table %}
-        {{field.name}} = new dbTable<_{{field.type}}>(db, this, (GetObjTbl_t) &_{{klass.name}}::getObjectTable, {{field.type}}Obj);
       {% elif field.isHashTable %}
         {{field.name}}.setTable({{field.table_name}});
       {% elif 'default' in field%}
@@ -135,7 +123,7 @@ namespace odb {
     switch (type) {
       {% for field in klass.fields %}
         {% if field.table %}
-          case {{field.type}}Obj:
+          case {{field.table_base_type}}Obj:
             return {{field.name}};
         {% endif %}
       {% endfor %}
@@ -213,7 +201,7 @@ namespace odb {
       {
       {% if field.dbSetGetter %}
           _{{klass.name}}* obj = (_{{klass.name}}*)this;
-          return dbSet<{{field.type}}>(obj, obj->{{field.name}});
+          return dbSet<{{field.table_base_type}}>(obj, obj->{{field.name}});
       {% elif field.isPassByRef %}
           _{{klass.name}}* obj = (_{{klass.name}}*)this;
           tbl = obj->{{field.name}};

src/odb/src/codeGenerator/templates/impl.h

@@ -5,8 +5,6 @@
 //Generator Code Begin Header
 #pragma once
 
-#include "odb/odb.h"
-#include "dbCore.h"
 
 {% for include in klass.h_sys_includes %}
   #include <{{include}}>
@@ -19,9 +17,8 @@
 // User Code End Includes
 
 namespace odb {
-  class dbIStream;
-  class dbOStream;
-  class _dbDatabase;
+  // User Code Begin Consts
+  // User Code End Consts
   {% for _class in klass.declared_classes %}
     {% if _class in ["dbTable", "dbHashTable"] %}
       template <class T>
@@ -62,11 +59,7 @@ namespace odb {
       {% if "comment" in field %}
         {{field.comment}}
       {% endif %}
-      {% if field.table %}
-        dbTable<_{{field.type}}>* {{field.name}};
-      {% else %}
-        {{field.type}} {{field.name}};
-      {% endif %}
+      {{field.type}} {{field.name}};
     {% endfor %}
 
     // User Code Begin Fields

src/odb/src/codeGenerator/templates/macros.jinja

@@ -34,7 +34,7 @@
 {% macro getter_signature(field, klass=None) -%}
   {% if klass %}{% set prefix = klass.name + "::" %}{% endif %}
   {% if field.dbSetGetter %}
-    dbSet<{{field.type}}> {{prefix}}get{{field.functional_name}}() const
+    dbSet<{{field.table_base_type}}> {{prefix}}get{{field.functional_name}}() const
   {% elif field.isPassByRef %}
     void {{prefix}}{{field.getterFunctionName}}({{field.getterReturnType}}& tbl) const
   {% elif field.isHashTable %}

src/odb/src/codeGenerator/templates/serializer_out.cpp

@@ -2,6 +2,9 @@
   {% set sname = (parent.name + "::" if parent else '_') + klass.name %}
   dbOStream& operator<<(dbOStream& stream, const {{sname}}& obj)
   {
+    {% if klass.ostream_scope %}
+    dbOStreamScope scope(stream, "{{klass.name}}");
+    {% endif %}
     {% for field in klass.fields %}
       {% if field.bitFields %}
         {% if field.numBits == 32 %}
@@ -23,3 +26,4 @@
     return stream;
   }
 {%- endmacro %}
+

src/odb/src/db/dbBusPort.h

@@ -6,7 +6,6 @@
 
 #include "dbCore.h"
 #include "odb/odb.h"
-
 // User Code Begin Includes
 #include "dbModuleBusPortModBTermItr.h"
 #include "dbVector.h"

src/odb/src/db/dbGlobalConnect.cpp

@@ -11,7 +11,6 @@
 #include "dbTable.h"
 #include "dbTable.hpp"
 #include "odb/db.h"
-
 // User Code Begin Includes
 #include "dbInst.h"
 #include "dbLib.h"

src/odb/src/db/dbGroup.h

@@ -6,7 +6,6 @@
 
 #include "dbCore.h"
 #include "odb/odb.h"
-
 // User Code Begin Includes
 #include "dbVector.h"
 // User Code End Includes

src/odb/src/db/dbGuide.h

@@ -6,7 +6,6 @@
 
 #include "dbCore.h"
 #include "odb/odb.h"
-
 // User Code Begin Includes
 #include "odb/geom.h"
 // User Code End Includes