"

 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.

"

SimpleView subclass:#InspectorView

	instanceVariableNames:'listView workspace inspectedObject selectedLine nShown hasMore

		monitorProcess'

	classVariableNames:'DefaultIcon'

	poolDictionaries:''

	category:'Interface-Inspector'

!

!InspectorView 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.

"

!

documentation

"

    This class implements an graphical inspector.

    Inspecting can be done on an object -

    (where its instvarnames/values are inspected)

    or a list of objects (where a namearray/valuesarray is inspected).

    The later is used by the debugger to inspect method variables/args.

    The system calls the inspector through the global variable 'Inspector'

    which is bound to this class (but could be redefined - it actually is

    set to MiniInspector in a smalltalk without graphical user interface).

    Also notice, that there are two methods to inspect an object:

    sending #basicInspect to any object, will open this kind of inspector on 

    it (showing instance variables which are physically present).

    Sending it #inspect, will - depending on the object - sometimes invoke a

    specialized inspector. 

    (see OrderedCollectionInspectorView, ImageInspectorView etc. as examples).

    You can also open a monitoring inspector, which displays some instance

    variable in regular intervals. See #openOn:monitor:.

    examples:

            #(1 2 3 4) asOrderedCollection inspect

            #(1 2 3 4) asOrderedCollection basicInspect

            (Array new:10000) inspect

            (Image fromFile:'bitmaps/claus.gif') inspect

            (Image fromFile:'bitmaps/claus.gif') basicInspect

            (Image fromFile:'bitmaps/SBrowser.xbm') inspect

            (Image fromFile:'bitmaps/SBrowser.xbm') basicInspect

            InspectorView openOn:Display

            InspectorView openOn:Display monitor:'shiftDown'

    [author:]

        Claus Gittinger

"

! !

!InspectorView class methodsFor:'instance creation'!

for:anObject

    "create and launch a new inspector for anObject.

     This protocol is a historic leftover - this method will vanish."

    ^ self openOn:anObject

!

inspect:anObject

    "create and launch a new inspector for anObject.

     This protocol is a historic leftover - this method will vanish."

    ^ self openOn:anObject

!

openOn:anObject

    "create and launch a new inspector for anObject"

    ^ self openOn:anObject monitor:nil

    "

     InspectorView openOn:(5 @ 7)

     InspectorView openOn:(Array new:400)

     DictionaryInspectorView openOn:(IdentityDictionary new)

    "

    "Modified: 1.3.1996 / 19:31:03 / cg"

!

