MultiReadStream.st
author Claus Gittinger <cg@exept.de>
Sun, 18 Aug 2013 12:55:55 +0200
changeset 3090 76525cef6c24
parent 3081 a95c8fd7b433
child 3272 7e58d594ab27
permissions -rw-r--r--
class: MultiReadStream comment/format in: #contentsSpecies
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2449
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     1
"{ Package: 'stx:libbasic2' }"
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     2
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     3
PeekableStream subclass:#MultiReadStream
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     4
	instanceVariableNames:'streamStack'
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     5
	classVariableNames:''
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     6
	poolDictionaries:''
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     7
	category:'Streams-Misc'
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     8
!
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     9
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    10
!MultiReadStream class methodsFor:'documentation'!
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    11
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    12
documentation
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    13
"
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    14
    Stacked streams. At any time, another stream can be stacked onto
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    15
    a stream stack. Making this streams contents to be returned before the
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    16
    rest. To the stream reader, this looks like a bunch of embedded streams.
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    17
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    18
    Useful when reading files which include each other, or to handle
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    19
    define-macro expansion in a c-parser.
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    20
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    21
    [instance variables:]
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    22
"
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    23
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    24
    "Created: / 21-05-2010 / 14:34:48 / cg"
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    25
!
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    26
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    27
examples
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    28
"
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    29
    |s|
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    30
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    31
    s := MultiReadStream on:('abcd' readStream).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    32
    self assert:(s peek == $a).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    33
    self assert:(s next == $a).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    34
    s pushInputStream:('1234' readStream).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    35
    self assert:(s next == $1).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    36
    self assert:(s next == $2).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    37
    s pushInputStream:('aa' readStream).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    38
    self assert:(s next == $a).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    39
    self assert:(s next == $a).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    40
    self assert:(s atEnd not).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    41
    self assert:(s next == $3).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    42
    self assert:(s next == $4).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    43
    self assert:(s next == $b).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    44
    self assert:(s next == $c).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    45
    self assert:(s next == $d).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    46
    self assert:(s atEnd).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    47
    self assert:(s peek == nil).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    48
    self assert:(s next == nil).
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    49
"
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    50
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    51
    "Created: / 21-05-2010 / 14:27:53 / cg"
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    52
! !
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    53
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    54
!MultiReadStream class methodsFor:'instance creation'!
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    55
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    56
on:aReadStream
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    57
    ^ self basicNew pushInputStream:aReadStream
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    58
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    59
    "Created: / 21-05-2010 / 14:26:03 / cg"
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    60
! !
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    61
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    62
!MultiReadStream methodsFor:'private'!
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    63
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    64
checkCurrentStreamAtEnd
2655
2cb26ee25173 changed:8 methods
Stefan Vogel <sv@exept.de>
parents: 2654
diff changeset
    65
    [streamStack size > 1 and:[streamStack last atEnd]] whileTrue:[
2cb26ee25173 changed:8 methods
Stefan Vogel <sv@exept.de>
parents: 2654
diff changeset
    66
        "keep the last stream, so that the #position kludge will work"
2449
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    67
        self popInputStream
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    68
    ].
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    69
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    70
    "Created: / 21-05-2010 / 14:30:20 / cg"
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    71
! !
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    72
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    73
!MultiReadStream methodsFor:'stream protocol'!
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    74
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    75
atEnd
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    76
    self checkCurrentStreamAtEnd.
2655
2cb26ee25173 changed:8 methods
Stefan Vogel <sv@exept.de>
parents: 2654
diff changeset
    77
    ^ streamStack isEmptyOrNil or:[streamStack last atEnd]
2449
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    78
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    79
    "Created: / 21-05-2010 / 14:31:48 / cg"
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    80
!
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    81
2450
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
    82
contentsSpecies 
3090
76525cef6c24 class: MultiReadStream
Claus Gittinger <cg@exept.de>
parents: 3081
diff changeset
    83
    "return a class of which instances will be returned, when
76525cef6c24 class: MultiReadStream
Claus Gittinger <cg@exept.de>
parents: 3081
diff changeset
    84
     parts of the collection are asked for. 
76525cef6c24 class: MultiReadStream
Claus Gittinger <cg@exept.de>
parents: 3081
diff changeset
    85
     (see upTo-kind of methods in Stream)"
76525cef6c24 class: MultiReadStream
Claus Gittinger <cg@exept.de>
parents: 3081
diff changeset
    86
2450
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
    87
    streamStack isEmptyOrNil ifTrue:[^ super contentsSpecies].
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
    88
    ^ streamStack first contentsSpecies
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
    89
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
    90
    "Created: / 21-05-2010 / 14:44:26 / cg"
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
    91
!
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
    92
2449
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    93
next
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    94
    self checkCurrentStreamAtEnd.
2655
2cb26ee25173 changed:8 methods
Stefan Vogel <sv@exept.de>
parents: 2654
diff changeset
    95
    streamStack isEmptyOrNil ifTrue:[^ self pastEndRead].
2449
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    96
    ^ streamStack last next
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    97
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    98
    "Created: / 21-05-2010 / 14:31:23 / cg"
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    99
!
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   100
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   101
peek
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   102
    self checkCurrentStreamAtEnd.
2655
2cb26ee25173 changed:8 methods
Stefan Vogel <sv@exept.de>
parents: 2654
diff changeset
   103
    streamStack isEmptyOrNil ifTrue:[^ self pastEndRead].
