hg/stx-libbasic: comparison WriteStream.st

equal deleted inserted replaced

-:8d4fe353a2d2
+:d0a478542bbf
 from pieces - create a writeStream, add the pieces (with #nextPut: or
 #nextPutAll:) and finally fetch the concatenated string via #contents.
 This is much better than constructing the big string by concatenating via
 the comma (,) operator, since less intermediate garbage objects are created.
 This implementation currently DOES change the
 identity if the streamed-upon collection IF it cannot grow easily.
 Collections which cannot grow easily are for example: Array, ByteArray and String.
 Thus it is slightly incompatible to ST-80 since 'aStream contents' does
 not always return the original collection. This may change.
 [caveat:]
-Basing capabilities like readability/writability/positionability/peekability on inheritance makes
+	Basing capabilities like readability/writability/positionability/peekability on inheritance makes
-the class hierarchy ugly and leads to strange and hard to teach redefinitions (aka. NonPositionableStream
+	the class hierarchy ugly and leads to strange and hard to teach redefinitions (aka. NonPositionableStream
-below PositionableStream or ExternalReadStream under WriteStream)
+	below PositionableStream or ExternalReadStream under WriteStream)
 [author:]
-Claus Gittinger
+	Claus Gittinger
 [see also:]
-CharacterWriteStream (if streaming for a unicode string)
+	CharacterWriteStream (if streaming for a unicode string)
 "
 !
 examples
 "
 |lastIndex|
 lastIndex := position.
 collection size == lastIndex ifFalse:[
-collection isFixedSize ifTrue:[
+	collection isFixedSize ifTrue:[
-"
+	    "
-grow is expensive - return a copy.
+	     grow is expensive - return a copy.
-(is this what users of writeStream expect ?)
+	     (is this what users of writeStream expect ?)
-"
+	    "
-collection := collection copyFrom:1 to:lastIndex
+	    collection := collection copyFrom:1 to:lastIndex
-] ifFalse:[
+	] ifFalse:[
-collection grow:lastIndex
+	    collection grow:lastIndex
-]
+	]
 ].
 ^ collection
 "Modified: / 19.2.1997 / 08:57:28 / stefan"
 "Modified: / 30.10.1997 / 16:21:23 / cg"
 "
 |s|
 s := '' writeStream.
 s nextPut:$a.
 s last.
 s nextPut:$b.
 s last.
 s nextPut:$c.
 s last.
 "
 !
 last:n
 "return the last n elements as species of the underlying collection;
 "
 |s|
 s := '' writeStream.
 s nextPut:$a.
 s last:1.
 s nextPut:$b.
 s last:1.
 s last:2.
 s nextPut:$c.
 s last:1.
 s last:2.
 s last:3.
 "
 !
 reset
 "reset the stream; write anew.
 ^ self position == 0
 "Created: 14.10.1997 / 20:44:37 / cg"
 !
 isReadable
 "return true if the receiver supports reading - thats not true"
 ^ false
 "Created: / 8.11.1997 / 14:06:07 / cg"
 |final|
 count == 0 ifTrue:[^ self].
 (collection isNil or:[writeLimit notNil]) ifTrue:[
-super next:count put:anObject.
+	super next:count put:anObject.
-^ self.
+	^ self.
 ].
 final := position + count.
 (final > collection size) ifTrue:[
-self growCollection:final
+	self growCollection:final
 ].
 collection from:position + 1 to:final put:anObject.
 position := position + count.
 (position >= readLimit) ifTrue:[readLimit := position].
 |s|
 s := '' writeStream.
 s nextPutAll:'hello '.
 s next:5 putAll:'1234world012345' startingAt:5.
 s contents
 "
 "Modified: 12.7.1996 / 10:31:36 / cg"
 !
 coll = __INST(collection);
 p = __INST(position);
 if (__isNonNilObject(coll) && __isSmallInteger(p)) {
-pos = __intVal(p);
+	pos = __intVal(p);
-/* make 1-based */
+	/* make 1-based */
-pos = pos + 1;
+	pos = pos + 1;
-wL = __INST(writeLimit);
+	wL = __INST(writeLimit);
-if ((wL == nil)
+	if ((wL == nil)
-|| (__isSmallInteger(wL) && (pos <= __intVal(wL)))) {
+	 || (__isSmallInteger(wL) && (pos <= __intVal(wL)))) {
-OBJ cls;
+	    OBJ cls;
-cls = __qClass(coll);
+	    cls = __qClass(coll);
-rL = __INST(readLimit);
+	    rL = __INST(readLimit);
-if (__isSmallInteger(rL)) {
+	    if (__isSmallInteger(rL)) {
-__readLimit = __intVal(rL);
+		__readLimit = __intVal(rL);
-}
+	    }
-if (cls == @global(String)) {
+	    if (cls == @global(String)) {
-if (__isCharacter(anObject)
+		if (__isCharacter(anObject)
-&& ((ch = __intVal(__characterVal(anObject))) <= 255) /* ch is unsigned */
+		 && ((ch = __intVal(__characterVal(anObject))) <= 255) /* ch is unsigned */
-&& (pos <= __stringSize(coll))) {
+		 && (pos <= __stringSize(coll))) {
-__StringInstPtr(coll)->s_element[pos-1] = ch;
+		    __StringInstPtr(coll)->s_element[pos-1] = ch;
 advancePositionAndReturn: ;
-if ((__readLimit >= 0) && (pos >= __readLimit)) {
+		    if ((__readLimit >= 0) && (pos >= __readLimit)) {
-__INST(readLimit) = __mkSmallInteger(pos);
+			__INST(readLimit) = __mkSmallInteger(pos);
-}
+		    }
-__INST(position) = __mkSmallInteger(__intVal(__INST(position)) + 1);
+		    __INST(position) = __mkSmallInteger(__intVal(__INST(position)) + 1);
-RETURN ( anObject );
+		    RETURN ( anObject );
-}
+		}
-} else if (cls == @global(ByteArray)) {
+	    } else if (cls == @global(ByteArray)) {
-if (__isSmallInteger(anObject)
+		if (__isSmallInteger(anObject)
-&& ((ch = __intVal(anObject)) <= 0xFF) /* ch is unsigned */
+		 && ((ch = __intVal(anObject)) <= 0xFF) /* ch is unsigned */
-&& (pos <= __byteArraySize(coll))) {
+		 && (pos <= __byteArraySize(coll))) {
-__ByteArrayInstPtr(coll)->ba_element[pos-1] = ch;
+		    __ByteArrayInstPtr(coll)->ba_element[pos-1] = ch;
-goto advancePositionAndReturn;
+		    goto advancePositionAndReturn;
-}
+		}
-} else if (cls == @global(Array)) {
+	    } else if (cls == @global(Array)) {
-if (pos <= __arraySize(coll)) {
+		if (pos <= __arraySize(coll)) {
-__ArrayInstPtr(coll)->a_element[pos-1] = anObject;
+		     __ArrayInstPtr(coll)->a_element[pos-1] = anObject;
-__STORE(coll, anObject);
+		    __STORE(coll, anObject);
-goto advancePositionAndReturn;
+		    goto advancePositionAndReturn;
-}
+		}
-} else if (cls == @global(Unicode16String)) {
+	    } else if (cls == @global(Unicode16String)) {
-if (__isCharacter(anObject)
+		if (__isCharacter(anObject)
-&& ((ch = __intVal(__characterVal(anObject))) <= 0xFFFF) /* ch is unsigned */
+		 && ((ch = __intVal(__characterVal(anObject))) <= 0xFFFF) /* ch is unsigned */
-&& (pos <= __unicode16StringSize(coll))) {
+		 && (pos <= __unicode16StringSize(coll))) {
-__Unicode16StringInstPtr(coll)->s_element[pos-1] = ch;
+		     __Unicode16StringInstPtr(coll)->s_element[pos-1] = ch;
-goto advancePositionAndReturn;
+		    goto advancePositionAndReturn;
-}
+		}
-} else if (cls == @global(Unicode32String)) {
+	    } else if (cls == @global(Unicode32String)) {
-if (__isCharacter(anObject)
+		if (__isCharacter(anObject)
-&& (pos <= __unicode32StringSize(coll))) {
+		 && (pos <= __unicode32StringSize(coll))) {
-__Unicode32StringInstPtr(coll)->s_element[pos-1] = __intVal(__characterVal(anObject));
+		     __Unicode32StringInstPtr(coll)->s_element[pos-1] = __intVal(__characterVal(anObject));
-goto advancePositionAndReturn;
+		    goto advancePositionAndReturn;
-}
+		}
-}
+	    }
-}
+	}
 }
 #endif
 %}.
 (writeLimit isNil
 or:[(position + 1) <= writeLimit]) ifTrue:[
-(position >= collection size) ifTrue:[self growCollection].
+	(position >= collection size) ifTrue:[self growCollection].
-collection at:(position + 1) put:anObject.
+	collection at:(position + 1) put:anObject.
-(position >= readLimit) ifTrue:[readLimit := (position + 1)].
+	(position >= readLimit) ifTrue:[readLimit := (position + 1)].
-position := position + 1.
+	position := position + 1.
 ] ifFalse:[
-WriteError raiseErrorString:'write beyond writeLimit'
+	WriteError raiseErrorString:'write beyond writeLimit'
 ].
 ^anObject
 !
 nextPutAll:aCollection
 instead a single grow on the final size is performed."
 |nMore "{ Class: SmallInteger }"
 final "{ Class: SmallInteger }" |
