"

 COPYRIGHT (c) 2009 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:libtool2' }"

"{ NameSpace: Tools }"

AssistantApplication subclass:#ProjectBuilderAssistantApplication

	instanceVariableNames:'packageToBuildHolder projectType projectTypeHolder

		selectedProjectIndexHolder selectedProjectDefinition

		listOfMatchingProjects listOfMatchingPackageIds

		selectedProjectsComment hasProjectSelectedHolder newProjectsName

		hideSTXProjects hideOtherApplicationClasses

		hideOtherStartupClasses startMakeButtonEnabled

		stopMakeButtonVisible makeOutputHolder newApplicationsName

		listOfApplicationsInProject selectedApplicationIndexHolder

		selectedApplication hasApplicationSelectedHolder

		listOfStartupClassesInProject selectedStartupClassIndexHolder

		selectedStartupClass hasStartupClassSelectedHolder

		selectedApplicationsComment buildDirectoryHolder makeProcess

		listOfClassesInProject makeOutputWindow projectBuilder

		newStartupClassName usedCompilerHolder listOfNewProjectsName

		newProjectsNameListExtendedComboBox productNameHolder

		companyNameHolder compilerWarnMessageHolder

		compilerWarnMessageVisibleHolder listOfPrerequisitesInProject

		nameOfUsedCompilerSuiteHolder usedCompilerIndexHolder'

	classVariableNames:'LastUsedCompiler Debugging'

	poolDictionaries:''

	category:'System-Support-Projects'

!

!ProjectBuilderAssistantApplication class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 2009 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

"

    a user friendly interface to the build process.

    Simply wraps up existing tools like the CodeGeneratorTool, the browsers

    and the ProjetBuilder

    [see also:]

        CodeGeneratorTool

        ProjectBuilder

        ProjectDefinition

    [author:]

        Claus Gittinger

"

!

help

