"

 COPYRIGHT (c) 2002 by eXept Software AG

              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' }"

Object subclass:#CodeGeneratorTool

	instanceVariableNames:'compositeChangeCollector compositeChangeNesting'

	classVariableNames:'GenerateCommentsForGetters GenerateCommentsForSetters'

	poolDictionaries:''

	category:'Interface-Browsers'

!

!CodeGeneratorTool class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 2002 by eXept Software AG

              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 utility class contains various code generation facilites;

    these were extracted from the old and newBrowser.

    There is probably more to come...

    [author:]

        Claus Gittiner

"

! !

!CodeGeneratorTool class methodsFor:'code generation'!

createAccessMethodsFor:aCollectionOfVarNames in:aClass withChange:withChange asValueHolder:asValueHolder readersOnly:readersOnly writersOnly:writersOnly

    "create accessors in aClass"

    ^ self new 

        createAccessMethodsFor:aCollectionOfVarNames 

        in:aClass 

        withChange:withChange 

        asValueHolder:asValueHolder 

        readersOnly:readersOnly 

        writersOnly:writersOnly

!

createApplicationCodeFor:aClass

    "create an empty application framework"

    ^ self new createApplicationCodeFor:aClass

!

createClassResponsibleProtocolFor:aClass

    "create stubs for the required protocol"

    ^ self new createClassResponsibleProtocolFor:aClass

!

createClassTypeTestMethodsIn:aClass forClasses:subClasses

    "create a #isXXX test methods (I'm tired of typing)"

    ^ self new createClassTypeTestMethodsIn:aClass forClasses:subClasses

!

createDocumentationMethodsFor:aClass

    "create empty documentation methods"

    ^ self new createDocumentationMethodsFor:aClass

!

createEnumTypeCodeFor:aClass

    ^ self new createEnumTypeCodeFor:aClass

!

createInitializedInstanceCreationMethodsIn:aClass

    "create a #new and #initialize methods (I'm tired of typing)"

    ^ self new createInitializedInstanceCreationMethodsIn:aClass

!

createParametrizedInstanceCreationMethodsNamed:selector in:aClass

    "create a #selector instance creation method (I'm tired of typing)"

    ^ self new createParametrizedInstanceCreationMethodsNamed:selector in:aClass

!

createTestCaseSampleCodeFor:aClass

    "create an (almost) empty testCase class"

    ^ self new createTestCaseSampleCodeFor:aClass

!

createVisitorMethodsIn:visitedClass andVisitorClass:visitorClass

    "create acceptVisitor: in visitedClass and acceptXXX in visitorClass. (I'm tired of typing)"

    ^ self new createVisitorMethodsIn:visitedClass andVisitorClass:visitorClass

!

createWebApplicationCodeFor:aClass

    "create an empty webApplication framework"

    ^ self new createWebApplicationCodeFor:aClass

!

initialMenuSpecMethodSourceForApplications

    "return a menuSpec with typical stuff in it"

    ^

'mainMenu

    "This resource specification was automatically generated by the CodeGeneratorTool."

    "Do not manually edit this!! If it is corrupted,

     the MenuEditor may not be able to read the specification."

    "

     MenuEditor new openOnClass:%1 andSelector:#mainMenu

    "

    <resource: #menu>

    ^ #(#Menu

           #(

             #(#MenuItem

                #label: ''File''

                #translateLabel: true

                #submenu: 

                 #(#Menu

                     #(

                       #(#MenuItem

                          #label: ''New''

                          #translateLabel: true

                          #value: #menuNew

                      )

                       #(#MenuItem

                          #label: ''-''

                      )

                       #(#MenuItem

                          #label: ''Open...''

                          #translateLabel: true

                          #value: #menuOpen

                      )

                       #(#MenuItem

                          #label: ''-''

                      )

                       #(#MenuItem

                          #label: ''Save''

                          #translateLabel: true

                          #value: #menuSave

                      )

                       #(#MenuItem

                          #label: ''Save As...''

                          #translateLabel: true

                          #value: #menuSaveAs

                      )

                       #(#MenuItem

                          #label: ''-''

                      )

                       #(#MenuItem

                          #label: ''Exit''

                          #translateLabel: true

                          #value: #closeRequest

                      )

                    ) nil

                    nil

                )

            )

             #(#MenuItem

                #label: ''Help''

                #translateLabel: true

                #startGroup: #right

                #submenu: 

                 #(#Menu

                     #(

                       #(#MenuItem

                          #label: ''Documentation''

                          #translateLabel: true

                          #value: #openDocumentation

                      )

                       #(#MenuItem

                          #label: ''-''

                      )

                       #(#MenuItem

                          #label: ''About this Application...''

                          #translateLabel: true

                          #value: #openAboutThisApplication

                      )

                    ) nil

                    nil

                )

            )

          ) nil

          nil

      )

