"

 COPYRIGHT (c) 1989 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 variableSubclass:#Array

       instanceVariableNames:''

       classVariableNames:''

       poolDictionaries:''

       category:'Collections-Indexed'

!

Array comment:'

COPYRIGHT (c) 1989 by Claus Gittinger

              All Rights Reserved

'!

!Array class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1989 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.

"

!

version

"

$Header: /cvs/stx/stx/libbasic/Array.st,v 1.11 1994-06-02 11:18:26 claus Exp $

"

!

documentation

"

    Arrays store general objects; the size is fixed, so add/remove is not

    allowed. Access to the elements is via an Integer index. Since Arrays

    are used very often in the system, some methods have been tuned by

    reimplementation as primitive.

"

! !

!Array class methodsFor:'queries'!

isBuiltInClass

    "this class is known by the run-time-system"

    ^ self == Array

! !

!Array methodsFor:'accessing'!

basicSize

    "return the number of indexed elements in the receiver"

%{  /* NOCONTEXT */

    RETURN ( _MKSMALLINT(_arraySize(self) - _intVal(_ClassInstPtr(_qClass(self))->c_ninstvars) ));

%}

!

basicAt:index

    "return the indexed instance variable with index, anInteger

     - added here for speed"

%{  /* NOCONTEXT */

    REGISTER int indx;

    REGISTER int nIndex;

    OBJ cls;

    if (_isSmallInteger(index)) {

        indx = _intVal(index) - 1;

        if (indx >= 0) {

            nIndex = (_qSize(self) - OHDR_SIZE) / sizeof(OBJ);

            if ((cls = _qClass(self)) != Array)

                indx += _intVal(_ClassInstPtr(cls)->c_ninstvars);

            if (indx < nIndex) {

                RETURN ( _InstPtr(self)->i_instvars[indx] );

            }

        }

    }

%}

.

    ^ super basicAt:index

!

basicAt:index put:anObject

    "store the 2nd arg, anObject as indexed instvar with index, anInteger.

     - added here for speed"

%{  /* NOCONTEXT */

    REGISTER int indx;

    REGISTER int nIndex;

    OBJ cls;

    if (_isSmallInteger(index)) {

        indx = _intVal(index) - 1;

        if (indx >= 0) {

            nIndex = (_qSize(self) - OHDR_SIZE) / sizeof(OBJ);

            if ((cls = _qClass(self)) != Array)

                indx += _intVal(_ClassInstPtr(cls)->c_ninstvars);

            if (indx < nIndex) {

                _InstPtr(self)->i_instvars[indx] = anObject;

                __STORE(self, anObject);

                RETURN ( anObject );

            }

        }

    }

%}

.

    ^ super basicAt:index put:anObject

! !

!Array methodsFor:'converting'!

asArray

    "return the receiver as an array"

    "could be an instance of a subclass..."

    self class == Array ifTrue:[

        ^ self

    ].

    ^ super asArray

! !

!Array methodsFor:'copying'!

copyWith:something

    "reimplemented for speed if receiver is an Array"

%{

    OBJ nObj, element;

    int mySize;

    int nIndex;

    REGISTER OBJ *srcP, *dstP;

    if (_qClass(self) == Array) {

        mySize = _qSize(self);

        _qAlignedNew(nObj, mySize + sizeof(OBJ), __context);

        if (nObj) {

            _InstPtr(nObj)->o_class = Array;

            nIndex = (mySize - OHDR_SIZE) / sizeof(OBJ);

            /* sorry: must take care of stores ... */

            srcP = _ArrayInstPtr(self)->a_element;

            dstP = _ArrayInstPtr(nObj)->a_element;

            while (nIndex--) {

                element = *srcP++;

                *dstP++ = element;

                __STORE(nObj, element);

            }

            *dstP = something;

            __STORE(nObj, something);

            RETURN ( nObj );

        }

    }

%}

.

    ^ super copyWith:something

! !

!Array methodsFor:'filling & replacing'!

from:index1 to:index2 put:anObject

    "reimplemented for speed if receiver is an Array"

%{  /* NOCONTEXT */

    REGISTER int index;

    int nIndex;

    int endIndex;

    REGISTER OBJ *dst;

    if ((_qClass(self) == Array)

     && _isSmallInteger(index1)

     && _isSmallInteger(index2)) {

        index = _intVal(index1) - 1;

        if (index >= 0) {

            nIndex = (_qSize(self) - OHDR_SIZE) / sizeof(OBJ);

            endIndex = _intVal(index2) - 1;

            if (endIndex < nIndex) {

                dst = &(_InstPtr(self)->i_instvars[index]);

#ifdef memset4

                memset4(dst, anObject, (endIndex-index+1));

                __STORE(self, anObject);

#else

                if ((INT)anObject == 0) {

                    memset(dst, 0, (endIndex-index+1) * sizeof(OBJ));

                } else {

                    for (; index <= endIndex; index++) {

                        *dst++ = anObject;

                    }

                    __STORE(self, anObject);

                }

#endif

                RETURN ( self );

            }

        }

    }

%}