"

  Packager - A Standalone-Executable Builder and Packager

    This assistant-application allows for standalone applications to be built very easily. 

    It will generate all required classes, files, start the compilation process, 

    generate a self-installable executable with a few mouse clicks. 

    A simple demo application like the famous 'Hello World' can be generated in a few minutes.

  Prerequisites

    * Windows Users:

    Please install either the 'Borland Free Commandline Compiler Tools (bcc32)' 

    or the 'Microsoft Visual-C++' package (also free). 

     In addition, the 'NullSoft NSIS-Installer Package' is required.

    Due to limitations and bugs in the Visual-C++ compiler (limit on the size of 

    string-constants), some Smalltalk code is still not compilable 

    (currently, this affects classes which contain image-resource methods for big images). 

    Although microsoft is doing their best (a relative measure) to make things better 

    (they increase the string-limit with every new release), they still seem to be unable 

    to figure out how ti use malloc for string-data). 

    We are patiently waiting for a real fix and still using bcc in the meanwhile. 

    Therefore, we recommend using the borland compiler suite. 

    Please install it at its standard location ('C:\Borland') as our makefiles might 

    still contain hard-coded pathes (yes, we are ashamed about this).

    * Unix Users:

    You should already have the gcc compile suite (including all required header files) 

    installed and ready to use. For a lack of time on our side, there is currently no 

    self-installer support for Unix. The packager will generate a zipped tar file, 

    which must be deployed and unpacked for use. This may change in the near future.

  Packages, Projects, PackageIDs and ProjectDefinitions

    Smalltalk basically uses two objects for packaging:

        * PackageIDs (also called ProjectID's occasionally)

        * ProjectDefinitions 

    Older ST/X versions used instances of a Project class - this is now obsolete and 

    removed from the system (although there are still some minor uses of it, 

    which might remain there for backward compatibility for some time, as some customers 

    have built their own packaging scheme around it).

  PackageIDs

    These are simple symbols and are attached to classes and methods. If a method has 

    a packageID different from its class, it is called an extension method.

    PackageIDs must have a certain fixed format: they always contain exactly two parts, 

    which are separated by a colon character: the module and the directory part. 

    The module is used as main-selector on where and how the source code repository is 

    accessed. The directory is a path below that repository. If checked out into the local 

    filesystem, the module defines the top-level directory. Thus, if a packageID is 

    'stx:libbasic', the corresponding sources will be found in the repository associated 

    to the 'stx' module, under the directory 'libbasic'. 

    In the local file system, it will be found under 'stx/libbasic'. 

    As another example, if the packageID is 'exept:expecco/plugins/foo', 

    the repository is whichever is associated with the 'exept' module, and the subdirectory 

    is 'expecco/plugins/foo'. The local path to the sourcefiles would be 

    'exept/expecco/plugins/foo'.

    Please notice that it does make sense to associate different repositories to different 

    modules: for example, you could setup the sourceCodeManager to use CVS access to the 

    exept repository for everything under the 'stx' module, 

    and at the same time, use a local SVN repository for everything under the 'myCompany' 

    module.

  ProjectDefinitions

    These describe the contents of a project, such as the classes to include, 

    the set of extension methods, any additional compilation information. 

    ProjectDefinitions come in 3 flavours:

        * GUI Application Definition

        * non-GUI Application Definition

        * ClassLibrary Definition 

    ProjectDefinitions are stored and managed as class-instances, located as subclasses 

    of one of ApplicationDefinition or LibraryDefinition. 

    As classes, they are themself managed, compiled and packaged as part of the project 

    (and also have the same PackageID as their components). 

    They are also treated like any other class w.r.t. source code management.

  Packaging

    All classes and extension methods belonging to a single package are supposed to be 

    loaded (and possibly unloaded) together. They are also usually deployed inside a single 

    dynamic link library ('dll', for short). In the Unix world, these are called 

    'shared object' or 'so'. 

    Finally, they are stored in a common directory both on the local file system and in a 

    source code repository (CVS, SVN, etc.).

  Structure of a Project

    The artefacts as manipulated by the packager are:

        * the ProjectDefinition class

          This defines the type of application (GUI / non-GUI), 

          its contents (i.e. the set of classes to be included in the binary itself and 

          the set of library-dll's to be included in the deployed package), 

          and some other metadata, such as icon, title etc.

        * the ApplicationModel class

          This defines the GUI, and is typically created using the UI-Painter.

        * the Startup class

          This is the first class which gets control when the executable is started; 

          it can analyze the command line arguments, read patches or updates, 

          start background ptocesses, and will eventually open the applications GUI. 

  Build Procedure

    All of the three components above can be generated by the packager to provide an 

    initial framework for further work.

    After the definition of those classes, all required files are stored in a temporary 

    build directory. This means that the above classes are filed out, 

    and make- and other support files are generated.

    Finally, the actual build process is started. This requires an external C-compiler. 

    Under windows, both Borland-C (free download available via the internet) and Microsoft's 

    Visual-C++ (also available for free) can be used (the later with some limitations as explained above).

    A self-installing executable is built using the NullSoft NSIS package. 

    This is also required to be installed before the packager is started.

    After the build, all required files are packaged in a single install-file. 

    This is called 'MyApplicationSetup.exe' and found in the project-specific subdirectory 

    of the build directory. For deployment, this single file has to be delivered to a customer 

    and executed there.

    Summary: It has NEVER been easier to create a GUI application with Smalltalk. 

"

! !

!ProjectBuilderAssistantApplication class methodsFor:'assistant pages spec'!

assistantSpec

    ^ #(Array

        ( AssistantPageSpec

            pageTitle: 'Project Type Selection'

            windowSpecSelector: page1_projectTypeSelectionSpec

            enterCallbackSelector: updateListOfMatchingProjects

            infoText: 'Choose the <B>type</B> of project you are about to build.'

        )

        (AssistantPageSpec

            pageTitle: 'ProjectDefinition Selection'

            windowSpecSelector: page2_projectSelectionSpec

            enterCallbackSelector: updateListOfMatchingProjectsAndProjectIDs

            leaveCallbackSelector: fetchAttributesFromProjectDefinition

            infoText: 'Choose an existing project definition or create a new one. These are subclasses of <I>ProjectDefinition</I> and define the type and contents of a project. Notice that the ID directly reflects the project''s location within the source code repository (module:directory/subdirectory...). If in doubt, use "&lt;yourname&gt;:demos/xxx_n".'

        )

        (AssistantPageSpec

            pageTitle: 'Startup Application Selection'

            windowSpecSelector: page3_applicationSelectionSpec

            isEnabledQuerySelector: #projectTypeIsGuiApplication

            canEnterQuerySelector: #canEnterApplicationSelection

            enterCallbackSelector: updateListOfApplicationsInProject

            infoText: 'Choose an existing application or create a new one. These are subclasses of <I>ApplicationModel</I> and define the GUI and control flow inside the application. Can also be left blank if the startup class does it all (stx build).'

        )

        (AssistantPageSpec

            pageTitle: 'Startup Class Selection'

            windowSpecSelector: page4_startupClassSelectionSpec

            isEnabledQuerySelector: #projectTypeIsNotLibrary

            canEnterQuerySelector: #canEnterStartupClassSelection

            enterCallbackSelector: updateListOfStartupClassesInProject

            infoText: 'Choose an existing startup-class or create a new one. These are subclasses of <I>StandaloneStartup</I> and start the application. Command line arguments can be interpreted there.'

        )

        (AssistantPageSpec

            pageTitle: 'Specify Contents'

            windowSpecSelector: page5_specifyIncludedClasses

            enterCallbackSelector: enterContentsSpecification

            canEnterQuerySelector: #canEnterContentsSelection

            infoText: 'Define which (other) classes are to be included. Do not include classes from other packages here. Press "<I>Scan</I>" to include all classes of the package; "<I>Browse</I>" to edit the contents manually.'

        )

        (AssistantPageSpec

            pageTitle: 'Specify Prerequisites'

            windowSpecSelector: page5b_specifyPrerequisitePackages

            enterCallbackSelector: enterPrerequisitesSpecification

            canEnterQuerySelector: #canEnterPrerequisitesSelection

            infoText: 'Define which packages are needed as prerequisites. These are required class libraries which should be packaged together with the application. Press "<I>Scan</I>" to search for prerequisites; "<I>Browse</I>" to edit the list manually.'

        )

        (AssistantPageSpec

            pageTitle: 'Specify Project Attributes'

            windowSpecSelector: page6a_specifyProjectAttributes

            infoText: 'Define additional attributes. These will be shown during the installation of the deployed package and affect the name of the deployed self installable file.'

            enterCallbackSelector: updateProjectAttributes

            leaveCallbackSelector: #rememberProjectAttributes

        )

        (AssistantPageSpec

            pageTitle: 'Specify Build Directory'

            windowSpecSelector: page6b_specifyBuildDirectorySpec

            infoText: 'Define where the build-process is to be performed and which compiler to use. All generated files are created below that directory. After deployment, the build directory is no longer needed (but you can keep it for a faster compile the next time).'

            enterCallbackSelector: #checkCompilerAvailability

            leaveCallbackSelector: #rememberUsedCompiler

        )

        (AssistantPageSpec

            pageTitle: 'Check Into Source Repository'

            windowSpecSelector: page7a_checkinSpec

            enterCallbackSelector: #checkSourceCodeManagerType

            infoText: 'Check the package''s source and build-support files into the source code repository.'

        )

        (AssistantPageSpec

            pageTitle: 'Build'

            windowSpecSelector: page7b_buildSpec

            canEnterQuerySelector: #canEnterBuild

            enterCallbackSelector: #restoreMakeOutputsContents

            leaveCallbackSelector: #rememberMakeOutputsContents

            infoText: 'Start the build-process. This will run "make"+"bcc/vc/gcc" to compile all required classes and "nsis" to generate a self-installable executable (on windows). 

You must have the compiler (borland-bcc or visual-c) and NullSoft NSIS packages installed for this to work.

Without NSIS, zip the folder where the exe is generated and unzip on a target machine.

<P>

To try the application, open an explorer/finder on the directory and double click on the executable.

Alternatively, open a command window and type the name of the executable there. Sorry, but double-click in the ST/X file browser does not work.'

        )

        (AssistantPageSpec

            pageTitle: 'Deploy'

            windowSpecSelector: page8_deploySpec

            canEnterQuerySelector: #canEnterDeploy

            infoText: 'Find the installer-file to be deployed (or test-run the executable). 

You can open a Windows-explorer/finder there to copy the files for deployment. After that, the build directory is no longer needed. However, you can keep it for a faster compile the next time.'

        )

    ) decodeAsLiteralArray.

    "Modified: / 04-09-2012 / 09:49:50 / cg"

! !

!ProjectBuilderAssistantApplication class methodsFor:'defaults'!

defaultIcon

    <resource: #programImage>

    ^ ToolbarIconLibrary projectBuilderIcon

!

windowLabelTemplate

    ^ 'ST/X Packager: %1'

! !

!ProjectBuilderAssistantApplication class methodsFor:'help'!

flyByHelpSpec

    <resource: #help>

    ^ super flyByHelpSpec addPairsFrom:#(

#'projectType'

'Choose the type of Project you are about to deploy'

#existingProjects

'Projects with an existing ProjectDefinition of the chosen type (above)'

#nameOfApplicationClass

'For GUI applications: the name of your application class (subclass of ApplicationModel).

This will be opened by the startup sequence and defines the UI.

(Usually, these are named "XXXApplication" or "XXXApp")

Click on the "Create"-button to create a simple helloWorld app to start with'

#createNewApplication

'Create a new simple dummy application (HelloWorld-like). 

Press this button to get some template code to play with - but enter a name first'

#nameOfStartupClass

'This class contains the main method, in which the show starts when the executable runs.

Its main task is to parse command line arguments (if any) and fire up the real application.

It should inherit from StandaloneStartup.

(Usually, these are named "XXXStart" or "XXXStartup")

Click on the "Create"-button to create something to start with (will launch your application)'

#createNewStartupClass

'Create a new simple startup class which fires up the defined application.

Press this button to get a standard startup class which does not care for command line args.

But enter a name first'

#browseSelectedProject

'Open a SystemBrowser on the selected Project'

#hideSTXBasePackages

'Only show packages which are not already included in the basic ST/X delivery'

#'listOfNewProjectsName'

'PackageID (module:directory).

The pull-down list contains packageIDs for which no ProjectDefinition exists (yet)'

#'createNewProject'

'PackageID (module:directory).

Click to create a new (empty) ProjectDefinition for the given PackageID'

#clearBuildDirectory

'Clear the build directory'

#makeAll

'Build a self-installing deployable package'

#makeApp

'Build the app only (for test-running)'

#makeExe

'Build the executable only (for test-running)'

#makeExeQuick

'Quick build the executable only (for test-running). 

Does not regenerate the header files. Only the target package files are recreated'

#makeOutput

'Displays the output of the build process (make command)'

#openExplorer

'Open a Windows Explorer on the build directory. You can double-click on the built executable there'

#openFinder

'Open a Finder on the build directory. You can double-click on the built executable there'

#openFileBrowser

'Open a Filebrowser on the build directory'

#openTerminal

'Open a terminal (console) in the build directory'

#stopMake

'Abort the ongoing build process. Please clear the build directory afterwards to remove any leftover garbage'

#hideOtherStartupClasses

'Hide startup classes from other packages. Uncheck to see them.\(Notice: the startup class really should be in the same package)'

)

    "Modified: / 06-09-2012 / 16:09:10 / cg"

