    -- | Data types for Osc messages, bundles and packets.
    module Sound.Osc.Packet where

    import Sound.Osc.Datum {- hosc -}

    -- * Message

    -- | Osc address pattern.  This is strictly an Ascii value, however it
    --   is very common to pattern match on addresses and matching on
    --   Data.ByteString.Char8 requires @OverloadedStrings@.
    type Address_Pattern = String

    -- | An Osc message, an 'Address_Pattern' and a sequence of 'Datum'.
    data Message =
      Message
      {Message -> Address_Pattern
    messageAddress :: !Address_Pattern
      ,Message -> [Datum]
    messageDatum :: ![Datum]}
      deriving (Eq Message
    Eq Message
    -> (Message -> Message -> Ordering)
    -> (Message -> Message -> Bool)
    -> (Message -> Message -> Bool)
    -> (Message -> Message -> Bool)
    -> (Message -> Message -> Bool)
    -> (Message -> Message -> Message)
    -> (Message -> Message -> Message)
    -> Ord Message
    Message -> Message -> Bool
    Message -> Message -> Ordering
    Message -> Message -> Message
    forall a.
    Eq a
    -> (a -> a -> Ordering)
    -> (a -> a -> Bool)
    -> (a -> a -> Bool)
    -> (a -> a -> Bool)
    -> (a -> a -> Bool)
    -> (a -> a -> a)
    -> (a -> a -> a)
    -> Ord a
    $ccompare :: Message -> Message -> Ordering
    compare :: Message -> Message -> Ordering
    $c< :: Message -> Message -> Bool
    < :: Message -> Message -> Bool
    $c<= :: Message -> Message -> Bool
    <= :: Message -> Message -> Bool
    $c> :: Message -> Message -> Bool
    > :: Message -> Message -> Bool
    $c>= :: Message -> Message -> Bool
    >= :: Message -> Message -> Bool
    $cmax :: Message -> Message -> Message
    max :: Message -> Message -> Message
    $cmin :: Message -> Message -> Message
    min :: Message -> Message -> Message
    Ord, Message -> Message -> Bool
    (Message -> Message -> Bool)
    -> (Message -> Message -> Bool) -> Eq Message
    forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
    $c== :: Message -> Message -> Bool
    == :: Message -> Message -> Bool
    $c/= :: Message -> Message -> Bool
    /= :: Message -> Message -> Bool
    Eq, ReadPrec [Message]
    ReadPrec Message
    Int -> ReadS Message
    ReadS [Message]
    (Int -> ReadS Message)
    -> ReadS [Message]
    -> ReadPrec Message
    -> ReadPrec [Message]
    -> Read Message
    forall a.
    (Int -> ReadS a)
    -> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
    $creadsPrec :: Int -> ReadS Message
    readsPrec :: Int -> ReadS Message
    $creadList :: ReadS [Message]
    readList :: ReadS [Message]
    $creadPrec :: ReadPrec Message
    readPrec :: ReadPrec Message
    $creadListPrec :: ReadPrec [Message]
    readListPrec :: ReadPrec [Message]
    Read, Int -> Message -> ShowS
    [Message] -> ShowS
    Message -> Address_Pattern
    (Int -> Message -> ShowS)
    -> (Message -> Address_Pattern)
    -> ([Message] -> ShowS)
    -> Show Message
    forall a.
    (Int -> a -> ShowS)
    -> (a -> Address_Pattern) -> ([a] -> ShowS) -> Show a
    $cshowsPrec :: Int -> Message -> ShowS
    showsPrec :: Int -> Message -> ShowS
    $cshow :: Message -> Address_Pattern
    show :: Message -> Address_Pattern
    $cshowList :: [Message] -> ShowS
    showList :: [Message] -> ShowS
    Show)

    -- | 'Message' constructor.  It is an 'error' if the 'Address_Pattern'
    -- doesn't conform to the Osc specification.
    message :: Address_Pattern -> [Datum] -> Message
    message :: Address_Pattern -> [Datum] -> Message
    message Address_Pattern
    a [Datum]
    xs =
        case Address_Pattern
    a of
          Char
    '/':Address_Pattern
    _ -> Address_Pattern -> [Datum] -> Message
    Message Address_Pattern
    a [Datum]
    xs
          Address_Pattern
    _ -> Address_Pattern -> Message
    forall a. HasCallStack => Address_Pattern -> a
    error Address_Pattern
    "message: ill-formed address pattern"

    messageSignature :: Message -> String
    messageSignature :: Message -> Address_Pattern
    messageSignature = [Datum] -> Address_Pattern
    signatureFor ([Datum] -> Address_Pattern)
    -> (Message -> [Datum]) -> Message -> Address_Pattern
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . Message -> [Datum]
    messageDatum

    messageDescriptor :: Message -> Ascii
    messageDescriptor :: Message -> Ascii
    messageDescriptor = [Datum] -> Ascii
    descriptor ([Datum] -> Ascii) -> (Message -> [Datum]) -> Message -> Ascii
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . Message -> [Datum]
    messageDatum

    -- * Bundle

    {- | An Osc bundle, a 'Time' and a sequence of 'Message's.
    Do not allow recursion, all contents must be messages.
    -}
    data Bundle =
      Bundle
      {Bundle -> Time
    bundleTime :: !Time
      ,Bundle -> [Message]
    bundleMessages :: ![Message]}
      deriving (Bundle -> Bundle -> Bool
    (Bundle -> Bundle -> Bool)
    -> (Bundle -> Bundle -> Bool) -> Eq Bundle
    forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
    $c== :: Bundle -> Bundle -> Bool
    == :: Bundle -> Bundle -> Bool
    $c/= :: Bundle -> Bundle -> Bool
    /= :: Bundle -> Bundle -> Bool
    Eq,ReadPrec [Bundle]
    ReadPrec Bundle
    Int -> ReadS Bundle
    ReadS [Bundle]
    (Int -> ReadS Bundle)
    -> ReadS [Bundle]
    -> ReadPrec Bundle
    -> ReadPrec [Bundle]
    -> Read Bundle
    forall a.
    (Int -> ReadS a)
    -> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
    $creadsPrec :: Int -> ReadS Bundle
    readsPrec :: Int -> ReadS Bundle
    $creadList :: ReadS [Bundle]
    readList :: ReadS [Bundle]
    $creadPrec :: ReadPrec Bundle
    readPrec :: ReadPrec Bundle
    $creadListPrec :: ReadPrec [Bundle]
    readListPrec :: ReadPrec [Bundle]
    Read,Int -> Bundle -> ShowS
    [Bundle] -> ShowS
    Bundle -> Address_Pattern
    (Int -> Bundle -> ShowS)
    -> (Bundle -> Address_Pattern)
    -> ([Bundle] -> ShowS)
    -> Show Bundle
    forall a.
    (Int -> a -> ShowS)
    -> (a -> Address_Pattern) -> ([a] -> ShowS) -> Show a
    $cshowsPrec :: Int -> Bundle -> ShowS
    showsPrec :: Int -> Bundle -> ShowS
    $cshow :: Bundle -> Address_Pattern
    show :: Bundle -> Address_Pattern
    $cshowList :: [Bundle] -> ShowS
    showList :: [Bundle] -> ShowS
    Show)

    -- | Osc 'Bundle's can be ordered (time ascending).
    instance Ord Bundle where
        compare :: Bundle -> Bundle -> Ordering
    compare (Bundle Time
    a [Message]
    _) (Bundle Time
    b [Message]
    _) = Time -> Time -> Ordering
    forall a. Ord a => a -> a -> Ordering
    compare Time
    a Time
    b

    -- | 'Bundle' constructor. It is an 'error' if the 'Message' list is empty.
    bundle :: Time -> [Message] -> Bundle
    bundle :: Time -> [Message] -> Bundle
    bundle Time
    t [Message]
    xs =
        case [Message]
    xs of
          [] -> Address_Pattern -> Bundle
    forall a. HasCallStack => Address_Pattern -> a
    error Address_Pattern
    "bundle: empty?"
          [Message]
    _ -> Time -> [Message] -> Bundle
    Bundle Time
    t [Message]
    xs

    -- * Packet

    -- | An Osc 'Packet' is either a 'Message' or a 'Bundle'.
    data Packet =
      Packet_Message {Packet -> Message
    packetMessage :: !Message} |
      Packet_Bundle {Packet -> Bundle
    packetBundle :: !Bundle}
      deriving (Packet -> Packet -> Bool
    (Packet -> Packet -> Bool)
    -> (Packet -> Packet -> Bool) -> Eq Packet
    forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
    $c== :: Packet -> Packet -> Bool
    == :: Packet -> Packet -> Bool
    $c/= :: Packet -> Packet -> Bool
    /= :: Packet -> Packet -> Bool
    Eq,ReadPrec [Packet]
    ReadPrec Packet
    Int -> ReadS Packet
    ReadS [Packet]
    (Int -> ReadS Packet)
    -> ReadS [Packet]
    -> ReadPrec Packet
    -> ReadPrec [Packet]
    -> Read Packet
    forall a.
    (Int -> ReadS a)
    -> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
    $creadsPrec :: Int -> ReadS Packet
    readsPrec :: Int -> ReadS Packet
    $creadList :: ReadS [Packet]
    readList :: ReadS [Packet]
    $creadPrec :: ReadPrec Packet
    readPrec :: ReadPrec Packet
    $creadListPrec :: ReadPrec [Packet]
    readListPrec :: ReadPrec [Packet]
    Read,Int -> Packet -> ShowS
    [Packet] -> ShowS
    Packet -> Address_Pattern
    (Int -> Packet -> ShowS)
    -> (Packet -> Address_Pattern)
    -> ([Packet] -> ShowS)
    -> Show Packet
    forall a.
    (Int -> a -> ShowS)
    -> (a -> Address_Pattern) -> ([a] -> ShowS) -> Show a
    $cshowsPrec :: Int -> Packet -> ShowS
    showsPrec :: Int -> Packet -> ShowS
    $cshow :: Packet -> Address_Pattern
    show :: Packet -> Address_Pattern
    $cshowList :: [Packet] -> ShowS
    showList :: [Packet] -> ShowS
    Show)

    -- | 'Packet_Bundle' of 'bundle'.
    p_bundle :: Time -> [Message] -> Packet
    p_bundle :: Time -> [Message] -> Packet
    p_bundle Time
    t = Bundle -> Packet
    Packet_Bundle (Bundle -> Packet) -> ([Message] -> Bundle) -> [Message] -> Packet
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . Time -> [Message] -> Bundle
    bundle Time
    t

    -- | 'Packet_Message' of 'message'.
    p_message :: Address_Pattern -> [Datum] -> Packet
    p_message :: Address_Pattern -> [Datum] -> Packet
    p_message Address_Pattern
    a = Message -> Packet
    Packet_Message (Message -> Packet) -> ([Datum] -> Message) -> [Datum] -> Packet
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . Address_Pattern -> [Datum] -> Message
    message Address_Pattern
    a

    {- | Constant indicating a bundle to be executed immediately.  It has the Ntp64 representation of @1@.

    > ntpr_to_ntpi immediately == 1
    -}
    immediately :: Time
    immediately :: Time
    immediately = Time
    1 Time -> Time -> Time
    forall a. Fractional a => a -> a -> a
    / Time
    2Time -> Int -> Time
    forall a b. (Num a, Integral b) => a -> b -> a
    ^(Int
    32::Int)

    -- | The 'Time' of 'Packet', if the 'Packet' is a 'Message' this is 'immediately'.
    packetTime :: Packet -> Time
    packetTime :: Packet -> Time
    packetTime = (Message -> Time) -> (Bundle -> Time) -> Packet -> Time
    forall a. (Message -> a) -> (Bundle -> a) -> Packet -> a
    at_packet (Time -> Message -> Time
    forall a b. a -> b -> a
    const Time
    immediately) Bundle -> Time
    bundleTime

    -- | Retrieve the set of 'Message's from a 'Packet'.
    packetMessages :: Packet -> [Message]
    packetMessages :: Packet -> [Message]
    packetMessages = (Message -> [Message])
    -> (Bundle -> [Message]) -> Packet -> [Message]
    forall a. (Message -> a) -> (Bundle -> a) -> Packet -> a
    at_packet Message -> [Message]
    forall a. a -> [a]
    forall (m :: * -> *) a. Monad m => a -> m a
    return Bundle -> [Message]
    bundleMessages

    -- | If 'Packet' is a 'Message' add 'immediately' timestamp, else 'id'.
    packet_to_bundle :: Packet -> Bundle
    packet_to_bundle :: Packet -> Bundle
    packet_to_bundle = (Message -> Bundle) -> (Bundle -> Bundle) -> Packet -> Bundle
    forall a. (Message -> a) -> (Bundle -> a) -> Packet -> a
    at_packet (\Message
    m -> Time -> [Message] -> Bundle
    Bundle Time
    immediately [Message
    m]) Bundle -> Bundle
    forall a. a -> a
    id

    -- | If 'Packet' is a 'Message' or a 'Bundle' with an /immediate/ time
    -- tag and with one element, return the 'Message', else 'Nothing'.
    packet_to_message :: Packet -> Maybe Message
    packet_to_message :: Packet -> Maybe Message
    packet_to_message Packet
    p =
        case Packet
    p of
          Packet_Bundle Bundle
    b ->
              case Bundle
    b of
                Bundle Time
    t [Message
    m] -> if Time
    t Time -> Time -> Bool
    forall a. Eq a => a -> a -> Bool
    == Time
    immediately then Message -> Maybe Message
    forall a. a -> Maybe a
    Just Message
    m else Maybe Message
    forall a. Maybe a
    Nothing
                Bundle
    _ -> Maybe Message
    forall a. Maybe a
    Nothing
          Packet_Message Message
    m -> Message -> Maybe Message
    forall a. a -> Maybe a
    Just Message
    m

    -- | Is 'Packet' immediate, ie. a 'Bundle' with timestamp 'immediately', or a plain Message.
    packet_is_immediate :: Packet -> Bool
    packet_is_immediate :: Packet -> Bool
    packet_is_immediate = (Time -> Time -> Bool
    forall a. Eq a => a -> a -> Bool
    == Time
    immediately) (Time -> Bool) -> (Packet -> Time) -> Packet -> Bool
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . Packet -> Time
    packetTime

    -- | Variant of 'either' for 'Packet'.
    at_packet :: (Message -> a) -> (Bundle -> a) -> Packet -> a
    at_packet :: forall a. (Message -> a) -> (Bundle -> a) -> Packet -> a
    at_packet Message -> a
    f Bundle -> a
    g Packet
    p =
        case Packet
    p of
          Packet_Message Message
    m -> Message -> a
    f Message
    m
          Packet_Bundle Bundle
    b -> Bundle -> a
    g Bundle
    b

    -- * Address Query

    -- | Does 'Message' have the specified 'Address_Pattern'.
    message_has_address :: Address_Pattern -> Message -> Bool
    message_has_address :: Address_Pattern -> Message -> Bool
    message_has_address Address_Pattern
    x = (Address_Pattern -> Address_Pattern -> Bool
    forall a. Eq a => a -> a -> Bool
    == Address_Pattern
    x) (Address_Pattern -> Bool)
    -> (Message -> Address_Pattern) -> Message -> Bool
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . Message -> Address_Pattern
    messageAddress

    -- | Do any of the 'Message's at 'Bundle' have the specified
    -- 'Address_Pattern'.
    bundle_has_address :: Address_Pattern -> Bundle -> Bool
    bundle_has_address :: Address_Pattern -> Bundle -> Bool
    bundle_has_address Address_Pattern
    x = (Message -> Bool) -> [Message] -> Bool
    forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
    any (Address_Pattern -> Message -> Bool
    message_has_address Address_Pattern
    x) ([Message] -> Bool) -> (Bundle -> [Message]) -> Bundle -> Bool
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . Bundle -> [Message]
    bundleMessages

    -- | Does 'Packet' have the specified 'Address_Pattern', ie.
    -- 'message_has_address' or 'bundle_has_address'.
    packet_has_address :: Address_Pattern -> Packet -> Bool
    packet_has_address :: Address_Pattern -> Packet -> Bool
    packet_has_address Address_Pattern
    x =
        (Message -> Bool) -> (Bundle -> Bool) -> Packet -> Bool
    forall a. (Message -> a) -> (Bundle -> a) -> Packet -> a
    at_packet (Address_Pattern -> Message -> Bool
    message_has_address Address_Pattern
    x)
                  (Address_Pattern -> Bundle -> Bool
    bundle_has_address Address_Pattern
    x)