CIRCT  19.0.0git
Public Member Functions | Protected Attributes | List of all members
circt::Namespace Class Reference

A namespace that is used to store existing names and generate new names in some scope within the IR. More...

#include <Namespace.h>

Inheritance diagram for circt::Namespace:
Inheritance graph
[legend]
Collaboration diagram for circt::Namespace:
Collaboration graph
[legend]

Public Member Functions

 Namespace ()
 
 Namespace (const Namespace &other)=default
 
 Namespace (Namespace &&other)
 
Namespaceoperator= (const Namespace &other)=default
 
Namespaceoperator= (Namespace &&other)
 
void add (mlir::ModuleOp module)
 
void add (SymbolCache &symCache)
 SymbolCache initializer; initialize from every key that is convertible to a StringAttr in the SymbolCache. More...
 
void clear ()
 Empty the namespace. More...
 
StringRef newName (const Twine &name)
 Return a unique name, derived from the input name, and add the new name to the internal namespace. More...
 
StringRef newName (const Twine &name, const Twine &suffix)
 Return a unique name, derived from the input name and ensure the returned name has the input suffix. More...
 

Protected Attributes

llvm::StringMap< size_t > nextIndex
 

Detailed Description

A namespace that is used to store existing names and generate new names in some scope within the IR.

This exists to work around limitations of SymbolTables. This acts as a base class providing facilities common to all namespaces implementations.

Definition at line 30 of file Namespace.h.

Constructor & Destructor Documentation

◆ Namespace() [1/3]

circt::Namespace::Namespace ( )
inline

Definition at line 32 of file Namespace.h.

References nextIndex.

◆ Namespace() [2/3]

circt::Namespace::Namespace ( const Namespace other)
default

◆ Namespace() [3/3]

circt::Namespace::Namespace ( Namespace &&  other)
inline

Definition at line 38 of file Namespace.h.

Member Function Documentation

◆ add() [1/2]

void circt::Namespace::add ( mlir::ModuleOp  module)
inline

◆ add() [2/2]

void circt::Namespace::add ( SymbolCache symCache)
inline

SymbolCache initializer; initialize from every key that is convertible to a StringAttr in the SymbolCache.

Definition at line 56 of file Namespace.h.

References nextIndex.

◆ clear()

void circt::Namespace::clear ( )
inline

Empty the namespace.

Definition at line 63 of file Namespace.h.

References nextIndex.

◆ newName() [1/2]

StringRef circt::Namespace::newName ( const Twine &  name)
inline

Return a unique name, derived from the input name, and add the new name to the internal namespace.

There are two possible outcomes for the returned name:

  1. The original name is returned.
  2. The name is given a _<n> suffix where <n> is a number starting from 0 and incrementing by one each time (_0, ...).

Definition at line 72 of file Namespace.h.

References nextIndex.

Referenced by circt::firrtl::applyGCTMemTaps(), circt::SMTGlobalsHandler::create(), circt::FirMemLowering::createMemoryModule(), createModuleForCut(), circt::ExportVerilog::lowerHWInstanceChoices(), ModuleNameSanitizer::rewrite(), and LowerLayersPass::runOnOperation().

◆ newName() [2/2]

StringRef circt::Namespace::newName ( const Twine &  name,
const Twine &  suffix 
)
inline

Return a unique name, derived from the input name and ensure the returned name has the input suffix.

Also add the new name to the internal namespace. There are two possible outcomes for the returned name:

  1. The original name + _<suffix> is returned.
  2. The name is given a suffix _<n>_<suffix> where <n> is a number starting from 0 and incrementing by one each time.

Definition at line 105 of file Namespace.h.

References concat(), and nextIndex.

◆ operator=() [1/2]

Namespace& circt::Namespace::operator= ( const Namespace other)
default

◆ operator=() [2/2]

Namespace& circt::Namespace::operator= ( Namespace &&  other)
inline

Definition at line 41 of file Namespace.h.

References nextIndex.

Member Data Documentation

◆ nextIndex

llvm::StringMap<size_t> circt::Namespace::nextIndex
protected

The documentation for this class was generated from the following file: