SplittingWriteStream.st
author Claus Gittinger <cg@exept.de>
Fri, 26 Oct 2007 16:07:25 +0200
changeset 1905 ec30ff95406a
parent 912 0252ad15028b
child 2993 50284280f5d6
permissions -rw-r--r--
default printFormat
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
912
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
     1
"{ Package: 'stx:libbasic2' }"
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
     2
833
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     3
Stream subclass:#SplittingWriteStream
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     4
	instanceVariableNames:'outStream1 outStream2'
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     5
	classVariableNames:''
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     6
	poolDictionaries:''
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     7
	category:'Streams-Misc'
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     8
!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     9
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    10
!SplittingWriteStream class methodsFor:'documentation'!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    11
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    12
documentation
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    13
"
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    14
    A stream duplicator - everything written onto a splittingWriteStream
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    15
    is written to two real streams.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    16
    Useful, if you have to send something to two files/destinations
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    17
    simultaneously, and do not want to (or cannot) buffer it.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    18
    Especially useful, to generate a checksum, 
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    19
    while sending something to a file 
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    20
    (if one of the output streams is a checksummer).
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    21
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    22
    [author:]
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    23
        Claus Gittinger (cg@exept)
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    24
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    25
    [see also:]
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    26
        WriteStream
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    27
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    28
    [instance variables:]
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    29
        outStream1      <Stream>       actual output streams
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    30
        outStream2      <Stream>
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    31
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    32
    [class variables:]
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    33
"
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    34
!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    35
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    36
examples
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    37
"
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    38
    examples to be added.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    39
                                                                [exBegin]
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    40
    |s1 s2 splitter|
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    41
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    42
    s1 := '/tmp/foo1' asFilename writeStream.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    43
    s2 := '/tmp/foo2' asFilename writeStream.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    44
    splitter := SplittingWriteStream on:s1 and:s2.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    45
    splitter nextPutAll:'hello world'.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    46
    splitter close.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    47
                                                                [exEnd]
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    48
"
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    49
! !
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    50
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    51
!SplittingWriteStream class methodsFor:'instance creation'!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    52
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    53
on:stream1 and:stream2
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    54
    ^ self basicNew setOutStream1:stream1 outStream2:stream2
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    55
! !
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    56
912
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    57
!SplittingWriteStream methodsFor:'accessing'!
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    58
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    59
outStream1
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    60
    "return the value of the instance variable 'outStream1' (automatically generated)"
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    61
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    62
    ^ outStream1!
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    63
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    64
outStream1:something
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    65
    "set the value of the instance variable 'outStream1' (automatically generated)"
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    66
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    67
    outStream1 := something.!
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    68
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    69
outStream2
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    70
    "return the value of the instance variable 'outStream2' (automatically generated)"
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    71
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    72
    ^ outStream2!
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    73
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    74
outStream2:something
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    75
    "set the value of the instance variable 'outStream2' (automatically generated)"
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    76
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    77
    outStream2 := something.! !
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    78
833
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    79
!SplittingWriteStream methodsFor:'private access'!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    80
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    81
setOutStream1:stream1 outStream2:stream2
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    82
    outStream1 := stream1.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    83
    outStream2 := stream2.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    84
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    85
! !
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    86
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    87
!SplittingWriteStream methodsFor:'writing'!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    88
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    89
close
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    90
    outStream1 close.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    91
    outStream2 close.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    92
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    93
!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    94
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    95
endEntry
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    96
    outStream1 endEntry.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    97
    outStream2 endEntry.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    98
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    99
!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   100
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   101
flush
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   102
    outStream1 flush.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   103
    outStream2 flush.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   104
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   105
!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   106
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   107
nextPut:something
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   108
    outStream1 nextPut:something.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   109
    outStream2 nextPut:something.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   110
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   111
!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   112
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   113
nextPutAll:something
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   114
    outStream1 nextPutAll:something.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   115
    outStream2 nextPutAll:something.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   116
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   117
! !
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   118
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   119
!SplittingWriteStream class methodsFor:'documentation'!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   120
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   121
version
912
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
   122
    ^ '$Header: /cvs/stx/stx/libbasic2/SplittingWriteStream.st,v 1.2 2000-09-11 18:09:01 cg Exp $'
833
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   123
! !