! !

!ProjectBuilderAssistantApplication class methodsFor:'help specs'!

helpSpec

    "This resource specification was automatically generated

     by the UIHelpTool of ST/X."

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

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

    "

     UIHelpTool openOnClass:Tools::ProjectBuilderAssistantApplication    

    "

    <resource: #help>

    ^ super helpSpec addPairsFrom:#(

#hideOtherStartupClasses

''

)

! !

!ProjectBuilderAssistantApplication class methodsFor:'interface specs'!

page1_projectTypeSelectionSpec

    "This resource specification was automatically generated

     by the UIPainter of ST/X."

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

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

    "

     UIPainter new openOnClass:Tools::ProjectBuilderAssistantApplication andSelector:#page1_projectTypeSelectionSpec

     Tools::ProjectBuilderAssistantApplication new openInterface:#page1_projectTypeSelectionSpec

    "

    <resource: #canvas>

    ^ 

     #(FullSpec

        name: #'page1_projectTypeSelectionSpec'

        window: 

       (WindowSpec

          label: 'Project Selection'

          name: 'Project Selection'

          min: (Point 0 0)

          bounds: (Rectangle 0 0 626 394)

        )

        component: 

       (SpecCollection

          collection: (

           (FramedBoxSpec

              label: 'Project Type'

              name: 'FramedBox1'

              layout: (LayoutFrame 0 0.0 0 0 4 1.0 120 0)

              activeHelpKey: projectType

              labelPosition: topLeft

              translateLabel: true

              component: 

             (SpecCollection

                collection: (

                 (VerticalPanelViewSpec

                    name: 'VerticalPanel1'

                    layout: (LayoutFrame 0 0.0 0 0.0 0 1.0 0 1.0)

                    horizontalLayout: leftSpace

                    verticalLayout: topSpace

                    horizontalSpace: 3

                    verticalSpace: 3

                    component: 

                   (SpecCollection

                      collection: (

                       (ViewSpec

                          name: 'Box1'

                          extent: (Point 10 10)

                        )

                       (RadioButtonSpec

                          label: 'GUI Application'