Smalltalk/X Webserver

Documentation of class 'VersionDiffBrowser':

Home

[back]

Class: VersionDiffBrowser

Inheritance
Description
Related information
Class protocol
Instance protocol
Private classes

Inheritance:

   Object
   |
   +--Model
      |
      +--ApplicationModel
         |
         +--VersionDiffBrowser

Package:: stx:libtool

Category:: Interface-Browsers

Version:: rev: 1.173 date: 2019/08/14 14:44:17; user: cg; file: VersionDiffBrowser.st directory: libtool; module: stx stc-classLibrary: libtool

Description:

This is not yet finished (work in progress).

A quickly hacked up browser to show differences between class versions,
allowing easy comparison; will also eventually add capabilities
to checkIn / load classes into / from the repository.

[usages:]
    VersionDiffBrowser openOnAllVersionsOfClass:Array.
    VersionDiffBrowser openOnAllClassesChangedSince:(Date today - 2 days) in:(Smalltalk allClasses).
    VersionDiffBrowser openOnAllClassesChangedSince:(Date today - 2 days) in:(Smalltalk allClassesMatchingPackage:'exept:bridgeFramework*').
    

[instance variables:]

[class variables:]

Related information:

Class protocol:

rememberedFilters

interface specs

This resource specification was automatically generated
by the UIPainter of ST/X.

usage example(s):

     UIPainter new openOnClass:VersionDiffBrowser andSelector:#windowSpec
     VersionDiffBrowser new openInterface:#windowSpec
     VersionDiffBrowser open

windowSpecForMultipleClasses

This resource specification was automatically generated
by the UIPainter of ST/X.

usage example(s):

     UIPainter new openOnClass:VersionDiffBrowser andSelector:#windowSpecForMultipleClasses
     VersionDiffBrowser new openInterface:#windowSpecForMultipleClasses

windowSpecForMultipleVersions

This resource specification was automatically generated
by the UIPainter of ST/X.

usage example(s):

     UIPainter new openOnClass:VersionDiffBrowser andSelector:#windowSpecForMultipleVersions
     VersionDiffBrowser new openInterface:#windowSpecForMultipleVersions

This resource specification was automatically generated
by the MenuEditor of ST/X.

usage example(s):

     MenuEditor new openOnClass:VersionDiffBrowser andSelector:#filterMenu
     (Menu new fromLiteralArrayEncoding:(VersionDiffBrowser filterMenu)) startUp

This resource specification was automatically generated
by the MenuEditor of ST/X.

usage example(s):

     MenuEditor new openOnClass:VersionDiffBrowser andSelector:#mainMenu
     (Menu new fromLiteralArrayEncoding:(VersionDiffBrowser mainMenu)) startUp

This resource specification was automatically generated
by the MenuEditor of ST/X.

This resource specification was automatically generated
by the MenuEditor of ST/X.

usage example(s):

     MenuEditor new openOnClass:VersionDiffBrowser andSelector:#menuB
     (Menu new fromLiteralArrayEncoding:(VersionDiffBrowser menuB)) startUp

This resource specification was automatically generated
by the MenuEditor of ST/X.

versionsMenu

This resource specification was automatically generated
by the MenuEditor of ST/X.

This resource specification was automatically generated
by the MenuEditor of ST/X.

plugIn spec

aspectSelectors: This resource specification was automatically generated
by the UIPainter of ST/X.

openOnAllClassesChangedSince: aDateOrTimestamp in: aSetOfClasses

create a VersionDiffBrowser instance and set the list of classes.
When a class is selected, the version list is extracted,
and the class diff set is generated from aClasses current version against
the selected version in the top selection list

usage example(s):

     VersionDiffBrowser 
        openOnAllClassesChangedSince:(Date today - 2 days) 
        in:(Smalltalk allClassesMatchingPackage:'exept:bridgeFramework*').

openOnAllVersionsOfClass: aClass

create a VersionDiffBrowser instance and set the class change set of the
browser. The class diff set is generated from aClasses current version against
the selected version in the top selection list

usage example(s):

     self openOnAllVersionsOfClass:Object

openOnAllVersionsOfClasses: aSetOfClasses

