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


-- | Pretty printing a simple diff of two values.
--   
--   Please see the README at
--   <a>https://github.com/stoeffel/pretty-diff</a>.
@package pretty-diff
@version 0.1.0.0


-- | Printing nice and simple diffs of two values.
--   
--   <pre>
--   import qualified Pretty.Diff as Diff
--   import Data.Default (def)
--   
--   Diff.pretty def "1234" "_23"
--   </pre>
--   
--   Will create a string that looks like this:
--   
--   <pre>
--    ▼ ▼
--   "1234"
--   ╷
--   │
--   ╵
--   "_23"
--    ▲
--   </pre>
module Pretty.Diff

-- | Configuration for <a>pretty</a>.
data Config
Config :: Maybe Text -> Wrapping -> Config

-- | Text that gets displayed inbetween the diffed values
--   
--   <pre>
--   Diff.pretty def { Diff.separatorText = "differing" } "1234" "_23"
--   </pre>
--   
--   Will create a string that looks like this:
--   
--   <pre>
--    ▼ ▼
--   "1234"
--   ╷
--   │ differing
--   ╵
--   "_23"
--    ▲
--   </pre>
[separatorText] :: Config -> Maybe Text

-- | Wrapping text to multiple lines if they are longer than the provided
--   length. This is useful in combination with <a>terminal-size</a>.
--   
--   <pre>
--   Diff.pretty def { Diff.wrapping = Diff.Wrap 6 } "0900000000" "9000000000"
--   </pre>
--   
--   Will create a string that looks like this:
--   
--   <pre>
--    ▼
--   "09000
--   00000"
--   ╷
--   │
--   ╵
--   "90000
--   00000"
--       ▲
--   </pre>
[wrapping] :: Config -> Wrapping

-- | Define whether or not to wrap the diffing lines.
data Wrapping
Wrap :: Int -> Wrapping
NoWrap :: Wrapping

-- | Printing a full diff of both values separated by some pipes.
pretty :: Show a => Config -> a -> a -> Text

-- | Printing The first value and the diff indicator above.
--   
--   <pre>
--   Diff.actual Diff.NoWrap "1234" "_23"
--   
--   </pre>
--   
--   <pre>
--    ▼ ▼
--   "1234"
--    
--   </pre>
actual :: Show a => Wrapping -> a -> a -> Text

-- | Printing The second value and the diff indicator below.
--   
--   <pre>
--   Diff.expected Diff.NoWrap "1234" "_23"
--   
--   </pre>
--   
--   <pre>
--   "_23"
--    ▲
--    
--   </pre>
expected :: Show a => Wrapping -> a -> a -> Text
instance Data.Default.Class.Default Pretty.Diff.Config