Merge pull request #7926 from osamahammad21/odb-prop

odb: code generate dbProperty

Author: osamahammad21

src/odb/include/odb/db.h

@@ -49,7 +49,6 @@ class dbBox;
 class dbJournalEntry;
 
 // Property objects
-class dbProperty;
 class dbBoolProperty;
 class dbStringProperty;
 class dbIntProperty;
@@ -136,6 +135,7 @@ class dbNetTrack;
 class dbPolygon;
 class dbPowerDomain;
 class dbPowerSwitch;
+class dbProperty;
 class dbScanChain;
 class dbScanInst;
 class dbScanList;
@@ -169,136 +169,6 @@ class dbExtControl;
 
 // Custom iterators
 class dbModuleBusPortModBTermItr;
-///
-/// dbProperty - Property base class.
-///
-class dbProperty : public dbObject
-{
- public:
-  enum Type
-  {
-    // Do not change the order or the values of this enum.
-    STRING_PROP = 0,
-    BOOL_PROP = 1,
-    INT_PROP = 2,
-    DOUBLE_PROP = 3
-  };
-
-  /// Get the type of this property.
-  Type getType();
-
-  /// Get thetname of this property.
-  std::string getName();
-
-  /// Get the owner of this property
-  dbObject* getPropOwner();
-
-  /// Find the named property. Returns nullptr if the property does not exist.
-  static dbProperty* find(dbObject* object, const char* name);
-
-  /// Find the named property of the specified type. Returns nullptr if the
-  /// property does not exist.
-  static dbProperty* find(dbObject* object, const char* name, Type type);
-
-  /// Destroy a specific property
-  static void destroy(dbProperty* prop);
-  /// Destroy all properties of the specific object
-  static void destroyProperties(dbObject* obj);
-  static dbSet<dbProperty> getProperties(dbObject* object);
-  static dbSet<dbProperty>::iterator destroy(dbSet<dbProperty>::iterator itr);
-  // 5.8
-  static std::string writeProperties(dbObject* object);
-  static std::string writePropValue(dbProperty* prop);
-};
-
-///
-/// dbProperty - Boolean property.
-///
-class dbBoolProperty : public dbProperty
-{
- public:
-  /// Get the value of this property.
-  bool getValue();
-
-  /// Set the value of this property.
-  void setValue(bool value);
-
-  /// Create a bool property. Returns nullptr if a property with the same name
-  /// already exists.
-  static dbBoolProperty* create(dbObject* object, const char* name, bool value);
-
-  /// Find the named property of type bool. Returns nullptr if the property does
-  /// not exist.
-  static dbBoolProperty* find(dbObject* object, const char* name);
-};
-
-///
-/// dbProperty - String property.
-///
-class dbStringProperty : public dbProperty
-{
- public:
-  /// Get the value of this property.
-  std::string getValue();
-
-  /// Set the value of this property.
-  void setValue(const char* value);
-
-  /// Create a string property. Returns nullptr if a property with the same name
-  /// already exists.
-  static dbStringProperty* create(dbObject* object,
-                                  const char* name,
-                                  const char* value);
-
-  /// Find the named property of type string. Returns nullptr if the property
-  /// does not exist.
-  static dbStringProperty* find(dbObject* object, const char* name);
-};
-
-///
-/// dbProperty - Int property.
-///
-class dbIntProperty : public dbProperty
-{
- public:
-  /// Get the value of this property.
-  int getValue();
-
-  /// Set the value of this property.
-  void setValue(int value);
-
-  /// Create a int property. Returns nullptr if a property with the same name
-  /// already exists.
-  static dbIntProperty* create(dbObject* object, const char* name, int value);
-
-  /// Find the named property of type int. Returns nullptr if the property does
-  /// not exist.
-  static dbIntProperty* find(dbObject* object, const char* name);
-};
-
-///
-/// dbProperty - Double property.
-///
-class dbDoubleProperty : public dbProperty
-{
- public:
-  /// Get the value of this property.
-  double getValue();
-
-  /// Set the value of this property.
-  void setValue(double value);
-
-  /// Create a double property. Returns nullptr if a property with the same name
-  /// already exists.
-  static dbDoubleProperty* create(dbObject* object,
-                                  const char* name,
-                                  double value);
-
-  /// Find the named property of type double. Returns nullptr if the property
-  /// does not exist.
-  static dbDoubleProperty* find(dbObject* object, const char* name);
-};
-
 ///////////////////////////////////////////////////////////////////////////////
 ///
 /// This class encapsulates a persitant ADS database.
@@ -8365,6 +8235,47 @@ class dbPowerSwitch : public dbObject
   // User Code End dbPowerSwitch
 };
 
+class dbProperty : public dbObject
+{
+ public:
+  // User Code Begin dbProperty
+  enum Type
+  {
+    // Do not change the order or the values of this enum.
+    STRING_PROP = 0,
+    BOOL_PROP = 1,
+    INT_PROP = 2,
+    DOUBLE_PROP = 3
+  };
+
+  /// Get the type of this property.
+  Type getType();
+
+  /// Get thetname of this property.
+  std::string getName();
+
+  /// Get the owner of this property
+  dbObject* getPropOwner();
+
+  /// Find the named property. Returns nullptr if the property does not exist.
+  static dbProperty* find(dbObject* object, const char* name);
+
+  /// Find the named property of the specified type. Returns nullptr if the
+  /// property does not exist.
+  static dbProperty* find(dbObject* object, const char* name, Type type);
+
+  /// Destroy a specific property
+  static void destroy(dbProperty* prop);
+  /// Destroy all properties of the specific object
+  static void destroyProperties(dbObject* obj);
+  static dbSet<dbProperty> getProperties(dbObject* object);
+  static dbSet<dbProperty>::iterator destroy(dbSet<dbProperty>::iterator itr);
+  // 5.8
+  static std::string writeProperties(dbObject* object);
+  static std::string writePropValue(dbProperty* prop);
+  // User Code End dbProperty
+};
+
 // A scan chain is a collection of dbScanLists that contains dbScanInsts.  Here,
 // scan_in, scan_out and scan_enable are the top level ports/pins to where this
 // scan chain is connected.  Each scan chain is also associated with a
