Packages

final class MutableRenameMap extends RenameMap

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

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

    Create new RenameMap that merges this and renameMap

    Definition Classes
    RenameMap
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. val _chained: Option[RenameMap]
    Attributes
    protected
    Definition Classes
    MutableRenameMap → RenameMap
  6. def _recordAll(map: Map[CompleteTarget, Seq[CompleteTarget]]): Unit
    Attributes
    protected
    Definition Classes
    RenameMap
  7. val _underlying: HashMap[CompleteTarget, Seq[CompleteTarget]]
    Attributes
    protected
    Definition Classes
    MutableRenameMap → RenameMap
  8. def addMap(map: Map[Named, Seq[Named]]): Unit
    Definition Classes
    MutableRenameMap → RenameMap
  9. 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

    Definition Classes
    RenameMap
    Note

    Self renames *will* be recorded

    ,

    Rename to/tos will be made distinct

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

    Renames a CompleteTarget

    Renames a CompleteTarget

    t

    target to rename

    returns

    renamed targets

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

    Fully rename from to tos

    Fully rename from to tos

    Attributes
    protected
    Definition Classes
    RenameMap
  14. def delete(name: ComponentName): Unit
    Definition Classes
    MutableRenameMap → RenameMap
  15. def delete(name: ModuleName): Unit
    Definition Classes
    MutableRenameMap → RenameMap
  16. def delete(name: CircuitName): Unit
    Definition Classes
    MutableRenameMap → RenameMap
  17. def delete(name: CompleteTarget): Unit

    Records that a CompleteTarget is deleted

    Records that a CompleteTarget is deleted

    Definition Classes
    MutableRenameMap → RenameMap
  18. val doDistinct: Boolean
    Attributes
    protected
    Definition Classes
    MutableRenameMap → RenameMap
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  21. def get(key: Named): Option[Seq[Named]]
    Definition Classes
    RenameMap
  22. def get(key: ComponentName): Option[Seq[ComponentName]]
    Definition Classes
    RenameMap
  23. def get(key: ModuleName): Option[Seq[ModuleName]]
    Definition Classes
    RenameMap
  24. def get(key: CircuitName): Option[Seq[CircuitName]]
    Definition Classes
    RenameMap
  25. 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

    Definition Classes
    RenameMap
  26. 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
  27. 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
  28. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. def hasChanges: Boolean

    returns

    Whether this RenameMap has collected any changes

    Definition Classes
    RenameMap
  30. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. 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

    Definition Classes
    MutableRenameMap → RenameMap
    Note

    Self renames *will* be recorded

    ,

    Rename to/tos will be made distinct

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

    Definition Classes
    MutableRenameMap → RenameMap
    Note

    Self renames *will* be recorded

    ,

    Rename to/tos will be made distinct

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

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

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

  40. def rename(from: ComponentName, tos: Seq[ComponentName]): Unit
    Definition Classes
    MutableRenameMap → RenameMap
  41. def rename(from: ComponentName, to: ComponentName): Unit
    Definition Classes
    MutableRenameMap → RenameMap
  42. def rename(from: Named, tos: Seq[Named]): Unit
    Definition Classes
    MutableRenameMap → RenameMap
  43. def rename(from: Named, to: Named): Unit
    Definition Classes
    MutableRenameMap → RenameMap
  44. def serialize: String

    Visualize the RenameMap

    Visualize the RenameMap

    Definition Classes
    RenameMap
  45. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  46. def toString(): String
    Definition Classes
    AnyRef → Any
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def chained: Option[RenameMap]
    Definition Classes
    RenameMap
    Annotations
    @deprecated
    Deprecated

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

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

    Creates a deep copy of this RenameMap

    Creates a deep copy of this RenameMap

    Definition Classes
    RenameMap
    Annotations
    @deprecated
    Deprecated

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

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

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

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

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

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

  8. def keys: Iterator[CompleteTarget]
    Definition Classes
    RenameMap
    Annotations
    @deprecated
    Deprecated

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

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

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

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

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

  13. def underlying: HashMap[CompleteTarget, Seq[CompleteTarget]]
    Definition Classes
    RenameMap
    Annotations
    @deprecated
    Deprecated

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

Inherited from RenameMap

Inherited from AnyRef

Inherited from Any

Ungrouped