SplittingWriteStream.st
author Claus Gittinger <cg@exept.de>
Thu, 09 Jun 2016 12:30:05 +0200
changeset 3886 b4fe47975cce
parent 3532 d4d9fa6ab6cf
child 4275 f19e46851a8e
permissions -rw-r--r--
initial checkin class: ValueDoubleLink added: #copyright #documentation #value #value:
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3532
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
     1
"{ Encoding: utf8 }"
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
     2
912
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
     3
"{ Package: 'stx:libbasic2' }"
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
     4
3470
850093c8df57 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 2993
diff changeset
     5
"{ NameSpace: Smalltalk }"
850093c8df57 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 2993
diff changeset
     6
833
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     7
Stream subclass:#SplittingWriteStream
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     8
	instanceVariableNames:'outStream1 outStream2'
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     9
	classVariableNames:''
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    10
	poolDictionaries:''
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    11
	category:'Streams-Misc'
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    12
!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    13
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    14
!SplittingWriteStream class methodsFor:'documentation'!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    15
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    16
documentation
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    17
"
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    18
    A stream duplicator - everything written onto a splittingWriteStream
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    19
    is written to two real streams.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    20
    Useful, if you have to send something to two files/destinations
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    21
    simultaneously, and do not want to (or cannot) buffer it.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    22
    Especially useful, to generate a checksum, 
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    23
    while sending something to a file 
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    24
    (if one of the output streams is a checksummer).
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    25
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    26
    [author:]
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    27
        Claus Gittinger (cg@exept)
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    28
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    29
    [see also:]
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    30
        WriteStream
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    31
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    32
    [instance variables:]
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    33
        outStream1      <Stream>       actual output streams
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    34
        outStream2      <Stream>
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    35
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    36
    [class variables:]
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    37
"
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    38
!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    39
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    40
examples
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    41
"
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    42
    examples to be added.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    43
                                                                [exBegin]
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    44
    |s1 s2 splitter|
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    45
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    46
    s1 := '/tmp/foo1' asFilename writeStream.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    47
    s2 := '/tmp/foo2' asFilename writeStream.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    48
    splitter := SplittingWriteStream on:s1 and:s2.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    49
    splitter nextPutAll:'hello world'.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    50
    splitter close.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    51
                                                                [exEnd]
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    52
"
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    53
! !
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    54
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    55
!SplittingWriteStream class methodsFor:'instance creation'!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    56
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    57
on:stream1 and:stream2
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    58
    ^ self basicNew setOutStream1:stream1 outStream2:stream2
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    59
! !
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    60
912
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    61
!SplittingWriteStream methodsFor:'accessing'!
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    62
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    63
outStream1
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    64
    "return the value of the instance variable 'outStream1' (automatically generated)"
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    65
2993
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
    66
    ^ outStream1
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
    67
!
912
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    68
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    69
outStream1:something
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    70
    "set the value of the instance variable 'outStream1' (automatically generated)"
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    71
2993
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
    72
    outStream1 := something.
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
    73
!
912
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    74
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    75
outStream2
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    76
    "return the value of the instance variable 'outStream2' (automatically generated)"
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    77
2993
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
    78
    ^ outStream2
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
    79
!
912
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    80
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    81
outStream2:something
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    82
    "set the value of the instance variable 'outStream2' (automatically generated)"
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    83
2993
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
    84
    outStream2 := something.
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
    85
! !
912
0252ad15028b accessors
Claus Gittinger <cg@exept.de>
parents: 833
diff changeset
    86
833
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    87
!SplittingWriteStream methodsFor:'private access'!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    88
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    89
setOutStream1:stream1 outStream2:stream2
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    90
    outStream1 := stream1.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    91
    outStream2 := stream2.
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
3532
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
    95
!SplittingWriteStream methodsFor:'redirect messages'!
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
    96
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
    97
doesNotUnderstand:aMessage
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
    98
    "if my superclass implements the message, it can be forwarded to both streams."
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
    99
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   100
    (outStream2 class canUnderstand:aMessage selector) ifTrue:[
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   101
        aMessage sendTo:outStream1.
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   102
        ^ aMessage sendTo:outStream2.
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   103
    ].
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   104
    ^ super doesNotUnderstand:aMessage.
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   105
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   106
    "
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   107
        |sp s1 s2|
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   108
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   109
        s1 := TextStream on:''.
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   110
        s2 := TextStream on:''.
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   111
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   112
        sp := SplittingWriteStream on:s1 and:s2.
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   113
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   114
        sp nextPutAllText:('ABC' allBold); closeRun.
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   115
        s2 contents inspect.
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   116
    "
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   117
! !
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   118
833
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   119
!SplittingWriteStream methodsFor:'writing'!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   120
2993
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
   121
clear
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
   122
    outStream1 isStream ifFalse:[ outStream1 clear ]. 
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
   123
    outStream2 isStream ifFalse:[ outStream2 clear ].
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
   124
!
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
   125
833
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   126
close
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   127
    outStream1 close.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   128
    outStream2 close.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   129
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   130
!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   131
2993
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
   132
contents
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
   133
    ^ outStream1 contents 
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
   134
!
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
   135
833
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   136
endEntry
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   137
    outStream1 endEntry.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   138
    outStream2 endEntry.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   139
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   140
!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   141
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   142
flush
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   143
    outStream1 flush.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   144
    outStream2 flush.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   145
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   146
!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   147
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   148
nextPut:something
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   149
    outStream1 nextPut:something.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   150
    outStream2 nextPut:something.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   151
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   152
!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   153
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   154
nextPutAll:something
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   155
    outStream1 nextPutAll:something.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   156
    outStream2 nextPutAll:something.
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   157
3470
850093c8df57 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 2993
diff changeset
   158
!
850093c8df57 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 2993
diff changeset
   159
850093c8df57 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 2993
diff changeset
   160
nextPutAll:aCollection startingAt:start to:stop
850093c8df57 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 2993
diff changeset
   161
    outStream1 nextPutAll:aCollection startingAt:start to:stop.
850093c8df57 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 2993
diff changeset
   162
    outStream2 nextPutAll:aCollection startingAt:start to:stop.
833
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   163
! !
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   164
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   165
!SplittingWriteStream class methodsFor:'documentation'!
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   166
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   167
version
3532
d4d9fa6ab6cf class: SplittingWriteStream
Stefan Vogel <sv@exept.de>
parents: 3470
diff changeset
   168
    ^ '$Header: /cvs/stx/stx/libbasic2/SplittingWriteStream.st,v 1.5 2015-03-13 12:38:16 stefan Exp $'
833
a0311a2e96cb initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   169
! !
2993
50284280f5d6 class: SplittingWriteStream
Claus Gittinger <cg@exept.de>
parents: 912
diff changeset
   170