Packages

sealed trait RenameMap extends AnyRef

Map old names to new names

Transforms that modify names should return a RenameMap with the CircuitState These are mutable datastructures for convenience

Source
RenameMap.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
MutableRenameMap
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RenameMap
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def _chained: Option[RenameMap]
    Attributes
    protected
  2. abstract def _underlying: HashMap[CompleteTarget, Seq[CompleteTarget]]
    Attributes
    protected
  3. abstract def doDistinct: Boolean
    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def ++(renameMap: RenameMap): RenameMap

    Create new RenameMap that merges this and renameMap

  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def _recordAll(map: Map[CompleteTarget, Seq[CompleteTarget]]): Unit
    Attributes
    protected
  6. def andThen(next: RenameMap): RenameMap

    Chain a RenameMap with this RenameMap

    Chain a RenameMap with this RenameMap

    next

    the map to chain with this map

    Note

    Self renames *will* be recorded

    ,

    Rename to/tos will be made distinct

  7. def apply(t: CompleteTarget): Seq[CompleteTarget]

    Renames a CompleteTarget

    Renames a CompleteTarget

    t

    target to rename

    returns

    renamed targets

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  10. def completeRename(from: CompleteTarget, tos: Seq[CompleteTarget]): Unit

    Fully rename from to tos

    Fully rename from to tos

    Attributes
    protected
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def get(key: Named): Option[Seq[Named]]
  14. def get(key: ComponentName): Option[Seq[ComponentName]]
  15. def get(key: ModuleName): Option[Seq[ModuleName]]
  16. def get(key: CircuitName): Option[Seq[CircuitName]]
  17. def get(key: IsMember): Option[Seq[IsMember]]

    Get renames of a IsMember

    Get renames of a IsMember

    key

    Target referencing the original member of the circuit

    returns

    Optionally return sequence of targets that key remaps to

  18. 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

  19. 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

  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def hasChanges: Boolean

    returns

    Whether this RenameMap has collected any changes

  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. def serialize: String

    Visualize the RenameMap

  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def addMap(map: Map[Named, Seq[Named]]): Unit
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

  2. def chained: Option[RenameMap]
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) This should never have been public

  3. def copy(chained: Option[RenameMap] = _chained): RenameMap

    Creates a deep copy of this RenameMap

    Creates a deep copy of this RenameMap

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) RenameMap is becoming more function-like, this shouldn't be necessary

  4. 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

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

  5. 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

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

  6. def delete(name: ComponentName): Unit
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

  7. def delete(name: ModuleName): Unit
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

  8. def delete(name: CircuitName): Unit
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

  9. def delete(name: CompleteTarget): Unit

    Records that a CompleteTarget is deleted

    Records that a CompleteTarget is deleted

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  11. def getReverseRenameMap: RenameMap
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) RenameMap is becoming more function-like and is not invertible

  12. def getUnderlying: Map[CompleteTarget, Seq[CompleteTarget]]

    Returns the underlying map of rename information

    Returns the underlying map of rename information

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) This should never have been public

  13. def keys: Iterator[CompleteTarget]
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) This should never have been public

  14. def record(from: IsMember, tos: Seq[IsMember]): Unit

    Record that the from IsMember is renamed to another sequence of IsMembers

    Record that the from IsMember is renamed to another sequence of IsMembers

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

    Note

    Self renames *will* be recorded

    ,

    Rename to/tos will be made distinct

  15. def record(from: IsMember, to: IsMember): Unit

    Record that the from Member is renamed to another IsMember

    Record that the from Member is renamed to another IsMember

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

    Note

    Self renames *will* be recorded

    ,

    Rename to/tos will be made distinct

  16. 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

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

    Note

    Self renames *will* be recorded

    ,

    Rename to/tos will be made distinct

  17. 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

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

    Note

    Self renames *will* be recorded

    ,

    Rename to/tos will be made distinct

  18. 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

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

    Note

    Self renames *will* be recorded

    ,

    Rename to/tos will be made distinct

  19. 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

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

  20. 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

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

  21. def rename(from: ComponentName, tos: Seq[ComponentName]): Unit
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

  22. def rename(from: ComponentName, to: ComponentName): Unit
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

  23. def rename(from: Named, tos: Seq[Named]): Unit
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

  24. def rename(from: Named, to: Named): Unit
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

  25. 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

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

  26. 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

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use firrtl.renamemap.MutableRenameMap for recording renames

  27. def underlying: HashMap[CompleteTarget, Seq[CompleteTarget]]
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) This should never have been public

Inherited from AnyRef

Inherited from Any

Ungrouped