"

 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

!

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

    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 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"

    |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 open.

    inspectorView inspect:anObject.

    ^ inspectorView

    "

     InspectorView openOn:(5 @ 7)

     InspectorView openOn:(Array new:400)

     DictionaryInspectorView openOn:(IdentityDictionary new)

    "

! !

!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

! !

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

!

mapped

    "delayed setup of lists till map-time - 

     this makes startup of inspectors a bit faster"

    |o|

    super mapped.

    "

     kludge to trick inspect:, which ignores setting the

     same object again ...

    "

    o := inspectedObject.

    inspectedObject := nil.

    self inspect:o

! !

!InspectorView methodsFor:'menu'!

fieldMenu

    |labels selectors|

    hasMore ifTrue:[

    ] ifFalse:[

    ].

    monitorProcess isNil ifTrue:[

    ] ifFalse:[

    ].

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

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

    ^ PopUpMenu

! !

!InspectorView methodsFor:'private'!

fieldList 

    "return a list of names to show in the selectionList.

     Leave hasMore as true, if a '...' entry should be added."

    |aList n cls s|

    aList := OrderedCollection new.

    aList add:'self'.

    cls := inspectedObject class.

    cls isClass ifTrue:[

	cls allInstVarNames do:[:instVarName |

	    aList add:instVarName

	]

    ] ifFalse:[

	1 to:cls instSize do:[:index |

	    aList add:('instvar' , index printString)

	]

    ].

    cls isVariable ifTrue:[

	n := inspectedObject basicSize.

	(n > nShown) ifTrue:[

	    n := nShown.

	    hasMore := true.

	].

	(inspectedObject respondsTo:#keys) ifTrue:[

	    s := ReadStream on:(inspectedObject keys).

	    1 to:n do:[:index |

		aList add:(s next printString)

	    ]

	] ifFalse:[

	    1 to:n do:[:index |

		aList add:(index printString)

	    ]

	].

    ].

    ^ aList

!

setDoItAction

    workspace doItAction:[:theCode |

	(inspectedObject class evaluatorClass) 

	    evaluate:theCode 

	    in:nil 

	    receiver:inspectedObject 

	    notifying:workspace 

	    logged:true 

	    ifFail:nil 

    ].

!

showMore

    hasMore ifTrue:[

	nShown := nShown * 2.

	self inspect:inspectedObject

    ]

! !

!InspectorView methodsFor:'release'!

release

    "release inpected object. This is normally not needed,

     since the garbage collector will find this memory alone.

     However, if some applications keeps invisible inspectors around

     (for example, the debugger does this), the inspected object

     would be kept from being freed or freed very late."

"

    inspectedObject notNil ifTrue:[

	inspectedObject removeDependent:self

    ].

"

    inspectedObject := nil.

    self setDoItAction.      "/ to release ref to inspectedObject in doItBlock

    workspace contents:nil.

    listView contents:nil

! !

!InspectorView methodsFor:'user interaction'!

browseClass

    |objectToBrowseClass|

    selectedLine notNil ifTrue:[

	objectToBrowseClass := self valueAtLine:selectedLine.

    ] ifFalse:[

	objectToBrowseClass := inspectedObject

    ].

    SystemBrowser browseClass:objectToBrowseClass class

!

browseClassHierarchy

    |objectToBrowseClass|

    selectedLine notNil ifTrue:[

	objectToBrowseClass := self valueAtLine:selectedLine.

    ] ifFalse:[

	objectToBrowseClass := inspectedObject

    ].

    SystemBrowser browseClassHierarchy:objectToBrowseClass class

!

browseFullClassProtocol

    |objectToBrowseClass|

    selectedLine notNil ifTrue:[

	objectToBrowseClass := self valueAtLine:selectedLine.

    ] ifFalse:[

	objectToBrowseClass := inspectedObject

    ].

    SystemBrowser browseFullClassProtocol:objectToBrowseClass class

!

destroy

    inspectedObject := nil.

    monitorProcess notNil ifTrue:[

	monitorProcess terminate

    ].

    super destroy

!

doAccept:theText

    |value index|

    value := inspectedObject class evaluatorClass 

		 evaluate:theText

		 receiver:inspectedObject 

		 notifying:workspace.

    selectedLine notNil ifTrue:[

	selectedLine == 1 ifFalse:[

	    index := selectedLine - 1.

	    (inspectedObject class isVariable) ifFalse:[

		inspectedObject instVarAt:index put:value

	    ] ifTrue:[

		index <= (inspectedObject class instSize) ifTrue:[

		    inspectedObject instVarAt:index put:value

		] ifFalse:[

		    index := index - inspectedObject class instSize.

		    inspectedObject basicAt:index put:value

		]

	    ]

	]

    ].

    inspectedObject changed

!

doBasicInspect

    "user selected inspect-menu entry"

    self doInspect:true 

!

doInspect