intel Installing Eclipse Plugins from the IDE User Guide

: June 9, 2024
: Intel

Table of Contents

intel Installing Eclipse Plugins from the IDE
Product Information: Eclipse* Plugins Installation
Notices and Disclaimers
Product Usage: Installing Eclipse* Plugins from the IDE
To Install Plugins with the Command Line
Install Eclipse* Plugins
Notices and Disclaimers
References
Read User Manual Online (PDF format)
Download This Manual (PDF format)

intel Installing Eclipse Plugins from the IDE

intel-Installing-Eclipse-Plugins-from-the-IDE-
PRODUCT

Product Information: Eclipse* Plugins Installation

Eclipse* plugins are additional software components that can be installed to enhance the functionality of the Eclipse IDE for C/C++ Developers. These plugins are included with the oneAPI tools package and can be installed using the command line or from within the Eclipse IDE. Before installing the plugins, ensure that CMake is installed on your system.

Notices and Disclaimers

Refer to the oneAPI Release Notes and License agreement for additional information regarding the installation and use of the Eclipse plugins.

Product Usage: Installing Eclipse* Plugins from the IDE

Locate the Eclipse plugins included with your oneAPI tools package. These plugins should be located in a folder named “ide_support” within each tool that includes an Eclipse plugin.
Open a command terminal and launch your installation of Eclipse for C/C++ Developers (Eclipse CDT).
Click on “Help” in the top menu and select “Install New Software”.
Click the “Add” button and then click “Archive” in the dialog box that appears.
Navigate to the location of the Eclipse plugin you wish to install.
Repeat this process for each Eclipse plugin that you want to install.
The plugin will be installed and should be available for use within the Eclipse IDE.

To Install Plugins with the Command Line

Use the “install-eclipse-plugins.sh” script located in /dev-utilities/latest/bin/.
Use the script with the “-h” or “–help” argument to display a help message.
Use the script with the “-v” or “-V” argument to enable verbose mode for troubleshooting purposes.
The script will prompt you for the location of the Eclipse binary into which you want to install the plugin.

Install Eclipse* Plugins

NOTE If you are using Eclipse with FPGA, see Intel® oneAPI DPC++ FPGA Workflows on Third-Party IDEs.

If you are going to use Eclipse IDE, there are some additional setup steps:

Locate the Eclipse plugins that were included with your oneAPI tools (see the note below).
Ensure that CMake has been installed.
Install plugins from the command line or Eclipse IDE.

NOTE
You can find the Eclipse plugins to install into your copy of the Eclipse IDE for C/C++ Developers in the
various tool folders located within the oneAPI installation folder, which is normally found in /opt/intel/oneapi or ~/intel/oneapi, depending on whether you installed the package as the superuser. Those plugins should be located in a folder named ide_support within each tool that includes an Eclipse plugin.

To locate all the Eclipse plugins that are part of your installation:

Open a terminal session (bash shell) and change directory to the root of your installation. For example, if you installed as the superuser using the default folder:
cd /opt/intel/oneapi
Use the find command to locate the available Eclipse plugin packages:
find . -type f -regextype awk -regex “.(com.intel|org.eclipse).[.]zip”
The find results look like this (the exact results depend on which tools you installed):

Install from Command Line or IDE
You can install the Intel plug ins using the command line or using Eclipse IDE.

To Install Plugins with the Command Line
For the Command Line, use the install-eclipse-plugins.sh script. Go to:

/dev-utilities/latest/bin/

The script does not require arguments to run. You can get a help message using any of the following:
./ install-eclipse-plugins.sh -h
./ install-eclipse-plugins.sh –help

Running the setvars.sh script will add install-eclipse-plugins.sh to your path (for the current terminal session):

/setvars.sh

The script supports a verbose mode which can be helpful if you are having issues running the script, especially if the script is failing to do its work. Use verbose mode as follows:
./ install-eclipse-plugins.sh -v
./ install-eclipse-plugins.sh -V

The script will ask for the location of the Eclipse binary into which you want to install or update the Intel plug-ins for Eclipse.

NOTE Enter the path to the eclipse executable, not just to the folder that contains the executable. Please make sure you enter the full absolute path to the eclipse executable. Relative paths with tilde ‘~’ are not supported.

The script performs the following operations:

Looks for Eclipse plug-ins included in the installed toolkit(s) and checks which are already installed in the selected copy of Eclipse.
Uninstalls any plug-in conflicts and runs the Eclipse garbage collector to clean up the uninstall.
Installs the included toolkit plug-ins into the selected copy of Eclipse.

To install the Eclipse plugins from the IDE:

Open a command terminal and launch your installation of Eclipse for C/C++ Developers (Eclipse CDT).
Once Eclipse launches, choose Help > Install New Software.
Click the Add button and then click Archive in the dialog box that appears.
Navigate to the location of the Eclipse plugin you wish to install.
NOTE If you cannot remember the location of the plugin, run the find command in a shell to show the locations of available plugins.
Repeat this process for each Eclipse plugin that you want to install. In this image, the compiler plugin (last in the previous find command list example) is being selected for installation into the copy of Eclipse for C/C++ Developers.
Select the plugin file (using the green Open button shown in the previous image), and then click the Add button in the Add Repository dialog box. The Location field should match the Eclipse plugin path and name that you identified using the file picker.
Check the boxes next to the name of the selected plugin or plugins, and then click Next.
Confirm that the plugin to be installed is listed in the Install Details dialog box, and then click Next.
Review the license agreement (you must select the I accept option to proceed), and then select Finish to start installation of the plugin.
After you click Finish, Eclipse installs the plugin.
The installation process may take several minutes if the plugin has required dependencies that are not part of your copy of Eclipse. That is most likely to happen if you are installing into a different build of Eclipse. For example, if you install the plugin into a copy of Eclipse IDE for Java Developers (aka Eclipse JDT) the missing Eclipse for C/C++ components will be automatically added, along with the plugin. A working Internet connection is required if this is the case and missing dependent plugins are required.
When the plugin installation is complete, Eclipse prompts you to restart. Click Restart Now. Do this for each plugin you add to your copy of Eclipse for C/C++ Developers.

Notices and Disclaimers

Intel technologies may require enabled hardware, software or service activation.
No product or component can be absolutely secure.
Your costs and results may vary.
© Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others.

Product and Performance Information

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.
Notice revision #20201201
No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document.
The products described may contain design defects or errors known as errata which may cause the product to deviate from published specifications. Current characterized errata are available on request.
Intel disclaims all express and implied warranties, including without limitation, the implied warranties of merchantability, fitness for a particular purpose, and non-infringement, as well as any warranty arising from course of performance, course of dealing, or usage in trade.