create a VersionDiffBrowser instance and set the list of classes.
When a class is selected, the version list is extracted,
and the class diff set is generated from aClasses current version against
the selected version in the top selection list

usage example(s):

     self openOnAllVersionsOfClasses:(Collection withAllSubclasses)
     self openOnAllVersionsOfClasses:(Smalltalk allClassesInPackage:'exept:bridgeFramework')
     self openOnAllVersionsOfClasses:(Smalltalk allClassesMatchingPackage:'exept:bridgeFramework*')

openOnClass: aClass againstVersion: aVersionA

create a VersionDiffBrowser instance and set the class change set of the
browser. The class diff set is generated from aClasses current against some version
via the source code manager.

usage example(s):

     self openOnClass:Array againstVersion:'1.116'
     self openOnClass:Array againstVersion:nil            - against the version on which Array is based upon
     self openOnClass:Array againstVersion:#newest        - against the newest repository version

     self openOnClass:VersionDiffBrowser againstVersion:nil
     self openOnClass:VersionDiffBrowser againstVersion:#newest

     (self openOnClass:ByteArray againstVersion:'1.116') includeExtensionsHolder value:true

openOnClass: classA labelA: aLabelA andClass: classB labelB: aLabelB title: title

create a VersionDiffBrowser instance and set the class change set of the
browser. The class diff set is generated from two classes.

usage example(s):

     self
        openOnClass:Array labelA:'Array'
        andClass:Collection labelB:'Collection'
        title:'Array vs. Collection'

openOnClass: classA labelA: aLabelA andClass: classB labelB: aLabelB title: title ifSame: sameAction

create a VersionDiffBrowser instance and set the class change set of the
browser. The class diff set is generated from two classes.

openOnClass: aClass labelA: aLabelA sourceA: aSourceA labelB: aLabelB sourceB: aSourceB

create a VersionDiffBrowser instance and set the class change set of the
browser. The class diff set is generated from two source files.

openOnClass: aClass labelA: aLabelA sourceA: aSourceA labelB: aLabelB sourceB: aSourceB title: ignoredTitle

create a VersionDiffBrowser instance and set the class change set of the
browser. The class diff set is generated from two source files.

openOnClass: aClass labelA: aLabelA sourceA: aSourceA labelB: aLabelB sourceB: aSourceB title: ignoredTitle ifSame: sameAction

create a VersionDiffBrowser instance and set the class change set of the
browser. The class diff set is generated from two source files.

openOnClass: aClass versionA: versionA versionB: versionB

create a VersionDiffBrowser instance and set the class change set of the
browser. The class diff set is generated from two versions of aClass via
the source code manager.

usage example(s):

     self openOnClass:Array versionA:'1.116' versionB:'1.113'
     self openOnClass:Array versionA:'1.113' versionB:'1.116'

openOnClassChangeSet: classChangeSet title: title

create a VersionDiffBrowser instance and set the class change set of the
browser. The class diff set is generated from two classes.

openOnDiffSet: diffSet labelA: aLabelA labelB: aLabelB title: ignoredTitle

openOnDiffSet: diffSet labelA: aLabelA labelB: aLabelB title: ignoredTitle ignoreExtensions: ignoreExtensionsBoolean

openOnDiffSet: diffSet labelA: aLabelA labelB: aLabelB title: ignoredTitle ignoreExtensions: ignoreExtensionsBoolean ignoreVersionMethods: ignoreVersionMethodsBoolean

openOnDiffsBetweenFile: file1 and: file2

VersionDiffBrowser
openOnDiffsBetweenFile:'/phys/exept/tmp/ws/Workflow::BlockDescription.st'
and:'/phys/exept/tmp/workflowClasses/Workflow::BlockDescription.st'

Instance protocol:

beMultipleClassesVersionBrowser
beMultipleVersionBrowser
canIncludeExtensions: aBoolean: Modified (format): / 08-05-2019 / 11:14:30 / Claus Gittinger
changeSetA: gets the change set which contains only the new methods
in versionA of the class
<return: ChangeSet>
changeSetB: gets the change set which contains only the new methods
in versionB of the class
<return: ChangeSet>
class: aClass versionA: revA versionB: revB
classBeingCompared: returns the class from the change set which is compared.
<return: Class>
classChangeSet: returns the class change set which is the model of the version diff browser.
classChangeSet: aClassChangeSet: sets the class change set which is the model of the version diff browser.
The labels, the lists, the visibility and the selection of the lists must be reseted
when a new change set is given.
classList: aCollectionOfClasses
ignoreExtensions: if true, extension methods are suppressed.
Ignoring is useful when comparing for baseClass checkin,
as opposed to extension-checking, where extensions should not be ignored.
the default is false
ignoreExtensions: aBoolean: if true, extension methods are suppressed.
Ignoring is useful when comparing for baseClass checkin,
as opposed to extension-checking, where extensions should not be ignored.
the default is false
ignoreVersionMethods: aBoolean: if true, version methods (version and version_XXX) are suppressed.
Ignoring is useful when comparing for real code changes.
the default is false
isMultipleClassesVersionBrowser
isMultipleVersionBrowser
selectedChangeInA: gets the selected method change for the 'method only in version A'.
<return: MethodChange | nil>
selectedChangeInB: gets the selected method change for the 'method only in version B'.
<return: MethodChange | nil>
selectedChangesInM: get the two method changes for the selected 'changed method'.
<return: <Array with:MethodChange with:MethodChange | nil>>
versionA: gets the first class version to be compared
<return: String>
versionB: gets the second class version to be compared
<return: String>

acceptInLeftView
acceptInRightView
acceptInSingleView
applyChange: change
applySelectedChangeInA
applySelectedChangeInB
methodInADoubleClicked: index: |change|
methodInBDoubleClicked: index: |change|
methodInChangedDoubleClicked: index
removeSelectedChangeInBFromImage
showLogMessages: the UI shows code-diffs if any change is selected, and version log entries otherwise.
But there is no way to deselect any of the method-change-lists, to go back to log-messages,
once a method has been looked at.
This view-menu entry helps.

boxAVisible
boxBVisible
boxMVisible
canIncludeExtensionsHolder: can include extensions ? (menu item enabler)
changedLabelHolder: aspect for the label of the changed method box
classListHolder: aspect for the 'list of classes' list.
<return: List>
classNameListHolder: aspect for the 'list of classes' list.
<return: List>
diffTextLabelA: aspect for the label for version A
diffTextLabelB: aspect for the label for version B
diffTextView: return the component for the diff text view.

<return: HVScrollableView>
hideDiffsWithCommentOrFormattingChangeOnly
hideDiffsWithCommentOrFormattingChangeOnlyHolder: hide changes which have no semantic effect?
includeCategoryChanges
includeCategoryChanges: aBoolean
includeCategoryChangesHolder
includeExtensions
includeExtensions: aBoolean
includeExtensionsHolder: only compare base-methods or include extensions ?
includeVersionMethods
includeVersionMethods: aBoolean
includeVersionMethodsHolder
infoHolder
methodText: aspect for the text in the method text view
methodsChanged: aspect for the 'changed method' list.
<return: List>
methodsChangedSelection: aspect for the selection holder of 'changed method'-list.
<return: ValueHolder>
methodsOnlyInA: aspect for the 'method only in version A' list.
methodsOnlyInASelection: aspect for the selection holder of 'method only in version A'-list.
methodsOnlyInB: aspect for the 'method only in version B' list
methodsOnlyInBSelection: aspect for the selection holder of 'method only in version B'-list.
onlyInALabelHolder: aspect for the label for 'method only in version A'.
onlyInBLabelHolder: aspect for the label for 'method only in version B'.
selectedClassIndexHolder
selectedSymbolicVersionHolder
selectedSymbolicVersionIndexHolder
selectedVersionHolder
selectedVersionIndex
selectedVersionIndexHolder
symbolicVersionList
symbolicVersionNameList
versionEntriesList
versionList

aspects-exported

changedLabelHolder: aValueHolder
classHolder
classHolder: aValueHolder
onlyInALabelHolder: aValueHolder
onlyInBLabelHolder: aValueHolder
versionAHolder: aValueHolder
versionBHolder: aValueHolder

aspects-menu

