Merge pull request #8510 from hzeller/feature-20251001-no-cyclic-dep

dbCompare is an implementation artifact of db.h. Make an inc.

Author: maliberty

src/gui/src/dbDescriptors.cpp

@@ -30,7 +30,6 @@
 #include "db_sta/dbSta.hh"
 #include "gui/gui.h"
 #include "odb/db.h"
-#include "odb/dbCompare.h"
 #include "odb/dbObject.h"
 #include "odb/dbShape.h"
 #include "odb/dbTransform.h"

src/odb/BUILD

@@ -46,6 +46,7 @@ cc_library(
         "src/lefout/*.cpp",
         "src/3dblox/*.cpp",
         "src/3dblox/*.h",
+        "include/odb/dbCompare.inc",
     ] + [
         "src/swig/common/swig_common.cpp",
     ]),

src/odb/include/odb/db.h

@@ -10992,4 +10992,4 @@ class dbDoubleProperty : public dbProperty
 }  // namespace odb
 
 // Overload std::less for these types
-#include "odb/dbCompare.h"
+#include "odb/dbCompare.inc"  // IWYU pragma: export

src/odb/include/odb/dbCompare.h src/odb/include/odb/dbCompare.incsrc/odb/include/odb/dbCompare.h renamed to src/odb/include/odb/dbCompare.inc

@@ -1,8 +1,6 @@
 // SPDX-License-Identifier: BSD-3-Clause
 // Copyright (c) 2019-2025, The OpenROAD Authors
 
-#pragma once
-
 // IWYU pragma: private, include "db.h"
 
 // Provide overloads of std::less for all instantiable, dbObject-derived types.
@@ -14,9 +12,6 @@
 
 #include <functional>
 
-// This is needed just for clang-tidy.  Normally people will not include
-// this header directly; they will include db.h and get this indirectly.
-#include "odb/db.h"
 #include "odb/dbObject.h"
 
 namespace odb {

src/odb/src/codeGenerator/gen.py

@@ -390,13 +390,13 @@ def generate(schema, env, includeDir, srcDir, keep_empty):
             with open(out_file, "w", encoding="ascii") as file:
                 file.write(text)
 
-    includes = ["db.h", "dbObject.h", "dbCompare.h"]
+    includes = ["db.h", "dbObject.h", "dbCompare.inc"]
     for template_file in [
         "db.h",
         "dbObject.h",
         "CMakeLists.txt",
         "dbObject.cpp",
-        "dbCompare.h",
+        "dbCompare.inc",
     ]:
         template = env.get_template(template_file)
         text = template.render(schema=schema)

…/src/codeGenerator/templates/dbCompare.h …rc/codeGenerator/templates/dbCompare.incsrc/odb/src/codeGenerator/templates/dbCompare.h renamed to src/odb/src/codeGenerator/templates/dbCompare.inc src/odb/src/codeGenerator/templates/dbCompare.h renamed to src/odb/src/codeGenerator/templates/dbCompare.inc

@@ -11,7 +11,6 @@
 
 #include "boost/geometry/geometry.hpp"
 #include "odb/db.h"
-#include "odb/dbCompare.h"
 #include "odb/geom.h"
 #include "odb/geom_boost.h"
 

src/pad/src/RDLRoute.cpp

@@ -8,8 +8,8 @@
 #include <optional>
 #include <string>
 
+#include "odb/db.h"
 #include "odb/dbBlockCallBackObj.h"
-#include "odb/dbCompare.h"
 
 namespace odb {
 class dbDatabase;