@@ -10675,6 +10586,93 @@ class dbTechLayerWrongDirSpacingRule : public dbObject
 };
 
 // Generator Code End ClassDefinition
+///
+/// dbProperty - Boolean property.
+///
+class dbBoolProperty : public dbProperty
+{
+ public:
+  /// Get the value of this property.
+  bool getValue();
+
+  /// Set the value of this property.
+  void setValue(bool value);
+
+  /// Create a bool property. Returns nullptr if a property with the same name
+  /// already exists.
+  static dbBoolProperty* create(dbObject* object, const char* name, bool value);
+
+  /// Find the named property of type bool. Returns nullptr if the property does
+  /// not exist.
+  static dbBoolProperty* find(dbObject* object, const char* name);
+};
+
+///
+/// dbProperty - String property.
+///
+class dbStringProperty : public dbProperty
+{
+ public:
+  /// Get the value of this property.
+  std::string getValue();
+
+  /// Set the value of this property.
+  void setValue(const char* value);
+
+  /// Create a string property. Returns nullptr if a property with the same name
+  /// already exists.
+  static dbStringProperty* create(dbObject* object,
+                                  const char* name,
+                                  const char* value);
+
+  /// Find the named property of type string. Returns nullptr if the property
+  /// does not exist.
+  static dbStringProperty* find(dbObject* object, const char* name);
+};
+
+///
+/// dbProperty - Int property.
+///
+class dbIntProperty : public dbProperty
+{
+ public:
+  /// Get the value of this property.
+  int getValue();
+
+  /// Set the value of this property.
+  void setValue(int value);
+
+  /// Create a int property. Returns nullptr if a property with the same name
+  /// already exists.
+  static dbIntProperty* create(dbObject* object, const char* name, int value);
+
+  /// Find the named property of type int. Returns nullptr if the property does
+  /// not exist.
+  static dbIntProperty* find(dbObject* object, const char* name);
+};
+
+///
+/// dbProperty - Double property.
+///
+class dbDoubleProperty : public dbProperty
+{
+ public:
+  /// Get the value of this property.
+  double getValue();
+
+  /// Set the value of this property.
+  void setValue(double value);
+
+  /// Create a double property. Returns nullptr if a property with the same name
+  /// already exists.
+  static dbDoubleProperty* create(dbObject* object,
+                                  const char* name,
+                                  double value);
+
+  /// Find the named property of type double. Returns nullptr if the property
+  /// does not exist.
+  static dbDoubleProperty* find(dbObject* object, const char* name);
+};
 
 }  // namespace odb
 

src/odb/include/odb/dbObject.h

@@ -90,6 +90,7 @@ enum dbObjectType
   dbPolygonObj,
   dbPowerDomainObj,
   dbPowerSwitchObj,
+  dbPropertyObj,
   dbScanChainObj,
   dbScanInstObj,
   dbScanListObj,
@@ -143,7 +144,6 @@ enum dbObjectType
   dbTechViaLayerRuleObj,
 
   // Property
-  dbPropertyObj,
   dbNameObj
 };
 

src/odb/src/codeGenerator/schema/chip/dbProperty.json

@@ -0,0 +1,60 @@
+{
+  "name": "dbProperty",
+  "type": "dbObject",
+  "hash": "0x66",
+  "do_not_generate_compare" : "true",
+  "fields": [
+    {
+      "name": "_type",
+      "type": "uint",
+      "bits": 4,
+      "flags": ["private"]
+    },
+    {
+      "name": "_owner_type",
+      "type": "uint", 
+      "bits": 8,
+      "flags": ["private"]
+    },
+          {
+        "name": "_spare_bits",
+        "type": "uint",
+        "bits": 20,
+        "flags": ["private", "no-cmp"]
+      },
+    {
+      "name": "_name",
+      "type": "uint",
+      "flags": ["private", "no-destruct"]
+    },
+    {
+      "name": "_next",
+      "type": "dbId<_dbProperty>",
+      "flags": ["private", "no-get"]
+    },
+    {
+      "name": "_owner",
+      "type": "uint",
+      "default": "0",
+      "flags": ["private", "no-cmp"]
+    },
+    {
+      "name": "_value",
+      "type": "std::variant<std::string, bool, int, double>",
+      "flags": ["private","no-template", "no-serial"]
+    }
+  ],
+  "h_includes": [
+    "odb/dbTypes.h",
+    "odb/dbId.h"
+  ],
+  "cpp_includes": [
+    "dbNameCache.h",
+    "dbPropertyItr.h",
+    "dbBlock.h",
+    "dbChip.h",
+    "dbLib.h",
+    "dbName.h",
+    "dbTech.h"
+  ]
+} 

src/odb/src/codeGenerator/templates/dbCompare.h

@@ -1,5 +1,6 @@
 //Generator Code Begin Less
 {% for klass in schema.classes|sort(attribute='name') %}
+{% if not klass.do_not_generate_compare %}
 template <>
 struct less<odb::{{klass.name}}*>
 {
@@ -10,5 +11,6 @@ struct less<odb::{{klass.name}}*>
   }
 };
 
+{% endif %}
 {% endfor %}
 //Generator Code End Less