"

 COPYRIGHT (c) 1993 by Claus Gittinger

	      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.

"

ArrayedCollection subclass:#UninterpretedBytes

	instanceVariableNames:''

	classVariableNames:'IsBigEndian'

	poolDictionaries:''

	category:'Collections-Abstract'

!

!UninterpretedBytes class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1993 by Claus Gittinger

	      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.

"

!

documentation

"

    UninterpretedBytes provides the common protocol for byte-storage 

    containers; concrete subclasses are 

	ByteArray (which store the bytes within the

    		   Smalltalk object memory) 

    and 

	ExternalBytes (which store the bytes in the malloc-heap).

    UninterpretedBytes itself is abstract, so no instances of it can be created.

    [author:]

        Claus Gittinger

    [See also:]

        ByteArray String ExternalBytes

    [author:]

        Claus Gittinger

"

! !

!UninterpretedBytes class methodsFor:'initialization'!

checkByteOrder

    "initialize our current byteOrder.

     Must be called at system init time and on snapshot restart"

    IsBigEndian := self isBigEndian.

    "Created: / 5.3.1998 / 14:51:41 / stefan"

!

initialize

    "get the byte order"

    self checkByteOrder.

    "want to be informed when returning from snapshot"

    ObjectMemory dependents addDependent:self

    "Created: / 5.3.1998 / 14:46:31 / stefan"

    "Modified: / 5.3.1998 / 14:53:28 / stefan"

!

update:something with:aParameter from:changedObject

    "handle image restarts and reget the byte order"

    (something == #returnFromSnapshot) ifTrue:[

        self checkByteOrder.

    ]

    "Created: / 5.3.1998 / 14:55:13 / stefan"

! !

!UninterpretedBytes class methodsFor:'instance creation'!

from:aCollection

    ^ ByteArray from:aCollection

    "Created: / 3.4.1998 / 13:29:50 / cg"

    "Modified: / 3.4.1998 / 13:30:12 / cg"

! !

!UninterpretedBytes class methodsFor:'queries'!

isBigEndian

    "return true, if words/shorts store the most-significant

     byte first (MSB), false if least-sign.-first (LSB). 

     I.e. false for vax, intel; true for m68k, sun."

%{  /* NOCONTEXT */

    /*

     * I dont like ifdefs - you always forget some ...

     * therefore we look into a structure at run-time

     */

    union {

	unsigned int   u_l;

	char           u_c[sizeof(int)];

    } u;

    u.u_l = 0x87654321;

    if (u.u_c[0] == 0x21) RETURN (false);

    RETURN (true);

%}

    "UninterpretedBytes isBigEndian"

!

isBuiltInClass

    "return true if this class is known by the run-time-system.

     Here, true is returned, since UninterpretedBytes is the superclass of

     some builtIn classes (ByteArray & ExternalBytes)"

    ^ self == UninterpretedBytes

    "Modified: / 23.4.1996 / 15:56:25 / cg"

    "Modified: / 5.3.1998 / 14:56:22 / stefan"

! !

!UninterpretedBytes methodsFor:'accessing'!

byteAt:index

    "return the byte at index. 

     For ByteArray, this is the same as basicAt:; 

     however, for strings or symbols, this returns a numeric byteValue

     instead of a character."

    ^ self subclassResponsibility

!

byteAt:index put:value

    "set the byte at index. For ByteArray, this is the same as basicAt:put:.

     However, for Strings, this expects a byteValue to be stored."

    ^ self subclassResponsibility

!

doubleAt:index

    "return the 8-bytes starting at index as a Float.

     Notice, that (currently) ST/X Floats are what Doubles are in ST-80.

     Notice also, that the bytes are expected to be in this machines

     float representation - if the bytearray originated from another

     machine, some conversion is usually needed."

    |newFloat|

    newFloat := Float basicNew.

    1 to:8 do:[:destIndex|

	newFloat basicAt:destIndex put:(self at:index - 1 + destIndex)

    ].

    ^ newFloat.

!

doubleAt:index put:aFloat

    "store the value of the argument, aFloat into the receiver

     starting at index.

     Notice, that (currently) ST/X Floats are what Doubles are in ST-80.

     Notice also, that the bytes are expected to be in this machines

     float representation - if the bytearray originated from another

     machine, some conversion is usually needed."

    |flt|

    flt := aFloat asFloat.

    1 to:8 do:[:srcIndex|

        self at:index - 1 + srcIndex put:(flt basicAt:srcIndex)

    ].

    ^ aFloat

!

doubleWordAt:index

    "return the 4-bytes starting at index as an (unsigned) Integer.

     The value is retrieved in the machines natural byte order.

     Subclasses may redefine this for better performance."

    ^ self doubleWordAt:index MSB:IsBigEndian

    "

     |b|

     b := ByteArray withAll:#(1 2 3 4).

     (b doubleWordAt:1) printStringRadix:16   

    "

    "Modified: / 5.3.1998 / 14:57:35 / stefan"

