"

 COPYRIGHT (c) 1990 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:#ChangesBrowser

	 instanceVariableNames:'changeListView codeView changeFileName changeChunks

                changePositions changeClassNames changeHeaderLines anyChanges

                changeNrShown changeNrProcessed skipSignal compareChanges

                compareCheckBox changeFileSize changeFileTimestamp checkBlock

                changeTimeStamps tabSpec'

	 classVariableNames:'CompressSnapshotInfo'

	 poolDictionaries:''

	 category:'Interface-Browsers'

!

!ChangesBrowser class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1990 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 implements a browser for the changes-file.

    See the extra document 'doc/misc/cbrowser.doc' for how to use this browser.

    written jan 90 by claus

    Class variables:

	CompressSnapshotInfo            if true (the default), snapshot entries

					are also compressed in the compress function.

					Some users prefer them to be not compressed.

					Set it to false for this.

    Notice:

	this needs a total rewrite, to build up a changeSet from the file

	(which did not exist when the ChangesBrowser was originally written) 

	and manipulate that changeSet.

	This way, we get a browser for any upcoming incore changeSets for

	free. Also, this will put the chunk analyzation code into Change and

	subclasses (where it belongs) and give a better encapsulation and

	overall structure. Do not take this as an example for good style ;-)

"

! !

!ChangesBrowser class methodsFor:'instance creation'!

new

    "create a new changes browser"

    ^ super label:'Changes Browser'

	     icon:(Form fromFile:'CBrowser.xbm' resolution:100)

!

openOn:aFileName

    "create c changes browser on a change file"

    ^ ((self new label:'Changes Browser: ', aFileName) changeFileName:aFileName) open

! !

!ChangesBrowser class methodsFor:'behavior'!

autoSelectNext

    "returning true here, makes a Delete operation automatically

     select the next change"

    ^ true

! !

!ChangesBrowser class methodsFor:'defaults'!

defaultLabel

    ^ 'Changes Browser'

! !

!ChangesBrowser methodsFor:'compiler interface'!

wantChangeLog

    "sent by the compiler to ask if a changeLog entry should

     be written. Return false here."

    ^ false

! !

!ChangesBrowser methodsFor:'error handling'!

correctableError:aString position:relPos to:relEndPos from:aCompiler

    "compiler notifys us of an error - this should really not happen since

     changes ought to be correct (did someone edit the changes file ??).

     Show the bad change in the codeView and let codeView hilight the error;

     no corrections allowed here therefore return false"

    self error:aString position:relPos to:relEndPos from:aCompiler.

    ^ false

!

error:aString position:relPos to:relEndPos from:aCompiler

    "compiler notifys us of an error - this should really not happen since

     changes ought to be correct (did someone edit the changes file ??).

     Show the bad change in the codeView and let codeView hilight the error"

    |action|

    (changeNrProcessed ~~ changeNrShown) ifTrue:[

	self changeSelection:changeNrProcessed

    ].

    (skipSignal notNil) ifTrue:[

	codeView highlightingErrorPosition:relPos to:relEndPos do:[

	    |box|

	    "

	     start dialog - make certain cleanup is done

	    "

	    action := OptionBox 

			  request:aString

			  label:'Error'

			  form:(WarningBox iconBitmap)

			  buttonLabels:#('abort' 'skip' 'continue')

			  values:#(#abort #skip #continue)

			  default:#continue.

	].

	action == #abort ifTrue:[

	    Object abortSignal raise.

	    ^ false

	].

	action == #skip ifTrue:[

	    skipSignal raise.

	    ^ false

	].

	^  false 

    ].

    ^ codeView error:aString position:relPos to:relEndPos from:aCompiler

!

warning:aString position:relPos to:relEndPos from:aCompiler

    "compiler notifys us of a warning - ignore it"

    ^ self

! !

!ChangesBrowser methodsFor:'event handling '!

handlesKeyPress:key inView:view

    "this method is reached via delegation: are we prepared to handle

     a keyPress in some other view ?"

    view == changeListView ifTrue:[

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

    ].

    ^ false

!

