Skip to content

haxe4e/haxe-studio

Repository files navigation

Haxe Studio - the Eclipse based Haxe IDE

Build Status License Contributor Covenant

Feedback and high-quality pull requests are highly welcome!

  1. About
  2. Download
  3. Usage
  4. Building from Sources
  5. Acknowledgement
  6. License

About

Haxe Studio is an Eclipse based IDE designed for development with the Haxe general purpose programming language.

It has the following plugins pre-installed:

Download

You can download the latest platform-specific releases from here:

Usage

Please check the Wiki

Common Key Bindings

Action Eclipse Haxe Studio vscode
Open Find Actions (Command Palette) CTRL+3 CTRL+3 F1 / CTRL+SHIFT+P
Open Quick Outline CTRL+O CTRL+O n/a
Full Screen Toggle ALT+F11 F11 F11
Format Source Code CTRL+SHIFT+F CTRL+SHIFT+F ALT+SHIFT+F
Go to Method/Type Declaration F3 F3 F12
Zoom In/Out CTRL++/- CTRL++/- CTRL++/-

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 plugins.

The project also uses the maven-toolchains-plugin, which decouples the JDK used to execute Maven and its plugins from the target JDK used for compilation and 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. Install a Java 17 JDK

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

  2. Configure Maven Toolchains

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

    <?xml version="1.0" encoding="UTF8"?>
    <toolchains xmlns="http://maven.apache.org/TOOLCHAINS/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://maven.apache.org/TOOLCHAINS/1.1.0 https://maven.apache.org/xsd/toolchains-1.1.0.xsd">
       <toolchain>
          <type>jdk</type>
          <provides>
             <version>17</version>
             <vendor>default</vendor>
          </provides>
          <configuration>
             <jdkHome>[PATH_TO_YOUR_JDK_17]</jdkHome>
          </configuration>
       </toolchain>
    </toolchains>

    Replace [PATH_TO_YOUR_JDK_17] with the path to your JDK installation.

  3. Clone the Repository

    git clone https://github.com/haxe4e/haxe-studio.git
  4. Build the Project

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

Acknowledgement

See https://github.com/haxe4e/haxe4e/blob/main/README.md#acknowledgement

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.