"

 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 labelView workspace inspectedObject selectedLine nShown

		hasMore monitorProcess hideReceiver showHex'

	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 a 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,

    or to NewInspector if that is wanted).

    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, 

     ColorInspectorView 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'.

     2 to:10 do:[:i |

         Delay waitForSeconds:1.

         m value:i

     ]

    "

    "

     |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: 11.12.1996 / 17:07:17 / cg"

! !

!InspectorView class methodsFor:'defaults'!

defaultIcon

    "return the browsers default window icon"

    <resource: #style (#ICON #ICON_FILE)>

    |nm i|

    (i := DefaultIcon) isNil ifTrue:[

        i := self classResources at:'ICON' default:nil.

        i isNil ifTrue:[

            nm := ClassResources at:'ICON_FILE' default:'Inspector.xbm'.

            i := Image fromFile:nm resolution:100.

            i isNil ifTrue:[

                i := Image fromFile:('bitmaps/' , nm) resolution:100.

                i isNil ifTrue:[

                    i := StandardSystemView defaultIcon

                ]

            ]

        ].

        i notNil ifTrue:[

            DefaultIcon := i := i on:Display

        ]

    ].

    ^ i

    "Modified: 18.4.1997 / 15:16:53 / cg"

!

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'!

hideReceiver:aBoolean

    hideReceiver := aBoolean

    "Created: 28.6.1996 / 15:08:32 / cg"

!

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

!

label:aString

    labelView label:aString

    "Created: 28.6.1996 / 15:30:26 / cg"

!

listView

    ^ listView

!

workspace

    ^ workspace

! !

!InspectorView methodsFor:'initialization'!

initialize

    |v panel helpView labelView2|

    super initialize.

    hideReceiver := false.

    showHex := false.

    panel := VariableHorizontalPanel 

                origin:(0.0 @ 0.0)

                corner:(1.0 @ 1.0)

                in:self.

    helpView := View origin:(0.0 @ 0.0) corner:(0.3 @ 1.0) in:panel.

    helpView level:0; borderWidth:0.

    labelView := Label origin:0.0@0.0 corner:1.0@0.0 in:helpView.

    labelView label:(self defaultLabel).

    labelView bottomInset:(labelView preferredExtent y negated).

    v := HVScrollableView 

                for:SelectionInListView 

                miniScrollerH:true

                miniScrollerV:false

                in:helpView.

    v autoHideScrollBars:true.

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

    v topInset:(labelView preferredExtent y).

    listView := v scrolledView.

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

    listView doubleClickAction:[:lineNr | self doInspect].

    listView ignoreReselect:false.

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

    helpView := View origin:(0.3 @ 0.0) corner:(1.0 @ 1.0) in:panel.

    helpView level:0; borderWidth:0.

    labelView2 := Label origin:0.0@0.0 corner:1.0@0.0 in:helpView.

    labelView2 label:''.

    labelView2 bottomInset:(labelView preferredExtent y negated).

    v := HVScrollableView 

                for:CodeView 

                miniScrollerH:true

                miniScrollerV:true

                in:helpView.

    v autoHideScrollBars:true.

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

    v topInset:(labelView2 preferredExtent y).

    workspace := v scrolledView.

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

    nShown := 100.

    hasMore := false.

    "Modified: / 7.5.1998 / 01:49:38 / cg"

!

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

    "return the menu for the field-list"

    <resource: #programMenu>

    |items labels selectors m|

    items := #(

                        ('inspect'                      #doInspect              )

                        ('basicInspect'                 #doBasicInspect         )

                        ('inspect hierarchical'         #doNewInspect           )

                        ('-')

                        ('browse'                       #browse                 )

                        ('browse class hierarchy'       #browseClassHierarchy   )

                        ('browse full class protocol'   #browseFullClassProtocol)

                        ('-')

                        ('trace messages'               #doTrace                )

                        ('trap message'                 #doTrapAll              )

                        ('trap all messages'            #doTrap                 )

                        ('untrace/untrap'               #doUntrace              )

              ).

    hasMore ifTrue:[

        items := items , #(

                        ('-')

                        ('show more'                    #showMore               )

                          )

    ].

    monitorProcess isNil ifTrue:[

        items := items , #(

                        ('-')

                        ('start monitor'                #doStartMonitor         )

                          ).

    ] ifFalse:[

        items := items , #(

                        ('-')

                        ('stop monitor'                #doStopMonitor           )

                          ).

    ].

    showHex ifTrue:[

        items := items , #(

                        ('-')

                        ('decimal integers'  #toggleHex               )

                          )

    ] ifFalse:[

        items := items , #(

                        ('-')

                        ('hex integers'      #toggleHex               )

                          )

    ].

    m := PopUpMenu

          itemList:items

          resources:resources.

    selectedLine isNil ifTrue:[

        m disableAll:#(doInspect doBasicInspect doNewInspect

                       browse browseClassHierarchy browseFullClassProtocol

                       doStartMonitor)

    ].

    ^ m

    "Modified: / 7.5.1998 / 19:37:50 / 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"