aboutsummaryrefslogtreecommitdiffhomepage
path: root/Pipes/Text/Internal
diff options
context:
space:
mode:
authormichaelt <what_is_it_to_do_anything@yahoo.com>2014-02-05 05:00:39 -0500
committermichaelt <what_is_it_to_do_anything@yahoo.com>2014-02-05 05:00:39 -0500
commitb23136b1aed02febbe0fa539c2b74edbecd9e1e0 (patch)
tree5e6a370c9ce5664a03823fdf34e32453030dbb32 /Pipes/Text/Internal
parent02bc50d59d3312f8848f6aa3a2535828516eb135 (diff)
downloadtext-pipes-b23136b1aed02febbe0fa539c2b74edbecd9e1e0.tar.gz
text-pipes-b23136b1aed02febbe0fa539c2b74edbecd9e1e0.tar.zst
text-pipes-b23136b1aed02febbe0fa539c2b74edbecd9e1e0.zip
rearranged internal modules to placate haddock
Diffstat (limited to 'Pipes/Text/Internal')
-rw-r--r--Pipes/Text/Internal/Codec.hs16
-rw-r--r--Pipes/Text/Internal/Decoding.hs23
2 files changed, 20 insertions, 19 deletions
diff --git a/Pipes/Text/Internal/Codec.hs b/Pipes/Text/Internal/Codec.hs
index 63cbd74..075a152 100644
--- a/Pipes/Text/Internal/Codec.hs
+++ b/Pipes/Text/Internal/Codec.hs
@@ -4,17 +4,15 @@
4-- Copyright: 2014 Michael Thompson, 2011 Michael Snoyman, 2010-2011 John Millikin 4-- Copyright: 2014 Michael Thompson, 2011 Michael Snoyman, 2010-2011 John Millikin
5-- License: MIT 5-- License: MIT
6-- This Parts of this code were taken from enumerator and conduits, and adapted for pipes 6-- This Parts of this code were taken from enumerator and conduits, and adapted for pipes
7{- | This module follows the model of the enumerator and conduits libraries, and defines 7
8 'Codec' s for various encodings. Note that we do not export a 'Codec' for ascii and 8-- This module follows the model of the enumerator and conduits libraries, and defines
9 iso8859_1. A 'Lens' in the sense of the pipes library cannot be defined for these, so 9-- 'Codec' s for various encodings. Note that we do not export a 'Codec' for ascii and
10 special functions appear in @Pipes.Text@ 10-- iso8859_1. A 'Lens' in the sense of the pipes library cannot be defined for these, so
11-} 11-- special functions appear in @Pipes.Text@
12
12 13
13module Pipes.Text.Internal.Codec 14module Pipes.Text.Internal.Codec
14 ( Decoding(..) 15 ( Codec(..)
15 , streamDecodeUtf8
16 , decodeSomeUtf8
17 , Codec(..)
18 , TextException(..) 16 , TextException(..)
19 , utf8 17 , utf8
20 , utf16_le 18 , utf16_le
diff --git a/Pipes/Text/Internal/Decoding.hs b/Pipes/Text/Internal/Decoding.hs
index 4b4bbe6..b5d928a 100644
--- a/Pipes/Text/Internal/Decoding.hs
+++ b/Pipes/Text/Internal/Decoding.hs
@@ -2,11 +2,10 @@
2{-# LANGUAGE GeneralizedNewtypeDeriving, MagicHash, UnliftedFFITypes #-} 2{-# LANGUAGE GeneralizedNewtypeDeriving, MagicHash, UnliftedFFITypes #-}
3{-# LANGUAGE DeriveDataTypeable, RankNTypes #-} 3{-# LANGUAGE DeriveDataTypeable, RankNTypes #-}
4 4
5{- | 5-- This module lifts assorted materials from Brian O'Sullivan's text package
6This module lifts assorted materials from Brian O'Sullivan's text package 6-- especially @Data.Text.Encoding@ in order to define a pipes-appropriate
7especially @Data.Text.Encoding@ in order to define a pipes-appropriate 7-- 'streamDecodeUtf8'
8'streamDecodeUtf8' 8
9-}
10module Pipes.Text.Internal.Decoding 9module Pipes.Text.Internal.Decoding
11 ( Decoding(..) 10 ( Decoding(..)
12 , streamDecodeUtf8 11 , streamDecodeUtf8
@@ -43,9 +42,13 @@ import Data.Maybe (catMaybes)
43 42
44 43
45 44
46-- | A stream oriented decoding result. Distinct from the similar type in @Data.Text.Encoding@ 45-- A stream oriented decoding result. Distinct from the similar type in Data.Text.Encoding
47data Decoding = Some Text ByteString (ByteString -> Decoding) -- | Text, continuation and any undecoded fragment. 46
48 | Other Text ByteString -- | Text followed by an undecodable ByteString 47data Decoding = Some Text ByteString (ByteString -> Decoding)
48 -- Text, continuation and any undecoded fragment.
49 | Other Text ByteString
50 -- Text followed by an undecodable ByteString
51
49instance Show Decoding where 52instance Show Decoding where
50 showsPrec d (Some t bs _) = showParen (d > prec) $ 53 showsPrec d (Some t bs _) = showParen (d > prec) $
51 showString "Some " . showsPrec prec' t . 54 showString "Some " . showsPrec prec' t .
@@ -61,7 +64,7 @@ instance Show Decoding where
61newtype CodePoint = CodePoint Word32 deriving (Eq, Show, Num, Storable) 64newtype CodePoint = CodePoint Word32 deriving (Eq, Show, Num, Storable)
62newtype DecoderState = DecoderState Word32 deriving (Eq, Show, Num, Storable) 65newtype DecoderState = DecoderState Word32 deriving (Eq, Show, Num, Storable)
63 66
64-- | Resolve a 'ByteString' into 'Text' and a continuation that can handle further 'ByteStrings'. 67-- Resolve a 'ByteString' into 'Text' and a continuation that can handle further 'ByteStrings'.
65streamDecodeUtf8 :: ByteString -> Decoding 68streamDecodeUtf8 :: ByteString -> Decoding
66streamDecodeUtf8 = decodeChunkUtf8 B.empty 0 0 69streamDecodeUtf8 = decodeChunkUtf8 B.empty 0 0
67 where 70 where
@@ -95,7 +98,7 @@ streamDecodeUtf8 = decodeChunkUtf8 B.empty 0 0
95 {-# INLINE decodeChunkUtf8 #-} 98 {-# INLINE decodeChunkUtf8 #-}
96{-# INLINE streamDecodeUtf8 #-} 99{-# INLINE streamDecodeUtf8 #-}
97 100
98-- | Resolve a ByteString into an initial segment of intelligible 'Text' and whatever is unintelligble 101-- Resolve a ByteString into an initial segment of intelligible 'Text' and whatever is unintelligble
99decodeSomeUtf8 :: ByteString -> (Text, ByteString) 102decodeSomeUtf8 :: ByteString -> (Text, ByteString)
100decodeSomeUtf8 bs@(PS fp off len) = runST $ do 103decodeSomeUtf8 bs@(PS fp off len) = runST $ do
101 dest <- A.new (len+1) 104 dest <- A.new (len+1)