Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Debug/Plan/3.6/Launch Templates"
(→Delete a template) |
(→Remove the template attribute) |
||
| Line 55: | Line 55: | ||
When a template is deleted in the LCD, users could be prompted to update all configurations assocaited with the template (i.e. to no longer be assocaited with the template). The user could decide not to update associated configurations such that the template could later be replaced and all references would become satisfied. | When a template is deleted in the LCD, users could be prompted to update all configurations assocaited with the template (i.e. to no longer be assocaited with the template). The user could decide not to update associated configurations such that the template could later be replaced and all references would become satisfied. | ||
| − | === Remove | + | === Remove template status === |
| + | |||
| + | A template can be made into an ordinary configuration by unchecking the "Template" box in the LCD. The user could be prompted to update all referencing configurations (similar to when a template is deleted). | ||
=== Disconnect a configuration from its template === | === Disconnect a configuration from its template === | ||
=== Associate a configuration with an existing template === | === Associate a configuration with an existing template === | ||
Revision as of 10:34, 14 October 2009
Contents
- 1 Launch Configuration Template Use Cases
- 1.1 Create a new template
- 1.2 Create a template from an existing configuration
- 1.3 Assign a default template to a project
- 1.4 Assign a default template to a workspace
- 1.5 Create a configuration based on a specific template
- 1.6 Create a configuration based on a project/workspace default template
- 1.7 Update a configuration from its associated template
- 1.8 Update all configurations made from a template
- 1.9 Rename a template
- 1.10 Delete a template
- 1.11 Remove template status
- 1.12 Disconnect a configuration from its template
- 1.13 Associate a configuration with an existing template
Launch Configuration Template Use Cases
The following use cases are intended to be used a starting point for launch configuration template design and integration into the debug platform.
Create a new template
Creating a new template is just like creating a new launch configuration. Use the "New" or "Duplicate" button in the launch configuration dialog (LCD) to create a new configuration and then click the "Template" check box to indicate that the configuration is a template.
A new (one line) set of controls could be added to the LCD underneath the existing "Name" section in the LCD, including a "template" check box.
Create a template from an existing configuration
Select the configuration in the LCD and click the "Template" check box to indicate that the configuration is a template.
Assign a default template to a project
A default template can be set for each launch configration type, for each project. From the "Properties > Run/Debug Settings" for a project, the user can use check boxes to select the default configuration for a project (the viewer in the properties page will become a check box list). Similarly, we could allow a default template to be set for any workspace folder, to allow for a rich set of default configurations.
An API will be available to set a default template per launch configuration type for any given scope (using IScopeContext's - the same construct used for workspace preference settings). This allows a default template per launch configuration type to be set using a project scope.
Assign a default template to a workspace
A default template can be set for each launch configuration type in the workspace. When a launch configuration type is selected in the LCD, the tab area will be enhanced to display a check box list of all templates of that type. The check box can be used to select one template as workspace default for that type.
Create a configuration based on a specific template
Select the template in the LCD and press the "New" button. This will create a new configuration associated with the selected template, initialized with attributes from the template.
Create a configuration based on a project/workspace default template
When a new template is created in the LCD or from invoking a launch shortcut, project and workspace default template settings should be taken into account to initialize newly created configurations. The debug platform can leverage configuration resource mappings to determine what template should be used to initialize newly created configurations.
- Select a launch configuration type node in the LCD and press the "New" button. This will create a new configuration and initialize it with default settings - ususally based on the selected resource or active editor in the workbench and usually sets a resource mapping for the configuration. The platform will locate a template based on project and workspace default settings for the configuration type and copy attributes from the first template found into the new configuration.
- Similarly, when a launch shortcut creates a configuration and sets a resource mapping, this will trigger template initialization.
Additionally, and API will be available to create a configuration based on a set of scopes (the same as preference scopes - project, workspace, etc.), and set a default configuration for a given scope. A launch shortcut could use the new API to explicitly control what template is used (if any) when creating a new configuration. However, to allow existing shortcuts to benefit from launch templates, resource mappings will be used to trigger template initialization.
Update a configuration from its associated template
A configuration can be initialized from a template, after which any of its attributes can be modified (including those specified by its template). The new template controls/widgets in the LCD will indicate that a configuration is "Based on template: [X]", and provide a button to "Restore" the configuration with template values. The button will only be enabled when an attribute in the configuration differs from its associated template. Pressing "Restore" will copy the attributes from the associated template to the configuration.
Update all configurations made from a template
From time to time, attributes in a template will be modified. The user can use the new "Apply..." button in the template controls to push all of the existing values out to the configurations associated with the template. The user could be prompted with a list of configurations that will be updated, and could potentially make the update selective.
Rename a template
Launch configurations keep track of which template (if any) they are based on. When a template is renamed in the LCD, all configurations made from that template may be updated to refer to the renamed template. This is much like a refactoring.
When the user renames a configuration that is a template and presses apply (or triggers a save via run/debug buttons), we could prompt the user on whether or not to update all references to the template.
Delete a template
When a template is deleted in the LCD, users could be prompted to update all configurations assocaited with the template (i.e. to no longer be assocaited with the template). The user could decide not to update associated configurations such that the template could later be replaced and all references would become satisfied.
Remove template status
A template can be made into an ordinary configuration by unchecking the "Template" box in the LCD. The user could be prompted to update all referencing configurations (similar to when a template is deleted).