-(collection isNil or:[aCollection isSequenceable not]) ifTrue:[
+(collection notNil and:[aCollection isSequenceable]) ifFalse:[
-"/ fallback
+	"/ fallback
-super nextPutAll:aCollection.
+	super nextPutAll:aCollection.
-^ self.
+	^ self.
 ].
 nMore := aCollection size.
 nMore == 0 ifTrue:[
-"/ for the programmer..
+	"/ for the programmer..
-aCollection isCollection ifFalse:[
+	aCollection isCollection ifFalse:[
-self error:'invalid argument (not a collection)' mayProceed:true
+	    self error:'invalid argument (not a collection)' mayProceed:true
-].
+	].
 ].
 final := position + nMore.
 (writeLimit notNil
 and:[final > writeLimit]) ifTrue:[
-final := writeLimit.
+	final := writeLimit.
-nMore := final - position
+	nMore := final - position
 ].
 (final > collection size) ifTrue:[
-self growCollection:final
+	self growCollection:final
 ].
 collection
-replaceFrom:(position + 1)
+	replaceFrom:(position + 1)
-to:final
+	to:final
-with:aCollection
+	with:aCollection
-startingAt:1.
+	startingAt:1.
 (position >= readLimit) ifTrue:[readLimit := position].
 position := position + nMore.
 "/ ^ aCollection -- self
 instead a single grow on the final size is performed."
 |nMore final|
 collection isNil ifTrue:[
-^ super nextPutAll:aCollection startingAt:pos1 to:pos2
+	^ super nextPutAll:aCollection startingAt:pos1 to:pos2
 ].
 nMore := pos2 - pos1 + 1.
 final := position + nMore.
 (writeLimit notNil
 and:[final > writeLimit]) ifTrue:[
-final := writeLimit.
+	final := writeLimit.
-nMore := final - position
+	nMore := final - position
 ].
 (final > collection size) ifTrue:[
-self growCollection:final
+	self growCollection:final
 ].
 collection replaceFrom:position + 1
-to:final
+			to:final
-with:aCollection
+		      with:aCollection
-startingAt:pos1.
+		startingAt:pos1.
 position := position + nMore.
 (position >= readLimit) ifTrue:[readLimit := position].
 "/ ^ aCollection -- return self
 nextPutAllUnicode:aString
 "normal streams can not handle multi-byte characters, so convert them to utf8"
 "this code is not perfect if you use both #nextPutAll: and #nextPutAllUnicode:
 with the same stream, since 8-bit characters (with the highest bits set)
 are not stored as UTF, so we get some inconsistent string"
 collection isString ifTrue:[
-collection bitsPerCharacter == 16 ifTrue:[
+	collection bitsPerCharacter == 16 ifTrue:[
-self nextPutAllUtf16:aString.
+	    self nextPutAllUtf16:aString.
-] ifFalse:[
+	] ifFalse:[
-self nextPutAllUtf8:aString.
+	    self nextPutAllUtf8:aString.
-].
+	].
 ] ifFalse:[
-self nextPutAll:aString
+	self nextPutAll:aString
 ].
 "Modified: / 28-09-2011 / 16:15:52 / cg"
 !
 coll = __INST(collection);
 p = __INST(position);
 if (__isNonNilObject(coll) && __isSmallInteger(p) && __isSmallInteger(anObject)) {
-unsigned ch;
+	unsigned ch;
-ch = __intVal(anObject);
+	ch = __intVal(anObject);
-pos = __intVal(p);
+	pos = __intVal(p);
-/* make 1-based */
+	/* make 1-based */
-pos = pos + 1 - __intVal( @global(PositionableStream:ZeroPosition));
+	pos = pos + 1 - __intVal( @global(PositionableStream:ZeroPosition));
-wL = __INST(writeLimit);
+	wL = __INST(writeLimit);
-if ((wL == nil)
+	if ((wL == nil)
-|| (__isSmallInteger(wL) && (pos <= __intVal(wL)))) {
+	 || (__isSmallInteger(wL) && (pos <= __intVal(wL)))) {
-OBJ cls;
+	    OBJ cls;
-cls = __qClass(coll);
+	    cls = __qClass(coll);
-rL = __INST(readLimit);
+	    rL = __INST(readLimit);
-if (__isSmallInteger(rL)) {
+	    if (__isSmallInteger(rL)) {
-__readLimit = __intVal(rL);
+		__readLimit = __intVal(rL);
-}
+	    }
-if (cls == @global(String)) {
+	    if (cls == @global(String)) {
-if ((pos <= __stringSize(coll))
+		if ((pos <= __stringSize(coll))
-&& (ch <= 0xFF)) { /* ch is unsigned */
+		 && (ch <= 0xFF)) { /* ch is unsigned */
-__StringInstPtr(coll)->s_element[pos-1] = ch;
+		    __StringInstPtr(coll)->s_element[pos-1] = ch;
 advancePositionAndReturn: ;
-if ((__readLimit >= 0) && (pos >= __readLimit)) {
+		    if ((__readLimit >= 0) && (pos >= __readLimit)) {
-__INST(readLimit) = __mkSmallInteger(pos);
+			__INST(readLimit) = __mkSmallInteger(pos);
-}
+		    }
-__INST(position) = __mkSmallInteger(__intVal(__INST(position)) + 1);
+		    __INST(position) = __mkSmallInteger(__intVal(__INST(position)) + 1);
-RETURN ( anObject );
+		    RETURN ( anObject );
-}
+		}
-} else if (cls == @global(ByteArray)) {
+	    } else if (cls == @global(ByteArray)) {
-if ((pos <= __byteArraySize(coll))
+		if ((pos <= __byteArraySize(coll))
-&& (ch <= 0xFF)) { /* ch is unsigned */
+		 && (ch <= 0xFF)) { /* ch is unsigned */
-__ByteArrayInstPtr(coll)->ba_element[pos-1] = ch;
+		    __ByteArrayInstPtr(coll)->ba_element[pos-1] = ch;
-goto advancePositionAndReturn;
+		    goto advancePositionAndReturn;
-}
+		}
-}
+	    }
-}
+	}
 }
 #endif
 %}.
 ^ super nextPutByte:anObject
 !
 nextPutBytes:count from:anObject startingAt:start
 "write count bytes from an object starting at index start.
 Return the number of bytes written.
 The object must have non-pointer indexed instvars
 (i.e. be a ByteArray, String, Float- or DoubleArray).
 Use with care - non object oriented i/o.
 This is provided for compatibility with externalStream;
 to support binary storage"
 anObject isByteCollection ifTrue:[
-self nextPutAll:anObject startingAt:start to:(start + count - 1).
+	self nextPutAll:anObject startingAt:start to:(start + count - 1).
-^ count.
+	^ count.
 ].
 ^ super nextPutBytes:count from:anObject startingAt:start
 !
 nextPutUnicode:aCharacter
 "normal streams can not handle multi-byte characters, so convert them to utf8"
 "this code is not perfect if you use both #nextPut: and #nextPutUnicode:
 with the same stream, since 8-bit characters (with the highest bits set)
 are not stored as UTF, so we get some inconsistent string"
 collection isString ifTrue:[
-collection bitsPerCharacter == 16 ifTrue:[
+	collection bitsPerCharacter == 16 ifTrue:[
-self nextPutUtf16:aCharacter.
+	    self nextPutUtf16:aCharacter.
-] ifFalse:[
+	] ifFalse:[
-self nextPutUtf8:aCharacter.
+	    self nextPutUtf8:aCharacter.
-].
+	].
 ] ifFalse:[
-self nextPut:aCharacter.
+	self nextPut:aCharacter.
 ].
 ! !
 !WriteStream class methodsFor:'documentation'!
 version
-^ '$Header: /cvs/stx/stx/libbasic/WriteStream.st,v 1.96 2015-03-26 23:32:34 cg Exp $'
+^ '$Header: /cvs/stx/stx/libbasic/WriteStream.st,v 1.97 2015-04-27 17:04:19 cg Exp $'
 !
 version_CVS
-^ '$Header: /cvs/stx/stx/libbasic/WriteStream.st,v 1.96 2015-03-26 23:32:34 cg Exp $'
+^ '$Header: /cvs/stx/stx/libbasic/WriteStream.st,v 1.97 2015-04-27 17:04:19 cg Exp $'
 ! !

branch	jv
changeset 18301	d0a478542bbf
parent 18192	32a7c53ef4d0
parent 18294	5c7b472ab445
child 19478	1f5aa87f6170