keyPress:key x:x y:y view:view

    "this method is reached via delegation from the changeListView"

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

	self doDelete.

	^ self

    ].

    changeListView keyPress:key x:x y:y

! !

!ChangesBrowser methodsFor:'help '!

helpTextFor:aComponent

    |s|

    aComponent == codeView ifTrue:[

	s := 'HELP_CODEVIEW'

    ].

    aComponent == changeListView ifTrue:[

	s := 'HELP_CHANGELIST'

    ].

    ((aComponent == compareCheckBox)

    or:[aComponent superView == compareCheckBox]) ifTrue:[

	s := 'HELP_CHECK_COMPARE'

    ].

    s notNil ifTrue:[

	^ resources string:s

    ].

    ^ nil

! !

!ChangesBrowser methodsFor:'initialize / release'!

changeListMenu

    |labels selectors m|

    labels := #(

		      'apply change'

		      'apply changes to end'

		      'apply changes for this class to end'

		      'apply all changes'

		      '-'

		      'delete'

		      'delete to end'

		      'delete changes for this class to end'

		      'delete all changes for this class'

		      '-'

		      'update'

		      'compress'

		      'compare with current version'

		      'browse class'

		      '-'

		      'make change a patch'

"/                       'update sourcefile from change'

"/                       '-'

		      'fileout & delete changes for this class'

		      '-'

		      'save change in file ...'

		      'save changes to end in file ...'

		      'save changes for this class to end in file ...'

		      'save all changes for this class in file ...'

		      '-'

		      'writeback changeFile').

    selectors := #(

		      doApply

		      doApplyRest

		      doApplyClassRest

		      doApplyAll

		      nil

		      doDelete

		      doDeleteRest

		      doDeleteClassRest

		      doDeleteClassAll

		      nil

		      doUpdate

		      doCompress

		      doCompare

		      doBrowse

		      nil

		      doMakePatch

"/                      doMakePermanent

"/                      nil

		      doFileoutAndDeleteClassAll

		      nil

		      doSave

		      doSaveRest

		      doSaveClassRest

		      doSaveClassAll

		      nil

		      doWriteBack

		).

    m := PopUpMenu 

	    labels:(resources array:labels)

	    selectors:selectors.

    changeListView hasSelection ifFalse:[

	m disableAll:#(doApply doApplyClassRest doApplyRest doDelete doDeleteRest doDeleteClassRest

		       doDeleteClassAll doCompare doMakePatch doSaveChangeInFile doMakePermanent

		       doSave doSaveRest doSaveClassAll doSaveClassRest doBrowse) 

    ].

    ^ m

    "Modified: 6.9.1995 / 17:14:22 / claus"

!

compare:aBoolean

    "sent from the compare-toggle"

    aBoolean ~~ compareChanges ifTrue:[

	compareChanges := aBoolean.

	compareChanges ifTrue:[

	    tabSpec positions:#(0  0.15  5   8.5 ).

	    self doUpdate

	] ifFalse:[

	    "/

	    "/ set tabs to hide compare-column

	    "/

	    tabSpec positions:#(-1  0    5   8.5 ).

	    changeListView clear; redraw.

	]

    ]

    "Modified: 18.11.1995 / 17:30:20 / cg"

!

focusSequence

    ^ Array with:changeListView with:codeView

!

initialize

    |panel v upperFrame buttonPanel|

    super initialize.

    changeFileName := ObjectMemory nameForChanges. "/ 'changes'.

    compareChanges := false.

    checkBlock := [self checkIfFileHasChanged].

    panel := VariableVerticalPanel origin:(0.0 @ 0.0)

				   corner:(1.0 @ 1.0)

			      borderWidth:0

				       in:self.

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

    v := HVScrollableView for:SelectionInListView miniScrollerH:true in:upperFrame.

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

    changeListView := v scrolledView.

    changeListView delegate:self.

    changeListView menuHolder:self; menuPerformer:self; menuMessage:#changeListMenu.

    buttonPanel := VerticalPanelView in:upperFrame.

    buttonPanel origin:(0.8 @ 0.0) corner:(1.0 @ 1.0).

    buttonPanel verticalLayout:#topSpace.

    compareCheckBox := CheckBox new.

    compareCheckBox label:(resources string:'compare').

    compareCheckBox action:[:val | self compare:val].

    buttonPanel addSubView:compareCheckBox.

    v := HVScrollableView for:CodeView miniScrollerH:true miniScrollerV:false in:panel.

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

    codeView := v scrolledView.

    codeView readOnly.

    anyChanges := false.

    ObjectMemory addDependent:self.   "to get shutdown-update"

    tabSpec := TabulatorSpecification new.

    tabSpec unit:#inch.

    tabSpec positions:#(-1      0        5      8.5 ).

    "                   +/-    cls>>sel  type   info"

    tabSpec align:    #(#left  #left     #left  #left).

    "Modified: 18.11.1995 / 17:30:59 / cg"

