"

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

"

"{ Package: 'stx:libtool' }"

InspectorView subclass:#DictionaryInspectorView

	instanceVariableNames:'keys hideClassVars hideClasses hideUnloadedClasses hideAliases

		hideNilValues hideLiteralValues'

	classVariableNames:''

	poolDictionaries:''

	category:'Interface-Inspector'

!

!DictionaryInspectorView class methodsFor:'documentation'!

copyright

"

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

"

    a modified Inspector for Dictionaries

    [author:]

        Claus Gittinger

"

! !

!DictionaryInspectorView methodsFor:'event handling'!

keyPress:key x:x y:y

    "handle special keys"

    <resource: #keyboard (#Delete #BackSpace #Insert)>

    (key == #Delete or:[key == #BackSpace]) ifTrue:[

        self doRemoveKey.

        ^ self.

    ].

    (key == #Insert) ifTrue:[

        self doAddKey.

        ^ self.

    ].

    super keyPress:key x:x y:y

! !

!DictionaryInspectorView methodsFor:'initialization & release'!

initialize

    super initialize.

    listView multipleSelectOk:true.

    hideClassVars := false.

    hideClasses := false.

    hideUnloadedClasses := false.

    hideAliases := false.

    hideLiteralValues := false.

    hideNilValues := false.

! !

!DictionaryInspectorView methodsFor:'menu'!

fieldMenu

    <resource: #programMenu >

    |items m selIdx|

    inspectedObject isNameSpace ifTrue:[

        items := #(

                       ('Copy Key'             doCopyKey      )

                       ('-')

                       ('Inspect'              doInspect      )

                       ('Inspect Key'          doInspectKey   )

                       ('BasicInspect'         doBasicInspect )

             ).

    NewInspector::NewInspectorView notNil ifTrue:[

        items := items , #(

                       ('Inspect Hierarchical'         #doNewInspect           )

                ).

    ].

    items := items , #(

                       ('-')

                       ('Owners'               showOwners     )

                       ('Ref Chains'           showReferences )

                       ('References to Global' showKeyReferences )

                       ('-')

                       ('Browse'               browse         )

                       ('-')

                       ('Add Key...'           doAddKey       )

                       ('Remove Key'           doRemoveKey    )

                       ('-')

                   ).

        hideClassVars == true ifTrue:[

            items := items , #(

                           ('Show ClassVars'   doShowClassVars )

                       ).

        ] ifFalse:[

            items := items , #(

                           ('Hide ClassVars'   doHideClassVars )

                       ).

        ].

        hideClasses == true ifTrue:[

            items := items , #(

                           ('Show Classes'     doShowClasses )

                       ).

        ] ifFalse:[

            items := items , #(

                           ('Hide Classes'     doHideClasses )

                       ).

        ].

        hideUnloadedClasses == true ifTrue:[

            items := items , #(

                           ('Show Unloaded Classes'     doShowUnloadedClasses )

                       ).

        ] ifFalse:[

            items := items , #(

                           ('Hide UnloadedClasses'     doHideUnloadedClasses )

                       ).

        ].

        hideAliases == true ifTrue:[

            items := items , #(

                           ('Show Aliases'     doShowAliases )

                       ).

        ] ifFalse:[

            items := items , #(

                           ('Hide Aliases'     doHideAliases )

                       ).

        ].

        hideLiteralValues == true ifTrue:[

            items := items , #(

                           ('Show Literal Values'  doShowLiteralValues )

                       ).

        ] ifFalse:[

            items := items , #(

                           ('Hide Literal Values'  doHideLiteralValues )

                       ).

        ].

        hideNilValues == true ifTrue:[

            items := items , #(

                           ('Show Nil Values'  doShowNilValues )

                       ).

        ] ifFalse:[

            items := items , #(

                           ('Hide Nil Values'  doHideNilValues )

                       ).

        ].

    ] ifFalse:[

        items := #(

                       ('Copy Key'             doCopyKey      )

                       ('-')

                       ('Inspect'              doInspect      )

                       ('Inspect Key'          doInspectKey   )

                       ('BasicInspect'         doBasicInspect )

                       ('Inspect Hierarchical' doNewInspect   )

                       ('-')

                       ('Owners'               showOwners     )

                       ('Ref Chains'           showReferences )

                       ('Ref Chains to Key'    showReferencesToKey )

                       ('-')

                       ('Browse'                       browse                 )

                       ('Browse Class Hierarchy'       browseClassHierarchy   )

                       ('Browse Full Class Protocol'   browseFullClassProtocol)

                       ('-')

                       ('Add Key...'           doAddKey       )

                       ('Remove Key'           doRemoveKey    )

                   ).

    ].

    monitorProcess isNil ifTrue:[

        items := items , #(

                       ('-')

                       ('Start Monitor'    doStartMonitor )

                          ).

    ] ifFalse:[

        items := items , #(

                       ('-')

                       ('Stop Monitor'     doStopMonitor  )

                          ).

    ].

    items := items , (self sortOrderItems).

    items := items , #(

                   ('-')

                   ('Update'     doUpdate  )

                      ).

    m := PopUpMenu itemList:items resources:resources.

    (inspectedObject isNameSpace or:[inspectedObject isSharedPool]) ifTrue:[

        m disableAll:#( doAddKey )

    ].

    (inspectedObject isSharedPool) ifTrue:[

        m disableAll:#( doRemoveKey )

    ].

    (selIdx := self theSingleSelectionIndex) isNil ifTrue:[

        m disableAll:#(doInspect doInspectKey doBasicInspect doNewInspect

                       doStartMonitor doStopMonitor doCopyKey 

                       showKeyReferences showReferences showOwners browse

                      ).

        selectionIndex isEmptyOrNil ifTrue:[

            "/ allowed for multi-select

            m disableAll:#( doRemoveKey )

        ]

    ] ifFalse:[

        (self keyIndexForLine:selIdx) isNil ifTrue:[

            m disableAll:#(doInspectKey doRemoveKey doCopyKey)

        ]

    ].

    hideLiteralValues == true ifTrue:[

        m disableAll:#( doShowNilValues doHideNilValues )

    ].

    ^ m.

    "Modified: / 26-09-2012 / 13:20:59 / cg"

