Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "Debug/Plan/3.6/Launch Templates"

(Defing default launch settings for a project)
(Launch Configuration Template Use Cases)
Line 20: Line 20:
  
 
Alternatively, double-clicking on an existing template will create a configuration based on that template.
 
Alternatively, double-clicking on an existing template will create a configuration based on that 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 all configurations made from a template ===
 
=== Update all configurations made from a template ===

Revision as of 12:06, 16 October 2009

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

To creating a template use the "New" drop down button in the LCD tree viewer toolbar, and select "Template".

Create a template from an existing configuration

Select the configuration in the LCD and click the "Template" toolbar button.

A configuration will automatically become a template if an existing configuration is dropped on it as a child configuration.

An "Add..." button on the LCD type page could be provided to add existing configurations to the template list.

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.

Alternatively, double-clicking on an existing template will create a configuration based on that template.

Update all configurations made from a template

From time to time, attributes in a template will be modified. When the "Apply" button is pressed the user will be prompted to update all children configurations (and have the option to "do not ask again").

A button should also be available in the toolbar to apply a template to all of its children.

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 will be updated to refer to the renamed template. This is much like a refactoring.

Delete a template

When a template is deleted in the LCD, users will be prompted to delete all children assocaited with the template. When children are not deleted, they are moved up a level in the tree (re-parented).

Remove template status

A template can be made into an ordinary configuration by selecting the template in the LCD type page, and pressing the "Remove" button. All of its decendents will be moved up one level in the tree.

Disconnect a configuration from its template

Drag & drop allows a user to re-parent it to a different template or to no template (dropping on configuration type node).

Associate a configuration with an existing template

A template can be associated with an existing template using drag & drop (dropping on the template). When this happens, the user will be prompted to apply the template settings to the freshly dropped template (with a "do not ask again" option).

Launch Configuration Template User Interface

Checkbox viewer on launch configuration type page

Currently, when a launch configuration type is selected in the LCD, a page of instructions is displayed on how to create and manage launch configrations.

  • Add a check box list to this page showing all templates of the selected type. The checked template specifies the workspace default template.
  • An "Add..." button allows existing configurations to become templates.
  • A "Remove" button allows a configuration to be made into a normal configuration, re-parenting its existing children.

Checkbox viewer on Run/Debug settings property page

Currently, the Run/Debug settings property page is a flat list. We will make this into a check box list for projects such a that a default template can be specified at the project level.

LCD tree viewer

  • The "New" button will be enhanced to be a drop down to allow a new "Configuration" or "Template" to be created.
  • The tree viewer in the LCD will nest configurations by templates - i.e. all children of a template will be displayed as children of that template in the tree.
  • Double-clicking a template in the tree will create a new configration based on the clicked template
  • The tree will support drag & drop to allow configurations to be re-parented under a different template (or disasscoiated with any template by dragging to the top level).
  • A button will be added to the toolbar to allow the selected template to be applied/pushed to all children.

Launch Configuration Template API

API will added to the following interfaces to support launch configuration templates

ILaunchConfigurationType

  • Set a default template for a specified scope (or remove when null)
  • Get the default template for a given scope (may return null)
  • Get all templates of this type
  • Create a new working copy based on a given set of scopes

ILaunchConfigurationWorkingCopy

  • Set whether a configuration is a template
  • Set the template a configuration is based on
  • Copy attributes from a template (any configuration) into the working copy

ILaunchConfiguration

  • Return whether a configuration is a template
  • Get the template a configuration is based on (may be null)
  • Get all configurations a template is associated with

AbstractLaunchConfigurationTab

  • A new method to validate templates. The default implementation will not validate templates (as they will usually have sparse/incomplete information that would be invalid). Clients can provide an implementation of the new method to perform template validation as needed.

Images

  • The launchConfigurationTypeImages extension will be enhanced to allow a custom image to be provided for templates.

Default Launch Configuration Settings (Workspace, Project preferences)

Related to launch configuration templates, are default workspace and project settings for launch configurations. Users can acheive features similar to default workspace/project settings by managing templates, but the SDK could also offer explicit support for this.

A user may want to define default settings for certain launch aspects. For example, a default JRE or VM arguments to use for all Java applications. Although this could be achieved with a template, one could imagine having default settings that could be applied to newly created launch configurations. Default settings work like preferences - they are used to override settings in specific launch configurations, but the launch configurations themselves contain no backpointer/reference to the settings (unlike a configuration based on a template, which keeps track of which template it was based on). The user can maintain a hierarchy of templates orthoganal to default settings. Newly created templates would obtain default settings the same way a configuration would.

Define default launch settings for a workspace

Default workspace settings can be defined for each launch configuration type available in the workspace.

Define default launch settings for a project

Default settings may also be specified and shared at the project level.

Back to the top