8295884: Implement IDE support for Eclipse by TheShermanTanker · Pull Request #10853 · openjdk/jdk

TheShermanTanker · 2022-10-25T13:23:34Z

Eclipse is a popular and very well-known IDE in the world of Java development, utilized widely in many contexts, by beginners and experienced teams alike. Although a relatively lightweight IDE, it features surprisingly powerful indexing and code analysis capabilities, as well as useful tools, among which are make integration. While the tools it provides are not always as sophisticated as other IDEs (IntelliJ IDEA will likely come to mind as one such competitor), the simplicity of using it, as well as the reliability of this rugged IDE makes up greatly for the slightly less advanced tooling. Eclipse requires very little starting infrastructure in the workspace for all these features and indexing support as well, which makes it a good candidate for developing on the JDK.

This enhancement adds 4 extra targets to the make system for generating a basic Eclipse Workspace that provides almost full indexing support for the JDK, with varying levels as desired, from a minimalistic option only including the Java Virtual Machine's source code, to generating a workspace with both Java and C/C++ natures included, which allows for using Eclipse's unique ability to quickly swap between Java and C/C++ mode to work on both native and Java sources at the same time. Cross Compiling support is available, and in its entirety the change touches very little of the existing make system, barring its own Makefile within the ide subdirectory.

Indexing capabilities utilizing the enhancement:

Progress

Change must be properly reviewed (1 review required, with at least 1 Reviewer)
Change must not contain extraneous whitespace
Commit message must refer to an issue

Issue

JDK-8295884: Implement IDE support for Eclipse

Reviewers

