"

 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.

"

ApplicationModel subclass:#SystemBrowser

	instanceVariableNames:'currentClass currentMethodCategory currentMethod currentSelector

		showInstance actualClasslastMethodCategory aspect lockUpdates

		autoSearch myLabel acceptClass'

	classVariableNames:'CheckForInstancesWhenRemovingClasses'

	poolDictionaries:''

	category:'Interface-Browsers'

!

!SystemBrowser 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 all kinds of class browsers.

    Typically, it is started with 'SystemBrowser open', but there are many other 

    startup messages, to launch special browsers.

    See the categories 'startup' and 'special search startup' in the classes

    protocol.

    Alse, see the extra document 'doc/misc/sbrowser.doc' or the HTML online doc

    for how to use the browser.

    written winter 89 by claus.

    Notice: SystemBrowser is currently being rewritten to be an instance

    of ApplicationModel - this transition is not yet complete and you see

    here an intermediate version. The instance variables defined here are NOT

    currently used - instead, everything is really done in the BrowserView

    which (currently) keeps the real state of the browser.

    This will certainly change ...

    [author:]

        Claus Gittinger

"

! !

!SystemBrowser class methodsFor:'initialization'!

initialize

    "Browser configuration;

     (values can be changed from your private startup file)"

"/    self classResources.

    "

     setting this to false, the removeClass function will remove

     classes WITHOUT checking for instances. Otherwise,

     it will check and let you confirm in case there are instances.

     Checking for instances may be a bit time consuming, though.

     The default is true - therefore, it will check

    "

    CheckForInstancesWhenRemovingClasses := true

    "

     CheckForInstancesWhenRemovingClasses := true

     CheckForInstancesWhenRemovingClasses := false

     SystemBrowser initialize

    "

! !

!SystemBrowser class methodsFor:'instance creation'!

open

    "launch a standard browser"

    ^ self openOnDevice:(Screen current) 

    "

     SystemBrowser open

    "

!

openInClass:aClass selector:aSelector

    "launch a standard browser which immediately switches

     to aClass>>aSelector."

    |brwsr cls|

    brwsr := self openOnDevice:(Screen current).

    brwsr waitUntilVisible.

    cls := aClass.

    cls notNil ifTrue:[

	cls isMeta ifTrue:[

	    cls := aClass soleInstance

	].

	brwsr switchToClassNamed:cls name. 

	brwsr updateClassCategoryList.

	aClass isMeta ifTrue:[

	    brwsr instanceProtocol:false

	].

	brwsr updateMethodCategoryList.

	aSelector notNil ifTrue:[

	    brwsr switchToMethodNamed:aSelector.

	]

    ].

    ^ brwsr

    "

     SystemBrowser openInClass:Object selector:#at:put:

     SystemBrowser openInClass:Object selector:nil

     SystemBrowser openInClass:nil selector:nil

    "

    "Created: 22.11.1995 / 21:04:50 / cg"

!

openOnDevice:aDisplay

    "launch a standard browser on another display."

    ^ self newWithLabel:(self classResources string:'System Browser')

	     setupBlock:[:browser | browser setupForAll]

	      onDevice:aDisplay

    "|d|

     d := XWorkstation new initializeFor:'porty:0'.

     d startDispatch.

     SystemBrowser openOnDevice:d

    "

! !

!SystemBrowser class methodsFor:'private helpers'!

showNoneFound

    super warn:(self classResources string:'None found').

!

showNoneFound:what

    super warn:(self classResources string:(what , '...\\... none found') withCRs).

! !

!SystemBrowser class methodsFor:'private instance creation'!

newWithLabel:aString setupBlock:aBlock

    "common helper method for all creation methods"

    ^ self newWithLabel:aString setupBlock:aBlock onDevice:Screen current

!

newWithLabel:aString setupBlock:aBlock onDevice:aWorkstation

    "common helper method for all creation methods"

    |newBrowser|

    newBrowser := BrowserView onDevice:aWorkstation.

    newBrowser title:aString.

    aBlock value:newBrowser.

    newBrowser open.

    ^ newBrowser

!

newWithLabel:aString setupSelector:aSymbol arg:arg

    "common helper method for all creation methods"

    ^ self newWithLabel:aString setupSelector:aSymbol arg:arg onDevice:Screen current 

!

