"

 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.

"

StandardSystemView subclass:#BrowserView

	 instanceVariableNames:'classCategoryListView classListView methodCategoryListView

		methodListView classMethodListView codeView classToggle

		instanceToggle currentClassCategory currentClassHierarchy

		currentClass currentMethodCategory currentMethod currentSelector

		showInstance actualClass fullClass lastMethodCategory aspect

		variableListView fullProtocol lockUpdates autoSearch myLabel

		acceptClass'

	 classVariableNames:'CheckForInstancesWhenRemovingClasses RememberAspect DefaultIcon'

	 poolDictionaries:''

	 category:'Interface-Browsers'

!

!BrowserView 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 intermediate versions of BrowserView/SystemBrowser. 

    All action is (currently) still done here in BrowserView, although the

    SystemBrowsers class methods are used to startup a browser.

    This will certainly change ...

"

! !

!BrowserView class methodsFor:'initialization'!

initialize

    "Browser configuration;

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

    "

     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.

    "

     setting this to true makes the browser remember the aspect shown

     in the classList and show this aspect when a new class is selected.

     If false, it always switches to the classes definition

    "

    RememberAspect := true.

    "

     CheckForInstancesWhenRemovingClasses := true

     CheckForInstancesWhenRemovingClasses := false

     RememberAspect := true

     RememberAspect := false

    "

    "Created: 23.11.1995 / 11:35:58 / cg"

    "Modified: 23.11.1995 / 11:36:34 / cg"

! !

!BrowserView class methodsFor:'defaults'!

defaultIcon

    DefaultIcon isNil ifTrue:[

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

    ].

    ^ DefaultIcon

! !

!BrowserView methodsFor:'change & update'!

update:something with:someArgument from:changedObject

    |list|

    "

     avoid update/warn after my own changes

    "

    lockUpdates == true ifTrue:[

"/         'ignored my change' printNL.

	^ self

    ].

"/ changedObject print. ' ' print. someArgument print. ' ' print.

"/ something printNL.

    (changedObject == Smalltalk) ifTrue:[

	something == #newClass ifTrue:[

	    (currentClass notNil

	    and:[someArgument name = currentClass name]) ifTrue:[

		"

		 the current class was autoloaded

		"

		self warnLabel:'the selected class has changed'.

		self updateClassListWithScroll:false.

	    ].

	    ((someArgument category = currentClassCategory)

	    or:[currentClassCategory notNil

		and:[currentClassCategory startsWith:'*']]) ifTrue:[

		self updateClassListWithScroll:false.

	    ].

	    someArgument category ~= currentClassCategory ifTrue:[

		"

		 category new ?

		"

		(classCategoryListView notNil 

		and:[(list := classCategoryListView list) notNil

		and:[(list includes:someArgument category) not]])

		ifTrue:[

		    self updateClassCategoryListWithScroll:false.

		]

	    ].

	    ^ self

	].

	something == #classRemove ifTrue:[

	    someArgument = currentClass ifTrue:[

		self warnLabel:'the selected class was removed'.

		^ self

	    ].

	    " fall into general update "

	].

	"

	 any other (unknown) change 

	 with the Smalltalk dictionary ...

	"

	self updateClassCategoryListWithScroll:false.

	self updateClassListWithScroll:false.

	^ self

    ].

    changedObject isBehavior ifTrue:[

	"

	 its a class, that has changed

	"

	(currentClass notNil 

	and:[changedObject name = currentClass name]) ifTrue:[

	    "

	     its the current class that has changed

	    "

	    something == #methodDictionary ifTrue:[

		(someArgument isSymbol) ifTrue:[

		    |changedMethod|

		    "

		     the method with selector someArgument was changed or removed

		    "

		    self updateMethodCategoryListWithScroll:false.

		    self updateMethodListWithScroll:false.

		    someArgument == currentSelector ifTrue:[

			"

			 special care here: the currently shown method has been

			 changed somehow in another browser (or via fileIn)

			"

			changedMethod := currentClass compiledMethodAt:currentSelector.

			changedMethod isNil ifTrue:[

			    self warnLabel:'the method shown was removed'.

			    ^ self

			].

			"compare the source codes"

			currentMethod notNil ifTrue:[

			    changedMethod source = codeView contents ifFalse:[

				self warnLabel:'method has changed - the code shown may be obsolete'.

			    ]

			].

			^ self    

		    ].

		    ^ self

		]

	    ].

	    something == #comment ifTrue:[

		"

		 the class has changed its comment; we dont care, except if

		 currently showing the comment

		"

		aspect == #comment ifTrue:[

		    self warnLabel:'the comment shown may not up to date'.

		].

		^ self

	    ].

	    something == #definition ifTrue:[

		"

		 the class has changed its definition.

		 Warn, except if showing a method.

		"

		aspect notNil ifTrue:[

		    self warnLabel:'the classes definition has changed'.

		].

