module PlutusTx.Bool (Bool (..), (&&), (||), not, otherwise) where

{-
We export off-chain Haskell's Bool type as on-chain Plutus's Bool type since they are the same.
-}

import Prelude (Bool (..), otherwise)

{- HLINT ignore -}

-- `(&&)` and `(||)` are handled specially in the plugin to make sure they can short-circuit.
-- See Note [Lazy boolean operators] in the plugin.

{-| Logical AND. Short-circuits if the first argument evaluates to `False`.

  >>> True && False
  False
-}
infixr 3 &&

(&&) :: Bool -> Bool -> Bool
&& :: Bool -> Bool -> Bool
(&&) Bool
l Bool
r = if Bool
l then Bool
r else Bool
False
{-# OPAQUE (&&) #-}

{-| Logical OR. Short-circuits if the first argument evaluates to `True`.

  >>> True || False
  True
-}
infixr 2 ||

(||) :: Bool -> Bool -> Bool
|| :: Bool -> Bool -> Bool
(||) Bool
l Bool
r = if Bool
l then Bool
True else Bool
r
{-# OPAQUE (||) #-}

{-| Logical negation

  >>> not True
  False
-}
not :: Bool -> Bool
not :: Bool -> Bool
not Bool
a = if Bool
a then Bool
False else Bool
True
{-# INLINEABLE not #-}