Haxe plugin for IntelliJ Platform based IDEs
Java Haxe Other
Latest commit bd307e1 Mar 30, 2016 @as3boyan as3boyan Merge pull request #23 from TiVo/JetBrainsPRfor0.9.10
Pull 0.9.10 release sources from TiVo fork up to Jetbrains.
Permalink
Failed to load latest commit information.
.idea just revert ant.xml project file (my mistake to commit that) Feb 25, 2016
common Fixing regexp to match errors on windows platform. Feb 8, 2016
doc Add new build and test instructions to README and CONTRIBUTING files. Apr 23, 2015
gen/com/intellij/plugins/haxe hxml: fix qualifiedName + improved highlighting Feb 1, 2016
grammar Issue TiVo #278 May 27, 2015
hxcpp-debugger-protocol Unknown semantics: WIP update Unknown in generics Jun 25, 2015
jps-plugin Optimized imports - no other logic, functional changes. Jun 4, 2015
resources committed to fast-forward Sep 24, 2014
src Release 0.9.10 prep. Update release notes, CHANGELOG, and CONTRIBUTORS. Mar 25, 2016
testData Merge FixCompletionForSuperWord Mar 23, 2016
testSrc/com/intellij/plugins/haxe Merge FixCompletionForSuperWord Mar 23, 2016
.gitignore - Improved a bit Type parsing (not function type parsing yet) Jun 3, 2015
.travis.yml Update IDEA15 builds to use version 15.0.4. Mar 23, 2016
CHANGELOG.md Release 0.9.10 prep. Update release notes, CHANGELOG, and CONTRIBUTORS. Mar 25, 2016
CONTRIBUTING.md Update release notes and CONTIBUTING doc. Feb 9, 2016
CONTRIBUTORS.md Release 0.9.10 prep. Update release notes, CHANGELOG, and CONTRIBUTORS. Mar 25, 2016
LICENSE.txt Added license Jun 14, 2013
Makefile Use v15 as the default installation for make. Feb 9, 2016
README.md More detailed installation instructions in the README. Feb 25, 2016
build-haxe-protocol.sh added file to build JavaProtocol.hx class to Java Mar 13, 2015
build-parsers.sh added script to build haxe and hxml parsers using GrammarKit Mar 16, 2015
build-test.xml Fix "Command line too long" error when compiling with Oracle JDK8. Feb 1, 2016
build.sh compatible with IDEA 14.1 (part1) Apr 16, 2015
build.xml Turn down the noise on the ant build. Feb 2, 2016
common.xml Some tweaks for better default builds on OS X. Feb 11, 2016
fetchIdea.sh Revert recent change to disable plugins in fetchidea.sh. Apr 17, 2015
idea_v14.1.5.properties v14.1.5 builds, required some refactoring of the build scripts. Jan 18, 2016
idea_v14.1.properties v14.1.5 builds, required some refactoring of the build scripts. Jan 18, 2016
idea_v14.properties Update release notes. Jan 19, 2016
idea_v15.properties Limit use to v15 builds. Feb 9, 2016
intellij-haxe.iml Add terminating <module> tag in the module file. Oct 13, 2015
travis.sh For CI, allow specific ant targets for each build version. Feb 2, 2016
update-contributors.sh added contributor list and script to update it Mar 13, 2015

README.md

Haxe plugin for Intellij IDEA

This plugin allows you to develop Haxe programs with Intellij IDEA. It requires Intellij IDEA Ultimate or Community Edition, versions 14 or 15.

Install

JetBrains' official plugin installation documentation is at https://www.jetbrains.com/idea/plugins/. The Haxe plugin page is https://plugins.jetbrains.com/plugin/6873?pr=idea.

To install using IDEA (from Intellij plugin repository):

Install and start IDEA. It is found at https://www.jetbrains.com/idea

If you do not have a project open in IDEA (and after first-time setup):

  • On the IDEA welcome screen, select "Configure(dropdown)->Plugins"
  • Click on the "Browse Repositories..." button.
  • Type 'haxe' to see the description for the plugin.
  • Select 'Install' to install it.
  • Allow IDEA to restart and initialize the plugin.

If you already have a project open in IDEA:

  • Open the Settings dialog (File->Settings...)
  • Highlight "Plugins" in the leftmost column
  • Click on the "Browse Repositories..." button.
  • Type 'haxe' to see the description for the plugin.
  • Select 'Install' to install it.
  • Allow IDEA to restart and initialize the plugin.

To manually install the latest or a previous Github release

