author | Claus Gittinger <cg@exept.de> |
Thu, 05 Nov 2009 15:42:46 +0100 | |
changeset 12471 | c6260f85e725 |
parent 12464 | c0a970ba9175 |
child 12491 | d74b78dd478a |
permissions | -rw-r--r-- |
3714 | 1 |
" |
2 |
COPYRIGHT (c) 1998 by eXept Software AG |
|
3 |
All Rights Reserved |
|
4 |
||
5 |
This software is furnished under a license and may be used |
|
6 |
only in accordance with the terms of that license and with the |
|
7 |
inclusion of the above copyright notice. This software may not |
|
8 |
be provided or otherwise made available to, or used by, any |
|
9 |
other person. No title to or ownership of the software is |
|
10 |
hereby transferred. |
|
11 |
" |
|
8807
606a4ec5b693
#notifyStoreError raise error proceedable.
Stefan Vogel <sv@exept.de>
parents:
3714
diff
changeset
|
12 |
"{ Package: 'stx:libcomp' }" |
606a4ec5b693
#notifyStoreError raise error proceedable.
Stefan Vogel <sv@exept.de>
parents:
3714
diff
changeset
|
13 |
|
606a4ec5b693
#notifyStoreError raise error proceedable.
Stefan Vogel <sv@exept.de>
parents:
3714
diff
changeset
|
14 |
String variableByteSubclass:#ImmutableString |
3714 | 15 |
instanceVariableNames:'' |
16 |
classVariableNames:'' |
|
17 |
poolDictionaries:'' |
|
18 |
category:'System-Compiler-Support' |
|
19 |
! |
|
20 |
||
21 |
!ImmutableString class methodsFor:'documentation'! |
|
22 |
||
23 |
copyright |
|
24 |
" |
|
25 |
COPYRIGHT (c) 1998 by eXept Software AG |
|
26 |
All Rights Reserved |
|
27 |
||
28 |
This software is furnished under a license and may be used |
|
29 |
only in accordance with the terms of that license and with the |
|
30 |
inclusion of the above copyright notice. This software may not |
|
31 |
be provided or otherwise made available to, or used by, any |
|
32 |
other person. No title to or ownership of the software is |
|
33 |
hereby transferred. |
|
34 |
" |
|
35 |
||
36 |
! |
|
37 |
||
38 |
documentation |
|
39 |
" |
|
40 |
By default, string literals in smalltalk are mutable objects. That |
|
41 |
may lead to some subtle (and hard to find errors), if some method passes |
|
42 |
a string constant as argument to someone else, who changes the |
|
43 |
string using at:put: like messages. Since the string object is kept in |
|
44 |
the first methods literals, the string constant has now been changed without |
|
12464 | 45 |
having the method's sourcecode reflect this. Thus, the method will |
3714 | 46 |
behave differently from what its source may make you think. |
47 |
||
48 |
To help finding this kind of 'feature/bug', the compiler can be |
|
49 |
configured to create instances of this ImmutableString instead of Strings |
|
12464 | 50 |
for literals. Instances of ImmutableString catch storing accesses and |
3714 | 51 |
enter the debugger. Although useful, this feature is disabled by default |
52 |
for compatibility to other smalltalk implementations. |
|
53 |
(Also, if turned on, this makes inspecting string literals entered in |
|
54 |
a workspace somewhat strange: you cannot modify it any longer). |
|
55 |
||
56 |
Turn the ImmutableString feature on by setting the Parsers class variable |
|
57 |
'StringsAreImmutable' to true or use the new launchers settings menu. |
|
58 |
||
12471 | 59 |
|
60 |
ATTENTION: |
|
61 |
there may be still code around which checks for explicit class being String |
|
62 |
(both in Smalltalk and in primitive code). All code like foo 'class == String' |
|
63 |
or '__isString' will not work with ImmutableStrings. |
|
64 |
A somewhat better approach would be to either add a flag to the object (mutability) |
|
65 |
and check this dynamically (expensive) or to place immutable objects into a readonly |
|
66 |
memory segment (the good solution). We will eventually implement the second in the future... |
|
67 |
||
3714 | 68 |
[see also:] |
69 |
ImmutableArray |
|
70 |
Parser Scanner |
|
71 |
||
72 |
[author:] |
|
73 |
Claus Gittinger |
|
74 |
" |
|
75 |
! ! |
|
76 |
||
77 |
!ImmutableString methodsFor:'accessing'! |
|
78 |
||
79 |
at:index put:value |
|
80 |
"Trigger an error if an immutable string is stored into. |
|
81 |
The store will be performed (for compatibility reasons) if you continue |
|
82 |
in the debugger." |
|
83 |
||
84 |
self notifyStoreError. |
|
85 |
^ super at:index put:value |
|
86 |
||
87 |
"Created: / 3.8.1998 / 14:45:14 / cg" |
|
12457 | 88 |
! |
89 |
||
90 |
basicAt:index put:value |
|
91 |
"Trigger an error if an immutable string is stored into. |
|
92 |
The store will be performed (for compatibility reasons) if you continue |
|
93 |
in the debugger." |
|
94 |
||
95 |
self notifyStoreError. |
|
96 |
^ super basicAt:index put:value |
|
97 |
! ! |
|
98 |
||
99 |
!ImmutableString methodsFor:'converting'! |
|
100 |
||
101 |
asImmutableString |
|
102 |
^ self |
|
3714 | 103 |
! ! |
104 |
||
105 |
!ImmutableString methodsFor:'copying'! |
|
106 |
||
107 |
copyEmpty |
|
108 |
"when copying, return a real (mutable) String" |
|
109 |
||
110 |
^ String new:self size |
|
111 |
||
112 |
"Created: / 3.8.1998 / 14:46:22 / cg" |
|
113 |
! |
|
114 |
||
115 |
copyEmptyAndGrow:size |
|
116 |
"when copying, return a real (mutable) String" |
|
117 |
||
118 |
^ String new:size |
|
119 |
||
120 |
"Created: / 3.8.1998 / 14:46:34 / cg" |
|
121 |
! |
|
122 |
||
123 |
postCopy |
|
12457 | 124 |
"when copied, make me a real (mutable) String" |
125 |
||
126 |
self changeClassTo:String. |
|
127 |
||
128 |
"Created: / 3.8.1998 / 14:46:45 / cg" |
|
129 |
! |
|
130 |
||
131 |
postDeepCopy |
|
3714 | 132 |
"when copied, make it me a real (mutable) String" |
133 |
||
134 |
self changeClassTo:String. |
|
135 |
||
12457 | 136 |
" |
137 |
'foobar' asImmutableString copy class |
|
138 |
'foobar' asImmutableString shallowCopy class |
|
139 |
'foobar' asImmutableString deepCopy class |
|
140 |
" |
|
3714 | 141 |
! |
142 |
||
143 |
shallowCopy |
|
144 |
"when copying, return a real (mutable) String" |
|
145 |
||
146 |
|sz| |
|
147 |
||
148 |
sz := self size. |
|
149 |
^ (String new:sz) replaceFrom:1 to:sz with:self startingAt:1 |
|
150 |
||
151 |
"Created: / 3.8.1998 / 14:47:00 / cg" |
|
152 |
! ! |
|
153 |
||
154 |
!ImmutableString methodsFor:'error handling'! |
|
155 |
||
156 |
creator |
|
157 |
"find the method that contains me" |
|
158 |
||
9236 | 159 |
^ Method allSubInstances detect:[:aMethod | (aMethod referencesGlobal:self)] ifNone:nil. |
3714 | 160 |
|
161 |
" |
|
162 |
'hello' creator |
|
163 |
" |
|
164 |
||
165 |
"Created: / 3.8.1998 / 14:47:19 / cg" |
|
166 |
! |
|
167 |
||
168 |
notifyStoreError |
|
169 |
"a store is attempted - for our convenience, find the method that |
|
170 |
contains me, for a nicer error message" |
|
171 |
||
172 |
|creator msg| |
|
173 |
||
174 |
creator := self creator. |
|
175 |
msg := 'store into/change of literal'. |
|
176 |
creator notNil ifTrue:[ |
|
177 |
msg := msg , ' (' , creator whoString , ')' |
|
178 |
]. |
|
179 |
" |
|
180 |
this error is reported on an attempt to store into a literal |
|
181 |
string. The literal was created in creator. |
|
182 |
If you press continue in the debugger, the store will be performed. |
|
8807
606a4ec5b693
#notifyStoreError raise error proceedable.
Stefan Vogel <sv@exept.de>
parents:
3714
diff
changeset
|
183 |
If you don't want this, press abort and check your code. |
3714 | 184 |
Storing into literals is VERY VERY bad coding style. |
185 |
" |
|
8807
606a4ec5b693
#notifyStoreError raise error proceedable.
Stefan Vogel <sv@exept.de>
parents:
3714
diff
changeset
|
186 |
self error:msg mayProceed:true |
3714 | 187 |
|
188 |
"Created: / 3.8.1998 / 14:47:45 / cg" |
|
189 |
! ! |
|
190 |
||
191 |
!ImmutableString methodsFor:'private'! |
|
192 |
||
193 |
species |
|
194 |
"Copies should be mutable" |
|
195 |
||
196 |
^ String |
|
197 |
||
198 |
"Created: / 3.8.1998 / 14:47:58 / cg" |
|
199 |
! ! |
|
200 |
||
201 |
!ImmutableString methodsFor:'specials'! |
|
202 |
||
203 |
become:anotherObject |
|
204 |
"trigger an error if I should become something else |
|
205 |
(this would be an even more tricky manipulation)" |
|
206 |
||
207 |
self notifyStoreError. |
|
208 |
^ super become:anotherObject |
|
209 |
||
210 |
"Created: / 3.8.1998 / 14:48:29 / cg" |
|
211 |
! |
|
212 |
||
213 |
becomeNil |
|
214 |
"trigger an error if I should become nil |
|
215 |
(this would be an even more tricky manipulation)" |
|
216 |
||
217 |
self notifyStoreError. |
|
218 |
^ super becomeNil |
|
219 |
||
220 |
"Created: / 3.8.1998 / 14:48:37 / cg" |
|
221 |
! ! |
|
222 |
||
223 |
!ImmutableString class methodsFor:'documentation'! |
|
224 |
||
225 |
version |
|
12471 | 226 |
^ '$Header: /cvs/stx/stx/libbasic/ImmutableString.st,v 1.7 2009-11-05 14:42:46 cg Exp $' |
12457 | 227 |
! |
228 |
||
229 |
version_CVS |
|
12471 | 230 |
^ '$Header: /cvs/stx/stx/libbasic/ImmutableString.st,v 1.7 2009-11-05 14:42:46 cg Exp $' |
3714 | 231 |
! ! |