ImmArray.st
author Claus Gittinger <cg@exept.de>
Thu, 23 Nov 1995 03:15:59 +0100
changeset 140 1ef1d1395146
parent 135 aa4f7b8f121e
child 148 ef0e604209ec
permissions -rw-r--r--
checkin from browser
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
65
441a440ab59d Initial revision
claus
parents:
diff changeset
     1
"
441a440ab59d Initial revision
claus
parents:
diff changeset
     2
 COPYRIGHT (c) 1995 by Claus Gittinger
441a440ab59d Initial revision
claus
parents:
diff changeset
     3
	      All Rights Reserved
441a440ab59d Initial revision
claus
parents:
diff changeset
     4
441a440ab59d Initial revision
claus
parents:
diff changeset
     5
 This software is furnished under a license and may be used
441a440ab59d Initial revision
claus
parents:
diff changeset
     6
 only in accordance with the terms of that license and with the
441a440ab59d Initial revision
claus
parents:
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
441a440ab59d Initial revision
claus
parents:
diff changeset
     8
 be provided or otherwise made available to, or used by, any
441a440ab59d Initial revision
claus
parents:
diff changeset
     9
 other person.  No title to or ownership of the software is
441a440ab59d Initial revision
claus
parents:
diff changeset
    10
 hereby transferred.
441a440ab59d Initial revision
claus
parents:
diff changeset
    11
"
441a440ab59d Initial revision
claus
parents:
diff changeset
    12
441a440ab59d Initial revision
claus
parents:
diff changeset
    13
Array subclass:#ImmutableArray
441a440ab59d Initial revision
claus
parents:
diff changeset
    14
	 instanceVariableNames:''
441a440ab59d Initial revision
claus
parents:
diff changeset
    15
	 classVariableNames:''
441a440ab59d Initial revision
claus
parents:
diff changeset
    16
	 poolDictionaries:''
69
8841df2f5fdd *** empty log message ***
claus
parents: 68
diff changeset
    17
	 category:'System-Compiler-Support'
65
441a440ab59d Initial revision
claus
parents:
diff changeset
    18
!
441a440ab59d Initial revision
claus
parents:
diff changeset
    19
441a440ab59d Initial revision
claus
parents:
diff changeset
    20
!ImmutableArray class methodsFor:'documentation'!
441a440ab59d Initial revision
claus
parents:
diff changeset
    21
441a440ab59d Initial revision
claus
parents:
diff changeset
    22
copyright
441a440ab59d Initial revision
claus
parents:
diff changeset
    23
"
441a440ab59d Initial revision
claus
parents:
diff changeset
    24
 COPYRIGHT (c) 1995 by Claus Gittinger
441a440ab59d Initial revision
claus
parents:
diff changeset
    25
	      All Rights Reserved
441a440ab59d Initial revision
claus
parents:
diff changeset
    26
441a440ab59d Initial revision
claus
parents:
diff changeset
    27
 This software is furnished under a license and may be used
441a440ab59d Initial revision
claus
parents:
diff changeset
    28
 only in accordance with the terms of that license and with the
441a440ab59d Initial revision
claus
parents:
diff changeset
    29
 inclusion of the above copyright notice.   This software may not
441a440ab59d Initial revision
claus
parents:
diff changeset
    30
 be provided or otherwise made available to, or used by, any
441a440ab59d Initial revision
claus
parents:
diff changeset
    31
 other person.  No title to or ownership of the software is
441a440ab59d Initial revision
claus
parents:
diff changeset
    32
 hereby transferred.
441a440ab59d Initial revision
claus
parents:
diff changeset
    33
"
441a440ab59d Initial revision
claus
parents:
diff changeset
    34
!
441a440ab59d Initial revision
claus
parents:
diff changeset
    35
441a440ab59d Initial revision
claus
parents:
diff changeset
    36
documentation
441a440ab59d Initial revision
claus
parents:
diff changeset
    37
"
441a440ab59d Initial revision
claus
parents:
diff changeset
    38
    By default, array literals in smalltalk are mutable objects. That
98
claus
parents: 97
diff changeset
    39
    may lead to some subtle (and hard to find errors), if some method passes
65
441a440ab59d Initial revision
claus
parents:
diff changeset
    40
    a literal array constant as argument to someone else, who changes the
441a440ab59d Initial revision
claus
parents:
diff changeset
    41
    array using at:put: like messages. Since the array object is kept in 
441a440ab59d Initial revision
claus
parents:
diff changeset
    42
    the first methods literals, the array constant has now been changed without
98
claus
parents: 97
diff changeset
    43
    having the methods sourcecode reflect this. Thus, the method will