!

doubleWordAt:index MSB:msb

    "return the 4-bytes starting at index as an (unsigned) Integer.

     The value is retrieved MSB-first, if the msb-arg is true;

     LSB-first otherwise.

     Subclasses may redefine this for better performance."

    |val 

     ival "{ Class: SmallInteger }"

     i    "{ Class: SmallInteger }"

     b1   "{ Class: SmallInteger }"

     b2   "{ Class: SmallInteger }"

     b3   "{ Class: SmallInteger }"

     b4   "{ Class: SmallInteger }"|

    i := index.

    b1 := self at:i.

    b2 := self at:(i+1).

    b3 := self at:(i+2).

    b4 := self at:(i+3).

    msb ifTrue:[

        ival := b1.

        ival := (ival bitShift:8) + b2.

        ival := (ival bitShift:8) + b3.

        val := (ival * 256) + b4.

    ] ifFalse:[

        ival := b4.

        ival := (ival bitShift:8) + b3.

        ival := (ival bitShift:8) + b2.

        val := (ival * 256) + b1.

    ].

    ^ val

    "

     |b|

     b := ByteArray withAll:#(1 2 3 4).

     (b doubleWordAt:1 MSB:true) printStringRadix:16.   

     (b doubleWordAt:1 MSB:false) printStringRadix:16   

    "

    "Modified: / 21.1.1998 / 17:42:30 / cg"

!

doubleWordAt:index put:value

    "set the 4-bytes starting at index from the (unsigned) Integer value.

     The value should be in the range 0 to 16rFFFFFFFF

     (for negative values, the stored value is not defined).

     The value is stored in the machines natural byte order.

     Subclasses may redefine this for better performance."

    ^ self doubleWordAt:index put:value MSB:IsBigEndian

    "

     |b|

     b := ByteArray new:4.

     b doubleWordAt:1 put:16r04030201.

     b inspect

    "

    "Modified: / 5.3.1998 / 14:57:48 / stefan"

!

doubleWordAt:index put:aNumber MSB:msb

    "set the 4-bytes starting at index from the (unsigned) Integer value.

     The value must be in the range 0 to 16rFFFFFFFF.

     The value is stored MSB-first if msb is true; LSB-first otherwise.

     Subclasses may redefine this for better performance."

    |i "{ Class: SmallInteger }" |

    ((aNumber < 0) or:[aNumber > 16rFFFFFFFF]) ifTrue:[

        ^ self elementBoundsError

    ].

    i := index.

    msb ifTrue:[

        self at:i     put:(aNumber digitAt:4).

        self at:(i+1) put:(aNumber digitAt:3).

        self at:(i+2) put:(aNumber digitAt:2).

        self at:(i+3) put:(aNumber digitAt:1).

    ] ifFalse:[

        self at:i     put:(aNumber digitAt:1).

        self at:(i+1) put:(aNumber digitAt:2).

        self at:(i+2) put:(aNumber digitAt:3).

        self at:(i+3) put:(aNumber digitAt:4).

    ].

    ^ aNumber

    "

     |b|

     b := ByteArray new:8.

     b doubleWordAt:1 put:16r04030201 MSB:true.

     b doubleWordAt:5 put:16r04030201 MSB:false.

     b inspect

    "

    "Modified: / 21.1.1998 / 17:43:34 / cg"

    "Modified: / 5.3.1998 / 11:42:17 / stefan"

!

doubleWordAtDoubleWordIndex:index

    "return the unsigned long at index, anInteger. 

     Fetching in the machines natural byte order.

     Indices are 1-based and scaled as appropriate to allow

     accessing the memory as an array of doubleWord entries.

     (i.e. indices are 1, 2, ...)"

    ^ self doubleWordAtDoubleWordIndex:index MSB:IsBigEndian

    "Created: / 21.1.1998 / 17:43:53 / cg"

    "Modified: / 5.3.1998 / 14:58:06 / stefan"

!

doubleWordAtDoubleWordIndex:index MSB:msb

    "return the unsigned long at index, anInteger. 

     Fetching is MSB if msb is true, LSB otherwise.

     Indices are 1-based and scaled as appropriate to allow

     accessing the memory as an array of doubleWord entries.

     (i.e. indices are 1, 2, ...)"

    ^ self doubleWordAt:(index - 1 * 4 + 1) MSB:msb

    "Created: / 21.1.1998 / 17:44:07 / cg"

!

doubleWordAtDoubleWordIndex:index put:value

    "set the long at index, anInteger. 

     Storing in the machines natural byte order.

     Indices are 1-based and scaled as appropriate to allow

     accessing the memory as an array of doubleWord entries.

     (i.e. indices are 1, 2, ...)"

    ^ self doubleWordAtDoubleWordIndex:index put:value MSB:IsBigEndian

    "Created: / 21.1.1998 / 17:44:13 / cg"

    "Modified: / 5.3.1998 / 14:58:19 / stefan"

