aboutsummaryrefslogtreecommitdiffstats
path: root/src/Verismith/Internal.hs
diff options
context:
space:
mode:
Diffstat (limited to 'src/Verismith/Internal.hs')
-rw-r--r--src/Verismith/Internal.hs49
1 files changed, 49 insertions, 0 deletions
diff --git a/src/Verismith/Internal.hs b/src/Verismith/Internal.hs
new file mode 100644
index 0000000..b47c924
--- /dev/null
+++ b/src/Verismith/Internal.hs
@@ -0,0 +1,49 @@
+{-|
+Module : Verismith.Internal
+Description : Shared high level code used in the other modules internally.
+Copyright : (c) 2018-2019, Yann Herklotz
+License : BSD-3
+Maintainer : yann [at] yannherklotz [dot] com
+Stability : experimental
+Portability : POSIX
+
+Shared high level code used in the other modules internally.
+-}
+
+module Verismith.Internal
+ ( -- * Useful functions
+ safe
+ , showT
+ , showBS
+ , comma
+ , commaNL
+ )
+where
+
+import Data.ByteString (ByteString)
+import Data.ByteString.Builder (byteStringHex, toLazyByteString)
+import qualified Data.ByteString.Lazy as L
+import Data.Text (Text)
+import qualified Data.Text as T
+import Data.Text.Encoding (decodeUtf8)
+
+-- | Function to show a bytestring in a hex format.
+showBS :: ByteString -> Text
+showBS = decodeUtf8 . L.toStrict . toLazyByteString . byteStringHex
+
+-- | Converts unsafe list functions in the Prelude to a safe version.
+safe :: ([a] -> b) -> [a] -> Maybe b
+safe _ [] = Nothing
+safe f l = Just $ f l
+
+-- | Show function for 'Text'
+showT :: (Show a) => a -> Text
+showT = T.pack . show
+
+-- | Inserts commas between '[Text]' and except the last one.
+comma :: [Text] -> Text
+comma = T.intercalate ", "
+
+-- | Inserts commas and newlines between '[Text]' and except the last one.
+commaNL :: [Text] -> Text
+commaNL = T.intercalate ",\n"