.

    ^ super from:index1 to:index2 put:anObject

!

replaceFrom:start to:stop with:aCollection startingAt:repStart

    "reimplemented for speed if both receiver and aCollection are Arrays"

%{  /* NOCONTEXT */

    int nIndex, repNIndex;

    int startIndex, stopIndex;

    REGISTER OBJ *src;

    REGISTER OBJ *dst;

    int repStopIndex;

    REGISTER int repStartIndex;

    REGISTER OBJ t;

    REGISTER int count;

    if ((_qClass(self) == Array)

     && (_Class(aCollection) == Array)

     && _isSmallInteger(start)

     && _isSmallInteger(stop)

     && _isSmallInteger(repStart)) {

        startIndex = _intVal(start) - 1;

        if (startIndex >= 0) {

            nIndex = (_qSize(self) - OHDR_SIZE) / sizeof(OBJ);

            stopIndex = _intVal(stop) - 1;

            count = stopIndex - startIndex + 1;

            if (count == 0) {

                RETURN ( self );

            }

            if ((count > 0) && (stopIndex < nIndex)) {

                repStartIndex = _intVal(repStart) - 1;

                if (repStartIndex >= 0) {

                    repNIndex = (_qSize(aCollection) - OHDR_SIZE) / sizeof(OBJ);

                    repStopIndex = repStartIndex + (stopIndex - startIndex);

                    if (repStopIndex < repNIndex) {

                        src = &(_InstPtr(aCollection)->i_instvars[repStartIndex]);

                        dst = &(_InstPtr(self)->i_instvars[startIndex]);

                        if (aCollection == self) {

                            /* no need to check stores */

                            /* take care of overlapping copy */

                            if (src < dst) {

                                /* must do a reverse copy */

                                src += count;

                                dst += count;

                                while (count-- > 0) {

                                    *--dst = *--src;

                                }

                                RETURN ( self );

                            }

#ifdef bcopy4

                            bcopy4(src, dst, count);

#else

# ifdef FAST_MEMCPY

                            bcopy(src, dst, count*sizeof(OBJ));

# else

                            while (count--) {

                                *dst++ = *src++;

                            }

# endif

#endif

                        } else {

                            while (count-- > 0) {

                                t = *src++;

                                *dst++ = t;

                                __STORE(self, t);

                            }

                        }

                        RETURN ( self );

                    }

                }

            }

        }

    }

%}

.

    ^ super replaceFrom:start to:stop with:aCollection startingAt:repStart

! !

!Array methodsFor:'testing'!

includes:anObject

    "return true, if the argument, anObject is contained in the array

     - reimplemented for speed"

    |element|

%{  /* NOCONTEXT */

    REGISTER int index;

    REGISTER OBJ o;

    int nIndex;

    nIndex = (_qSize(self) - OHDR_SIZE) / sizeof(OBJ);

    index = _intVal(_ClassInstPtr(_qClass(self))->c_ninstvars);

    /* quick check using == */

    o = anObject;

    while (index < nIndex) {

        if (_InstPtr(self)->i_instvars[index++] == o) {

            RETURN ( true );

        }

    }

    if (o == nil) {

        RETURN ( false );

    }

%}

.

%{

    REGISTER int index;

    int nIndex;

    static struct inlineCache eq = _ILC1;

    nIndex = (_qSize(self) - OHDR_SIZE) / sizeof(OBJ);

    index = _intVal(_ClassInstPtr(_qClass(self))->c_ninstvars);

    /* slow check using = */

    while (index < nIndex) {

        element = _InstPtr(self)->i_instvars[index++];

        if (element != nil) {

            if ((*eq.ilc_func)(anObject,

                               @symbol(=),

                               CON_COMMA nil,&eq,

                               element)==true) {

                RETURN ( true );

            }

        }

    }

%}

.

    ^ false

!

indexOf:anElement startingAt:start

    "search the array for anElement; return index if found, 0 otherwise

     - reimplemented for speed"

    |element|