canAcceptInCodeView
createPatchFileEnabled
createPatchFileVisible: for now
hasChangeSelectedInA
hasChangeSelectedInB
hasChangeSelectedInM
hasClassFilters
hasClassPatternFilter
hasNextVersionInVersionList: versions are sorted youngest first.
If the current selected one is the first, there is no next version
hasPreviousVersionInVersionList: versions are sorted youngest first.
If the current selected one is the last, there is no previous version
hasRememberedFilters
hasSelectorFilters
hasSelectorPatternFilter
showingClassChangeSet
versionsMenu

change & update

filterChanged: remember selection and scroll positions
methodsChangedSelectionChanged: the selection in the list of the 'changed methods' changed.
Reset the selection of the two other lists and calc the method change.
<return: self>
methodsOnlyInASelectionChanged: the selection in the list of the 'method only in version A' changed.
Reset the selection of the two other lists and show the method in
the text view.
<return: self>
methodsOnlyInBSelectionChanged: the selection in the list of the 'method only in version B' changed.
Reset the selection of the two other lists and show the method in
the text view.
<return: self>
selectVersion: version: if not found, get more version infos
selectedClassIndexHolderChanged
selectedSymbolicVersionHolderChanged
selectedSymbolicVersionIndexHolderChanged
selectedVersionHolderChanged: remember the previous selected method
selectedVersionIndexHolderChanged
shortChangeInfoFor: changeA and: changeB: see if the semantics have changed (or only prettyPrinted)
showActivity: someMessage: some activityNotification shalt be communicated to the user.
update: something with: parameter from: changedObject: (comment from inherited method)
dependent is notified of some change -
Default is to try update:with:
updateLabels: update the labels of the diff text view. Show the version numbers
of the class.
updateLists: walk over the changeSet(s) and setup the 3 lists:
onlyInA, changed, onlyInB,
Optionally filter extensions, categoryChanges and versionMethods,
changes with same semantic (variable renames)
and changes which have been explicitly filtered by the user.
updateVersionList: asks the classes source code manager for a list of revisions;
construct versionInfoList (containing the full info), versionList (containing version numbers only)
and tagList (containing symbolic names only).
This is only used when comparing multiple versions.

initialization & release

initialize: (comment from inherited method)
nothing done here;
but can be redefined in concrete applications
postBuildWith: aBuilder: components which are invisible should be ignored by the panel.
Cannot be set via the interface builder.

<return: self>
postOpenWith: aBuilder

menu action

browseChange: aChange: browse the change in aChange
browseClassInA: browse the selected method.
browseClassInB: browse the selected method.
browseClassInM: browse the selected method.
createPatchFile: create a patchFile, to patch the old version (versionA) into the new version (versionB).
I.e. a little changeFile to transport those changes.
createPatchFileWithVersionCheck: withVersionCheck: create a patchFile, to patch the old version (versionA) into the new version (versionB).
I.e. a little changeFile to transport those changes.
hideDiffsWithCommentOrFormattingChangeOnlyHolder: newValue: state of hide changes which have no semantic effect has changed
inspectSelectedChangeInA: inspect the selected method change for the 'method only in version A'.
inspectSelectedChangeInB: inspect the selected method change for the 'method only in version B'.
inspectSelectedChangeInM: inspect the two method changes for the selected 'changed method'.
mainMenu: if this application runs as an subapplication,
the menu bar should not be used.
menuAHolder
menuBHolder
menuMHolder
menuRemoveClassFromChangeSet: only do if we compare a single class
menuSelectClass: let user choose a class to be shown
openDocumentation
versionMenuCompareAgainstNextVersion
versionMenuCompareAgainstPreviousVersion

menu action - filters

