-- |
-- Module    : Codec.Binary.DataEncoding
-- Copyright : (c) 2007 Magnus Therning
-- License   : BSD3
--
-- This module exposes several instances of 'DataCodec', one for each data
-- encoding implemented in the library without causing the name clashing that
-- would result from importing the individual encoding modules.
--
-- Further documentation and information can be found at
-- <http://www.haskell.org/haskellwiki/Library/Data_encoding>.
module Codec.Binary.DataEncoding
    ( DataCodec
    , base16
    , base32
    , base32Hex
    , base64
    , base64Url
    , base85
    , chop
    , decode
    , encode
    , py
    , qp
    , unchop
    , url
    , uu
    , xx
    )
    where

import Data.Word

import qualified Codec.Binary.Base16 as Base16
import qualified Codec.Binary.Base32 as Base32
import qualified Codec.Binary.Base32Hex as Base32Hex
import qualified Codec.Binary.Base64 as Base64
import qualified Codec.Binary.Base64Url as Base64Url
import qualified Codec.Binary.Base85 as Base85
import qualified Codec.Binary.Url as Url
import qualified Codec.Binary.Uu as Uu
import qualified Codec.Binary.Xx as Xx
import qualified Codec.Binary.QuotedPrintable as QP
import qualified Codec.Binary.PythonString as Py