! !

!DictionaryInspectorView methodsFor:'menu actions'!

browse

    |cls|

    cls := self selection class theNonMetaclass.

"/    cls isNameSpace ifTrue:[

"/        self halt.

"/    ].

    cls browserClass openInClass:cls selector:nil

!

doAddKey

    "add a key"

    |keyName key val l|

    keyName := Dialog request:'Key to add (storeString):' initialAnswer:''.

    keyName notEmptyOrNil ifTrue:[

        key := Object readFrom:keyName onError:[ self information:'Bad input.'. ^ self].

        (inspectedObject includesKey:key) ifFalse:[

            val := Dialog request:'Value to add (storeString):' initialAnswer:''.

            val notNil ifTrue:[

                val := Object readFrom:val onError:[ self information:'Bad input.'. ^ self].

            ].

            inspectedObject at:key put:val.

            selectionIndex := selectedLine := nil.

            inspectedObject changed.

            l := listView firstLineShown.

            self reinspect. "force list update"

            listView scrollToLine:l

        ]

    ]

    "Modified: / 01-07-2010 / 10:53:25 / cg"

!

doHideAliases

    hideAliases := true.

    self reinspect

!

doHideClassVars

    hideClassVars := true.

    self reinspect

!

doHideClasses

    hideClasses := true.

    self reinspect

!

doHideLiteralValues

    hideLiteralValues := true.

    self reinspect

!

doHideNilValues

    hideNilValues := true.

    self reinspect

!

doHideUnloadedClasses

    hideUnloadedClasses := true.

    self reinspect

!

doInspectKey

    "inspect selected items key"

    |key|

    key := self selectedKey.

    key notNil ifTrue:[

        key inspect

    ]

!