65
441a440ab59d Initial revision
claus
parents:
diff changeset
    44
    behave differently from what its source may make you think.
441a440ab59d Initial revision
claus
parents:
diff changeset
    45
98
claus
parents: 97
diff changeset
    46
    To help finding this kind of 'feature/bug', the compiler can be
65
441a440ab59d Initial revision
claus
parents:
diff changeset
    47
    configured to create instances of this ImmutableArray instead of Arrays
441a440ab59d Initial revision
claus
parents:
diff changeset
    48
    for array literals. Instances of ImmutableArray catch storing accesses and
441a440ab59d Initial revision
claus
parents:
diff changeset
    49
    enter the debugger. Although useful, this feature is disabled by default
441a440ab59d Initial revision
claus
parents:
diff changeset
    50
    for compatibility to other smalltalk implementations. 
441a440ab59d Initial revision
claus
parents:
diff changeset
    51
    (Also, if turned on, this makes inspecting array literals entered in
441a440ab59d Initial revision
claus
parents:
diff changeset
    52
     a workspace somewhat strange: you cannot modify it any longer).
441a440ab59d Initial revision
claus
parents:
diff changeset
    53
441a440ab59d Initial revision
claus
parents:
diff changeset
    54
    Turn the ImmutableArray feature on by setting the Parsers class variable
98
claus
parents: 97
diff changeset
    55
    'ArraysAreImmutable' to true or use the new launchers settings menu.
65
441a440ab59d Initial revision
claus
parents:
diff changeset
    56
"
140
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    57
!
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    58
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    59
version
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    60
    ^ '$Header: /cvs/stx/stx/libcomp/Attic/ImmArray.st,v 1.11 1995-11-23 02:13:03 cg Exp $'
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    61
! !
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    62
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    63
!ImmutableArray methodsFor:'accessing'!
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    64
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    65
at: index put: value
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    66
    "Trigger an error if an immutable array is stored into.
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    67
     The store will be performed (for compatibility reasons) if you continue
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    68
     in the debugger."
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    69
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    70
    self notifyStoreError.
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    71
    ^ super at: index put: value
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    72
!
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    73
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    74
basicAt: index put: value
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    75
    "Trigger an error if an immutable array is stored into.
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    76
     The store will be performed (for compatibility reasons) if you continue
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    77
     in the debugger."
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    78
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    79
    self notifyStoreError.
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    80
    ^ super basicAt: index put: value
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    81
! !
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    82
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    83
!ImmutableArray methodsFor:'copying'!
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    84
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    85
copyEmpty
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    86
    "when copying, return a real (mutable) Array"
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    87
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    88
    ^ Array new:self size
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    89
!
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    90
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    91
copyEmptyAndGrow:size
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    92
    "when copying, return a real (mutable) Array"
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    93
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    94
    ^ Array new:size
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    95
!
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    96
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    97
postCopy
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    98
    "when copied, make it me a real (mutable) Array"
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
    99
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   100
    self changeClassTo:Array.
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   101
!
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   102
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   103
shallowCopy
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   104
    "when copying, return a real (mutable) Array"
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   105
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   106
    |sz|
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   107
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   108
    sz := self size.
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   109
    ^ (Array new:sz)
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   110
	replaceFrom:1 to:sz with:self startingAt:1
65
441a440ab59d Initial revision
claus
parents:
diff changeset
   111
! !
441a440ab59d Initial revision
claus
parents:
diff changeset
   112
441a440ab59d Initial revision
claus
parents:
diff changeset
   113
!ImmutableArray methodsFor:'error handling'!
441a440ab59d Initial revision
claus
parents:
diff changeset
   114
441a440ab59d Initial revision
claus
parents:
diff changeset
   115
creator 
441a440ab59d Initial revision
claus
parents:
diff changeset
   116
    "find the method that contains me"
441a440ab59d Initial revision
claus
parents:
diff changeset
   117
84
claus
parents: 69
diff changeset
   118
    Method allSubInstances do:[:aMethod |
65
441a440ab59d Initial revision
claus
parents:
diff changeset
   119
	|lits|
441a440ab59d Initial revision
claus
parents:
diff changeset
   120
441a440ab59d Initial revision
claus
parents:
diff changeset
   121
	lits := aMethod literals.
441a440ab59d Initial revision
claus
parents:
diff changeset
   122
	(lits notNil and:[(lits identityIndexOf:self) ~~ 0]) ifTrue:[
441a440ab59d Initial revision
claus
parents:
diff changeset
   123
	    ^ aMethod
441a440ab59d Initial revision
claus
parents:
diff changeset
   124
	]
441a440ab59d Initial revision
claus
parents:
diff changeset
   125
    ].