-- {{{1 DataCodec
-- | Used to group a specific data encoding's functions.
data DataCodec = DataCodec {
    DataCodec -> [Word8] -> String
encode :: [Word8] -> String,
    DataCodec -> String -> Maybe [Word8]
decode :: String -> Maybe [Word8],
    DataCodec -> Int -> String -> [String]
chop :: Int -> String -> [String],
    DataCodec -> [String] -> String
unchop :: [String] -> String
}

-- {{{1 base16
-- | Base16 encoding, see "Codec.Binary.Base16" for more details on
--   the individual functions.
base16 :: DataCodec
base16 :: DataCodec
base16 = DataCodec {
    encode :: [Word8] -> String
encode=[Word8] -> String
Base16.encode,
    decode :: String -> Maybe [Word8]
decode=String -> Maybe [Word8]
Base16.decode,
    chop :: Int -> String -> [String]
chop=Int -> String -> [String]
Base16.chop,
    unchop :: [String] -> String
unchop=[String] -> String
Base16.unchop
}

-- {{{1 base32
-- | Base32 encoding, see "Codec.Binary.Base32" for more details on
--   the individual functions.
base32 :: DataCodec
base32 :: DataCodec
base32 = DataCodec {
    encode :: [Word8] -> String
encode=[Word8] -> String
Base32.encode,
    decode :: String -> Maybe [Word8]
decode=String -> Maybe [Word8]
Base32.decode,
    chop :: Int -> String -> [String]
chop=Int -> String -> [String]
Base32.chop,
    unchop :: [String] -> String
unchop=[String] -> String
Base32.unchop
}

-- {{{1 base32Hex
-- | Base32Hex encoding, see "Codec.Binary.Base32Hex" for more details
--   on the individual functions.
base32Hex :: DataCodec
base32Hex :: DataCodec
base32Hex = DataCodec {
    encode :: [Word8] -> String
encode=[Word8] -> String
Base32Hex.encode,
    decode :: String -> Maybe [Word8]
decode=String -> Maybe [Word8]
Base32Hex.decode,
    chop :: Int -> String -> [String]
chop=Int -> String -> [String]
Base32Hex.chop,
    unchop :: [String] -> String
unchop=[String] -> String
Base32Hex.unchop
}

-- {{{1 base64
-- | Base64 encoding, see "Codec.Binary.Base64" for more details on
--   the individual functions.
base64 :: DataCodec
base64 :: DataCodec
base64 = DataCodec {
    encode :: [Word8] -> String
encode=[Word8] -> String
Base64.encode,
    decode :: String -> Maybe [Word8]
decode=String -> Maybe [Word8]
Base64.decode,
    chop :: Int -> String -> [String]
chop=Int -> String -> [String]
Base64.chop,
    unchop :: [String] -> String
unchop=[String] -> String
Base64.unchop
}

-- {{{1 base64Url
-- | Base64Url encoding, see "Codec.Binary.Base64Url" for more details
--   on the individual functions.
base64Url :: DataCodec
base64Url :: DataCodec
base64Url = DataCodec {
    encode :: [Word8] -> String
encode=[Word8] -> String
Base64Url.encode,
    decode :: String -> Maybe [Word8]
decode=String -> Maybe [Word8]
Base64Url.decode,
    chop :: Int -> String -> [String]
chop=Int -> String -> [String]
Base64Url.chop,
    unchop :: [String] -> String
unchop=[String] -> String
Base64Url.unchop
}

-- {{{1 base85
-- | Base85 encoding, see "Codec.Binary.Base85" for more details
--   on the individual functions.
base85 :: DataCodec
base85 :: DataCodec
base85 = DataCodec {
    encode :: [Word8] -> String
encode=[Word8] -> String
Base85.encode,
    decode :: String -> Maybe [Word8]
decode=String -> Maybe [Word8]
Base85.decode,
    chop :: Int -> String -> [String]
chop=Int -> String -> [String]
Base85.chop,
    unchop :: [String] -> String
unchop=[String] -> String
Base85.unchop
}

-- {{{1 uu
-- | Uuencoding, see "Codec.Binary.Uu" for more details on the
--   individual functions.
uu :: DataCodec
uu :: DataCodec
uu = DataCodec {
    encode :: [Word8] -> String
encode=[Word8] -> String
Uu.encode,
    decode :: String -> Maybe [Word8]
decode=String -> Maybe [Word8]
Uu.decode,
    chop :: Int -> String -> [String]
chop=Int -> String -> [String]
Uu.chop,
    unchop :: [String] -> String
unchop=[String] -> String
Uu.unchop
}

-- {{{1 xx
-- | Xxencoding, see "Codec.Binary.Xx" for more details on the
--   individual functions.
xx :: DataCodec
xx :: DataCodec
xx = DataCodec {
    encode :: [Word8] -> String
encode=[Word8] -> String
Xx.encode,
    decode :: String -> Maybe [Word8]
decode=String -> Maybe [Word8]
Xx.decode,
    chop :: Int -> String -> [String]
chop=Int -> String -> [String]
Xx.chop,
    unchop :: [String] -> String
unchop=[String] -> String
Xx.unchop
}

-- {{{1 quoted-printable
-- | Quoted-printable, see "Codec.Binary.QuotedPrintable" for more details on
-- the individual functions.
qp :: DataCodec
qp :: DataCodec
qp = DataCodec
    { encode :: [Word8] -> String
encode  = [Word8] -> String
QP.encode
    , decode :: String -> Maybe [Word8]
decode  = String -> Maybe [Word8]
QP.decode
    , chop :: Int -> String -> [String]
chop    = Int -> String -> [String]
QP.chop
    , unchop :: [String] -> String
unchop  = [String] -> String
QP.unchop
    }

-- {{{1 python string
-- | Quoted-printable, see "Codec.Binary.PythonString" for more details on
-- the individual functions.
py :: DataCodec
py :: DataCodec
py = DataCodec
    { encode :: [Word8] -> String
encode  = [Word8] -> String
Py.encode
    , decode :: String -> Maybe [Word8]
decode  = String -> Maybe [Word8]
Py.decode
    , chop :: Int -> String -> [String]
chop    = Int -> String -> [String]
Py.chop
    , unchop :: [String] -> String
unchop  = [String] -> String
Py.unchop
    }

-- {{{1 url encoding
-- | URL encoding, see "Codec.Binary.Url" for more details on the individual
-- functions.
url :: DataCodec
url :: DataCodec
url = DataCodec
    { encode :: [Word8] -> String
encode  = [Word8] -> String
Url.encode
    , decode :: String -> Maybe [Word8]
decode  = String -> Maybe [Word8]
Url.decode
    , chop :: Int -> String -> [String]
chop    = Int -> String -> [String]
Url.chop
    , unchop :: [String] -> String
unchop  = [String] -> String
Url.unchop
    }