dbObject.h

// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2019-2025, The OpenROAD Authors

#pragma once

#include <cstdint>
#include <string>

namespace utl {
class Logger;
}

namespace odb {

///
/// When adding a new database object, you must add a dbObjectType enumerator
/// and edit dbObject.cpp and assign an unique "character" code for its
/// database-name.
///
class _dbDatabase;
class dbOStream;
class dbIStream;
class dbObjectPage;
class dbObjectTable;
class _dbObject;

///
/// Steps to add new objects -
///      - add the "name_tbl" entry in dbObject.cpp
///      - add the table entry to the getObjectTable method of the container
///      object.
///
enum dbObjectType
{
  // Design Objects
  dbGdsLibObj,
  dbBlockObj,
  dbInstHdrObj,
  dbInstObj,
  dbNetObj,
  dbBTermObj,
  dbITermObj,
  dbBoxObj,
  dbViaObj,
  dbTrackGridObj,
  dbObstructionObj,
  dbBlockageObj,
  dbWireObj,
  dbSWireObj,
  dbSBoxObj,
  dbCapNodeObj,
  dbRSegObj,
  dbCCSegObj,
  dbRowObj,
  dbFillObj,
  dbRegionObj,
  dbHierObj,
  dbBPinObj,
  // Generator Code Begin DbObjectType
  dbAccessPointObj,
  dbAlignmentMarkerRuleObj,
  dbBusPortObj,
  dbCellEdgeSpacingObj,
  dbChipObj,
  dbChipBumpObj,
  dbChipBumpInstObj,
  dbChipConnObj,
  dbChipInstObj,
  dbChipNetObj,
  dbChipPathObj,
  dbChipRegionObj,
  dbChipRegionInstObj,
  dbCornerObj,
  dbDatabaseObj,
  dbDftObj,
  dbGCellGridObj,
  dbGDSARefObj,
  dbGDSBoundaryObj,
  dbGDSBoxObj,
  dbGDSPathObj,
  dbGDSSRefObj,
  dbGDSStructureObj,
  dbGDSTextObj,
  dbGlobalConnectObj,
  dbGroupObj,
  dbGuideObj,
  dbIsolationObj,
  dbLevelShifterObj,
  dbLogicPortObj,
  dbMarkerObj,
  dbMarkerCategoryObj,
  dbMasterEdgeTypeObj,
  dbMetalWidthViaMapObj,
  dbModBTermObj,
  dbModInstObj,
  dbModITermObj,
  dbModNetObj,
  dbModuleObj,
  dbNetTrackObj,
  dbPolygonObj,
  dbPowerDomainObj,
  dbPowerSwitchObj,
  dbPropertyObj,
  dbScanChainObj,
  dbScanInstObj,
  dbScanListObj,
  dbScanPartitionObj,
  dbScanPinObj,
  dbTechLayerObj,
  dbTechLayerAreaRuleObj,
  dbTechLayerArraySpacingRuleObj,
  dbTechLayerCornerSpacingRuleObj,
  dbTechLayerCutClassRuleObj,
  dbTechLayerCutEnclosureRuleObj,
  dbTechLayerCutSpacingRuleObj,
  dbTechLayerCutSpacingTableDefRuleObj,
  dbTechLayerCutSpacingTableOrthRuleObj,
  dbTechLayerEolExtensionRuleObj,
  dbTechLayerEolKeepOutRuleObj,
  dbTechLayerForbiddenSpacingRuleObj,
  dbTechLayerKeepOutZoneRuleObj,
  dbTechLayerMaxSpacingRuleObj,
  dbTechLayerMinCutRuleObj,
  dbTechLayerMinStepRuleObj,
  dbTechLayerSpacingEolRuleObj,
  dbTechLayerSpacingTablePrlRuleObj,
  dbTechLayerTwoWiresForbiddenSpcRuleObj,
  dbTechLayerVoltageSpacingObj,
  dbTechLayerWidthTableRuleObj,
  dbTechLayerWrongDirSpacingRuleObj,
  dbUnfoldedChipBumpInstObj,
  dbUnfoldedChipConnObj,
  dbUnfoldedChipInstObj,
  dbUnfoldedChipNetObj,
  dbUnfoldedChipRegionInstObj,
  // Generator Code End DbObjectType

  // Lib Objects
  dbLibObj,
  dbSiteObj,
  dbMasterObj,
  dbMPinObj,
  dbMTermObj,
  dbTechAntennaPinModelObj,

  // Tech Objects
  dbTechObj,
  dbTechViaObj,
  dbTechNonDefaultRuleObj,  // also a design object
  dbTechLayerRuleObj,       // also a design object
  dbTechSameNetRuleObj,
  dbTechLayerSpacingRuleObj,
  dbTechMinCutRuleObj,
  dbTechMinEncRuleObj,
  dbTechV55InfluenceEntryObj,
  dbTechLayerAntennaRuleObj,
  dbTechViaRuleObj,
  dbTechViaGenerateRuleObj,
  dbTechViaLayerRuleObj,

  // Property
  dbNameObj
};

class dbDatabase;

class dbObject
{
 public:
  dbObjectType getObjectType() const;
  dbDatabase* getDb() const;
  uint32_t getId() const;
  const char* getTypeName() const;
  std::string getName() const;
  bool isValid() const;

  static const char* getTypeName(dbObjectType type);
  static dbObjectType getType(const char* name, utl::Logger* logger);

  ///
  /// These are not intended for client use as the returned class is
  /// not exported.  They are for internal db convenience.
  ///
  _dbObject* getImpl();
  const _dbObject* getImpl() const;

  ///
  /// Returns object name for debugging
  /// e.g., "dbITerm(34, 0x555551234b, 'u0/buf/A')"
  ///
  std::string getDebugName() const;

 protected:
  dbObject() = default;
  ~dbObject() = default;
};

dbIStream& operator>>(dbIStream& stream, dbObjectType& type);
dbOStream& operator<<(dbOStream& stream, dbObjectType type);

}  // namespace odb