Update Eclipse project files

[Pieter12345]

This PR adds missing build path entries to the Java Eclipse IDE specific .classpath files, effectively resolving all compile errors in the project. An outdated license file for jmdns was also updated in the process.
The changes in this PR only affect people who use Java Eclipse to build this project.

This resolves issue #5459.

[Pieter12345]

@facchinm The requested change was made and the PR is up-to-date with master again. Is any additional action required to get this merged?
Edit: I've rebased this onto master, rather than merging master into this branch.

[Pieter12345]

Force pushed to c00e50a to also remove references to that removed library from the class path in the launcher config.xml and config_debug.xml files.

[Pieter12345]

These additional changes make the project more clean, but also allow running the Arduino IDE from Java Eclipse on Windows. To do so, create a run configuration for main class processing.app.Base with the following VM arguments:

-splash:"${workspace_loc:Arduino}/build/shared/lib/splash.png"
-Dsun.java2d.d3d=false
-Djna.nosys=true
-Djna.nounpack=true
-Djna.boot.library.name=jnidispatch-4.2.2-win32-x86
-Djna.boot.library.path="${workspace_loc:Arduino}/build/windows/work/lib"
-Djssc.library.path="${workspace_loc:Arduino}/build/windows/work/lib"
-DAPP_DIR="${workspace_loc:Arduino}/build/windows/work"

Note: To be able to run the project from Eclipse, ant build/run/dist has to be executed first to extract 3 required .dll files from library jars. This is also why the Eclipse build configuration options contain build/windows/work. If these .dll files were manually extracted, the project would be able to run without use of Ant, which allows developers to make and test changes without installing any additional software (other than a 32 bits JDK). The downside of this would be that adding these .dll files also adds redundancy. Note that on OSX and Unix, this might already be possible since they do not depend on these .dll files.

[Pieter12345]

Force pushed to revert linking to my personal 32 bits JVM by name in the .classpath file.

[Pieter12345]

Rebased this PR onto master.

[Pieter12345]

Rebased this PR onto master to resolve merge conflicts.

[Pieter12345]

In the current PR state, the following setup is possible in Eclipse by importing Arduino (my clone name), Arduino/app and Arduino/arduino-core into Eclipse:

Note that since parent project Arduino has the same source and binary directory as Arduino/app, it is not necessary to import Arduino/app as separate project. It is possible to remove the Arduino project setup so that it becomes just a container for the 2 child projects (or modules), I'd like to have your opinions on this @facchinm and @cmaglie.

[facchinm]

Hi @Pieter12345 ,
I just tried the complete patchset; there's a problem with 6ed443e (in fact it breaks ant build since the ant projects are no more self contained). A trivial patch is to reference the other folder in the lib search path, like this

diff --git a/arduino-core/build.xml b/arduino-core/build.xml
index cef9fe404..4ddbaea94 100644
--- a/arduino-core/build.xml
+++ b/arduino-core/build.xml
@@ -5,6 +5,9 @@
     <fileset dir="lib">
       <include name="*.jar"/>
     </fileset>
+    <fileset dir="../app/lib">
+      <include name="*.jar"/>
+    </fileset>
     <pathelement path="${env.JAVA_HOME}/lib/tools.jar"/>
   </path>
diff --git a/app/build.xml b/app/build.xml
index cc38670ad..08b57ba31 100644
--- a/app/build.xml
+++ b/app/build.xml
@@ -2,6 +2,9 @@
 <project name="Arduino PDE" default="build">
 
   <path id="class.path">
+    <fileset dir="../arduino-core/lib">
+      <include name="*.jar"/>
+    </fileset>
     <fileset dir="lib">
       <include name="*.jar"/>
     </fileset>

but I'm not a big fan of this approach. Probably unifying the lib folder and have it at the top level would work (not very Java-ish). @cmaglie any hint?

Anyway, I also haven't been able to setup the eclipse project to run; it looks like APP_DIR variable is not being applied, so all files are searched under app/lib/.
Did you find something similar?

[cmaglie]

It is possible to remove the Arduino project setup so that it becomes just a container for the 2 child projects (or modules)

I've successfully setup eclipse without the "parent" Arduino project, so I'm positive to removing it.

