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 "PTP/ETFw/PTP External Tools Framework Feedback View"
< PTP
(New page: This page will contain information about the ETFw Feedback view.) |
|||
| Line 1: | Line 1: | ||
| − | + | The Parallel Tools Platform External Tools Framework Feedback view provides an eclipse view, exposing information found e.g. in an XML file, with convenient mapping and navigation to source lines referenced in the XML file. For example, a compiler or analysis tool may expose items of interest in an XML file and list the filename and line number (or range of lines, or character region) applicable to the item found. A performance tool may note regions of interest with source code lines that are referenced. | |
| + | |||
| + | The PTP ETFw Feedback view allows a convenient way to expose this information in a way that allows the user to easily navigate to the source code lines in the user's source code. | ||
| + | |||
| + | == Show Items in feedback view == | ||
| + | |||
| + | As an example, check out the org.eclipse.ptp.etfw.feedback.sample project from CVS: | ||
| + | |||
| + | * Host: dev.eclipse.org | ||
| + | * Repository path: /cvsroot/tools | ||
| + | * Under HEAD, scroll down to org.eclipse.ptp and expand it. | ||
| + | * Expand tools/etfw | ||
| + | * Check out org.eclipse.ptp.etfw.feedback.sample | ||
| + | |||
| + | Launch a development eclipse workspace | ||
| + | |||
| + | # Create a basic C project (or almost any type of Eclipse project will do) | ||
| + | # Put the xml file in the project (e.g. use data/sample.xml in the above project) | ||
| + | # Put source files referenced in the xml file(s) in the same directory (e.g. use data/sample.c from the above project) as the xml file, unless you put specific code in your plug-in to find them. | ||
| + | # Select the xml file in the Project Explorer view Hit the (purple) button in the toolbar (Hover says "Show Feedback View for selected XML File") | ||
| + | # The xml file is parsed by the SampleFeedbackParser class, IFeedbackItems are created, and markers are created for each of these, which appear in the Feedback view. | ||
| + | #* The items are initially all collapsed. You can expand individual parent nodes, or use the "Expand All" button in the view's toolbar (see red arrow in middle of image above\) to see more information. | ||
| + | # To see the source file line referred to by an item, double-click on the line in the Feedback view. | ||
| + | # To see more information on an item, rightMouse and select "Show Info", or select the item and hit the "Show Info" (icon "i") button in the view toolbar. | ||
Revision as of 00:07, 30 November 2009
The Parallel Tools Platform External Tools Framework Feedback view provides an eclipse view, exposing information found e.g. in an XML file, with convenient mapping and navigation to source lines referenced in the XML file. For example, a compiler or analysis tool may expose items of interest in an XML file and list the filename and line number (or range of lines, or character region) applicable to the item found. A performance tool may note regions of interest with source code lines that are referenced.
The PTP ETFw Feedback view allows a convenient way to expose this information in a way that allows the user to easily navigate to the source code lines in the user's source code.
Show Items in feedback view
As an example, check out the org.eclipse.ptp.etfw.feedback.sample project from CVS:
- Host: dev.eclipse.org
- Repository path: /cvsroot/tools
- Under HEAD, scroll down to org.eclipse.ptp and expand it.
- Expand tools/etfw
- Check out org.eclipse.ptp.etfw.feedback.sample
Launch a development eclipse workspace
- Create a basic C project (or almost any type of Eclipse project will do)
- Put the xml file in the project (e.g. use data/sample.xml in the above project)
- Put source files referenced in the xml file(s) in the same directory (e.g. use data/sample.c from the above project) as the xml file, unless you put specific code in your plug-in to find them.
- Select the xml file in the Project Explorer view Hit the (purple) button in the toolbar (Hover says "Show Feedback View for selected XML File")
- The xml file is parsed by the SampleFeedbackParser class, IFeedbackItems are created, and markers are created for each of these, which appear in the Feedback view.
- The items are initially all collapsed. You can expand individual parent nodes, or use the "Expand All" button in the view's toolbar (see red arrow in middle of image above\) to see more information.
- To see the source file line referred to by an item, double-click on the line in the Feedback view.
- To see more information on an item, rightMouse and select "Show Info", or select the item and hit the "Show Info" (icon "i") button in the view toolbar.