"/                ^ self

	    ].

	    "

	     get the class again - in case of a changed class definition,

	     we are otherwise refering to the obsolete old class

	    "

	    currentClass := Smalltalk at:(currentClass name asSymbol).

	    showInstance ifTrue:[

		actualClass := currentClass

	    ] ifFalse:[

		actualClass := currentClass class

	    ].

	    self updateMethodCategoryListWithScroll:false.

	    "dont update codeView ...."

	    "self update"

	    ^ self

	].

	"

	 any other class has changed (but not its organization, since

	 that is cought in the above case).

	 We are not interrested in it - except, if showing fullProtocol

	 or hierarchy ...

	"

	currentClassHierarchy notNil ifTrue:[

	    fullProtocol ifTrue:[

		(currentClass isSubclassOf:changedObject) ifTrue:[

		]

	    ] ifFalse:[

		((currentClass isSubclassOf:changedObject)

		or:[changedObject isSubclassOf:currentClass]) ifTrue:[

		]                

	    ]

	].

	^ self

    ].

    (changedObject isMethod) ifTrue:[

    ]

! !

!BrowserView methodsFor:'class category list menu'!

classCategoryCheckinEach

    self withWaitCursorDo:[

	|logMessage|

	logMessage := Dialog 

			 request:'enter a log message (used for all):' 

			 initialAnswer:''  

			 onCancel:nil.

	logMessage notNil ifTrue:[

	    Smalltalk allClassesInCategory:currentClassCategory do:[:aClass |

		self busyLabel:'checking in %1' with:aClass name.

		SourceCodeManager checkinClass:aClass logMessage:logMessage.

		self normalLabel.

	    ]

	].

	self normalLabel.

    ]

    "Created: 23.11.1995 / 11:41:38 / cg"

    "Modified: 23.11.1995 / 18:43:34 / cg"

!

classCategoryClone

    "open a new SystemBrowser showing the same method as I do"

    SystemBrowser openInClass:actualClass selector:currentSelector

    "Created: 14.9.1995 / 10:55:20 / claus"

    "Modified: 14.9.1995 / 10:59:31 / claus"

!

classCategoryFileOut

    "create a file 'categoryName' consisting of all classes in current category"

    |aStream fileName|

    self checkClassCategorySelected ifFalse:[^ self].

    fileName := currentClassCategory asString.

    fileName replaceAll:Character space by:$_.

    "

     this test allows a smalltalk to be built without Projects/ChangeSets

    "

    Project notNil ifTrue:[

	fileName := Project currentProjectDirectory , fileName.

    ].

    self withWaitCursorDo:[

	"

	 if file exists, save original in a .sav file

	"

	fileName asFilename exists ifTrue:[

	    self busyLabel:'saving existing %1' with:fileName.

	    fileName asFilename copyTo:(fileName , '.sav')

	].

	aStream := FileStream newFileNamed:fileName.

	aStream isNil ifTrue:[

	    self warn:'cannot create: %1' with:fileName

	] ifFalse:[

	    self busyLabel:'writing: %1' with:fileName.

	    Smalltalk allClassesInCategory:currentClassCategory inOrderDo:[:aClass |

		aClass fileOutOn:aStream.

	    ].

	    aStream close.

	]

    ].

    self normalLabel.