2449
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   104
    ^ streamStack last peek
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   105
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   106
    "Created: / 21-05-2010 / 14:29:06 / cg"
2450
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
   107
!
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
   108
2463
cbb5fd7ae437 added: #position
Stefan Vogel <sv@exept.de>
parents: 2450
diff changeset
   109
position
cbb5fd7ae437 added: #position
Stefan Vogel <sv@exept.de>
parents: 2450
diff changeset
   110
    "/ thats depatable !!
cbb5fd7ae437 added: #position
Stefan Vogel <sv@exept.de>
parents: 2450
diff changeset
   111
    "/ the code below only makes sense, if we see the multiStream as some kind of
cbb5fd7ae437 added: #position
Stefan Vogel <sv@exept.de>
parents: 2450
diff changeset
   112
    "/ macro-expanding c-define stream
2654
b6e04b9a3500 added: #position0Based
Stefan Vogel <sv@exept.de>
parents: 2463
diff changeset
   113
b6e04b9a3500 added: #position0Based
Stefan Vogel <sv@exept.de>
parents: 2463
diff changeset
   114
    streamStack isEmptyOrNil ifTrue:[
2655
2cb26ee25173 changed:8 methods
Stefan Vogel <sv@exept.de>
parents: 2654
diff changeset
   115
        "we assume we are at the beginning"
2cb26ee25173 changed:8 methods
Stefan Vogel <sv@exept.de>
parents: 2654
diff changeset
   116
        ^ 0
2654
b6e04b9a3500 added: #position0Based
Stefan Vogel <sv@exept.de>
parents: 2463
diff changeset
   117
    ].
2463
cbb5fd7ae437 added: #position
Stefan Vogel <sv@exept.de>
parents: 2450
diff changeset
   118
    ^ streamStack first position
cbb5fd7ae437 added: #position
Stefan Vogel <sv@exept.de>
parents: 2450
diff changeset
   119
cbb5fd7ae437 added: #position
Stefan Vogel <sv@exept.de>
parents: 2450
diff changeset
   120
    "Created: / 21-05-2010 / 14:52:40 / cg"
cbb5fd7ae437 added: #position
Stefan Vogel <sv@exept.de>
parents: 2450
diff changeset
   121
!
cbb5fd7ae437 added: #position
Stefan Vogel <sv@exept.de>
parents: 2450
diff changeset
   122
2654
b6e04b9a3500 added: #position0Based
Stefan Vogel <sv@exept.de>
parents: 2463
diff changeset
   123
position0Based
3081
a95c8fd7b433 class: MultiReadStream
Stefan Vogel <sv@exept.de>
parents: 2655
diff changeset
   124
    <resource: #obsolete>
a95c8fd7b433 class: MultiReadStream
Stefan Vogel <sv@exept.de>
parents: 2655
diff changeset
   125
    ^ self position
2654
b6e04b9a3500 added: #position0Based
Stefan Vogel <sv@exept.de>
parents: 2463
diff changeset
   126
b6e04b9a3500 added: #position0Based
Stefan Vogel <sv@exept.de>
parents: 2463
diff changeset
   127
    "Created: / 21-05-2010 / 14:52:40 / cg"
b6e04b9a3500 added: #position0Based
Stefan Vogel <sv@exept.de>
parents: 2463
diff changeset
   128
!
b6e04b9a3500 added: #position0Based
Stefan Vogel <sv@exept.de>
parents: 2463
diff changeset
   129
2450
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
   130
position1Based
3081
a95c8fd7b433 class: MultiReadStream
Stefan Vogel <sv@exept.de>
parents: 2655
diff changeset
   131
    <resource: #obsolete>
a95c8fd7b433 class: MultiReadStream
Stefan Vogel <sv@exept.de>
parents: 2655
diff changeset
   132
    ^ self position + 1
2450
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
   133
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
   134
    "Created: / 21-05-2010 / 14:52:40 / cg"
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
   135
!
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
   136
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
   137
readStream
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
   138
    ^ self
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
   139
Claus Gittinger <cg@exept.de>
parents: 2449
diff changeset
   140
    "Created: / 21-05-2010 / 14:51:05 / cg"
2449
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   141
! !
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   142
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   143
!MultiReadStream methodsFor:'stream stacking'!
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   144
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   145
popInputStream
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   146
    streamStack removeLast
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   147
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   148
    "Created: / 21-05-2010 / 14:25:30 / cg"
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   149
!
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   150
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   151
pushInputStream:aReadStream
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   152
    streamStack isNil ifTrue:[
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   153
        streamStack := OrderedCollection new.
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   154
    ].
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   155
    streamStack add:aReadStream
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   156
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   157
    "Created: / 21-05-2010 / 14:25:17 / cg"
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   158
! !
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   159
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   160
!MultiReadStream class methodsFor:'documentation'!
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   161
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   162
version_CVS
3090
76525cef6c24 class: MultiReadStream
Claus Gittinger <cg@exept.de>
parents: 3081
diff changeset
   163
    ^ '$Header: /cvs/stx/stx/libbasic2/MultiReadStream.st,v 1.7 2013-08-18 10:55:55 cg Exp $'
2449
1401dd52e200 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   164
! !
3081
a95c8fd7b433 class: MultiReadStream
Stefan Vogel <sv@exept.de>
parents: 2655
diff changeset
   165