%{

    REGISTER int index;

    int nIndex, nInsts;

    static struct inlineCache eq = _ILC1;

    if (_isSmallInteger(start)) {

        index = _intVal(start) - 1;

        if (index >= 0) {

            nInsts = _intVal(_ClassInstPtr(_qClass(self))->c_ninstvars);

            index += nInsts;

            nIndex = (_qSize(self) - OHDR_SIZE) / sizeof(OBJ);

            if (anElement != nil) {

                while (index < nIndex) {

                    element = _InstPtr(self)->i_instvars[index++];

                    if (element != nil) {

                        if ((element == anElement) 

                         || ((*eq.ilc_func)(anElement,

                                            @symbol(=), 

                                            CON_COMMA nil,&eq,

                                            element) == true)) {

                            RETURN ( _MKSMALLINT(index - nInsts) );

                        }

                    }

                }

            } else {

                /* search for nil */

                while (index < nIndex) {

                    if (_InstPtr(self)->i_instvars[index++] == nil) {

                        RETURN ( _MKSMALLINT(index - nInsts) );

                    }

                }

            }

        }

    }

%}

.

    ^ 0

!

identityIndexOf:anElement startingAt:start

    "search the array for anElement; return index if found, 0 otherwise

     - reimplemented for speed"

%{  /* NOCONTEXT */

    REGISTER int index;

    REGISTER OBJ el;

    REGISTER OBJ *op;

    REGISTER int nIndex;

    int nInsts;

    if (_isSmallInteger(start)) {

        index = _intVal(start) - 1;

        if (index >= 0) {

            nInsts = _intVal(_ClassInstPtr(_qClass(self))->c_ninstvars);

            index += nInsts;

            nIndex = (_qSize(self) - OHDR_SIZE) / sizeof(OBJ);

            el = anElement;

            op = & (_InstPtr(self)->i_instvars[index]);

            while (index++ < nIndex) {

                if (*op++ == el) {

                    RETURN ( _MKSMALLINT(index - nInsts) );

                }

            }

            RETURN ( _MKSMALLINT(0) );

        }

    }

%}

.

    ^ super identityIndexOf:anElement startingAt:start

! !

!Array methodsFor:'printing & storing'!

isLiteral

    "return true, if the receiver can be used as a literal

     (i.e. can be used in constant arrays)"

    thisContext isRecursive ifTrue:[^ false].

    self do:[:element |

        element isLiteral ifFalse:[^ false]

    ].

    ^ true

!

displayString

    "return a printed representation of the receiver for displaying"

    |s|

    self isLiteral ifTrue:[

        s := WriteStream on:String new.

        s nextPutAll:'#('.

        self do:[:element | s nextPutAll:element displayString. s space].

        s nextPutAll:')'.

        ^ s contents

    ].

    ^ super displayString

!

storeOn:aStream

    "append a printed representation of the receiver to aStream,

     which allows reconstructing it via readFrom:.

     Does not work for self referencing Objects"

    self isLiteral ifTrue:[

        aStream nextPutAll:'#('.

        self do:[:element | element storeOn:aStream. aStream space].

        aStream nextPutAll:')'

    ] ifFalse:[

        super storeOn:aStream

    ]

! !

!Array methodsFor:'enumeration'!

do:aBlock

    "evaluate the argument, aBlock for each element in the collection.

     - reimplemented for speed"

    |home element|

%{

    REGISTER OBJFUNC codeVal;

    REGISTER int index;

    int nIndex;

    extern OBJ Block;

    static struct inlineCache val = _ILC1;

    REGISTER OBJ rHome;

    index = _intVal(_ClassInstPtr(_qClass(self))->c_ninstvars);

    nIndex = (_qSize(self) - OHDR_SIZE) / sizeof(OBJ);

    if (__isBlock(aBlock)

     && ((codeVal = _BlockInstPtr(aBlock)->b_code) != (OBJFUNC)nil)

     && (_BlockInstPtr(aBlock)->b_nargs == _MKSMALLINT(1))) {

#ifdef NEW_BLOCK_CALL

        for (; index < nIndex; index++) {

            if (InterruptPending != nil) interruptL(__LINE__ COMMA_CON);

            (*codeVal)(aBlock, CON_COMMA  _InstPtr(self)->i_instvars[index]);

        } 

#else

        home = _BlockInstPtr(aBlock)->b_home;

        rHome = home;

        if ((rHome == nil) || (_qSpace(rHome) >= STACKSPACE)) {

            /*

             * home will not move - keep in a fast register

             */

            for (; index < nIndex; index++) {

                if (InterruptPending != nil) interruptL(__LINE__ COMMA_CON);

                (*codeVal)(rHome, CON_COMMA  _InstPtr(self)->i_instvars[index]);

            } 

        } else {

            for (; index < nIndex; index++) {

                if (InterruptPending != nil) interruptL(__LINE__ COMMA_CON);