'.

!

initialWindowSpecMethodSourceForApplications

    "return an empty windowSpec with an initial menubar in it"

    ^

'windowSpec

    "This resource specification was automatically generated by the CodeGeneratorTool."

    "Do not manually edit this!! If it is corrupted,

     the UIPainter may not be able to read the specification."

    "

     UIPainter new openOnClass:%1 andSelector:#windowSpec

    "

    <resource: #canvas>

    ^ #(#FullSpec

          #window: 

           #(#WindowSpec

              #name: ''%1''

              #layout: #(#LayoutFrame 204 0 162 0 503 0 461 0)

              #label: ''%1''

              #min: #(#Point 10 10)

              #max: #(#Point 1024 768)

              #bounds: #(#Rectangle 204 162 504 462)

              #menu: #mainMenu

              #usePreferredExtent: false

          )

          #component: 

           #(#SpecCollection

              #collection: #()

          )

      )

'.

!

initialWindowSpecMethodSourceForDialogs

    "return an empty windowSpec for dialogs"

    ^

'windowSpec

    "This resource specification was automatically generated by the CodeGeneratorTool."

    "Do not manually edit this!! If it is corrupted,

     the UIPainter may not be able to read the specification."

    "

     UIPainter new openOnClass:%1 andSelector:#windowSpec

    "

    <resource: #canvas>

    ^

       #(#FullSpec

          #window: 

           #(#WindowSpec

              #name: ''%1''

              #layout: #(#LayoutFrame 221 0 118 0 520 0 417 0)

              #level: 0

              #label: ''%1''

              #min: #(#Point 10 10)

              #max: #(#Point 1024 768)

              #bounds: #(#Rectangle 221 118 521 418)

              #usePreferredExtent: false

          )

          #component: 

           #(#SpecCollection

              #collection: 

               #(

                 #(#HorizontalPanelViewSpec

                    #name: ''buttonPanel''

                    #layout: #(#LayoutFrame 0 0.0 -45 1 0 1.0 0 1.0)

                    #component: 

                     #(#SpecCollection

                        #collection: 

                         #(

                          #(#ActionButtonSpec

                             #name: ''cancelButton''

                             #label: ''Cancel''

                             #tabable: true

                             #translateLabel: true

                             #model: #cancel

                             #extent: #(#Point 125 22)

                           )

                           #(#ActionButtonSpec

                              #name: ''okButton''

                              #label: ''OK''

                              #tabable: true

                              #translateLabel: true

                              #isDefault: true

                              #model: #accept

                              #extent: #(#Point 125 22)

                          )

                        )

                    )

                    #reverseOrderIfOKAtLeft: true

                    #horizontalLayout: #spreadSpaceMax

                    #verticalLayout: #center

                    #horizontalSpace: 3

                    #verticalSpace: 3

                )

              )

          )

      )

'.

! !

!CodeGeneratorTool class methodsFor:'code generation-basic'!

createAccessMethodsFor:aCollectionOfVarNames in:aClass withChange:withChange asValueHolder:asValueHolder readersOnly:readersOnly writersOnly:writersOnly lazyInitialization:lazyInitialization

    "workhorse for creating access methods for instvars."

    ^ self new 

        createAccessMethodsFor:aCollectionOfVarNames in:aClass withChange:withChange asValueHolder:asValueHolder readersOnly:readersOnly writersOnly:writersOnly lazyInitialization:lazyInitialization

! !

!CodeGeneratorTool class methodsFor:'code generation-individual methods'!

