-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Encoding scheme to encode any Unicode string with only [0-9a-zA-Z_]
--   
--   Double-X-Encoding is an encoding scheme to encode any Unicode string
--   with only characters from [0-9a-zA-Z_]. Therefore it's quite similar
--   to URL percent-encoding. It's especially useful for GraphQL ID
--   generation, as it includes support for encoding leading digits and
--   double underscores.
@package double-x-encoding
@version 1.2.0


-- | Implementation of Double-X-Encoding encoder and decoder in Haskell
--   
--   Main functions:
--   
--   <ul>
--   <li><a>doubleXEncode</a></li>
--   <li><a>doubleXEncodeGql</a></li>
--   <li><a>doubleXDecode</a></li>
--   </ul>
module DoubleXEncoding

-- | Encoder mapping for ASCII characters.
charEncode :: Char -> Char

-- | Decoder mapping for ASCII characters.
charDecode :: Char -> Char

-- | Map hex characters to an alternative hex alphabet ranging from a to p
--   instead of 0 to f.
hexShiftEncode :: Char -> Char

-- | Map alternative hex alphabet back to the original hex alphabet.
hexShiftDecode :: Char -> Char

-- | Options for encoding:
--   
--   <ul>
--   <li><i><a>encodeLeadingDigit</a></i> Encode the leading digit of the
--   input string</li>
--   <li><i><a>encodeDoubleUnderscore</a></i> Encode double underscores
--   <tt>__</tt> as <tt>XXRXXR</tt></li>
--   </ul>
--   
--   Especially relevant for GraphQL, as <a>the spec</a> does not allow
--   leading digits or double underscores for field names.
data EncodeOptions
EncodeOptions :: Bool -> Bool -> EncodeOptions
[encodeLeadingDigit] :: EncodeOptions -> Bool
[encodeDoubleUnderscore] :: EncodeOptions -> Bool

-- | Encode a text using the Double-X-Encoding algorithm with provided
--   options.
doubleXEncodeWithOptions :: EncodeOptions -> Text -> Text

-- | Default options with no leading digit encoding and no double
--   underscore encoding.
defaultOptions :: EncodeOptions

-- | Encode a text using the Double-X-Encoding algorithm.
--   
--   <pre>
--   &gt;&gt;&gt; doubleXEncode "id-with.special$chars!"
--   "idXXDwithXXEspecialXX4charsXX1"
--   </pre>
doubleXEncode :: Text -> Text

-- | Default options for GraphQL encoding. Leading digits or double
--   underscores are not allowed for field names.
gqlOptions :: EncodeOptions

-- | Encode a text using the Double-X-Encoding algorithm with GraphQL
--   options.
--   
--   <pre>
--   &gt;&gt;&gt; doubleXEncodeGql "1FileFormat__"
--   "XXZ1FileFormatXXRXXR"
--   </pre>
doubleXEncodeGql :: Text -> Text

-- | Decode a Double-X-Encoding encoded text.
--   
--   <pre>
--   &gt;&gt;&gt; doubleXDecode "idXXDwithXXEspecialXX4charsXX1"
--   "id-with.special$chars!"
--   </pre>
doubleXDecode :: Text -> Text