newWithLabel:aString setupSelector:aSymbol arg:arg onDevice:aWorkstation

    "common helper method for all creation methods"

    |newBrowser|

    newBrowser := BrowserView onDevice:aWorkstation.

    newBrowser title:aString.

    newBrowser perform:aSymbol with:arg.

    newBrowser open.

    ^ newBrowser

! !

!SystemBrowser class methodsFor:'special search startup'!

aproposSearch:aString

    "browse all methods, which have aString in their selector or

     in the methods comment.

     This is relatively slow, since all source must be processed."

    ^ self aproposSearch:aString in:(Smalltalk allClasses)

!

aproposSearch:aString in:aCollectionOfClasses

    "browse all methods, which have aString in their selector or

     in the methods comment.

     This is relatively slow, since all source must be processed."

    |matchString list s searchBlock browser|

    matchString := '*' , aString , '*'.

    list := OrderedCollection new.

    (aString includesMatchCharacters) ifTrue:[

        s := '*' , aString , '*'.

        "a matchString"

        searchBlock := [:text | (text asCollectionOfLinesfindFirst:[:line | s match:line]) ~~ 0].

    ] ifFalse:[

        searchBlock := [:source | (source findString:aString) ~~ 0]

    ].

    browser := self browseMethodsIn:aCollectionOfClasses 

                     where:[:class :method :sel |

                                |comment|

                                Processor yield.

                                (searchBlock value:sel) ifTrue:[

                                    true

                                ] ifFalse:[

                                    comment := method comment.

                                    comment notNil 

                                    and:[searchBlock value:method comment]

                                ].

                           ]

                     title:(ClassResources string:'apropos: %1' with:aString).

    browser notNil ifTrue:[

        browser autoSearch:aString 

    ].

    ^ browser

    "

     SystemBrowser aproposSearch:'append' in:(Collection withAllSubclasses)

     SystemBrowser aproposSearch:'add'    in:(Collection withAllSubclasses)

     SystemBrowser aproposSearch:'sort'   in:(Collection withAllSubclasses)

     SystemBrowser aproposSearch:'[Aa]bsent' in:(Collection withAllSubclasses)

    "

    "Created: 9.12.1995 / 18:02:36 / cg"

!

browseAllCallsOn:aSelectorString

    "launch a browser for all senders of aSelector"

    ^ self browseAllCallsOn:aSelectorString 

                         in:(Smalltalk allClasses)

                      title:(self classResources string:'senders of: %1' with:aSelectorString)

    "

     SystemBrowser browseAllCallsOn:#+

    "

    "Created: 9.12.1995 / 18:00:41 / cg"

    "Modified: 9.12.1995 / 18:10:57 / cg"

!

browseAllCallsOn:aSelectorString in:aCollectionOfClasses title:title

    "launch a browser for all senders of aSelector in aCollectionOfClasses"

    |sel browser searchBlock|

    ((aSelectorString ~= '*') and:[aSelectorString includesMatchCharacters]) ifTrue:[

	"a matchString"

	searchBlock := [:class :method :s |

			    |lits found|

			    lits := method literals.

			    found := false.

			    lits notNil ifTrue:[

				lits do:[:aLiteral |

				    found ifFalse:[

					(aLiteral isMemberOf:Symbol) ifTrue:[

					    found := (aSelectorString match:aLiteral)

					]

				    ]

				]

			    ].

			    found

		       ].

    ] ifFalse:[

	sel := aSelectorString asSymbolIfInterned.

	sel isNil ifTrue:[

"

	    Transcript showCr:'none found.'.

"

	    self showNoneFound:title.

	    ^ nil

	].

	searchBlock := [:class :method :s | method sends:sel].

    ].

    browser := self browseMethodsIn:aCollectionOfClasses

			      where:searchBlock

			      title:title.

    browser notNil ifTrue:[

	|s|

	"

	 kludge for now, if its a multipart selector,

	 no easy search is (as yet) possible

	"

	s := aSelectorString.

	(s includes:$:) ifTrue:[

	    s := s copyTo:(s indexOf:$:)

	].

	browser autoSearch:s 

    ].

    ^ browser

!

browseCallsOn:aSelectorString under:aClass

    "launch a browser for all senders of aSelector in aClass and subclasses"

    ^ self browseAllCallsOn:aSelectorString

                         in:(aClass withAllSubclasses)

                      title:(self classResources string:'senders of: %1 (in and below %2)'

                                       with:aSelectorString 

                                       with:aClass name)

    "

     SystemBrowser browseCallsOn:#+ under:Number

    "

    "Created: 9.12.1995 / 17:59:57 / cg"

    "Modified: 9.12.1995 / 18:11:10 / cg"