openOn:anObject monitor:anInstVarName

    "create and launch a new inspector for anObject.

     If anInstVarName is nonNil, let the inspector monitor it."

    |topView inspectorView|

    topView := StandardSystemView

                    label:(self labelFor:anObject)

                     icon:self defaultIcon

                minExtent:(100 @ 100).

    topView iconLabel:(self labelNameFor:anObject).

    topView extent:(Screen current extent // 3).

    inspectorView := self origin:(0.0 @ 0.0)

                          corner:(1.0 @ 1.0)

                             in:topView.

    "kludge: must realize first, to be able to set menu again"

    topView openAndWait.

    topView windowGroup focusSequence:(Array with:inspectorView listView

                                 with:inspectorView workspace).

    inspectorView inspect:anObject.

    anInstVarName notNil ifTrue:[

        inspectorView monitor:anInstVarName

    ].

    ^ inspectorView

    "

     |m|

     m := 1 asValue.

     InspectorView openOn:m monitor:'value'.

     Delay waitForSeconds:1.

     m value:2

    "

    "

     |o|

     o := Array with:1 with:2 with:3.

     InspectorView openOn:o monitor:'2'.

     Delay waitForSeconds:1.

     o at:2 put:20

    "

    "Created: 1.3.1996 / 19:30:50 / cg"

    "Modified: 1.3.1996 / 19:35:19 / cg"

! !

!InspectorView class methodsFor:'defaults'!

defaultIcon

    DefaultIcon isNil ifTrue:[

	DefaultIcon := Form fromFile:'Inspector.xbm' resolution:100

    ].

    ^ DefaultIcon

!

labelFor:anObject

    "return the windowLabel to use in my topView, when inspecting anObject."

    ^ self classResources 

	string:'Inspector on: %1' with:(self labelNameFor:anObject)

!

labelNameFor:anObject

    "return the iconLabel to use in my topView, when inspecting anObject.

     Simply returns the className or name of anObjects class"

    |nm|

    anObject isClass ifTrue:[

	nm := anObject displayString

    ].

    nm isNil ifTrue:[

	nm := anObject classNameWithArticle

    ].

    ^ nm

! !

!InspectorView methodsFor:'accessing'!

inspect:anObject

    "define the object to be inspected"

    |aList sameObject|

    sameObject := anObject == inspectedObject.

    inspectedObject := anObject.

    hasMore := false.

    aList := self fieldList.

    hasMore ifTrue:[

	aList add:' ... '

    ].

    sameObject ifTrue:[

	listView setContents:aList.

"/        listView selection:1.

    ] ifFalse:[

	listView contents:aList

    ].

    workspace contents:nil.

    self setDoItAction.

    selectedLine := nil

!

listView

    ^ listView

!

workspace

    ^ workspace

! !

!InspectorView methodsFor:'initialization'!

initialize

    |v panel|

    super initialize.

    panel := VariableHorizontalPanel 

		origin:(0.0 @ 0.0)

		corner:(1.0 @ 1.0)

		in:self.

    v := HVScrollableView 

		for:SelectionInListView 

		miniScrollerH:true

		miniScrollerV:false

		in:panel.

    v origin:(0.0 @ 0.0) corner:(0.3 @ 1.0).

    listView := v scrolledView.

    listView action:[:lineNr | self showSelection:lineNr].

    listView doubleClickAction:[:lineNr | self doInspect].

    listView ignoreReselect:false.

    listView menuHolder:self; menuPerformer:self; menuMessage:#fieldMenu.

    v := HVScrollableView 

		for:CodeView 

		miniScrollerH:true

		miniScrollerV:false

		in:panel.

    v origin:(0.3 @ 0.0) corner:(1.0 @ 1.0).

    workspace := v scrolledView.

    workspace acceptAction:[:theText | self doAccept:theText asString].

    nShown := 100.

    hasMore := false.

!

realize

    "delayed setup of lists till first map-time - 

     this makes startup of inspectors a bit faster"

    |o|

    super realize.

    inspectedObject notNil ifTrue:[

        "

         kludge to trick inspect:, which ignores setting the

         same object again ...

        "

        o := inspectedObject.

        inspectedObject := nil.

        self inspect:o

    ]

    "Created: 30.5.1996 / 09:38:37 / cg"

! !

!InspectorView methodsFor:'menu'!

fieldMenu

    |labels selectors m|

    hasMore ifTrue:[

        labels := #(

                      'inspect'

                      'basicInspect'

                      '-'

                      'browse'

                      'browse class hierarchy'

                      'browse full class protocol'

                      '-'

                      'trace messages'

                      'trap message'

                      'trap all messages'

                      'untrace/untrap'

                      '-'

                      'show more'

                   ).

        selectors := #(

                      doInspect 

                      doBasicInspect 

                      nil 

                      browse

                      browseClassHierarchy

                      browseFullClassProtocol

                      nil

                      doTrace

                      doTrapAll

                      doTrap

                      doUntrace

                      nil 

                      showMore

                      ).

    ] ifFalse:[

        labels := #(

                      'inspect'

                      'basicInspect'

                      '-'

                      'browse'

                      'browse class hierarchy'

                      'browse full class protocol'

                      '-'

                      'trace messages'

                      'trap message'

                      'trap all messages'

                      'untrace/untrap'

                   ).

        selectors := #(

                      doInspect 

                      doBasicInspect 

                      nil 

                      browse

                      browseClassHierarchy

                      browseFullClassProtocol

                      nil

                      doTrace

                      doTrap

                      doTrapAll

                      doUntrace

                      ).

    ].

    monitorProcess isNil ifTrue:[

        labels := labels , #('-' 'start monitor').

        selectors := selectors , #(nil #doStartMonitor).

    ] ifFalse:[

        labels := labels , #('-' 'stop monitor').

        selectors := selectors , #(nil #doStopMonitor).

    ].