Download the intellij-haxe.jar file from the release you want from Github releases. More recent releases have begun to be named intellij-haxe-<release>.jar, where <release> is the version of Idea for which the Jar is built. (e.g. intellij-haxe-14.1.1.jar) Make sure that you pick the proper one for your release. A message should pop up and warn you if a release is incompatible.

If you do not yet have a project open in IDEA (and after first-time setup):

  • On the IDEA welcome screen, select "Configure(dropdown)->Plugins"
  • Click “Install plugin from disk...”
  • Select the “intellij-haxe.jar” file you downloaded
  • Allow IDEA to restart and initialize the plugin.

If you already have a project open IDEA:

  • Open the Settings dialog (File->Settings...)
  • Highlight "Plugins" in the leftmost column
  • Click “Install plugin from disk...”
  • Select the “intellij-haxe.jar” file you downloaded
  • Allow IDEA to restart and initialize the plugin.

Build

This describes the command line build on a Linux platform. To build from Intellij IDEA itself, see the contributing document to setup your development environment. Much more detail is provided there for command line build options as well.

Dependencies

  • Ant
  • Oracle JDK 7 or Open JDK 7
  • Make
  • A bash compatible shell

Build command

make

This will generate a intelllij-haxe-<release>.jar file at the root of the project that you can then install from disk (see “Install the latest or a previous Github release). Note that the default make will build the plugin for Idea 13.1.6. To override the default, set the IDEA_VERSION environment variable prior to executing make.

IDEA_VERSION=14.1.1 make

Note that building via make will download the requested version of IntelliJ Ultimate (to a temporary directory) every time a build is started. This can be quite slow at times. For repeated building and testing, we recommended that you set up your machine as described in the contributing document.

Test

Dependencies

Same as for build.

Test command

make test

This will build and run the tests and display the JUnit report. Again, you can override the Idea version being tested against by overriding IDEA_VERSION.

IDEA_VERSION=14.1.1 make test

Use the hxcpp debugger

The hxcpp debugger functionality has been rewritten to conform to the Haxe v3.0 debugger. In order to use this, you must:

  • Install the newest debugger haxelib from https://github.com/TiVo/debugger. The haxecpp-debugger that is installed via 'haxelib install' is generally not the latest or best working version. (The Haxe Foundation maintainers do not release regular updates for it). Instead, get the current sources locally: Install git and clone the repository from http://github.com/HaxeFoundation/hxcpp-debugger and install via haxelib git <your_local_clone>. Then, you'll have the version that matches the plugin. Whenever you need to update the debugger to the latest sources, do a 'git pull' and then rebuild your app.
  • Re-build your project using this newest debugger haxelib.
  • Configure your haxe program to start the debugger when the following command line option is provided:
    -start_debugger

If you expect to do remote debugging, you'll also have to support:

    -debugger_host=[host]:[port]

Most likely you'll just want to add the following in your main() when -start_debugger is set:

    new debugger.HaxeRemote(true, host, port);

Generally speaking, the build/debug configuration (Run->Edit Configurations) is set up to use port 6972, so you can probably cheat and use:

    new debugger.HaxeRemote(true, "localhost", 6972);

However, the line has to match your debug settings. Fortunately, they are passed to your program on the command line. Notice the "-start_debugger -debugger_host=localhost:6972" passed to haxelib:

    C:/HaxeToolkit/haxe/haxelib.exe run lime run C:/temp/issue349/openfl_cpp_debug/openfl_cpp_debug/project.xml
      windows -verbose -Ddebug -debug -args  -start_debugger -debugger_host=localhost:6972

Your program should now: 1) Look for the '-start_debugger' parameter before doing anything. It won't be there if the program is being started via the "Run" command from IDEA. 2) Parse the '-debugger_host=' parameter. If it exists, then a remote controller (e.g. IDEA) will be trying to connect on that port. If it doesn't exist, then the user (you) probably want to start the command line debugger:

    new debugger.Local(true);

Here's a snippet you can use: (Thanks to @isBatak)

  #if (debug && cpp)
    var startDebugger:Bool = false;
    var debuggerHost:String = "";
    var argStartDebugger:String = "-start_debugger";
    var pDebuggerHost:EReg = ~/-debugger_host=(.+)/;

    for (arg in Sys.args()) {
      if(arg == argStartDebugger){
        startDebugger = true;
      }
      else if(pDebuggerHost.match(arg)){
        debuggerHost = pDebuggerHost.matched(1);
      }
    }

    if(startDebugger){
      if(debuggerHost != "") {
        var args:Array<String> = debuggerHost.split(":");
        new debugger.HaxeRemote(true, args[0], Std.parseInt(args[1]));
      }
      else {
        new debugger.Local(true);
      }
    }
  #end

Contribute

See the contributing document.