package scalaz package std trait OptionInstances0 { implicit def optionEqual[A](implicit A0: Equal[A]) = new OptionEqual[A] { implicit def A = A0 } } trait OptionInstances extends OptionInstances0 { implicit val optionInstance = new Traverse[Option] with MonadPlus[Option] with Each[Option] with Index[Option] with Length[Option] with Cozip[Option] with Zip[Option] with Unzip[Option] with IsEmpty[Option] { def point[A](a: => A) = Some(a) def each[A](fa: Option[A])(f: A => Unit) = fa foreach f def index[A](fa: Option[A], n: Int) = if (n == 0) fa else None def length[A](fa: Option[A]) = if (fa.isEmpty) 0 else 1 override def ap[A, B](fa: => Option[A])(f: => Option[A => B]) = f match { case Some(f) => fa match { case Some(x) => Some(f(x)) case None => None } case None => None } def bind[A, B](fa: Option[A])(f: A => Option[B]) = fa flatMap f override def map[A, B](fa: Option[A])(f: A => B) = fa map f def traverseImpl[F[_], A, B](fa: Option[A])(f: A => F[B])(implicit F: Applicative[F]) = fa map (a => F.map(f(a))(Some(_): Option[B])) getOrElse F.point(None) def empty[A]: Option[A] = None def plus[A](a: Option[A], b: => Option[A]) = a orElse b override def foldRight[A, B](fa: Option[A], z: => B)(f: (A, => B) => B) = fa match { case Some(a) => f(a, z) case None => z } def cozip[A, B](a: Option[A \/ B]) = a match { case None => -\/(None) case Some(e) => e match { case -\/(a) => -\/(Some(a)) case \/-(b) => \/-(Some(b)) } } def zip[A, B](a: => Option[A], b: => Option[B]) = for { x <- a y <- b } yield (x, y) def unzip[A, B](a: Option[(A, B)]) = a match { case None => (None, None) case Some((a, b)) => (Some(a), Some(b)) } def isEmpty[A](opt: Option[A]) = opt.isEmpty } implicit def optionMonoid[A: Semigroup]: Monoid[Option[A]] = new Monoid[Option[A]] { def append(f1: Option[A], f2: => Option[A]) = (f1, f2) match { case (Some(a1), Some(a2)) => Some(Semigroup[A].append(a1, a2)) case (Some(a1), None) => f1 case (None, Some(a2)) => f2 case (None, None) => None } def zero: Option[A] = None } /** Add `None` as an element less than all `A`s. */ implicit def optionOrder[A](implicit A0: Order[A]): Order[Option[A]] = new OptionOrder[A] { implicit def A = A0 } implicit def optionShow[A: Show]: Show[Option[A]] = new Show[Option[A]] { override def show(o1: Option[A]) = o1 match { case Some(a1) => Cord("Some(", Show[A].show(a1), ")") case None => "None" } } implicit def optionFirst[A] = new Monoid[FirstOption[A]] { def zero: FirstOption[A] = Tag(None) def append(f1: FirstOption[A], f2: => FirstOption[A]) = Tag(f1.orElse(f2)) } implicit def optionFirstShow[A: Show]: Show[FirstOption[A]] = Tag.subst(Show[Option[A]]) implicit def optionFirstOrder[A: Order]: Order[FirstOption[A]] = Tag.subst(Order[Option[A]]) implicit def optionFirstMonad: Monad[FirstOption] = new Monad[FirstOption] { def point[A](a: => A): FirstOption[A] = Tag(Some(a)) override def map[A, B](fa: FirstOption[A])(f: A => B) = Tag(fa map f) def bind[A, B](fa: FirstOption[A])(f: A => FirstOption[B]): FirstOption[B] = Tag(fa flatMap f) } implicit def optionLast[A] = new Monoid[LastOption[A]] { def zero: LastOption[A] = Tag(None) def append(f1: LastOption[A], f2: => LastOption[A]) = Tag(f2.orElse(f1)) } implicit def optionLastShow[A: Show]: Show[LastOption[A]] = Tag.subst(Show[Option[A]]) implicit def optionLastOrder[A: Order]: Order[LastOption[A]] = Tag.subst(Order[Option[A]]) implicit def optionLastMonad: Monad[LastOption] = new Monad[LastOption] { def point[A](a: => A): LastOption[A] = Tag(Some(a)) override def map[A, B](fa: LastOption[A])(f: A => B) = Tag(fa map f) def bind[A, B](fa: LastOption[A])(f: A => LastOption[B]): LastOption[B] = Tag(fa flatMap f) } implicit def optionMin[A](implicit o: Order[A]) = new Monoid[MinOption[A]] { def zero: MinOption[A] = Tag(None) def append(f1: MinOption[A], f2: => MinOption[A]) = Tag(Order[Option[A]].min(f1, f2)) } implicit def optionMinShow[A: Show]: Show[MinOption[A]] = Tag.subst(Show[Option[A]]) implicit def optionMinOrder[A: Order]: Order[MinOption[A]] = Tag.subst(Order[Option[A]]) implicit def optionMinMonad: Monad[MinOption] = new Monad[MinOption] { def point[A](a: => A): MinOption[A] = Tag(Some(a)) override def map[A, B](fa: MinOption[A])(f: A => B) = Tag(fa map f) def bind[A, B](fa: MinOption[A])(f: A => MinOption[B]): MinOption[B] = Tag(fa flatMap f) } implicit def optionMax[A](implicit o: Order[A]) = new Monoid[MaxOption[A]] { def zero: MaxOption[A] = Tag(None) def append(f1: MaxOption[A], f2: => MaxOption[A]) = Tag(Order[Option[A]].max(f1, f2)) } implicit def optionMaxShow[A: Show]: Show[MaxOption[A]] = Tag.subst(Show[Option[A]]) implicit def optionMaxOrder[A: Order]: Order[MaxOption[A]] = Tag.subst(Order[Option[A]]) implicit def optionMaxMonad: Monad[MaxOption] = new Monad[MaxOption] { def point[A](a: => A): MaxOption[A] = Tag(Some(a)) override def map[A, B](fa: MaxOption[A])(f: A => B) = Tag(fa map f) def bind[A, B](fa: MaxOption[A])(f: A => MaxOption[B]): MaxOption[B] = Tag(fa flatMap f) } } trait OptionFunctions { /** [[scala.Some.apply]] with a sometimes more convenient type. */ final def some[A](a: A): Option[A] = Some(a) /** [[scala.None]] with a sometimes more convenient type. */ final def none[A]: Option[A] = None /** * Catamorphism over the option. Returns the provided function `some` applied to item contained in the Option * if it is defined, otherwise, the provided value `none`. */ final def cata[A, X](oa: Option[A])(some: A => X, none: => X): X = oa match { case None => none case Some(a) => some(a) } /**Alias for `cata` */ final def fold[A, X](oa: Option[A])(some: A => X, none: => X): X = cata(oa)(some, none) final def toSuccess[A, E](oa: Option[A])(e: => E): Validation[E, A] = oa match { case Some(a) => Success(a) case None => Failure(e) } final def toFailure[A, B](oa: Option[A])(b: => B): Validation[A, B] = oa match { case Some(e) => Failure(e) case None => Success(b) } final def toRight[A, E](oa: Option[A])(e: => E): E \/ A = oa match { case Some(a) => \/-(a) case None => -\/(e) } final def toLeft[A, B](oa: Option[A])(b: => B): A \/ B = oa match { case Some(a) => -\/(a) case None => \/-(b) } /** * Returns the item contained in the Option wrapped in type M if the Option is defined, * otherwise, the empty value for type M. */ final def orEmpty[A, M[_] : Applicative : PlusEmpty](oa: Option[A]): M[A] = oa match { case Some(a) => Applicative[M].point(a) case None => PlusEmpty[M].empty } /** * Returns the given value if None, otherwise lifts the Some value and passes it to the given function. */ final def foldLift[F[_], A, B](oa: Option[A])(b: => B, k: F[A] => B)(implicit p: Applicative[F]): B = oa match { case None => b case Some(a) => k(Applicative[F].point(a)) } /** * Returns the given value if None, otherwise lifts the Some value to Option and passes it to the given function. */ final def foldLiftOpt[A, B](oa: Option[A])(b: => B, k: Option[A] => B): B = { import scalaz.std.option.optionInstance foldLift[Option, A, B](oa)(b, k) } } object option extends OptionInstances with OptionFunctions { object optionSyntax extends scalaz.syntax.std.ToOptionOps with scalaz.syntax.std.ToOptionIdOps } // // Type class implementation traits // trait OptionEqual[A] extends Equal[Option[A]] { implicit def A: Equal[A] override def equalIsNatural: Boolean = A.equalIsNatural override def equal(o1: Option[A], o2: Option[A]): Boolean = (o1, o2) match { case (Some(a1), Some(a2)) => A.equal(a1, a2) case (None, None) => true case (None, Some(_)) => false case (Some(_), None) => false } } trait OptionOrder[A] extends Order[Option[A]] with OptionEqual[A] { implicit def A: Order[A] import Ordering._ def order(f1: Option[A], f2: Option[A]) = (f1, f2) match { case (Some(a1), Some(a2)) => Order[A].order(a1, a2) case (None, Some(_)) => LT case (Some(_), None) => GT case (None, None) => EQ } }