"

 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.

"

CompiledCode subclass:#Block

	instanceVariableNames:'home nargs sourcePos initialPC'

	classVariableNames:'InvalidNewSignal'

	poolDictionaries:''

	category:'Kernel-Methods'

!

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.

"

!

documentation

"

    Blocks are pieces of executable code which can be evaluated by sending

    them a value-message (''value'', ''value:'', ''value:value:'' etc).

    In smalltalk, Blocks provide the basic (and heavily used) mechanism

    for looping, enumerating collection elements, visitors, exception

    handling, unwinding, delayed execution and processes.

    Blocks are never created explicitely; the only creation

    is done by the compilers, when some sourceCode is compiled to either

    machine or byteCode.

    Blocks with arguments need a message of type ''value:arg1 ... value:argn''

    for evaluation; the number of arguments passed when evaluating must match

    the number of arguments the block was declared with otherwise an error is

    raised. Blocks without args need a ''value'' message for evaluation.

    Blocks keep a reference to the context where the block was declared -

    this allows blocks to access the methods arguments and/or variables.

    This is still true after the method has returned - since the

    block keeps this reference, the methods context will NOT die in this case.

    (i.e. Blocks are closures in Smalltalk/X)

    A return (via ^-statement) out of a block will force a return from the

    blocks method context (if it is still living) - this make the implementation

    of long-jumps and control structures possible.

    (If the method is not alive (i.e. has already returned), a return out of the 

     block will trigger an error)

    Long-jump is done by defining a catchBlock as ''[^ self]''

    somewhere up in the calling-tree. Then, to do the long-jump from out of some 

    deeply nested method, simply do: ''catchBlock value''.

    [Instance variables:]

      home        <Context>         the context where this block was created (i.e. defined)

                                    this may be a blockContext or a methodContext

      nargs       <SmallInteger>    the number of arguments the block expects

      sourcePos   <SmallInteger>    the character position of its source, in chars

                                    relative to methods source beginning

      initialPC   <SmallInteger>    the start position within the byteCode

                                    for compiled blocks, this is nil.

    [Class variables:]

      InvalidNewSignal              raised if a Block is tried to be created

                                    with new (which is not allowed).

                                    Only the VM is allowed to create Blocks.

    NOTICE: layout known by runtime system and compiler - do not change

    [author:]

        Claus Gittinger

    [see also:]

        Process Context

        Collection

        ( contexts. blocks & unwinding : programming/contexts.html)

"

!

examples

"

    define a block and evaluate it:

                                                                        [exBegin]

        |b|

        b := [ Transcript showCR:'hello' ].

        Transcript showCR:'now evaluating the block ...'.

        b value.

                                                                        [exEnd]

    even here, blocks are involved: 

    (although, the compiler optimizes things if possible)

                                                                        [exBegin]

        Transcript showCR:'now evaluating one of two blocks ...'.

        1 > 4 ifTrue:[

            Transcript showCR:'foo'

        ] ifFalse:[

            Transcript showCR:'bar'

        ]

                                                                        [exEnd]

    here things become obvious:

                                                                        [exBegin]

        |yesBlock noBlock|

        yesBlock := [ Transcript showCR:'foo' ].

        noBlock := [ Transcript showCR:'bar' ].

        Transcript showCR:'now evaluating one of two blocks ...'.

        1 > 4 ifTrue:yesBlock

              ifFalse:noBlock

                                                                        [exEnd]

    simple loops:

      not very objectOriented:

                                                                        [exBegin]

        |i|

        i := 1.

        [i < 10] whileTrue:[

            Transcript showCR:i.

            i := i + 1

        ]

                                                                        [exEnd]

      using integer protocol:

                                                                        [exBegin]

        1 to:10 do:[:i |

            Transcript showCR:i.

        ]

                                                                        [exEnd]

      interval protocol:

                                                                        [exBegin]

        (1 to:10) do:[:i |

            Transcript showCR:i.

        ]

                                                                        [exEnd]

    looping over collections:

      bad code:

      (only works with numeric-indexable collections)

                                                                        [exBegin]

        |i coll|

        coll := #(9 8 7 6 5).

        i := 1.

        [i <= coll size] whileTrue:[

            Transcript showCR:(coll at:i).

            i := i + 1.

        ]

                                                                        [exEnd]

      just as bad (well, marginally better ;-):

      (only works with numeric-indexable collections)

                                                                        [exBegin]

        |coll|   

        coll := #(9 8 7 6 5).

        1 to:coll size do:[:i |

            Transcript showCR:(coll at:i).

        ]

                                                                        [exEnd]

      the smalltalk way:

      (works with any collection)

                                                                        [exBegin]

        |coll|   

        coll := #(9 8 7 6 5).

        coll do:[:element |

            Transcript showCR:element.

        ]

                                                                        [exEnd]

    Rule: use enumeration protocol of the collection instead of

          manually indexing it. [with few exceptions]

    processes:

      forking a lightweight process (thread):

                                                                        [exBegin]

        [

            Transcript showCR:'waiting ...'.

            Delay waitForSeconds:2.

            Transcript showCR:'here I am'.

        ] fork

                                                                        [exEnd]

      some with low prio:

                                                                        [exBegin]

        [

            Transcript showCR:'computing ...'.

            10000 factorial.

            Transcript showCR:'here I am'.

        ] forkAt:(Processor userBackgroundPriority)

                                                                        [exEnd]

    handling exceptions:

                                                                        [exBegin]

        Object errorSignal handle:[:ex |

            Transcript showCR:'exception handler forces return'.

            ex return

        ] do:[

            Transcript showCR:'now, doing something bad ...'.

            1 / 0.

            Transcript showCR:'not reached'

        ]

                                                                        [exEnd]

    performing cleanup actions:

                                                                        [exBegin]

        Object errorSignal handle:[:ex |

            Transcript showCR:'exception handler forces return'.

            ex return

        ] do:[

            [

                Transcript showCR:'doing something bad ...'.

                1 / 0.

                Transcript showCR:'not reached'

            ] valueOnUnwindDo:[

                Transcript showCR:'cleanup'

            ]

        ]

                                                                        [exEnd]

    delayed execution (visitor pattern):

    (looking carefully into the example, 

     C/C++ programmers may raise their eyes ;-)

                                                                        [exBegin]

        |showBlock countBlock 

         howMany 

         top panel b1 b2|

        howMany := 0.

        showBlock := [ Transcript showCR:howMany ].

        countBlock := [ howMany := howMany + 1 ].

        top := StandardSystemView extent:200@200.

        panel := HorizontalPanelView origin:0.0@0.0 corner:1.0@1.0 in:top.

        b1 := Button label:'count up' in:panel.

        b1 action:countBlock.

        b2 := Button label:'show value' in:panel.

        b2 action:showBlock.

        top open.

        Transcript showCR:'new process started;'.

        Transcript showCR:'notice: the blocks can still access the'.

        Transcript showCR:'        howMany local variable.'.

                                                                        [exEnd]