currentFilterParameters: get the current settings
exportFilterParameters: generate XML with the current settings
(to be pasted into Jabber for interchange)
filterClassAndPrivateClassesInA: filter all changes for the selected change's class and its private classes (don't show it).
filterClassAndPrivateClassesInB: filter all changes for the selected change's class and its private classes (don't show it).
filterClassAndPrivateClassesInM: filter all changes for the selected change's class and its private classes (don't show it).
filterClassAndPrivateClassesNamed: nonMetaClassName: filter all changes for the given class and its private classes (don't show it).
filterClassInA: filter all changes for the selected change's class (don't show it).
filterClassInB: filter all changes for the selected change's class (don't show it).
filterClassInM: filter all changes for the selected change's class (don't show it).
filterClassNamed: nonMetaClassName: filter all changes for the given class (don't show it).
filterClassesMatching: ask for a GLOB pattern;
filter all changes with matching classnames .
filterMethod: aChange: filter this change (don't show it).
filterMethodInA: filter this entry (don't show it).
filterMethodInB: filter this entry (don't show it).
filterMethodInM: filter this entry (don't show it).
filterSelectorFromA: filter all changes for the selected change's selector(don't show it).
filterSelectorFromB: filter all changes for the selected change's selector(don't show it).
filterSelectorFromChange: aChange: common to set a filter;
gets the change as argument,
takes its selector and adds it to the filters
filterSelectorFromM: filter all changes for the selected change's selector(don't show it).
filterSelectorFromSet: setOfChanges: common to set a filter;
get the sub-set (A,B,M as argument),
takes its first selection and adds it to the filters
filterSelectorsMatching: ask for a GLOB pattern;
filter all changes with matching selectors.
forgetFilterNamed: forget a remembered named filter
importFilterParameters: ask for XML representation as exported previously.
(to be pasted from Jabber for interchange)
inspectFilterParameters: inspect the current settings
loadFilterNamed: load a remembered named filter
rememberFilterAs: remember the current settings under a named filter
removeAllClassFilters: clear all the current class filter (but not named ones)
removeAllSelectorFilters: clear all the current class filter (but not named ones)
removeClassPatternFilter: clear the current class filter (but not named ones)
removeSelectorPatternFilter: clear the current selector filter (but not named ones)
setFilterChangedAfter: aTimestamp
setFilterChangedBefore: aTimestamp
setFilterParameters: filter: setup from a remembered filter

menu action - searching

findNextChangeWithStringIn: listOfchanges selectionHolder: whichMethodSelectionHolder: common code to select the next change which contains some string
findNextChangeWithStringInA: select the next change which contains some string
findNextChangeWithStringInB: select the next change which contains some string
findNextChangeWithStringInM: select the next change which contains some string
findNextChangeWithStringInPairs: listOfchangePairs selectionHolder: whichMethodSelectionHolder: select the next change which contains some string

addAcceptToTextViewMenus: add to the standard diff text view or single text views menu an accept entry.
The acceptAction will fetch the corresponding change and apply it
(not the shown text)

<return: self>
informationUntranslated: msg: (comment from inherited method)
applications which want to show this in some info-area at the bottom
may redefine this or the informationHolder message.
printStringForChange: aChange: generate a print string for a change.
resetSelectionHolders: reset all selection holders when a new change set is given.
First set the selection to nil.

<return: self>
showDiffTextView: if a method change is selected, then show the diff text view.
Add an accept entry to the popup menu.

<return: self>
showSingleTextView: if a method is selected which is only in version A or B of the class,
then show the text view.
Add an accept entry to the popup menu.

<return: self>
showVersionInfoIfNothingSelected: show the revision info (author, date, time and logMessage),
if no method is selected

setup

setupForClass: aClass againstVersion: aVersionA: compute the class change set for the class aClass of its current version against the repository version A.
When setting the class change set, the labels, list etc. of the receiver
are updated.
setupForClass: classA labelA: aLabelA andClass: classB labelB: aLabelB: generate the class change set from the two classes A and B.
When setting the class change set, the labels, list etc. of the receiver
are updated.
setupForClass: aClass labelA: aLabelA sourceA: aSourceA labelB: aLabelB sourceB: aSourceB: generate the class change set from the two source files A and B.
When setting the class change set, the labels, list etc. of the receiver
are updated.
setupForClass: aClass versionA: aVersionA versionB: aVersionB: compute the class change set for the class aClass and the versions A and B.
When setting the class change set, the labels, list etc. of the receiver
are updated.
setupForDiffSet: diffSet labelA: aLabelA labelB: aLabelB

Private classes:

    ClassChangeSet
    FilterParameters

ST/X 7.2.0.0; WebServer 1.670 at bd0aa1f87cdd.unknown:8081; Fri, 26 Apr 2024 00:55:51 GMT