1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
{-#LANGUAGE RankNTypes#-}
module Pipes.Prelude.Text
(
-- * Simple line-based Text IO
-- $lineio
fromHandleLn
, toHandleLn
, stdinLn
, stdoutLn
, stdoutLn'
, readFileLn
, writeFileLn
) where
import qualified System.IO as IO
import Control.Exception (throwIO, try)
import Foreign.C.Error (Errno(Errno), ePIPE)
import qualified GHC.IO.Exception as G
import Data.Text (Text)
import qualified Data.Text as T
import qualified Data.Text.IO as T
import Pipes
import qualified Pipes.Safe.Prelude as Safe
import Pipes.Safe (MonadSafe(..), runSafeT, runSafeP)
import Prelude hiding (readFile, writeFile)
{- $lineio
Line-based operations are marked with a final \-@Ln@, like 'stdinLn', 'readFileLn', etc. They are
drop-in replacements for the line-based operations in @Pipes.Prelude@ and
@Pipes.Safe.Prelude@ - the final \-@Ln@ being added where necessary.
With them, one is producing, piping and consuming semantically significant individual texts,
understood as lines, just as one would produce or pipe 'Int's or 'Char's or anything else.
Thus, the standard materials from @Pipes@ and @Pipes.Prelude@ and
@Data.Text@ are all you need to interact with these lines as you read or write them, and
you can use these operations without using any of the other material in this package.
Thus, to take a trivial case, here we upper-case three lines from standard input and write
them to a file.
>>> import Pipes
>>> import qualified Pipes.Prelude as P
>>> import qualified Pipes.Text.IO as Text
>>> import qualified Data.Text as T
>>> Text.runSafeT $ runEffect $ Text.stdinLn >-> P.take 3 >-> P.map T.toUpper >-> Text.writeFileLn "threelines.txt"
one<Enter>
two<Enter>
three<Enter>
>>> :! cat "threelines.txt"
ONE
TWO
THREE
The point of view is very much that of @Pipes.Prelude@. It would still be the same even if
we did something more sophisticated, like run an ordinary attoparsec 'Text' parser on
each line, as if frequently reasonable.
The line-based operations are, however, subject to a number of caveats.
First, where they read from a handle, they will of course happily
accumulate indefinitely long lines. This is likely to be legitimate for input
typed in by a user, and for locally produced log files and other known material, but
otherwise not. See the post on
<http://www.haskellforall.com/2013/09/perfect-streaming-using-pipes-bytestring.html perfect streaming>
to see why @pipes-bytestring@ and this package take a different approach. Furthermore,
like those in @Data.Text.IO@, the operations use the system encoding (and @T.hGetLine@)
and thus are slower than the \'official\' route, which would use bytestring IO and
the encoding and decoding functions in @Pipes.Text.Encoding@. Finally, they will generate
text exceptions after the fashion of @Data.Text.Encoding@ rather than returning the
undigested bytes in the style of @Pipes.Text.Encoding@
-}
{-| Read separate lines of 'Text' from 'IO.stdin' using 'T.getLine'
This function will accumulate indefinitely long strict 'Text's. See the caveats above.
Terminates on end of input
-}
stdinLn :: MonadIO m => Producer' T.Text m ()
stdinLn = fromHandleLn IO.stdin
{-# INLINABLE stdinLn #-}
{-| Write 'String's to 'IO.stdout' using 'putStrLn'
Unlike 'toHandle', 'stdoutLn' gracefully terminates on a broken output pipe
-}
stdoutLn :: MonadIO m => Consumer' T.Text m ()
stdoutLn = go
where
go = do
str <- await
x <- liftIO $ try (T.putStrLn str)
case x of
Left (G.IOError { G.ioe_type = G.ResourceVanished
, G.ioe_errno = Just ioe })
| Errno ioe == ePIPE
-> return ()
Left e -> liftIO (throwIO e)
Right () -> go
{-# INLINABLE stdoutLn #-}
{-| Write lines of 'Text's to 'IO.stdout'.
This does not handle a broken output pipe, but has a polymorphic return
value.
-}
stdoutLn' :: MonadIO m => Consumer' T.Text m r
stdoutLn' = for cat (\str -> liftIO (T.putStrLn str))
{-# INLINABLE stdoutLn' #-}
{-# RULES
"p >-> stdoutLn'" forall p .
p >-> stdoutLn' = for p (\str -> liftIO (T.putStrLn str))
#-}
{-| Read separate lines of 'Text' from a 'IO.Handle' using 'T.hGetLine'.
This operation will accumulate indefinitely large strict texts. See the caveats above.
Terminates on end of input
-}
fromHandleLn :: MonadIO m => IO.Handle -> Producer' Text m ()
fromHandleLn h = go where
getLine :: IO (Either G.IOException Text)
getLine = try (T.hGetLine h)
go = do txt <- liftIO getLine
case txt of
Left e -> return ()
Right y -> do yield y
go
{-# INLINABLE fromHandleLn #-}
-- to do: investigate differences from the above:
-- fromHandleLn :: MonadIO m => IO.Handle -> Producer' T.Text m ()
-- fromHandleLn h = go
-- where
-- go = do
-- eof <- liftIO $ IO.hIsEOF h
-- unless eof $ do
-- str <- liftIO $ T.hGetLine h
-- yield str
-- go
-- {-# INLINABLE fromHandleLn #-}
-- | Write separate lines of 'Text' to a 'IO.Handle' using 'T.hPutStrLn'
toHandleLn :: MonadIO m => IO.Handle -> Consumer' T.Text m r
toHandleLn handle = for cat (\str -> liftIO (T.hPutStrLn handle str))
{-# INLINABLE toHandleLn #-}
{-# RULES
"p >-> toHandleLn handle" forall p handle .
p >-> toHandleLn handle = for p (\str -> liftIO (T.hPutStrLn handle str))
#-}
{-| Stream separate lines of text from a file. This operation will accumulate
indefinitely long strict text chunks. See the caveats above.
-}
readFileLn :: MonadSafe m => FilePath -> Producer Text m ()
readFileLn file = Safe.withFile file IO.ReadMode fromHandleLn
{-# INLINE readFileLn #-}
{-| Write lines to a file, automatically opening and closing the file as
necessary
-}
writeFileLn :: (MonadSafe m) => FilePath -> Consumer' Text m r
writeFileLn file = Safe.withFile file IO.WriteMode toHandleLn
{-# INLINABLE writeFileLn #-}
|