but I'm not a big fan of this approach. Probably unifying the lib folder and have it at the top level would work (not very Java-ish). @cmaglie any hint?

+1 to this too, but we should check launchers configuration for the "dist" target.

Need to fix ant build before going on

[Pieter12345]

I just tried the complete patchset; there's a problem with 6ed443e (in fact it breaks ant build since the ant projects are no more self contained). A trivial patch is to reference the other folder in the lib search path, but I'm not a big fan of this approach. Probably unifying the lib folder and have it at the top level would work (not very Java-ish). @cmaglie any hint?

I've tried putting a lib directory in the base directory, but there appears to be no way to link there other than making this lib a separate project as well (the reason it is possible to link to /arduino-core/lib/... from app is that arduino-core is a known project in the workspace). Ideally, I would like to see Apache Ant download and link dependencies like most Maven or Gradle projects do (Maven or Gradle actually replace the need for also having dependencies in the .classpath file, making it impossible to have mismatching dependency versions in config files). I have never worked with Ant before, so support for this in Ant is a gray area for me though.
As for fixing this issue for this PR without fixing the above mentioned technical debt, the two easiest solutions I can come up with are the one you mentioned and introducing duplicate jars again (have the same jar in both projects if both projects use it). I would be in favor of the first option, since the second allows more space for errors and non-deterministic behavior (unknown which version of a dependency is picked when two versions are available by accident) in my opinion. Any thoughts on this in combination with better dependency management @facchinm / @cmaglie ?

Anyway, I also haven't been able to setup the eclipse project to run; it looks like APP_DIR variable is not being applied, so all files are searched under app/lib/.
Did you find something similar?

Perhaps try to set your working directory (under run configurations) to the work directory?

[Pieter12345]

Rebased onto master.

[facchinm]

Perhaps try to set your working directory (under run configurations) to the work directory?

This may be in fact what In was missing 🙂

About the maven/gradle dependency manager I'm totally positive about adding it. The problem right now is really technical debt since we don't have a proper Java programmer. Any pull request is well accepted as usual, but this time it could be a bit cumbersome to provide test builds since the build environment would change too.

[Pieter12345]

About the maven/gradle dependency manager I'm totally positive about adding it. The problem right now is really technical debt since we don't have a proper Java programmer. Any pull request is well accepted as usual, but this time it could be a bit cumbersome to provide test builds since the build environment would change too.

Maven would fully replace Apache Ant, which means that the entire Build.xml files would have to be converted to pom.xml Maven files in an entirely different format. Finding a translation for all functionality and then translating it will likely take quite some time, but would be good for the project (less software to install to start developing (only Maven, which comes with most IDE's) and no more IDE-dependent (.classpath / .project files for Eclipse) files).
This indeed does affect the build environment. I could not find much info on the build environment, but it looks like it is some task that builds the software every hour (whether it changed or not) and does never run tests. What build software is actually used and how is it configured (I did not see a CI setup file in the repository)?

[facchinm]

The CI infrastructure is based on Jenkins and builds the IDE for every merged commit to compose the hourly build (crosscompiling with ant dist for every OS target). In parallel, some lower priority jobs build the IDE and run the tests on their native OS.

If we replace ant we need a tool that:

• compiles jars 🙂
• compresses/uncompresses archives
• controls checksums
• can invoke other jars (like appbundler)
• invokes external binaries
• runs tests

They all look simple (maybe appbundler is not so easy but there are a couple of projects on github that look ok).
@cmaglie what do you think about that?

[szb512]

revapi/testjars can compile jar files

[Pieter12345]

Need to fix ant build before going on

I've added a copy of the jars that are used in both app and arduino-core to app/lib, which should fix the Ant build. This might not be the ideal solution, but it should be sufficient for the scope of this PR. Changing the build system to download jars instead of including them as binaries would be the proper fix, but this falls out of scope for this PR.

As of this point, this PR:

• Fixes Eclipse project setup files (.classpath files and removal of the redundant parent container setup files).
• Cleans up dependencies (remove unused, update license file).
• Allows developers to run the Arduino IDE directly from Eclipse.

Can you validate that this change fixes the Ant build @facchinm? If so, is there anything left that prevents this PR from being merged?

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}