Haxe4E - Haxe programming language support for the Eclipse IDE

Feedback and high-quality pull requests are highly welcome!

1. About
2. Installation
3. Building from Sources
4. Acknowledgement
5. License

About

Haxe4E is an extension for the Eclipse IDE to support development using the Haxe general purpose programming language.

Features

• Syntax Highlighting
• Source Code Formatting
• Auto Completion
• Code Refactoring
• Running and debugging of Haxe Eval programs
• Display project dependencies in project outline

Installation

If you don't have Eclipse installed you can install Haxe Studio - a custom Eclipse distribution - which has this plugin preinstalled.

To install Haxe4E into an existing Eclipse installation do:

1. Within Eclipse go to: Help -> Install New Software...
2. Enter the following update site URL: https://raw.githubusercontent.com/haxe4e/haxe4e/updatesite
3. Select the Haxe4E feature to install.
4. Ensure that the option Contact all update sites during install to find required software is enabled.
5. Click Next twice.
6. Read/accept the license terms and click Finish.
7. Eclipse will now download the necessary files in the background.
8. When the download has finished, Eclipse will ask about installing unsigned content. You need to accept if you want to
9. After installation you will be prompted for a restart of Eclipse, which is recommended.

Building from Sources

To ensure reproducible builds this Maven project inherits from the vegardit-maven-parent project which declares fixed versions and sensible default settings for all official Maven plug-ins.

The project also uses the maven-toolchains-plugin which decouples the JDK that is used to execute Maven and it's plug-ins from the target JDK that is used for compilation and/or unit testing. This ensures full binary compatibility of the compiled artifacts with the runtime library of the required target JDK.

To build the project follow these steps:

1. Download and install a Java 17 SDK, e.g. from:

   • https://github.com/ojdkbuild/ojdkbuild
   • https://adoptium.net/releases.html?variant=openjdk17
   • https://www.azul.com/downloads/?version=java-17-lts&architecture=x86-64-bit&package=jdk#download-openjdk

2. Download and install the latest Maven distribution.

3. In your user home directory create the file .m2/toolchains.xml with the following content:

   <?xml version="1.0" encoding="UTF8"?>
   <toolchains>
      <toolchain>
         <type>jdk</type>
         <provides>
            <version>17</version>
            <vendor>default</vendor>
         </provides>
         <configuration>
            <jdkHome>[PATH_TO_YOUR_JDK_17]</jdkHome>
         </configuration>
      </toolchain>
   </toolchains>

   Set the [PATH_TO_YOUR_JDK_17] parameter accordingly.

4. Checkout the code using one of the following methods:

   • git clone https://github.com/haxe4e/haxe4e
   • svn co https://github.com/haxe4e/haxe4e haxe4e

5. Run mvn clean verify in the project root directory. This will execute compilation, unit-testing, integration-testing and packaging of all artifacts.

Acknowledgement

Haxe4E was created by Sebastian Thomschke and is sponsored by Vegard IT GmbH.

Haxe4E would not have been possible without the following technologies and learning resources:

Technologies/Libraries

• Haxe Language Server
• Haxe TextMate Grammar
• Haxe Formatter
• Eclipse Platform
• Eclipse LSP4E - Language Server Protocol for Eclipse
• Eclipse TM4E - TextMate support for Eclipse
• Eclipse Tycho - tools to build Eclipse plug-ins with Maven
• Eclipse RedDeer - UI testing framework

Tutorials

• https://eclipse.org/articles
  • Understanding Decorators
  • Using Progress Monitors
  • On the Job: The Eclipse Jobs API
• https://blogs.itemis.com
  • Eclipse Actions für Project und Package Explorer
• https://www.vogella.com/tutorials
  • Eclipse IDE Plug-in Development: Plug-ins, Features, Update Sites and IDE Extensions
  • Creating Eclipse Wizards
  • Eclipse Project Natures
  • Developing an Eclipse language server integration
  • Defining custom launcher for the Eclipse IDE
  • Testing Eclipse application with the RedDeer framework
• http://blog.eclipse-tips.com
  • Selection Dialogs in Eclipse

License

If not otherwise specified (see below), files in this repository fall under the Eclipse Public License 2.0.

Individual files contain the following tag instead of the full license text:

SPDX-License-Identifier: EPL-2.0

This enables machine processing of license information based on the SPDX License Identifiers that are available here: https://spdx.org/licenses/.

An exception is made for:

1. files in readable text which contain their own license information, or
2. files in a directory containing a separate LICENSE.txt file, or
3. files where an accompanying file exists in the same directory with a .LICENSE.txt suffix added to the base-name of the original file. For example foobar.js is may be accompanied by a foobar.LICENSE.txt license file.