Class: ImmutableString

• Inheritance
• Description
• Class protocol
  • queries
  • testing
• Instance protocol
  • accessing
  • converting
  • copying
  • copying-private
  • private
  • queries
  • specials

Inheritance:

   Object
   |
   +--Collection
      |
      +--SequenceableCollection
         |
         +--ArrayedCollection
            |
            +--UninterpretedBytes
               |
               +--CharacterArray
                  |
                  +--String
                     |
                     +--ImmutableString
                        |
                        +--MIMETypes::MIMEType

Package:

stx:libbasic

Category:

System-Compiler-Support

Version:

rev: 1.30 date: 2024/04/12 18:03:22

user: stefan

file: ImmutableString.st directory: libbasic

module: stx stc-classLibrary: libbasic

Description:

By default, string literals in smalltalk are mutable objects. That
may lead to some subtle (and hard to find errors), if some method passes
a string constant as argument to someone else, who changes the
string using at:put: like messages. Since the string object is kept in
the first methods literals, the string constant has now been changed without
having the method's sourcecode reflect this. Thus, the method will
behave differently from what its source may make you think.

To help finding this kind of 'feature/bug', the compiler can be
configured to create instances of this ImmutableString instead of Strings
for literals. Instances of ImmutableString catch storing accesses and
enter the debugger. Although useful, this feature is disabled by default
for compatibility to other smalltalk implementations.
(Also, if turned on, this makes inspecting string literals entered in
 a workspace somewhat strange: you cannot modify it any longer).

Turn the ImmutableString feature on by setting the Parsers class variable
'StringsAreImmutable' to true or use the new launchers settings menu.

This class should be used only by the compiler.

ATTENTION:
    there may be still code around which checks for explicit class being String
    (both in Smalltalk and in primitive code). All code like foo 'class == String'
    or '__isString()' will not work with ImmutableStrings. Use '__isStringLike()' instead.
    A somewhat better approach would be to either add a flag to the object (mutability)
    and check this dynamically (expensive) or to place immutable objects into a readonly
    memory segment (the good solution). We will eventually implement the second in the future...

copyright
COPYRIGHT (c) 1998 by eXept Software AG
             All Rights Reserved

This software is furnished under a license and may be used
only in accordance with the terms of that license and with the
inclusion of the above copyright notice.   This software may not
be provided or otherwise made available to, or used by, any
other person.  No title to or ownership of the software is
hereby transferred.

Class protocol:

 mutableClass

answer an equivalent mustable class

 hasImmutableInstances

Instance protocol:

 at: index put: value

Trigger an error if an immutable string is stored into.
The store will be performed (for compatibility reasons) if you continue
in the debugger.

 atAllPut: value

Trigger an error if an immutable string is stored into.
The store will be performed (for compatibility reasons) if you continue
in the debugger.

 basicAt: index put: value

Trigger an error if an immutable string is stored into.
The store will be performed (for compatibility reasons) if you continue
in the debugger.

 asImmutableCollection

(comment from inherited method)
return a write-protected copy of myself.
Redefined in Symbol and ImmutableString to return self.

 asMutableCollection

return a writable copy of myself

 beImmutable

that's what I am

 beMutable

you never go back

 copy

return a copy of the receiver

Usage example(s):

'abcd' asImmutableString copy

 deepCopy

when copying, return a real (mutable) String

Usage example(s):

'hello world' asImmutableString deepCopy

 deepCopyUsing: aDictionary postCopySelector: postCopySelector

return a deep copy of the receiver - reimplemented to be a bit faster

Usage example(s):

'hello world' asImmutableString deepCopyUsing:nil postCopySelector:nil

 shallowCopy

when copying, return a real (mutable) String

Usage example(s):

'hello world' asImmutableString shallowCopy

 simpleDeepCopy

when copying, return a real (mutable) String

Usage example(s):

'hello world' asImmutableString simpleDeepCopy

 postCopy

when copied, make me a real (mutable) String

 postDeepCopy

when copied, make it me a real (mutable) String

 species

Copies should be mutable

 speciesForCopy

Copies should be mutable

 isImmutable

return true, if the receiver is immutable.
Since I am an immutable string, return always true here

 become: anotherObject

trigger an error if I should become something else
(this would be an even more tricky manipulation)

 becomeNil

trigger an error if I should become nil
(this would be an even more tricky manipulation)

 becomeSameAs: anotherObject

trigger an error if I should become something else
(this would be an even more tricky manipulation)