doc: additional docs and tests

Author: tittoassini

src/Flat/Decoder/Strict.hs

@@ -247,10 +247,10 @@ dUTF16 :: Get T.Text
 dUTF16 = do
  _ <- dFiller
 #if MIN_VERSION_text(2,0,0)
- -- Checked decoding
+ -- Checked decoding (from UTF-8)
  T.decodeUtf16LE <$> dByteString_
 #else
- -- Unchecked decoding
+ -- Unchecked decoding (already UTF16)
  (ByteArray array, lengthInBytes) <- dByteArray_
  return (T.Text (TA.Array array) 0 (lengthInBytes `div` 2))
 #endif

src/Flat/Instances/Test.hs

@@ -13,7 +13,7 @@ module Flat.Instances.Test (
 import Control.Monad ((>=>))
 import Data.Word
 import Flat.Bits (Bits, asBytes, bits,
- paddedBits, takeBits)
+ paddedBits, takeBits,toBools)
 import Flat.Class (Flat (..))
 import Flat.Encoder.Prim (eFillerF)
 import Flat.Encoder.Strict (Encoding (Encoding),
@@ -24,7 +24,7 @@ import Text.PrettyPrint.HughesPJClass (prettyShow)
 
 -- | Returns: result of flat/unflat test, encoding size in bits, byte encoding
 tst :: (Eq a, Flat a) => a -> (Bool, NumBits, [Word8])
-tst v = (unflat (flat v) == Right v, size v 0, showBytes v)
+tst v = (unflat (flat v) == Right v && size v 0 >= length (toBools (bits v)), size v 0, showBytes v)
 
 -- | Returns: result of flat/unflat test, encoding size in bits, bits encoding
 tstBits :: (Eq a, Flat a) => a -> (Bool, NumBits, String)

src/Flat/Instances/Text.hs

@@ -18,25 +18,26 @@ import Flat.Instances.Util
 -- >>> import qualified Data.Text as T
 -- >>> import qualified Data.Text.Lazy as TL
 -- >>> import Data.Word
+-- >>> tt t = let (ts,_,bs) = tst t in (ts,bs) 
 
-{-|
+{- |
 Text (and Data.Text.Lazy) is encoded as a byte aligned array of bytes corresponding to its UTF8 encoding.
 
->>> tst $ T.pack ""
-(True,16,[1,0])
+>>> tt $ T.pack ""
+(True,[1,0])
 
->>> tst $ T.pack "aaa"
-(True,120,[1,3,97,97,97,0])
+>>> tt $ T.pack "aaa"
+(True,[1,3,97,97,97,0])
 
->>> tst $ T.pack "¢¢¢"
-(True,120,[1,6,194,162,194,162,194,162,0])
+>>> tt $ T.pack "¢¢¢"
+(True,[1,6,194,162,194,162,194,162,0])
 
->>> tst $ T.pack "日日日"
-(True,120,[1,9,230,151,165,230,151,165,230,151,165,0])
+>>> tt $ T.pack "日日日"
+(True,[1,9,230,151,165,230,151,165,230,151,165,0])
 
 #ifndef ETA
->>> tst $ T.pack "𐍈𐍈𐍈"
-(True,120,[1,12,240,144,141,136,240,144,141,136,240,144,141,136,0])
+>>> tt $ T.pack "𐍈𐍈𐍈"
+(True,[1,12,240,144,141,136,240,144,141,136,240,144,141,136,0])
 #endif
 
 Strict and Lazy Text have the same encoding:
@@ -62,7 +63,7 @@ The default encoding is UTF8:
 >>> tst (UTF8Text $ T.pack "日日日") == tst (T.pack "日日日")
 True
 -}
--- |A wrapper to encode/decode Text as UTF8 (slower but more compact)
+-- |A wrapper to encode/decode Text as UTF8
 newtype UTF8Text = UTF8Text {unUTF8::T.Text} deriving (Eq,Ord,Show)
 
 instance Flat UTF8Text where
@@ -72,11 +73,11 @@ instance Flat UTF8Text where
 
 #if ! defined (ETA_VERSION) && ! defined (ETA)
 {-|
->>> tst (UTF16Text $ T.pack "aaa")
-(True,72,[1,6,97,0,97,0,97,0,0])
+>>> tt (UTF16Text $ T.pack "aaa")
+(True,[1,6,97,0,97,0,97,0,0])
 
->>> tst (UTF16Text $ T.pack "𐍈𐍈𐍈")
-(True,120,[1,12,0,216,72,223,0,216,72,223,0,216,72,223,0])
+>>> tt (UTF16Text $ T.pack "𐍈𐍈𐍈")
+(True,[1,12,0,216,72,223,0,216,72,223,0,216,72,223,0])
 -}
 
 -- |A wrapper to encode/decode Text as UTF16