Erik Joelsson (@erikj79 - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk pull/10853/head:pull/10853
$ git checkout pull/10853

Update a local copy of the PR:
$ git checkout pull/10853
$ git pull https://git.openjdk.org/jdk pull/10853/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 10853

View PR using the GUI difftool:
$ git pr show -t 10853

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/10853.diff

bridgekeeper · 2022-10-25T13:24:52Z

👋 Welcome back jwaters! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

openjdk · 2022-10-25T13:30:18Z

@TheShermanTanker The following labels will be automatically applied to this pull request:

build
ide-support

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

mlbridge · 2022-10-25T14:09:26Z

Webrevs

erikj79

This looks like nice work.

I'm curious how does this eclipse project figures out preprocessor settings like -D flags from the build to correctly setup the environment for the native code? I know this was a major deal when creating the compile-commands.json for other native IDE integrations. I've heard some IDEs just run the build once and inspect the command lines, but our default log level won't show that. I'm not familiar with eclipse project files, but I couldn't really see anything here that addressed this issue. Can you work with the native code in a meaningful way without it?

make/ide/eclipse/CreateWorkspace.gmk

TheShermanTanker · 2022-10-26T09:59:13Z

This looks like nice work.

I'm curious how does this eclipse project figures out preprocessor settings like -D flags from the build to correctly setup the environment for the native code? I know this was a major deal when creating the compile-commands.json for other native IDE integrations. I've heard some IDEs just run the build once and inspect the command lines, but our default log level won't show that. I'm not familiar with eclipse project files, but I couldn't really see anything here that addressed this issue. Can you work with the native code in a meaningful way without it?

You're right, it seems I forgot to also include the preprocessor defines in the generated workspace :P
I'll add them in the next commit, thanks for catching that. Eclipse does work very well with native code even without those defines and flags from the build for the most part though, just that utilities which require them (For instance something like PRODUCT_ONLY and NOT_PRODUCT in HotSpot) wouldn't properly work with the indexer, which would be annoying, but it's more of a mild inconvenience than anything.

openjdk-notifier · 2022-10-26T10:12:09Z

@TheShermanTanker Please do not rebase or force-push to an active PR as it invalidates existing review comments. All changes will be squashed into a single commit automatically when integrating. See OpenJDK Developers’ Guide for more information.

tstuefe · 2022-10-26T10:15:10Z

Will this work with jtreg test sources too? At least on Intellij those require a brittle intellij plugin.

TheShermanTanker · 2022-10-27T02:50:56Z

I've heard some IDEs just run the build once and inspect the command lines, but our default log level won't show that.

I also forgot to mention that CDT does come with an integrated Build Output Parser that can do just that, but I do want to avoid using it, if possible, since it's much more convenient to be able to start working on code the moment configure completes instead of having to wait for the build to finish once

…aces including native code

TheShermanTanker · 2023-03-07T15:56:44Z

@erikj79 @magicus Seems like this is the best I can do for now, baseline support for Eclipse should now be present with these final touchups (Environment setup is not fully complete yet, but Eclipse is flexible enough that for most development work, this should not be too problematic). I do plan to refine support for it in the future, since there are still areas for improvement, but at present I think this should be decent enough for the time being

magicus · 2023-03-07T16:14:32Z

make/ide/eclipse/workspace.template

+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+    <name>Java</name>
+    <comment>The official Java HotSpot Virtual Machine, Runtime Environment, and Development Kit</comment>


Just call it OpenJDK; there is a legal trademark swamp associated with "Java".

Got it, will also rename it to just jdk to match the cloned repository to be extra safe

magicus · 2023-03-07T16:14:57Z

make/ide/visualstudio/hotspot/CreateVSProject.gmk


-  # Use server as base for defines and includes
-  JVM_VARIANT=server
+  # Use primary variant for defines and includes


This might be a correct fix but it is independent of this PR.

Submitted https://bugs.openjdk.org/browse/JDK-8303760 and #12906 to fix that issue separately

TheShermanTanker · 2023-03-09T08:25:27Z

:(

erikj79

Functionally this looks ok to me, just some comment on cosmetics.

doc/ide.md

make/ide/eclipse/CreateWorkspace.gmk

Co-authored-by: Erik Joelsson <37597443+erikj79@users.noreply.github.com>

TheShermanTanker · 2023-03-10T15:04:24Z

Alright, that should be all of them

doc/ide.md

make/ide/eclipse/CreateWorkspace.gmk

openjdk · 2023-03-14T13:10:05Z

@TheShermanTanker This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8295884: Implement IDE support for Eclipse

Reviewed-by: erikj

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 167 new commits pushed to the master branch:

ec1eb00: 8303415: Add VM_Version::is_intrinsic_supported(id)
31680b2: 8303410: Remove ContentSigner APIs and jarsigner -altsigner and -altsignerpath options
0cc0f06: 8304015: G1: Metaspace-induced GCs should not trigger maximal compaction
43eca1d: 8303910: jdk/classfile/CorpusTest.java failed 1 of 6754 tests
b6d70f2: 8303973: Library detection in runtime/ErrorHandling/TestDwarf.java fails on ppc64le RHEL8.5 for libpthread-2.28.so
2bb990e: 8301244: Tidy up compiler specific warnings files
c073ef2: 8303482: Update LCMS to 2.15
49181b8: 8303955: RISC-V: Factor out the tmp parameter from copy_memory and copy_memory_v
7bbc5e0: 8300517: Refactor VisibleMemberTable (method members)
a8f662e: 8303908: Add missing check in VTMS_transition_disable_for_all() for suspend mode
... and 157 more: https://git.openjdk.org/jdk/compare/b51ea4204eaa18687e7712e87cdc92efbddfcb5b...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

TheShermanTanker · 2023-03-14T14:23:22Z

Thanks Erik!

@magicus is this final revision ok with you?

TheShermanTanker · 2023-03-14T17:29:57Z

/integrate

TheShermanTanker · 2023-03-14T17:31:29Z

Sorry this took so long, for everyone that was waiting for this. Do note that C support may still be a little wonky in some cases, if there are any bugs do feel free to send me a message in this Pull Request (doesn't matter that it's already been integrated)

openjdk · 2023-03-14T17:32:37Z

Going to push as commit 45809fd.
Since your change was applied there have been 176 commits pushed to the master branch:

baf11e7: 8303814: getLastErrorString should avoid charset conversions
830fd41: 8302795: Shared archive failed on old version class with jsr bytecode
4e631fa: 8298966: Deprecate JMX Subject Delegation and the method JMXConnector.getMBeanServerConnection(Subject) for removal.
10f1674: 8303809: Dispose context in SPNEGO NegotiatorImpl
9f9ab02: 8303895: Simplify and clean up LinkFactory code
a00f5d2: 8303861: Error handling step timeouts should never be blocked by OnError and others
da044dd: 8300939: sun/security/provider/certpath/OCSP/OCSPNoContentLength.java fails due to network errors
c466cdf: 8299546: C2: MulLNode::mul_ring() wrongly returns bottom type due to casting errors with large numbers
55aa122: 8304059: Use InstanceKlass in dependencies
ec1eb00: 8303415: Add VM_Version::is_intrinsic_supported(id)
... and 166 more: https://git.openjdk.org/jdk/compare/b51ea4204eaa18687e7712e87cdc92efbddfcb5b...master

Your commit was automatically rebased without conflicts.

openjdk · 2023-03-14T17:32:53Z

@TheShermanTanker Pushed as commit 45809fd.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

TheShermanTanker added 2 commits October 25, 2022 20:18

Implement Eclipse support

0c24f5d

Documentation

d698ab7

openjdk bot changed the title ~~8295884~~ 8295884: Support for developing with the Eclipse IDE Oct 25, 2022

TheShermanTanker changed the title ~~8295884: Support for developing with the Eclipse IDE~~ 8295884: Support for development with the Eclipse IDE Oct 25, 2022

openjdk bot added build build-dev@openjdk.org ide-support ide-support-dev@openjdk.org labels Oct 25, 2022

TheShermanTanker marked this pull request as draft October 25, 2022 13:33

Carriage Returns

310efd2

TheShermanTanker force-pushed the eclipse branch from b6a85ca to 310efd2 Compare October 25, 2022 13:38

TheShermanTanker added 2 commits October 25, 2022 21:46

Whitespace

b1d7fff

Formatting

a1d02f7

TheShermanTanker marked this pull request as ready for review October 25, 2022 14:01

openjdk bot added the rfr Pull request is ready for review label Oct 25, 2022

erikj79 reviewed Oct 25, 2022

View reviewed changes

make/ide/eclipse/CreateWorkspace.gmk Outdated Show resolved Hide resolved

Merge

839db0b

TheShermanTanker added 2 commits October 26, 2022 18:54

File operations should use MakeIO.gmk

42278c7

Squash issue with commas

5891398

TheShermanTanker changed the title ~~8295884: Support for development with the Eclipse IDE~~ 8295884: Implement IDE support for Eclipse Oct 27, 2022

Merge

d35062e

TheShermanTanker added 4 commits October 27, 2022 11:31

Prevent Eclipse from automatically attaching binary parsers to worksp…

2dca7ca

…aces including native code

Initial support for Language Settings Providers

8402431

Nuke accidental comment not meant to be added

e667491

SINGLE_DOLLAR is not required

4e468aa

TheShermanTanker added 3 commits March 5, 2023 03:05

Explicitly forbid Visual C++

9449372

Formatting

85df2b7

Wording

13c0b9b

magicus reviewed Mar 7, 2023

View reviewed changes

Address Review and add extra comments

2ceb46a

erikj79 reviewed Mar 9, 2023

View reviewed changes

TheShermanTanker and others added 5 commits March 10, 2023 02:08

make/ide/eclipse/CreateWorkspace.gmk

01f9f71

Co-authored-by: Erik Joelsson <37597443+erikj79@users.noreply.github.com>

make/ide/eclipse/CreateWorkspace.gmk

4d00b4c

Co-authored-by: Erik Joelsson <37597443+erikj79@users.noreply.github.com>

make/ide/eclipse/CreateWorkspace.gmk

61a97a2

Co-authored-by: Erik Joelsson <37597443+erikj79@users.noreply.github.com>

Indents

f3dd379

More Indents

8593183

erikj79 reviewed Mar 13, 2023

View reviewed changes

doc/ide.md Outdated Show resolved Hide resolved

make/ide/eclipse/CreateWorkspace.gmk Outdated Show resolved Hide resolved

make/ide/eclipse/CreateWorkspace.gmk Outdated Show resolved Hide resolved

Review

99ea34d

erikj79 approved these changes Mar 14, 2023

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Mar 14, 2023

openjdk bot added the integrated Pull request has been integrated label Mar 14, 2023

openjdk bot closed this Mar 14, 2023

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Mar 14, 2023

TheShermanTanker deleted the eclipse branch March 14, 2023 17:33

Conversation

TheShermanTanker commented Oct 25, 2022 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented Oct 25, 2022

Uh oh!

openjdk bot commented Oct 25, 2022

Uh oh!

mlbridge bot commented Oct 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

erikj79 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

TheShermanTanker commented Oct 26, 2022

Uh oh!

openjdk-notifier bot commented Oct 26, 2022

Uh oh!

tstuefe commented Oct 26, 2022

Uh oh!

TheShermanTanker commented Oct 27, 2022

Uh oh!

TheShermanTanker commented Mar 7, 2023

Uh oh!

magicus Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

TheShermanTanker Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

magicus Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

TheShermanTanker Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

TheShermanTanker commented Mar 9, 2023

Uh oh!

erikj79 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TheShermanTanker commented Mar 10, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

openjdk bot commented Mar 14, 2023

Uh oh!

TheShermanTanker commented Mar 14, 2023

Uh oh!

TheShermanTanker commented Mar 14, 2023

Uh oh!

TheShermanTanker commented Mar 14, 2023

Uh oh!

openjdk bot commented Mar 14, 2023

Uh oh!

openjdk bot commented Mar 14, 2023

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

TheShermanTanker commented Oct 25, 2022 •

edited by openjdk bot

Loading

mlbridge bot commented Oct 25, 2022 •

edited

Loading

erikj79 left a comment •

edited

Loading