final class MutableRenameMap extends RenameMap
- Alphabetic
- By Inheritance
- MutableRenameMap
- RenameMap
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def ++(renameMap: RenameMap): RenameMap
Create new RenameMap that merges this and renameMap
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val _chained: Option[RenameMap]
- Attributes
- protected
- Definition Classes
- MutableRenameMap → RenameMap
- def _recordAll(map: Map[CompleteTarget, Seq[CompleteTarget]]): Unit
- Attributes
- protected
- Definition Classes
- RenameMap
- val _underlying: HashMap[CompleteTarget, Seq[CompleteTarget]]
- Attributes
- protected
- Definition Classes
- MutableRenameMap → RenameMap
- def addMap(map: Map[Named, Seq[Named]]): Unit
- Definition Classes
- MutableRenameMap → RenameMap
- def andThen(next: RenameMap): RenameMap
- def apply(t: CompleteTarget): Seq[CompleteTarget]
Renames a CompleteTarget
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def completeRename(from: CompleteTarget, tos: Seq[CompleteTarget]): Unit
Fully rename
from
totos
Fully rename
from
totos
- Attributes
- protected
- Definition Classes
- RenameMap
- def delete(name: ComponentName): Unit
- Definition Classes
- MutableRenameMap → RenameMap
- def delete(name: ModuleName): Unit
- Definition Classes
- MutableRenameMap → RenameMap
- def delete(name: CircuitName): Unit
- Definition Classes
- MutableRenameMap → RenameMap
- def delete(name: CompleteTarget): Unit
Records that a CompleteTarget is deleted
Records that a CompleteTarget is deleted
- Definition Classes
- MutableRenameMap → RenameMap
- val doDistinct: Boolean
- Attributes
- protected
- Definition Classes
- MutableRenameMap → RenameMap
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def get(key: Named): Option[Seq[Named]]
- Definition Classes
- RenameMap
- def get(key: ComponentName): Option[Seq[ComponentName]]
- Definition Classes
- RenameMap
- def get(key: ModuleName): Option[Seq[ModuleName]]
- Definition Classes
- RenameMap
- def get(key: CircuitName): Option[Seq[CircuitName]]
- Definition Classes
- RenameMap
- def get(key: IsMember): Option[Seq[IsMember]]
Get renames of a IsMember
- def get(key: CircuitTarget): Option[Seq[CircuitTarget]]
Get renames of a CircuitTarget
Get renames of a CircuitTarget
- key
Target referencing the original circuit
- returns
Optionally return sequence of targets that key remaps to
- Definition Classes
- RenameMap
- def get(key: CompleteTarget): Option[Seq[CompleteTarget]]
Get renames of a CircuitTarget
Get renames of a CircuitTarget
- key
Target referencing the original circuit
- returns
Optionally return sequence of targets that key remaps to
- Definition Classes
- RenameMap
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hasChanges: Boolean
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def record(from: IsMember, tos: Seq[IsMember]): Unit
Record that the from IsMember is renamed to another sequence of IsMembers
- Definition Classes
- MutableRenameMap → RenameMap
- Note
Self renames *will* be recorded
,Rename to/tos will be made distinct
- def record(from: IsMember, to: IsMember): Unit
Record that the from Member is renamed to another IsMember
- Definition Classes
- MutableRenameMap → RenameMap
- Note
Self renames *will* be recorded
,Rename to/tos will be made distinct
- def record(from: CircuitTarget, tos: Seq[CircuitTarget]): Unit
Record that the from CircuitTarget is renamed to another sequence of CircuitTargets
Record that the from CircuitTarget is renamed to another sequence of CircuitTargets
- Definition Classes
- MutableRenameMap → RenameMap
- Note
Self renames *will* be recorded
,Rename to/tos will be made distinct
- def record(from: CircuitTarget, to: CircuitTarget): Unit
Record that the from CircuitTarget is renamed to another CircuitTarget
Record that the from CircuitTarget is renamed to another CircuitTarget
- Definition Classes
- MutableRenameMap → RenameMap
- Note
Self renames *will* be recorded
,Rename to/tos will be made distinct
- def recordAll(map: Map[CompleteTarget, Seq[CompleteTarget]]): Unit
Records that the keys in map are also renamed to their corresponding value seqs.
Records that the keys in map are also renamed to their corresponding value seqs. Only (CircuitTarget -> Seq[ CircuitTarget ]) and (IsMember -> Seq[ IsMember ]) key/value allowed
- Definition Classes
- MutableRenameMap → RenameMap
- Note
Self renames *will* be recorded
,Rename to/tos will be made distinct
- def rename(from: ComponentName, tos: Seq[ComponentName]): Unit
- Definition Classes
- MutableRenameMap → RenameMap
- def rename(from: ComponentName, to: ComponentName): Unit
- Definition Classes
- MutableRenameMap → RenameMap
- def rename(from: Named, tos: Seq[Named]): Unit
- Definition Classes
- MutableRenameMap → RenameMap
- def rename(from: Named, to: Named): Unit
- Definition Classes
- MutableRenameMap → RenameMap
- def serialize: String
Visualize the RenameMap
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def chained: Option[RenameMap]
- Definition Classes
- RenameMap
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.5) This should never have been public
- def copy(chained: Option[RenameMap] = _chained): RenameMap
Creates a deep copy of this RenameMap
- def delete(names: Seq[String]): Unit
Records that references in names are all deleted The reference's root module and circuit are determined by whomever called setModule or setCircuit last
Records that references in names are all deleted The reference's root module and circuit are determined by whomever called setModule or setCircuit last
- Definition Classes
- MutableRenameMap → RenameMap
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.5) Use type-safe delete methods instead
- def delete(name: String): Unit
Records named reference is deleted The reference's root module and circuit are determined by whomever called setModule or setCircuit last
Records named reference is deleted The reference's root module and circuit are determined by whomever called setModule or setCircuit last
- Definition Classes
- MutableRenameMap → RenameMap
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.5) Use type-safe delete methods instead
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def getReverseRenameMap: RenameMap
- Definition Classes
- RenameMap
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.5) RenameMap is becoming more function-like and is not invertible
- def getUnderlying: Map[CompleteTarget, Seq[CompleteTarget]]
Returns the underlying map of rename information
Returns the underlying map of rename information
- Definition Classes
- RenameMap
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.5) This should never have been public
- def keys: Iterator[CompleteTarget]
- Definition Classes
- RenameMap
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.5) This should never have been public
- def rename(from: String, tos: Seq[String]): Unit
Records how a reference maps to a new reference The reference's root module and circuit are determined by whomever called setModule or setCircuit last
Records how a reference maps to a new reference The reference's root module and circuit are determined by whomever called setModule or setCircuit last
- Definition Classes
- MutableRenameMap → RenameMap
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.5) Use type-safe rename methods instead
- def rename(from: String, to: String): Unit
Records how a reference maps to a new reference
Records how a reference maps to a new reference
- Definition Classes
- MutableRenameMap → RenameMap
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.5) Use type-safe rename methods instead
- def setCircuit(circuit: String): Unit
Sets mutable state to record current circuit we are visiting
Sets mutable state to record current circuit we are visiting
- Definition Classes
- MutableRenameMap → RenameMap
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.5) Use type-safe rename methods instead
- def setModule(module: String): Unit
Sets mutable state to record current module we are visiting
Sets mutable state to record current module we are visiting
- Definition Classes
- MutableRenameMap → RenameMap
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.5) Use type-safe rename methods instead
- def underlying: HashMap[CompleteTarget, Seq[CompleteTarget]]
- Definition Classes
- RenameMap
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.5) This should never have been public
This is the documentation for Firrtl.