441a440ab59d Initial revision
claus
parents:
diff changeset
   126
    ^ nil
441a440ab59d Initial revision
claus
parents:
diff changeset
   127
!
441a440ab59d Initial revision
claus
parents:
diff changeset
   128
441a440ab59d Initial revision
claus
parents:
diff changeset
   129
notifyStoreError
441a440ab59d Initial revision
claus
parents:
diff changeset
   130
    "a store is attempted - for our convenience, find the method that
441a440ab59d Initial revision
claus
parents:
diff changeset
   131
     contains me, for a nicer error message"
441a440ab59d Initial revision
claus
parents:
diff changeset
   132
441a440ab59d Initial revision
claus
parents:
diff changeset
   133
    |creator msg|
441a440ab59d Initial revision
claus
parents:
diff changeset
   134
441a440ab59d Initial revision
claus
parents:
diff changeset
   135
    creator := self creator.
97
claus
parents: 84
diff changeset
   136
    msg := 'store into/change of literal'.
65
441a440ab59d Initial revision
claus
parents:
diff changeset
   137
    creator notNil ifTrue:[
441a440ab59d Initial revision
claus
parents:
diff changeset
   138
	msg := msg , ' (' , creator whoString , ')'
441a440ab59d Initial revision
claus
parents:
diff changeset
   139
    ].
441a440ab59d Initial revision
claus
parents:
diff changeset
   140
    "
441a440ab59d Initial revision
claus
parents:
diff changeset
   141
     this error is reported on an attempt to store into a literal
441a440ab59d Initial revision
claus
parents:
diff changeset
   142
     array. The literal was created in creator.
441a440ab59d Initial revision
claus
parents:
diff changeset
   143
     If you press continue in the debugger, the store will be performed.
441a440ab59d Initial revision
claus
parents:
diff changeset
   144
     If you dont want this, press abort and check your code.
441a440ab59d Initial revision
claus
parents:
diff changeset
   145
     Storing into literals is VERY VERY bad coding style.
441a440ab59d Initial revision
claus
parents:
diff changeset
   146
    "
441a440ab59d Initial revision
claus
parents:
diff changeset
   147
    self error:msg
441a440ab59d Initial revision
claus
parents:
diff changeset
   148
! !
441a440ab59d Initial revision
claus
parents:
diff changeset
   149
140
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   150
!ImmutableArray methodsFor:'private'!
65
441a440ab59d Initial revision
claus
parents:
diff changeset
   151
140
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   152
species
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   153
    "Copies should be mutable"
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   154
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   155
    ^Array
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   156
! !
65
441a440ab59d Initial revision
claus
parents:
diff changeset
   157
140
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   158
!ImmutableArray methodsFor:'queries'!
65
441a440ab59d Initial revision
claus
parents:
diff changeset
   159
140
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   160
isLiteral
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   161
    "return true, if the receiver can be used as a literal
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   162
     (i.e. can be used in constant arrays)"
65
441a440ab59d Initial revision
claus
parents:
diff changeset
   163
140
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   164
    "yes, I must be"
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   165
    ^ true
1ef1d1395146 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 135
diff changeset
   166
65
441a440ab59d Initial revision
claus
parents:
diff changeset
   167
! !
441a440ab59d Initial revision
claus
parents:
diff changeset
   168
97
claus
parents: 84
diff changeset
   169
!ImmutableArray methodsFor:'specials'!
claus
parents: 84
diff changeset
   170
claus
parents: 84
diff changeset
   171
become:anotherObject
100
claus
parents: 98
diff changeset
   172
    "trigger an error if I should become something else
claus
parents: 98
diff changeset
   173
     (this would be an even more tricky manipulation)"
claus
parents: 98
diff changeset
   174
97
claus
parents: 84
diff changeset
   175
    self notifyStoreError.
claus
parents: 84
diff changeset
   176
    ^ super become:anotherObject
claus
parents: 84
diff changeset
   177
!
claus
parents: 84
diff changeset
   178
claus
parents: 84
diff changeset
   179
becomeNil
100
claus
parents: 98
diff changeset
   180
    "trigger an error if I should become nil
claus
parents: 98
diff changeset
   181
     (this would be an even more tricky manipulation)"
claus
parents: 98
diff changeset
   182
97
claus
parents: 84
diff changeset
   183
    self notifyStoreError.
claus
parents: 84
diff changeset
   184
    ^ super becomeNil
claus
parents: 84
diff changeset
   185
! !
claus
parents: 84
diff changeset
   186