author | Claus Gittinger <cg@exept.de> |
Tue, 18 Nov 2014 17:16:00 +0100 | |
changeset 17070 | 713e0328c7d0 |
parent 16824 | d609e592fd2f |
child 17373 | 2dcc19464bd0 |
permissions | -rw-r--r-- |
3714 | 1 |
" |
2 |
COPYRIGHT (c) 1998 by eXept Software AG |
|
12538
e6bf8c42e1d4
Moved to libbasic from libcomp - change package name
Stefan Vogel <sv@exept.de>
parents:
12491
diff
changeset
|
3 |
All Rights Reserved |
3714 | 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 |
" |
|
12538
e6bf8c42e1d4
Moved to libbasic from libcomp - change package name
Stefan Vogel <sv@exept.de>
parents:
12491
diff
changeset
|
12 |
"{ Package: 'stx:libbasic' }" |
8807
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 |
|
12538
e6bf8c42e1d4
Moved to libbasic from libcomp - change package name
Stefan Vogel <sv@exept.de>
parents:
12491
diff
changeset
|
26 |
All Rights Reserved |
3714 | 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 |
|
12538
e6bf8c42e1d4
Moved to libbasic from libcomp - change package name
Stefan Vogel <sv@exept.de>
parents:
12491
diff
changeset
|
43 |
string using at:put: like messages. Since the string object is kept in |
3714 | 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 |
12538
e6bf8c42e1d4
Moved to libbasic from libcomp - change package name
Stefan Vogel <sv@exept.de>
parents:
12491
diff
changeset
|
52 |
for compatibility to other smalltalk implementations. |
3714 | 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: |
|
14222 | 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. Use '__isStringLike()' instead. |
|
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... |
|
12471 | 67 |
|
3714 | 68 |
[see also:] |
14222 | 69 |
ImmutableArray |
70 |
Parser Scanner |
|
3714 | 71 |
|
72 |
[author:] |
|
14222 | 73 |
Claus Gittinger |
3714 | 74 |
" |
75 |
! ! |
|
76 |
||
77 |
!ImmutableString methodsFor:'accessing'! |
|
78 |
||
12538
e6bf8c42e1d4
Moved to libbasic from libcomp - change package name
Stefan Vogel <sv@exept.de>
parents:
12491
diff
changeset
|
79 |
at:index put:value |
3714 | 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." |
|
12538
e6bf8c42e1d4
Moved to libbasic from libcomp - change package name
Stefan Vogel <sv@exept.de>
parents:
12491
diff
changeset
|
83 |
|
12491 | 84 |
self noModificationError. |
3714 | 85 |
^ super at:index put:value |
86 |
||
87 |
"Created: / 3.8.1998 / 14:45:14 / cg" |
|
12457 | 88 |
! |
89 |
||
12538
e6bf8c42e1d4
Moved to libbasic from libcomp - change package name
Stefan Vogel <sv@exept.de>
parents:
12491
diff
changeset
|
90 |
basicAt:index put:value |
12457 | 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." |
|
12538
e6bf8c42e1d4
Moved to libbasic from libcomp - change package name
Stefan Vogel <sv@exept.de>
parents:
12491
diff
changeset
|
94 |
|
12491 | 95 |
self noModificationError. |
12457 | 96 |
^ super basicAt:index put:value |
97 |
! ! |
|
98 |
||
99 |
!ImmutableString methodsFor:'converting'! |
|
100 |
||
101 |
asImmutableString |
|
102 |
^ self |
|
16824 | 103 |
! |
104 |
||
105 |
asMutableCollection |
|
106 |
"return a writable copy of myself" |
|
107 |
||
108 |
^ self copy changeClassTo:String |
|
3714 | 109 |
! ! |
110 |
||
111 |
!ImmutableString methodsFor:'copying'! |
|
112 |
||
113 |
postCopy |
|
12457 | 114 |
"when copied, make me a real (mutable) String" |
115 |
||
116 |
self changeClassTo:String. |
|
117 |
||
118 |
"Created: / 3.8.1998 / 14:46:45 / cg" |
|
119 |
! |
|
120 |
||
121 |
postDeepCopy |
|
3714 | 122 |
"when copied, make it me a real (mutable) String" |
123 |
||
124 |
self changeClassTo:String. |
|
125 |
||
12457 | 126 |
" |
127 |
'foobar' asImmutableString copy class |
|
128 |
'foobar' asImmutableString shallowCopy class |
|
129 |
'foobar' asImmutableString deepCopy class |
|
130 |
" |
|
3714 | 131 |
! |
132 |
||
133 |
shallowCopy |
|
134 |
"when copying, return a real (mutable) String" |
|
135 |
||
136 |
|sz| |
|
137 |
||
138 |
sz := self size. |
|
139 |
^ (String new:sz) replaceFrom:1 to:sz with:self startingAt:1 |
|
140 |
||
14115
8599762e8a45
comment/format in: #shallowCopy
Stefan Vogel <sv@exept.de>
parents:
14025
diff
changeset
|
141 |
" |
8599762e8a45
comment/format in: #shallowCopy
Stefan Vogel <sv@exept.de>
parents:
14025
diff
changeset
|
142 |
'hello world' asImmutableString shallowCopy |
8599762e8a45
comment/format in: #shallowCopy
Stefan Vogel <sv@exept.de>
parents:
14025
diff
changeset
|
143 |
" |
8599762e8a45
comment/format in: #shallowCopy
Stefan Vogel <sv@exept.de>
parents:
14025
diff
changeset
|
144 |
|
3714 | 145 |
"Created: / 3.8.1998 / 14:47:00 / cg" |
146 |
! ! |
|
147 |
||
148 |
!ImmutableString methodsFor:'private'! |
|
149 |
||
150 |
species |
|
151 |
"Copies should be mutable" |
|
152 |
||
153 |
^ String |
|
154 |
||
155 |
"Created: / 3.8.1998 / 14:47:58 / cg" |
|
16400 | 156 |
! |
157 |
||
158 |
speciesForCopy |
|
159 |
"Copies should be mutable" |
|
160 |
||
161 |
^ String |
|
162 |
||
163 |
"Created: / 3.8.1998 / 14:47:58 / cg" |
|
3714 | 164 |
! ! |
165 |
||
14386 | 166 |
!ImmutableString methodsFor:'queries'! |
167 |
||
168 |
isImmutable |
|
169 |
^ true |
|
170 |
! ! |
|
171 |
||
3714 | 172 |
!ImmutableString methodsFor:'specials'! |
173 |
||
12538
e6bf8c42e1d4
Moved to libbasic from libcomp - change package name
Stefan Vogel <sv@exept.de>
parents:
12491
diff
changeset
|
174 |
become:anotherObject |
3714 | 175 |
"trigger an error if I should become something else |
176 |
(this would be an even more tricky manipulation)" |
|
12538
e6bf8c42e1d4
Moved to libbasic from libcomp - change package name
Stefan Vogel <sv@exept.de>
parents:
12491
diff
changeset
|
177 |
|
12491 | 178 |
self noModificationError. |
3714 | 179 |
^ super become:anotherObject |
180 |
||
181 |
"Created: / 3.8.1998 / 14:48:29 / cg" |
|
182 |
! |
|
183 |
||
184 |
becomeNil |
|
185 |
"trigger an error if I should become nil |
|
186 |
(this would be an even more tricky manipulation)" |
|
12538
e6bf8c42e1d4
Moved to libbasic from libcomp - change package name
Stefan Vogel <sv@exept.de>
parents:
12491
diff
changeset
|
187 |
|
12491 | 188 |
self noModificationError. |
3714 | 189 |
^ super becomeNil |
190 |
||
191 |
"Created: / 3.8.1998 / 14:48:37 / cg" |
|
192 |
! ! |
|
193 |
||
194 |
!ImmutableString class methodsFor:'documentation'! |
|
195 |
||
196 |
version |
|
16824 | 197 |
^ '$Header: /cvs/stx/stx/libbasic/ImmutableString.st,v 1.15 2014-08-23 17:44:00 cg Exp $' |
12457 | 198 |
! |
199 |
||
200 |
version_CVS |
|
16824 | 201 |
^ '$Header: /cvs/stx/stx/libbasic/ImmutableString.st,v 1.15 2014-08-23 17:44:00 cg Exp $' |
3714 | 202 |
! ! |
16400 | 203 |