createAcceptVisitorMethod:selector in:aClass

    "create an acceptVisitor: method

     (I'm tired of typing)"

    ^ self new createAcceptVisitorMethod:selector in:aClass

!

createAcceptVisitorMethodIn:aClass

    "create an acceptVisitor: method

     (I'm tired of typing)"

    ^ self new createAcceptVisitorMethodIn:aClass

!

createCopyrightMethodFor:aClass

    "add copyright method containing your/your companies

     copyright template but only if not already present.

     this is only added, if specified in the 

     COPYRIGHT_TEMPLATE_FILE resources."

    ^ self new createCopyrightMethodFor:aClass

!

createDocumentationMethodFor:aClass

    "add documentation method containing doc template

     but only if not already present."

    ^ self new createDocumentationMethodFor:aClass

!

createExamplesMethodFor:aClass

    "add examples method containing examples template

     but only if not already present."

    ^ self new createExamplesMethodFor:aClass

!

createImageSpecMethodFor:anImage comment:comment in:aClass selector:sel

    ^ self new createImageSpecMethodFor:anImage comment:comment in:aClass selector:sel

!

createInitialHistoryMethodFor:aClass

    "add history method containing created-entry

     but only if not already present."

    ^ self new createInitialHistoryMethodFor:aClass

!

createInstanceCreationMethodWithSetupFor:selector category:category in:aMetaClass

    "add an inst-creation method"

    ^ self new createInstanceCreationMethodWithSetupFor:selector category:category in:aMetaClass

!

createMultiSetterMethodFor:aCollectionOfVarNames in:aClass

    "create a multi-setter method for instvars."

    ^ self new createMultiSetterMethodFor:aCollectionOfVarNames in:aClass

!

createSubclassResponsibilityMethodFor:aSelector category:cat in:aClass

    "add a subclassResponsibility method;

     but only if not already present."

    ^ self new createSubclassResponsibilityMethodFor:aSelector category:cat in:aClass

!

createUpdateMethodIn:aClass

    "create an update:with:from:-method

     (I'm tired of typing)"

    ^ self new createUpdateMethodIn:aClass

!

createVersionMethodFor:aClass

    "add version method containing RCS template

     but only if not already present and its not a private class."

    ^ self new createVersionMethodFor:aClass

! !

!CodeGeneratorTool class methodsFor:'compilation'!

compile:theCode forClass:aClass inCategory:cat 

    "install some code for a class.

     If refactory browser stuff is avaliable the refactory tools are used to support undo"

    ^ self new compile:theCode forClass:aClass inCategory:cat

! !

!CodeGeneratorTool class methodsFor:'private'!

canUseRefactoringSupport

    "check if refactory browser stuff is avaliable"

     ^ RefactoryChangeManager notNil 

    and:[RefactoryChangeManager isLoaded

    and:[UserPreferences current useRefactoringSupport]]

! !

!CodeGeneratorTool methodsFor:'buld changes'!

addChange:aChange

    compositeChangeCollector addChange:aChange

!

executeCollectedChangesNamed:name

    compositeChangeCollector notNil ifTrue:[

        compositeChangeNesting := compositeChangeNesting - 1.

        compositeChangeNesting == 0 ifTrue:[

            compositeChangeCollector name:name.

            compositeChangeCollector changesSize == 0 ifTrue:[

                self information:'Nothing generated.'.

            ] ifFalse:[

                RefactoryChangeManager instance performChange:compositeChangeCollector.

            ].

            compositeChangeCollector := nil.

        ]

    ]

!

startCollectChanges

    (self canUseRefactoringSupport) ifTrue:[

        compositeChangeCollector isNil ifTrue:[

            compositeChangeCollector := CompositeRefactoryChange new.

            compositeChangeNesting := 0.

        ].

        compositeChangeNesting := compositeChangeNesting + 1.

    ]

! !

!CodeGeneratorTool methodsFor:'code generation'!

createAccessMethodsFor:aCollectionOfVarNames in:aClass withChange:withChange asValueHolder:asValueHolder readersOnly:readersOnly writersOnly:writersOnly

    "create accessors in aClass"

    self

        createAccessMethodsFor:aCollectionOfVarNames 

        in:aClass 

        withChange:withChange 

        asValueHolder:asValueHolder 

        readersOnly:readersOnly 

        writersOnly:writersOnly 

        lazyInitialization:false

!

createApplicationCodeFor:aClass

    "create an empty application framework"

    |nonMetaClass metaClass className txt isDialog categoryForMenuActionsMethods|

    self startCollectChanges.

    categoryForMenuActionsMethods := UserPreferences current categoryForMenuActionsMethods.

    nonMetaClass := aClass theNonMetaclass.

    metaClass := aClass theMetaclass.

    className := nonMetaClass name.

    isDialog := (nonMetaClass isSubclassOf:SimpleDialog).

    "/ add a windowSpec method for an empty applicationWindow,

    "/ with a menuPanel.

    (metaClass includesSelector:#windowSpec) ifFalse:[

        isDialog ifTrue:[

            txt := self class initialWindowSpecMethodSourceForDialogs.

        ] ifFalse:[

            txt := self class initialWindowSpecMethodSourceForApplications.

        ].

        self

            compile:(txt bindWith:className)

            forClass:metaClass 

            inCategory:'interface specs'.

    ].