"/    labels := labels , #('-' 'owners').

"/    selectors := selectors , #(nil #inspectOwners).

    m := PopUpMenu

          labels:(resources array:labels)

          selectors:selectors.

    selectedLine isNil ifTrue:[

        m disableAll:#(doInspect doBasicInspect 

                       browse browseClassHierarchy browseFullClassProtocol

                       doStartMonitor)

    ].

    ^ m

    "Modified: 12.4.1996 / 14:02:40 / cg"

! !

!InspectorView methodsFor:'menu actions'!

browse

    |objectToBrowseClass cls|

    selectedLine notNil ifTrue:[

        objectToBrowseClass := self valueAtLine:selectedLine.

    ] ifFalse:[

        objectToBrowseClass := inspectedObject

    ].

    cls := objectToBrowseClass class.

    cls browserClass openInClass:cls selector:nil

    "Created: 14.12.1995 / 19:15:50 / cg"

    "Modified: 3.5.1996 / 12:39:51 / cg"

!

browseClass

    |objectToBrowseClass cls|

    selectedLine notNil ifTrue:[

        objectToBrowseClass := self valueAtLine:selectedLine.

    ] ifFalse:[

        objectToBrowseClass := inspectedObject

    ].

    cls := objectToBrowseClass class.

    cls browserClass browseClass:cls

    "Modified: 3.5.1996 / 12:39:32 / cg"

!

browseClassHierarchy

    |objectToBrowseClass cls|

    selectedLine notNil ifTrue:[

        objectToBrowseClass := self valueAtLine:selectedLine.

    ] ifFalse:[

        objectToBrowseClass := inspectedObject

    ].

    cls := objectToBrowseClass class.

    cls browserClass browseClassHierarchy:cls

    "Modified: 3.5.1996 / 12:40:04 / cg"

!

browseFullClassProtocol

    |objectToBrowseClass cls|

    selectedLine notNil ifTrue:[

        objectToBrowseClass := self valueAtLine:selectedLine.

    ] ifFalse:[

        objectToBrowseClass := inspectedObject

    ].

    cls := objectToBrowseClass class.

    cls browserClass browseFullClassProtocol:cls

    "Modified: 3.5.1996 / 12:40:17 / cg"

!

doBasicInspect

    "user selected inspect-menu entry"

    self doInspect:true 

!

doInspect

    "user selected inspect-menu entry"

    self doInspect:false

!

doStartMonitor

    "start a monitoring process"

    monitorProcess isNil ifTrue:[

        monitorProcess :=

            [

                |sel|

                [true] whileTrue:[

                    (sel := selectedLine) notNil ifTrue:[

                        self showSelection:sel 

                    ].

                    (Delay forSeconds:0.5) wait

                ]

            ] forkAt:Processor userBackgroundPriority

    ]

    "Modified: 12.4.1996 / 14:20:06 / cg"

!

doStopMonitor

    "stop the monitor"

    monitorProcess terminate.

    monitorProcess := nil

!

doTrace

    "place a trace on all messages sent to the inspected object"

    self topView withWaitCursorDo:[MessageTracer traceAll:inspectedObject]

!

doTrap

    "place a trap on a message sent to the inspected object"

    |string selector|

    string := Dialog request:'Selector to trap on:' onCancel:nil.

    selector isNil ifTrue:[^ self].