!

classCategoryFileOutEach

    self withWaitCursorDo:[

	Smalltalk allClassesInCategory:currentClassCategory do:[:aClass |

	    self busyLabel:'saving: %1' with:aClass name.

	    Class fileOutErrorSignal handle:[:ex |

		self warn:'cannot create: %1' with:ex parameter.

		ex return.

	    ] do:[

		aClass fileOut

	    ]

	].

	self normalLabel.

    ]

!

classCategoryFindClass

    |box|

    box := self enterBoxForCodeSelectionTitle:'class to find:' okText:'find'.

    box entryCompletionBlock:[:contents |

	|s what m|

	s := contents withoutSpaces.

	what := Smalltalk classnameCompletion:s.

	box contents:what first.

	(what at:2) size ~~ 1 ifTrue:[

	    device beep

	]

    ].

    box action:[:aString | self switchToClassNameMatching:aString].

    box showAtPointer

!

classCategoryFindMethod

    |box|

    box := self listBoxForCodeSelectionTitle:'selector to find:' okText:'find'.

    box entryCompletionBlock:[:contents |

	|s what m|

	s := contents withoutSpaces.

	box topView withWaitCursorDo:[

	    what := Smalltalk selectorCompletion:s.

	    box list:(what at:2).

	    box contents:what first.

	    (what at:2) size ~~ 1 ifTrue:[

		device beep

	    ]

	]

    ].

    box action:[:aString | self switchToAnyMethod:aString].

    box showAtPointer

    "Modified: 30.8.1995 / 22:49:49 / claus"

!

classCategoryMenu

    |labels selectors|

    (device ctrlDown 

    and:[currentClassCategory notNil]) ifTrue:[

	labels :=  #(

		       'checkin each'

		    ).

	selectors := #(

		       classCategoryCheckinEach

		     ).

    ] ifFalse:[

	currentClassCategory isNil ifTrue:[

	    labels := #(

			'spawn full class'

			'-'

			'update'

			'find class ...'

			'find method ...'

			'-'

			'new class category ...'

		       ).

	    selectors := #(

			classCategorySpawnFullClass

			nil

			classCategoryUpdate

			classCategoryFindClass

			classCategoryFindMethod

			nil

			classCategoryNewCategory

		       ).

	] ifFalse:[

	    labels := #(

			'fileOut'

			'fileOut each'

"/

"/                      'fileOut binary'

"/

			'printOut' 

			'printOut protocol'

			'-'

			'clone'

			'SPAWN_CATEGORY'

			'spawn full class'

			'-'

			'update'

			'find class ...'

			'find method ...'

			'-'

			'new class category ...'

			'rename ...'

			'remove'

		       ).

	    selectors := #(

		       classCategoryFileOut

		       classCategoryFileOutEach

		       classCategoryPrintOut

		       classCategoryPrintOutProtocol

		       nil

		       classCategoryClone

		       classCategorySpawn

		       classCategorySpawnFullClass

		       nil

		       classCategoryUpdate

		       classCategoryFindClass

		       classCategoryFindMethod

		       nil

		       classCategoryNewCategory

		       classCategoryRename

		       classCategoryRemove

		       ).

	].

    ].

    ^ PopUpMenu labels:(resources array:labels)

		selectors:selectors

    "Created: 14.9.1995 / 10:50:17 / claus"

    "Modified: 23.11.1995 / 18:37:06 / cg"

!

classCategoryNewCategory

    |box|

    box := self enterBoxTitle:'name of new class category:' okText:'create'.

    box action:[:aString |

	|categories|

	currentClass notNil ifTrue:[

	    categories := Set new.

	    currentClass withAllSuperclasses do:[:aClass |

		aClass methodArray do:[:aMethod |

		    categories add:aMethod category

		]

	    ].

	    categories := categories asOrderedCollection

	].

	categories isNil ifTrue:[

	    categories := classCategoryListView list.

	].

	(categories includes:aString) ifFalse:[

	    categories add:aString.

	    categories sort.