!

realize

    super realize.

    self readChangesFileInBackground:true.

    self setChangeList.

    changeListView action:[:lineNr | self changeSelection:lineNr].

    Processor addTimedBlock:checkBlock afterSeconds:5.

!

update:what

    |box|

    (what == #aboutToExit) ifTrue:[

	"

	 smalltalk is about to shut down -

	 - if change list was modified, ask user and save if requested.

	"

	anyChanges ifTrue:[

	    self raiseDeiconified.

	    box := YesNoBox new.

	    box title:(resources at:'changefile has not been updated from the modified changelist.\\Update before exiting ?') withCRs.

	    box noText:(resources at:'don''t update').

	    box okText:(resources at:'update').

	    box yesAction:[self writeBackChanges] 

		 noAction:[].

	    box showAtPointer

	].

	^ self

    ].

    super update:what

! !

!ChangesBrowser methodsFor:'private'!

appendChange:changeNr toFile:fileName

    "append change to a file. return true if ok."

    |aStream outStream chunk sawExcla separator|

    outStream := FileStream oldFileNamed:fileName.

    outStream isNil ifTrue:[

	outStream isNil ifTrue:[

	    outStream := FileStream newFileNamed:fileName.

	    outStream isNil ifTrue:[

		self warn:'cannot update file ''%1''' with:fileName.

		^ false

	    ]

	]

    ].

    outStream setToEnd.

    aStream := self streamForChange:changeNr.

    aStream isNil ifTrue:[

	self warn:'oops cannot read change'.

	^ false

    ].

    separator := aStream class chunkSeparator.

    sawExcla := aStream peekFor:separator.

    sawExcla ifTrue:[

	outStream nextPut:separator

    ].

    chunk := aStream nextChunk.

    outStream nextChunkPut:chunk.

    outStream cr.

    sawExcla ifTrue:[

	chunk := aStream nextChunk.

	outStream nextChunkPut:chunk.

	outStream space

    ].

    sawExcla ifTrue:[

	outStream nextPut:separator

    ].

    outStream cr.

    aStream close.

    outStream close.

    ^ true

!

applyChange:changeNr

    "fileIn a change"

    |aStream nm|

    aStream := self streamForChange:changeNr.

    aStream isNil ifTrue:[^ self].

    nm := self classNameOfChange:changeNr.

    nm notNil ifTrue:[

	|cls|

	cls := Smalltalk at:(nm asSymbol) ifAbsent:[].

	cls notNil ifTrue:[

	    cls isLoaded ifFalse:[

		cls autoload

	    ]

	]

    ].

    changeNrProcessed := changeNr.

    Class withoutUpdatingChangesDo:[

	|sig|

	(skipSignal notNil) ifTrue:[

	    sig := skipSignal

	] ifFalse:[

	    sig := Object abortSignal

	].

	sig catch:[

	    aStream fileInNextChunkNotifying:self

	].

	changeNrProcessed := nil.

    ].

    aStream close

!

autoSelect:changeNr

    "select a change"

    self class autoSelectNext ifTrue:[

	(changeNr <= changePositions size) ifTrue:[

	    changeListView selection:changeNr.

	    self changeSelection:changeNr.

	    ^ self

	]

    ].

    self clearCodeView.

    changeListView selection:nil.

!

autoSelectLast

    "select the last change"

    self autoSelect:(changePositions size)

!

autoSelectOrEnd:changeNr

    "select the next change or the last"