!

browseClassRefsTo:aString in:aCollectionOfClasses modificationsOnly:modsOnly

    "launch a browser for all methods in aClass where the classVar named

     aString is referenced; if modsOnly is true, browse only methods where the

     classvar is modified"

    ^ self browseRefsTo:aString classVars:true in:aCollectionOfClasses modificationsOnly:modsOnly

!

browseClassRefsTo:varName in:aCollectionOfClasses modificationsOnly:modsOnly title:title

    "launch a browser for all methods in aCollectionOfClasses,

     where the classVar named aString is referenced; 

     if modsOnly is true, browse only methods where the classvar is modified"

    ^ self browseRefsTo:varName classVars:true in:aCollectionOfClasses modificationsOnly:modsOnly title:title

!

browseClassRefsTo:aString under:aClass modificationsOnly:modsOnly

    "launch a browser for all methods in aClass and subclasses

     where the classVar named aString is referenced; 

     if modsOnly is true, browse only methods where the classvar is modified"

    ^ self browseClassRefsTo:aString in:(aClass withAllSubclasses) modificationsOnly:modsOnly

!

browseForString:aString

    "launch a browser for all methods containing a string in their source.

     This may be slow, since source-code has to be scanned."

    ^ self browseForString:aString in:(Smalltalk allClasses)

!

browseForString:aString in:aCollectionOfClasses

    "launch a browser for all methods in aCollectionOfClasses  

     containing a string in their source.

     This may be slow, since source-code has to be scanned."

    |browser searchBlock title s|

    title := self classResources string:'methods containing: %1' with:aString displayString.

    (aString includesMatchCharacters) ifTrue:[

        s := '*' , aString , '*'.

        "a matchString"

        searchBlock := [:c :m :sel | 

                            |src|       

                            src := m source.

                            src isNil ifTrue:['no source' printNL. false]

                            ifFalse:[s match:m source]

                       ]

    ] ifFalse:[

        searchBlock := [:c :m :sel | 

                            |src|

                            src := m source.

                            src isNil ifTrue:['no source' printNL. false]

                            ifFalse:[ (m source findString:aString) ~~ 0 ]

                       ]

    ].

    browser := self browseMethodsIn:aCollectionOfClasses where:searchBlock title:title.

    browser notNil ifTrue:[

        browser autoSearch:aString

    ].

    ^ browser

    "

     SystemBrowser browseForString:'all' in:(Array with:Object)

     SystemBrowser browseForString:'should' in:(Array with:Object)

     SystemBrowser browseForString:'[eE]rror' in:(Array with:Object)

    "

    "Created: 9.12.1995 / 18:03:12 / cg"

    "Modified: 12.4.1996 / 19:03:29 / cg"

!

browseForSymbol:aSymbol

    "launch a browser for all methods referencing aSymbol"

    ^ self browseForSymbol:aSymbol title:(self classResources string:'users of: %1' with:aSymbol) warnIfNone:true

    "Created: 9.12.1995 / 18:04:34 / cg"

    "Modified: 9.12.1995 / 18:11:22 / cg"

!

browseForSymbol:aSymbol title:title warnIfNone:doWarn

    "launch a browser for all methods referencing aSymbol"

    |browser searchBlock sym|

    (aSymbol includesMatchCharacters) ifTrue:[

        "a matchString"

        searchBlock := [:c :m :s |

                            |found lits|

                            lits := m literals.

                            found := false.

                            lits notNil ifTrue:[

                                lits do:[:aLiteral |

                                    found ifFalse:[

                                        (aLiteral isMemberOf:Symbol) ifTrue:[

                                            found := (aSymbol match:aLiteral)

                                        ]

                                    ]

                                ]

                            ].

                            found

                       ].

    ] ifFalse:[

        "

         can do a faster search

        "

        sym := aSymbol asSymbolIfInterned.

        sym isNil ifTrue:[

            self showNoneFound:title.

            ^ nil

        ].

        searchBlock := [:c :m :s |

                            |found lits|

                            lits := m literals.

                            found := false.

                            lits notNil ifTrue:[

                                lits do:[:aLiteral |

                                    found ifFalse:[

                                        (aLiteral isMemberOf:Symbol) ifTrue:[

                                            found := (sym == aLiteral)

                                        ]

                                    ]

                                ]