!

doubleWordAtDoubleWordIndex:index put:value MSB:msb

    "set the long at index, anInteger. 

     Storing is MSB if msb is true, LSB otherwise.

     Indices are 1-based and scaled as appropriate to allow

     accessing the memory as an array of doubleWord entries.

     (i.e. indices are 1, 2, ...)"

    ^ self doubleWordAt:(index - 1 * 4 + 1) put:value MSB:msb

    "Created: / 21.1.1998 / 17:44:19 / cg"

!

floatAt:index

    "return the 4-bytes starting at index as a Float.

     Notice, that (currently) ST/X Floats are what Doubles are in ST-80;

     therefore this method reads a 4-byte float from the byteArray and returns

     a float object which keeps an 8-byte double internally.

     Notice also, that the bytes are expected to be in this machines

     float representation and order - if the bytearray originated from another

     machine, some conversion is usually needed."

    |newFloat|

    newFloat := ShortFloat basicNew.

    1 to:4 do:[:destIndex|

        newFloat basicAt:destIndex put:(self at:index - 1 + destIndex)

    ].

    ^ newFloat.

!

floatAt:index put:aFloat

    "store the 4 bytes of value of the argument, aFloat into the receiver

     starting at index.

     Notice, that (currently) ST/X Floats are what Doubles are in ST-80.

     Notice also, that the bytes are expected to be in this machines

     float representation - if the bytearray originated from another

     machine, some conversion is usually needed."

    |sflt|

    sflt := aFloat asShortFloat.

    1 to:4 do:[:srcIndex|

        self at:index - 1 + srcIndex put:(sflt basicAt:srcIndex)

    ].

    ^ aFloat

!

ieeeDoubleAt:index

    "retrieve the 8 bytes starting at index as a float.

     The 8 bytes are assumed to be in IEEE floating point single precision

     number format."

    "

     currently, we assume that the machines native number format is already

     IEEE format - we need some more code here whenever ST/X is ported

     to an IBM 370 or old VAX etc.

     To date, all supported systems use IEEE float numbers, so there should be

     no problem.

    "

    ^ self doubleAt:index

    "Created: / 5.3.1998 / 10:50:03 / stefan"

!

ieeeDoubleAt:index put:aFloat

    "store the value of the argument, aFloat into the receiver

     starting at index. Storage is in IEEE floating point double precision format.

     (i.e. 8 bytes are stored)."

    "

     currently, we assume that the machines native number format is already

     IEEE format - we need some more code here whenever ST/X is ported

     to an IBM 370 or old VAX etc.

     To date, all supported systems use IEEE float numbers, so there should be

     no problem.

    "

    ^ self doubleAt:index put:aFloat

    "Created: / 5.3.1998 / 10:50:26 / stefan"

!

ieeeFloatAt:index

    "retrieve the 4 bytes starting at index as a float.

     The 4 bytes are assumed to be in IEEE floating point single precision

     number format."

    "

     currently, we assume that the machines native number format is already

     IEEE format - we need some more code here whenever ST/X is ported

     to an IBM 370 or old VAX etc.

     To date, all supported systems use IEEE float numbers, so there should be

     no problem.

    "

    ^ self floatAt:index

    "Created: / 5.3.1998 / 10:50:45 / stefan"

!

ieeeFloatAt:index put:aFloat

    "store the value of the argument, aFloat into the receiver

     starting at index. Storage is in IEEE floating point single precision format.

     (i.e. 4 bytes are stored). Since ST/X floats are really doubles, the low-

     order 4 bytes of the precision is lost."

    "

     currently, we assume that the machines native number format is already

     IEEE format - we need some more code here whenever ST/X is ported

     to an IBM 370 or old VAX etc.

     To date, all supported systems use IEEE float numbers, so there should be

     no problem.

    "

    ^ self floatAt:index put:aFloat

    "Created: / 5.3.1998 / 10:51:11 / stefan"

!

longAt:index

    "return the 4-bytes starting at index as a signed Integer.

     The value is retrieved in the machines natural byte order.

     This may be worth a primitive."

    |w|

    w := self unsignedLongAt:index.

    (w > (16r7FFFFFFF)) ifTrue:[

        ^ w - (16r100000000)

    ].

    ^ w

    "

     |b|

     b := ByteArray new:4.

     b unsignedLongAt:1 put:16rFFFFFFFF.

     (b longAt:1)    

    "

    "Modified: / 1.7.1996 / 21:11:28 / cg"

    "Modified: / 5.3.1998 / 12:06:28 / stefan"

!

longAt:index bigEndian:msb

    "return the 4-bytes starting at index as a signed Integer.

     Depending on msb, the value is retrieved MSB-first or LSB-first.

     This may be worth a primitive."

    |w|

    w := self unsignedLongAt:index bigEndian:msb.