Queue.st
author claus
Mon, 22 Aug 1994 14:12:17 +0200
changeset 39 47fc4acc24db
parent 33 128540d086ae
child 47 2fc2796fbec8
permissions -rw-r--r--
added do:, nextPutAll:
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5
78a5b7c73feb Initial revision
claus
parents:
diff changeset
     1
"
78a5b7c73feb Initial revision
claus
parents:
diff changeset
     2
 COPYRIGHT (c) 1993 by Claus Gittinger
78a5b7c73feb Initial revision
claus
parents:
diff changeset
     3
              All Rights Reserved
78a5b7c73feb Initial revision
claus
parents:
diff changeset
     4
78a5b7c73feb Initial revision
claus
parents:
diff changeset
     5
 This software is furnished under a license and may be used
78a5b7c73feb Initial revision
claus
parents:
diff changeset
     6
 only in accordance with the terms of that license and with the
78a5b7c73feb Initial revision
claus
parents:
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
78a5b7c73feb Initial revision
claus
parents:
diff changeset
     8
 be provided or otherwise made available to, or used by, any
78a5b7c73feb Initial revision
claus
parents:
diff changeset
     9
 other person.  No title to or ownership of the software is
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    10
 hereby transferred.
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    11
"
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    12
30
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    13
Collection subclass:#Queue
5
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    14
         instanceVariableNames:'contentsArray readPosition writePosition tally'
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    15
         classVariableNames:''
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    16
         poolDictionaries:''
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    17
         category:'Collections-Ordered'
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    18
!
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    19
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    20
Queue comment:'
30
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    21
COPYRIGHT (c) 1993 by Claus Gittinger
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    22
              All Rights Reserved
33
128540d086ae *** empty log message ***
claus
parents: 30
diff changeset
    23
39
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    24
$Header: /cvs/stx/stx/libbasic2/Queue.st,v 1.5 1994-08-22 12:12:17 claus Exp $
30
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    25
'!
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    26
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    27
!Queue class methodsFor:'documentation'!
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    28
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    29
copyright
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    30
"
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    31
 COPYRIGHT (c) 1993 by Claus Gittinger
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    32
              All Rights Reserved
5
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    33
30
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    34
 This software is furnished under a license and may be used
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    35
 only in accordance with the terms of that license and with the
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    36
 inclusion of the above copyright notice.   This software may not
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    37
 be provided or otherwise made available to, or used by, any
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    38
 other person.  No title to or ownership of the software is
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    39
 hereby transferred.
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    40
"
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    41
!
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    42
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    43
version
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    44
"
39
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    45
$Header: /cvs/stx/stx/libbasic2/Queue.st,v 1.5 1994-08-22 12:12:17 claus Exp $
30
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    46
"
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    47
!
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    48
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    49
documentation
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    50
"
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    51
    Queues provides a simple implementation of a queue - it is not
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    52
    safe when two processes access Queues simultanously since accesses
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    53
    to the internals are not protected against process-switches.
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    54
    See SharedQueue for a class supporting this.
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    55
"
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
    56
! !
5
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    57
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    58
!Queue class methodsFor:'instance creation'!
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    59
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    60
new:size
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    61
    "return a new queue with space for size elements"
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    62
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    63
    ^ super new init:size
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    64
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    65
    "
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    66
     |q|
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    67
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    68
     q := Queue new.
39
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    69
     (1 to:5) do:[:i | q nextPut:i].
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    70
     Transcript show:(q next); space.
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    71
     Transcript show:(q next); space.
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    72
     Transcript show:(q next); space.
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    73
     Transcript show:(q next); space.
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    74
     q nextPutAll:(6 to:10).
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    75
     Transcript show:(q next); space.
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    76
     Transcript show:(q next); space.
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    77
     Transcript show:(q next); space.
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    78
     Transcript show:(q next); space.
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    79
     Transcript show:(q next); space.
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    80
     Transcript show:(q next); space.
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    81
     Transcript show:(q next); space.
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    82
     Transcript show:(q next); space.
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    83
     Transcript show:(q next); space.
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
    84
     Transcript showCr:(q next).
5
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    85
    "
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    86
!
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    87
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    88
new
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    89
    "return a new queue with space for 10 elements"
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    90
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    91
    ^ self new:10
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    92
! !
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    93
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    94
!Queue methodsFor:'initialization'!
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    95
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    96
init:size
14
ca0b5fbc8131 *** empty log message ***
claus
parents: 5
diff changeset
    97
    "initialize the receiver for size entries"
ca0b5fbc8131 *** empty log message ***
claus
parents: 5
diff changeset
    98
5
78a5b7c73feb Initial revision
claus
parents:
diff changeset
    99
    contentsArray := Array new:size.
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   100
    readPosition := writePosition := 1.
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   101
    tally := 0.
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   102
! !
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   103
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   104
!Queue methodsFor:'accessing'!
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   105
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   106
next
39
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   107
    "return the next value in the queue; 
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   108
     Return nil, if the queue is empty"
5
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   109
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   110
    |value|
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   111
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   112
    (tally == 0) ifTrue:[^ nil].
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   113
    value := contentsArray at:readPosition.
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   114
    readPosition := readPosition + 1.
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   115
    readPosition > contentsArray size ifTrue:[
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   116
        readPosition := 1
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   117
    ].
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   118
    tally := tally - 1.
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   119
    ^ value
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   120
!
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   121
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   122
nextPut:anObject
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   123
    "enter anObject into the queue - if the queue is full, report an error"
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   124
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   125
    (tally == contentsArray size) ifTrue:[
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   126
        self error:'queue is full'.
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   127
        ^ self
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   128
    ].
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   129
    contentsArray at:writePosition put:anObject.
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   130
    writePosition := writePosition + 1.
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   131
    writePosition > contentsArray size ifTrue:[
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   132
        writePosition := 1
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   133
    ].
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   134
    tally := tally + 1
39
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   135
!
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   136
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   137
nextPutAll:aCollection
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   138
    "enter all elements from aCollection into the queue."
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   139
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   140
    aCollection do:[:element | self nextPut:element]
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   141
! !
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   142
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   143
!Queue methodsFor:'enumeration'!
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   144
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   145
do:aBlock
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   146
    "evaluate the argument, aBlock for each element in the queue"
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   147
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   148
    |pos endPos|
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   149
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   150
    pos := readPosition.
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   151
    endPos := writePosition.
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   152
    1 to:tally do:[:i |
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   153
        aBlock value:(contentsArray at:pos).
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   154
        pos := pos + 1.
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   155
        pos > contentsArray size ifTrue:[
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   156
            pos := 1
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   157
        ]
47fc4acc24db added do:, nextPutAll:
claus
parents: 33
diff changeset
   158
    ]
5
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   159
! !
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   160
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   161
!Queue methodsFor:'queries'!
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   162
30
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
   163
isEmpty
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
   164
    "return true, if there are no elements in the queue"
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
   165
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
   166
    ^ tally == 0
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
   167
!
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
   168
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
   169
isFull
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
   170
    "return true, if the queue is full i.e. if writing is not
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
   171
     possible"
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
   172
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
   173
    ^ tally == contentsArray size
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
   174
!
f34b335ac2d7 *** empty log message ***
claus
parents: 14
diff changeset
   175
5
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   176
size
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   177
    "return the number of elements in the queue"
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   178
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   179
    ^ tally
78a5b7c73feb Initial revision
claus
parents:
diff changeset
   180
! !