"

 COPYRIGHT (c) 2002 by eXept Software AG

 COPYRIGHT (c) 2016 Jan Vrany

 COPYRIGHT (c) 2021 LabWare

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

"{ NameSpace: Smalltalk }"

Object subclass:#CodeGeneratorTool

	instanceVariableNames:'compositeChangeCollector compositeChangeNesting userPreferences

		generateComments confirmChanges targetClass'

	classVariableNames:'GenerateCommentsForGetters GenerateCommentsForSetters

		CopyrightTemplate'

	poolDictionaries:''

	category:'Interface-Browsers'

!

!CodeGeneratorTool class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 2002 by eXept Software AG

 COPYRIGHT (c) 2016 Jan Vrany

 COPYRIGHT (c) 2021 LabWare

              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...

    Note: being refactored into separate per-language generators

    [author:]

        Claus Gittiner

"

! !

!CodeGeneratorTool class methodsFor:'instance creation'!

new

    ^ self basicNew initialize.

! !

!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

!

createInitializationMethodIn:aClass

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

    ^ self new createInitializationMethodIn:aClass

!

createInitializedInstanceCreationMethodsIn:aClass

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

    ^ self new createInitializedInstanceCreationMethodsIn:aClass

!

createIsAbstractMethodIn:aClass

    "create a #isABstract query method (I'm tired of typing)"

    ^ self new createIsAbstractMethodIn:aClass

!

createParametrizedInstanceCreationMethodsNamed:selector in:aClass

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

    ^ self new createParametrizedInstanceCreationMethodsNamed:selector in:aClass

!

createRedefinedInstanceCreationMethodsIn:aClass

    "create a redefined #new method"

    ^ self new createRedefinedInstanceCreationMethodsIn:aClass

!

createSingletonPatternInstanceCreationMethodsIn:aClass usingVariable:varName

    "create redefined #new method for singleton pattern"

    ^ self new createSingletonPatternInstanceCreationMethodsIn:aClass usingVariable:varName

    "Created: / 10-02-2011 / 16:32:43 / cg"

!

createStandaloneStartupCodeFor:aClass

    "create an empty console application framework"

    ^ self new createStandaloneStartupCodeFor:aClass

    "Created: / 19-08-2011 / 01:58:57 / cg"

!

createStartupCodeFor:aClass forStartOf:anApplicationClassOrNil

    "create standAloneStartup code"

    ^ self new createStartupCodeFor:aClass forStartOf:anApplicationClassOrNil

!

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

!

createWebServiceCodeFor:aClass

    "create an empty webService framework"

    ^ self new createWebServiceCodeFor:aClass

!

createWidgetCodeFor:aClass

    "create usually required widget code (redraw, model update, event handling)"

    ^ self new createWidgetCodeFor:aClass

!

initialMenuSpecMethodSourceForApplications

    "return code for a menuSpec with typical stuff in it"

    self subclassResponsibility

!

initialPageMenuSpecMethodSourceForWebApplications

    "return code for a menuSpec with typical stuff in it"

    self subclassResponsibility

    "

     SmalltalkCodeGeneratorTool initialPageMenuSpecMethodSourceForWebApplications

    "

!

initialPageSpecMethodSourceForWebApplications

    "return an empty pageSpec"

    self subclassResponsibility

!

initialToolbarMenuSpecMethodSource

    "return a menuSpec with typical stuff in it"

    self subclassResponsibility

    "

     SmalltalkCodeGenerator initialToolbarMenuSpecMethodSource

    "

!

initialWindowSpecMethodSourceForApplications

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

    self subclassResponsibility

    "

     SmalltalkCodeGeneraotTool initialWindowSpecMethodSourceForApplications

    "

!

initialWindowSpecMethodSourceForDialogs

    "return an empty windowSpec for dialogs"

    self subclassResponsibility

    "

     SmalltalkCodeGeneraotTool initialWindowSpecMethodSourceForDialogs

    "

! !

!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

!

createAspectMethodFor:anAspectSymbol in:aClass

    "create an aspect method."

    ^ self new createAspectMethodFor:anAspectSymbol in: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

!

createFalseReturnMethodFor:aSelector category:cat in:aClass

    "add a ^ false method;

     but only if not already present."

    ^ self new createFalseReturnMethodFor:aSelector category:cat in: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

!

createMultiSetterInstanceCreationMethodFor:aCollectionOfVarNames in:aClass

    "create a multi-setter instance creator method for instvars.

     This creates a multi setter method (a:val1 b:val2 c:val3...)

     and a corresponding new method on the class side."

    ^ self new createMultiSetterInstanceCreationMethodFor:aCollectionOfVarNames in:aClass

!

createMultiSetterMethodFor:aCollectionOfVarNames in:aClass

    "create a multi-setter method (a:val1 b:val2 c:val3...) 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 a version method containing RCS template

     but only if not already present and it's not a private class."

    ^ self new createVersionMethodFor:aClass

    "Modified (comment): / 21-08-2012 / 11:55:15 / cg"

! !

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

createActionMethodFor:aSelector in:aClass category:aCategory redefine:redefine

    self subclassResponsibility

!

createAspectMethodFor:aSelector in:aClass category:aCategory redefine:redefine

    self subclassResponsibility

! !

!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:'defaults'!

copyrightTemplate

    "return the contents of COPYRIGHT_TEMPLATE_FILE resources

     or a standard template"

    |fn copyrightHolder|

    CopyrightTemplate notNil ifTrue:[^ CopyrightTemplate].

    fn := SystemBrowser classResources at:#'COPYRIGHT_TEMPLATE_FILE' default:nil.

    fn notNil ifTrue:[

        fn := fn asFilename.

        fn exists ifTrue:[

            ^ fn contentsAsString.

        ].

    ].

    (OperatingSystem getDomainName endsWith:'exept.de') ifTrue:[

        copyrightHolder := 'eXept Sofware AG'.

    ] ifFalse:[

        copyrightHolder := '>>your company<<'.

    ].

    ^ ' COPYRIGHT (c) %1 by %2

              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.' bindWith:(Date today year) with:copyrightHolder.

!

copyrightTemplate:aString

    "set the COPYRIGHT_TEMPLATE_FILE"

    CopyrightTemplate := aString.

! !

!CodeGeneratorTool class methodsFor:'interface specs'!

initialMenuSpecForApplications

    "return a menuSpec with typical stuff in it"

    "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:self andSelector:#initialMenuSpecForApplications

    "

    <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: 'MENU_Help'

                #translateLabel: true

                #startGroup: #right

                #submenu: 

                 #(#Menu

                     #(

                       #(#MenuItem

                          #label: 'Documentation'

                          #translateLabel: true

                          #value: #openDocumentation

                      )

                       #(#MenuItem

                          #label: '-'