doRemoveKey

    "remove selected item from keys"

    |l|

    listView withWaitCursorDo:[

        self selectedKeys do:[:key |

            (inspectedObject includesKey:key) ifTrue:[

                inspectedObject removeKey:key

            ]

        ].

        keys := nil.

        selectionIndex := selectedLine := nil.

        inspectedObject changed.

    ].

    l := listView firstLineShown.

    self reinspect. "force list update"

    listView scrollToLine:l.

!

doShowAliases

    hideAliases := false.

    self reinspect

!

doShowClassVars

    hideClassVars := false.

    self reinspect

!

doShowClasses

    hideClasses := false.

    self reinspect

!

doShowLiteralValues

    hideLiteralValues := false.

    self reinspect

!

doShowNilValues

    hideNilValues := false.

    self reinspect

!

doShowUnloadedClasses

    hideUnloadedClasses := false.

    self reinspect

!

showKeyReferences

    "show users of selected key (i.e. global).

     Only useful when inspecting smalltalk"

    |key|

    key := self selectedKey.

    key notNil ifTrue:[

        self topView withWaitCursorDo:[

            UserPreferences systemBrowserClass browseReferendsOf:(key asSymbol)

        ].

    ]

!

showReferencesToKey

    self selectedKey class hasImmediateInstances ifTrue:[

        ^ self warn:'Sorry - cannot show references to immediate objects'

    ].

    ObjectMemory displayRefChainTo:(self selectedKey)

! !

!DictionaryInspectorView methodsFor:'private'!

allNumericKeys

    inspectedObject keysDo:[:k | k isNumber ifFalse:[^ false]].

    ^ true

    "Created: / 10-05-2011 / 08:05:45 / cg"

!

baseInspectedObjectClass

    (inspectedObject isMemberOf:Dictionary) ifFalse:[

        (inspectedObject class inheritsFrom:Dictionary) ifFalse:[

            "this is true for e.g. MethodDictionary"

            ^ Object

        ]

    ].

    ^ Dictionary

    "Modified: / 23.7.1999 / 10:39:11 / stefan"

!

defaultLabel

    ^ 'Keys'

    "Created: 28.6.1996 / 19:46:51 / cg"

!

indexList

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

     Set hasMore to true, if a '...' entry should be added."

    |sortBlockForKeys allShown|

    allShown := inspectedObject size <= nShown.

    (allShown and:[self allNumericKeys]) ifTrue:[

        sortBlockForKeys := [:a :b | a < b].

    ] ifFalse:[

        sortBlockForKeys := [:a :b | a displayString < b displayString].

    ].

    (inspectedObject isNameSpace 

    or:[inspectedObject isSharedPool]) ifTrue:[

        ^ self indexListForNameSpace.

    ].

    "/ do not use 'inspectedObject keys',

    "/ since Sets cannot hold nils (which are now valid keys)

    allShown ifFalse:[

        keys := (SortedCollection new:nShown) sortBlock:sortBlockForKeys.

        inspectedObject keysDo:[:k | 

            keys add:k.

            keys size >= nShown ifTrue:[ 

                hasMore := true.

                ^ keys

            ].

        ].

    ].

    keys := OrderedCollection new.

    inspectedObject keysDo:[:k | keys add:k].

    keys := keys asSortedCollection:sortBlockForKeys.

    ^ keys

    "Modified: / 10-05-2011 / 08:14:59 / cg"

!

indexListForNameSpace

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

     Set hasMore to true, if a '...' entry should be added."

    keys := SortedCollection new:1000.

    inspectedObject keysDo:[:k |

        |hidden i o|

        hidden := false.

        hideClassVars == true ifTrue:[

            (i := k lastIndexOf:$:) ~~ 0 ifTrue:[

                (i > 1 and:[(k at:i-1) ~~ $:]) ifTrue:[

                    hidden := true

                ].

            ].

        ].

        (hidden not and:[hideNilValues == true]) ifTrue:[

            o isNil ifTrue:[ o := inspectedObject at:k ifAbsent:nil ].