Deprecate Gender and add implicit Flow conversion

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

1 files changed, 23 insertions, 0 deletions

diff --git a/src/main/scala/firrtl/package.scala b/src/main/scala/firrtl/package.scala
index eb68aef4..1e871c46 100644
--- a/src/main/scala/firrtl/package.scala
+++ b/src/main/scala/firrtl/package.scala
@@ -12,4 +12,27 @@ package object firrtl {
 
   @deprecated("Use firrtl.stage.TargetDirAnnotation", "1.2")
   val TargetDirAnnotation = firrtl.options.TargetDirAnnotation
+
+  @deprecated("Use Flow instead of Gender. This trait will be removed in 1.3", "1.2")
+  trait Gender
+
+  @deprecated("Use SourceFlow instead of MALE. This case object will be removed in 1.3", "1.2")
+  case object MALE extends Gender
+
+  @deprecated("Use SinkFlow instead of FEMALE. This case object will be removed in 1.3", "1.2")
+  case object FEMALE extends Gender
+
+  @deprecated("Use DuplexFlow instead of BIGENDER. This case object will be removed in 1.3", "1.2")
+  case object BIGENDER extends Gender
+
+  @deprecated("Use UnknownFlow instead of UNKNOWNGENDER. This case object will be removed in 1.3", "1.2")
+  case object UNKNOWNGENDER extends Gender
+
+  @deprecated("Please migrate from 'Gender' to 'Flow'. This implicit conversion will be removed in 1.3", "1.2")
+  implicit def genderToFlow(gender: Gender): Flow = gender match {
+    case MALE          => SourceFlow
+    case FEMALE        => SinkFlow
+    case BIGENDER      => DuplexFlow
+    case UNKNOWNGENDER => UnknownFlow
+  }
 }