"

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

"

nil subclass:#Object

	instanceVariableNames:''

	classVariableNames:'ErrorSignal HaltSignal MessageNotUnderstoodSignal

		UserInterruptSignal RecursionInterruptSignal

		ExceptionInterruptSignal SubscriptOutOfBoundsSignal

		NonIntegerIndexSignal NotFoundSignal KeyNotFoundSignal

		ElementOutOfBoundsSignal UserNotificationSignal InformationSignal

		WarningSignal PrimitiveFailureSignal DeepCopyErrorSignal

		AbortSignal ErrorRecursion Dependencies InfoPrinting

		ActivityNotificationSignal NonWeakDependencies'

	poolDictionaries:''

	category:'Kernel-Objects'

!

!Object  class methodsFor:'documentation'!

copyright

"

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

"

!

dependencies

"

   ST/X dependencies are slightly modified from ST-80's 

   (we think they are better ;-).

   One problem occuring very often in ST-80 is that some object

   cannot be garbage collected because some dependency is present,

   having the object as a dependent of some other object.

   In ST-80, this association remains alive (because a Dictionary

   is used to hold dependents) - even if no other references exist to

   to dependent or the dependee.

   This means, that in ST-80, a #release is mandatory in order to

   prevent memory leaks.

   We think, that this is a bad solution, since after all, exactly that

   kind of work should be performed by a garbage collector - you should not

   need to care about dependencies.

   From a philosophical point of view, why should some object depend on 

   something that the programmer considers a dead object ?

   (well - worse than that: it seems that some ST-80 code even depends on

    that behavior)

   In order to limit the trouble, ST-80 reimplemented the way dependents

   are stored in the model class - this one keeps the dependents locally,

   so these dependents go away, once the model is reclaimed.

   That may make things even more confusing: with models, no #release is

   needed, with general objects it is mandatory.

   In ST/X, dependencies are implemented using a WeakDictionary; this means,

   that once the dependee dies, the dependency association is removed automatically,

   and the dependent can be reclaimed by the garbage collector, if no other

   references exist to the dependent.

   In order to (at least) provide a mechanism for the old behavior

   (in case your application heavily depends on the ST-80 mechanism), complementary

   protocol to add nonWeak dependencies is provided 

   (see #addNonWeakDependent / #removeNonWeakDependent).

   Caveat:

      since interrests are implemented using InterrestConverter (which are simply

      forwarding messages), these must use the nonWeak mechanism (as done in ST-80

      automatically).

      The reason is that there are usually no direct references to the converters,

      and those would be reclaimed if stored in a weakDictionary.

      This means, that those interrests MUST be removed with #retractInterrest

      (which is bug-compatible to ST-80). 

      We rewrite things to provide a more convenient mechanism in the future ...

   I like to hear comments on the above - do you think its better ?

"

!

documentation

"

   Object is the superclass of most other classes. 

   (except for nil-subclasses, which inherit nothing,

    to catch any message into their #doesNotUnderstand: method)

   Protocol which is common to every object is defined here.

   Also some utility stuff (like notify) and error handling is implemented here.

   Object has no instance variables (and may not get any added). One reason is, that

   UndefinedObject and SmallInteger are also inheriting from Object - these two cannot 

   have instance variables (due to their implementation). 

   The other reason is that the runtime system (VM) knows about the layout of some built-in 

   classes (think of Class, Method, Block and also Integer or Float). 

   If you were allowed to add instance variables to Object, the VM had to be recompiled 

   (and also rewritten in some places).

   [Class variables:]

        ErrorSignal     <Signal>        Signal raised for error/error: messages

                                        also, parent of all other signals.

        HaltSignal      <Signal>        Signal raised for halt/halt: messages

        MessageNotUnderstoodSignal      Signals raised for various error conditions

        UserInterruptSignal

        RecursionInterruptSignal 

        ExceptionInterruptSignal

        SubscriptOutOfBoundsSignal 

        NonIntegerIndexSignal

        NotFoundSignal 

        KeyNotFoundSignal 

        ElementOutOfBoundsSignal

        InformationSignal

        WarningSignal

        DeepCopyErrorSignal

        AbortSignal      <Signal>       Signal raised by debugger, to abort a computation

                                        BUT, the debugger will only raise it if it is handled.

                                        By handling the abortSignal, you can control where the

                                        debuggers abort-function resumes execution in case of

                                        an error.

        ErrorRecursion   <Boolean>      controls behavior when recursive errors occur (i.e. 

                                        an error while handling an error).

        Dependencies     <Dictionary>   keeps track of object dependencies

    [author:]

        Claus Gittinger

"

! !

!Object  class methodsFor:'initialization'!

initialize

    "called only once - initialize signals"

    ErrorSignal isNil ifTrue:[

        ErrorSignal := (Signal new) mayProceed:true.

        ErrorSignal nameClass:self message:#errorSignal.

        ErrorSignal notifierString:'error encountered'.

        HaltSignal := ErrorSignal newSignalMayProceed:true.

        HaltSignal nameClass:self message:#haltSignal.

        HaltSignal notifierString:'halt encountered'.

        MessageNotUnderstoodSignal := ErrorSignal newSignalMayProceed:true.

        MessageNotUnderstoodSignal nameClass:self message:#messageNotUnderstoodSignal.

        MessageNotUnderstoodSignal notifierString:'message not understood'.

        PrimitiveFailureSignal := ErrorSignal newSignalMayProceed:true.

        PrimitiveFailureSignal nameClass:self message:#primitiveFailureSignal.

        PrimitiveFailureSignal notifierString:'primitive failed'.

"/        UserInterruptSignal := ErrorSignal newSignalMayProceed:true.

        UserInterruptSignal := (Signal new) newSignalMayProceed:true.

        UserInterruptSignal nameClass:self message:#userInterruptSignal.

        UserInterruptSignal notifierString:'user Interrupt'.

"/        RecursionInterruptSignal := ErrorSignal newSignalMayProceed:false.

        RecursionInterruptSignal := (Signal new) mayProceed:true.

        RecursionInterruptSignal nameClass:self message:#recursionInterruptSignal.

        RecursionInterruptSignal notifierString:'recursion limit reached'.

        ExceptionInterruptSignal := ErrorSignal newSignalMayProceed:true.

        ExceptionInterruptSignal nameClass:self message:#exceptionInterruptSignal.

        ExceptionInterruptSignal notifierString:'exception Interrupt'.

        SubscriptOutOfBoundsSignal := ErrorSignal newSignalMayProceed:false.

        SubscriptOutOfBoundsSignal nameClass:self message:#subscriptOutOfBoundsSignal.

        SubscriptOutOfBoundsSignal notifierString:'subscript out of bounds: '.

        ElementOutOfBoundsSignal := ErrorSignal newSignalMayProceed:false.

        ElementOutOfBoundsSignal nameClass:self message:#elementOutOfBoundsSignal.

        ElementOutOfBoundsSignal notifierString:'element not appropriate or out of bounds'.

        NotFoundSignal := ErrorSignal newSignalMayProceed:true.

        NotFoundSignal nameClass:self message:#notFoundSignal.

        NotFoundSignal notifierString:'no such element'.

        KeyNotFoundSignal := ErrorSignal newSignalMayProceed:true.

        KeyNotFoundSignal nameClass:self message:#keyNotFoundSignal.

        KeyNotFoundSignal notifierString:'no such key: '.

        NonIntegerIndexSignal := ErrorSignal newSignalMayProceed:false.

        NonIntegerIndexSignal nameClass:self message:#nonIntegerIndexSignal.

        NonIntegerIndexSignal notifierString:'index must be integer'.

        UserNotificationSignal := QuerySignal new newSignalMayProceed:true.

        UserNotificationSignal nameClass:self message:#userNotificationSignal.

        UserNotificationSignal notifierString:'user notifiaction'.

        InformationSignal := UserNotificationSignal newSignalMayProceed:true.

        InformationSignal nameClass:self message:#informationSignal.

        InformationSignal notifierString:'information'.

        WarningSignal := UserNotificationSignal newSignalMayProceed:true.

        WarningSignal nameClass:self message:#warnungSignal.

        WarningSignal notifierString:'warning'.

        ActivityNotificationSignal := UserNotificationSignal newSignalMayProceed:true.

        ActivityNotificationSignal nameClass:self message:#activityNotificationSignal.

        ActivityNotificationSignal notifierString:'activity'.

        DeepCopyErrorSignal := ErrorSignal newSignalMayProceed:true.

        DeepCopyErrorSignal nameClass:self message:#deepCopyErrorSignal.

        DeepCopyErrorSignal notifierString:'object cannot be deepCopy-ed'.

        "

         AbortSignal is not a child of ErrorSignal -

         this would complicate abort from within a signal handler

        "

        AbortSignal := Signal new mayProceed:true.

        AbortSignal nameClass:self message:#abortSignal.

        AbortSignal notifierString:'unhandled abort signal'.

        Dependencies isNil ifTrue:[

            Dependencies := WeakIdentityDictionary new.

        ].

        NonWeakDependencies isNil ifTrue:[

            NonWeakDependencies := IdentityDictionary new.

        ]

    ].

    InfoPrinting := true

    "Object initialize"

    "Modified: 12.5.1996 / 14:10:40 / cg"

! !

!Object  class methodsFor:'Signal constants'!

abortSignal 

    "return the signal used to abort user actions. This signal is only

     raised if cought (by the debugger), and will lead way out of the

     currently active doIt/printIt or inspectIt. (also some others use

     this for a save abort)"

    ^ AbortSignal

!

activityNotificationSignal

    "return the signal used for activity notifications.

     A handler for this signal gets all #activityNotification: sends"

    ^ ActivityNotificationSignal

!

deepCopyErrorSignal 

    "return the signal raised when a deepcopy is asked for

     an object which cannot do this (for example, BlockClosures

     or Contexts)."

    ^ DeepCopyErrorSignal

!

elementOutOfBoundsSignal

    "return the signal used for element error reporting

     (this signal is used for example when a value not in 0..255 is to

      be put into a bytearray)"

    ^ ElementOutOfBoundsSignal

!

errorSignal

    "return the signal used for error/error: - handling"

    ^ ErrorSignal

!

exceptionInterruptSignal

    "return the signal used for exception (display errors) error handling"

    ^ ExceptionInterruptSignal

!

haltSignal

    "return the signal used for halt/halt: - handling"

    ^ HaltSignal

!

informationSignal 

    "return the signal used for informations. 

     A handler for this signal gets all #information: sends"

    ^ InformationSignal

!

keyNotFoundSignal 

    "return the signal used for no such key error reporting"

    ^ KeyNotFoundSignal

!

messageNotUnderstoodSignal

    "return the signal used for doesNotUnderstand: - error handling"

    ^ MessageNotUnderstoodSignal

!

nonIntegerIndexSignal 

    "return the signal used for bad subscript error reporting"

    ^ NonIntegerIndexSignal

!

notFoundSignal 

    "return the signal used for no element found error reporting"

    ^ NotFoundSignal

!

primitiveFailureSignal

    "return the signal used for primitiveFailed - error handling"

    ^ PrimitiveFailureSignal

!

privateMethodSignal

    "return the signal used for privateMethod - error handling"

    ^ MessageNotUnderstoodSignal

!

recursionInterruptSignal 

    "return the signal used for recursion overflow error handling"

    ^ RecursionInterruptSignal

!

subscriptOutOfBoundsSignal

    "return the signal used for subscript error reporting.

     (this signal is used for example when an array is accessed with an

      index less than 1 or greater than the array size)"

    ^ SubscriptOutOfBoundsSignal

!

userInterruptSignal

    "return the signal used for ^C interrupts handling"

    ^ UserInterruptSignal

!

userNotificationSignal

    "the parent signal used with information and warnings.

     Handling this allows handling of both information- and warning notifications."

    ^ UserNotificationSignal

!

warningSignal 

    "return the signal used for warnings.

     A handler for this signal gets all #warn: sends"

    ^ WarningSignal

! !

!Object  class methodsFor:'info messages'!

infoPrinting

    "return the flag which controls information messages."

    ^ InfoPrinting

!

infoPrinting:aBoolean

    "{ Pragma: +optSpace }"

    "turn on/off printing of information messages.

     If the argument, aBoolean is false, infoPrint will not output

     messages. The default is true."

    InfoPrinting := aBoolean

! !

!Object  class methodsFor:'queries'!

isBuiltInClass

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

     i.e. you cannot add/remove instance variables without recompiling

     the VM.

     Here, true is returned for myself, false for subclasses."

    ^ self == Object

    "Modified: 23.4.1996 / 16:00:07 / cg"

! !

!Object methodsFor:'accessing'!

at:index

    "return the indexed instance variable with index, anInteger;

     this method can be redefined in subclasses."

    ^ self basicAt:index

!

at:index put:anObject

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

     this method can be redefined in subclasses. Returns anObject (sigh)"

    ^ self basicAt:index put:anObject

    "Modified: 19.4.1996 / 11:13:29 / cg"

!

basicAt:index

    "return the indexed instance variable with index, anInteger.

     Trigger an error if the receiver has no indexed instance variables.

     This method should NOT be redefined in any subclass"

%{  /* NOCONTEXT */

    REGISTER int nbytes, indx;

    OBJ myClass;

    REGISTER char *pFirst;

    unsigned char *cp;

    unsigned short *sp;

    short *ssp;

    unsigned long *lp;

    long *slp;

    unsigned long ul;

    long l;

    OBJ *op;

/*    int nInstBytes, nInstVars, flags; */

    REGISTER int n;

    /*

     * notice the missing test for self being a nonNilObject -

     * this can be done since basicAt: is defined both in UndefinedObject

     * and SmallInteger

     */

    if (__isSmallInteger(index)) {

	myClass = __qClass(self);

	indx = __intVal(index) - 1;

	n /* nInstVars */ = __intVal(__ClassInstPtr(myClass)->c_ninstvars);

	n /* nInstBytes */ = OHDR_SIZE + __OBJS2BYTES__(n /* nInstVars */);

	nbytes = __qSize(self) - n /* nInstBytes */;

	pFirst = (char *)(__InstPtr(self)) + n /* nInstBytes */;

	/* 

	 * replaced switch by open-coded if; this is slightly faster 

	 * since it avoids the range check and also handles the most common case first

	 */

	n = (INT)(__ClassInstPtr(myClass)->c_flags) & __MASKSMALLINT(ARRAYMASK);

	if ((n == __MASKSMALLINT(POINTERARRAY))

	 || (n == __MASKSMALLINT(WKPOINTERARRAY))) {

	    if ((indx >= 0) && (indx < (__BYTES2OBJS__(nbytes)))) {

		op = (OBJ *)pFirst + indx;

		RETURN ( *op );

	    }

	} else if (n == __MASKSMALLINT(BYTEARRAY)) {

	    if ((indx >= 0) && (indx < (nbytes / sizeof(char)))) {

		cp = (unsigned char *)pFirst + indx;

		RETURN ( __MKSMALLINT(*cp & 0xFF) );

	    }

	} else if (n == __MASKSMALLINT(FLOATARRAY)) {

	    if ((indx >= 0) && (indx < (nbytes / sizeof(float)))) {

		float *fp;

		fp = (float *)pFirst + indx;

		RETURN ( __MKFLOAT((double)(*fp)) COMMA_CON );

	    }

	} else if (n == __MASKSMALLINT(DOUBLEARRAY)) {

	    if ((indx >= 0) && (indx < (nbytes / sizeof(double)))) {

		double *dp;

#ifdef NEED_DOUBLE_ALIGN

		/*

		 * care for filler