"

! !

initialize

    "create signals raised by various errors"

    InvalidNewSignal isNil ifTrue:[

        InvalidNewSignal := ErrorSignal newSignalMayProceed:false.

        InvalidNewSignal nameClass:self message:#invalidNewSignal.

        InvalidNewSignal notifierString:'blocks are only created by the system'.

    ]

    "Modified: 22.4.1996 / 16:34:20 / cg"

! !

    "create a new cheap (homeless) block.

     Not for public use - this is a special hook for the compiler."

    |newBlock|

    newBlock := (super basicNew:(literals size)) 

                           byteCode:bCode

                           numArgs:numArgs

                     sourcePosition:sourcePos

                          initialPC:initialPC

    ^ newBlock

    "Modified: 24.6.1996 / 12:36:48 / stefan"

!

new

    "catch creation of blocks - only the system creates blocks"

    ^ InvalidNewSignal raise.

!

new:size

    "catch creation of blocks - only the system creates blocks"

    ^ InvalidNewSignal raise.

! !

isBuiltInClass

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

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

    ^ self == Block

    "Modified: 23.4.1996 / 15:55:58 / cg"

!

maxNumberOfArguments

    "return the maximum number of arguments a block can have.

     This is a limit in the VM, which may be removed in one of 

     the next versions ..."

%{  /* NOCONTEXT */

    RETURN (__MKSMALLINT(MAX_METHOD_ARGS));

%}

! !

!Block methodsFor:'STV compatibility'!

on:aSignal do:exceptionBlock

    "added for ST/V compatibility; evaluate the receiver,

     handling aSignal. The argument, exceptionBlock is evaluated

     if the signal is raised during evaluation.

     Warning: no warranty, if the code below mimics ST/V's behavior

     correctly - give me a note if it does not ."

    aSignal handle:[:ex |

	exceptionBlock value.

	ex return

    ] do:self

    "

     [

	1 foo

     ] on:MessageNotUnderstoodSignal do:[]

    "

! !

!Block methodsFor:'accessing'!

home

    "return the receivers home context (the context where it was

     created). For cheap blocks, nil is returned"

    ^ home

!

method

    "return the receivers method 

     (the method where the block was created)."

    home notNil ifTrue:[

	^ home method

    ].

    ^ nil

!

methodHome

    "return the receivers method home context (the context where it was

     defined). For cheap blocks, nil is returned"

    home notNil ifTrue:[

	^ home methodHome

    ].

    ^ home

!

numArgs

    "return the number of arguments I expect for evaluation"

    ^ nargs

! !

!Block methodsFor:'copying'!

deepCopy

    "raise an error - deepCopy is not allowed for blocks"

    ^ self deepCopyError

! !

!Block methodsFor:'error handling'!

invalidCodeObject

    "this error is triggered by the interpreter when a non-Block object

     is about to be executed.

     In this case, the VM sends this to the bad method (the receiver).

     Can only happen when the Compiler/runtime system is broken or

     someone played around."

    ^ InvalidCodeSignal

	raiseRequestWith:self

	errorString:'invalid block - not executable'

!

wrongNumberOfArguments:numberGiven

    "report that the number of arguments given does not match the number expected"

    ^ ArgumentSignal

	raiseRequestWith:self

	errorString:('block got ' , numberGiven printString ,

		     ' args while ' , nargs printString , ' where expected')

! !

!Block methodsFor:'evaluation'!

value

    "evaluate the receiver with no block args. 

     The receiver must be a block without arguments."

%{  /* NOCONTEXT */

    REGISTER OBJFUNC thecode;

    OBJ home;

    if (__INST(nargs) == __MKSMALLINT(0)) {

#if defined(THIS_CONTEXT)

	if (__ISVALID_ILC_LNO(__pilc))

	    __ContextInstPtr(__thisContext)->c_lineno = __ILC_LNO_AS_OBJ(__pilc);

#endif

	thecode = __BlockInstPtr(self)->b_code;

#ifdef NEW_BLOCK_CALL

	if (thecode != (OBJFUNC)nil) {

	    /* compiled machine code */

	    RETURN ( (*thecode)(self, COMMA_SND) );

	}

	/* interpreted code */

# ifdef PASS_ARG_POINTER

	RETURN ( __interpret(self, 0, nil, nil COMMA_SND, nil, nil) );

# else

	RETURN ( __interpret(self, 0, nil, nil COMMA_SND, nil, nil) );