Haxe plugin for IntelliJ Platform based IDEs
Java Haxe Other
Pull request Compare This branch is 156 commits ahead, 1 commit behind JetBrains:master.
Latest commit f78a60b Jan 19, 2017 @EricBishton EricBishton committed on GitHub Merge pull request #543 from HaxeFoundation/CompilerCompletion
Compiler completion
Permalink
Failed to load latest commit information.
.idea Incomplete initial v16 support Apr 4, 2016
common Update for Hxcpp 3.3 compiler output. Oct 30, 2016
doc Add new build and test instructions to README and CONTRIBUTING files. Apr 23, 2015
grammar fix typedef multiple extensions highlighting Dec 10, 2016
hxcpp-debugger-protocol Unknown semantics: WIP update Unknown in generics Jun 25, 2015
jps-plugin Remove ununsed imports causing v14jps-plugin build to fail. Oct 10, 2016
resources Update icons to use the Haxe logo. Add a couple of new ones. Jan 19, 2017
src Make compiler completions look the same as PSI-generated ones. Jan 19, 2017
testData Formatter: Prevent excess linefeed between doctype and function Dec 21, 2016
testSrc/com/intellij Formatter: Prevent excess linefeed between doctype and function Dec 21, 2016
.gitignore Remove gen tree from the committed source base. Nov 23, 2016
.travis.yml Drop versions 2016.3 and 2016.3.1 from the Travis-CI build matrix. Jan 4, 2017
CHANGELOG.md Prep (again) for 0.10.1 release. Dec 27, 2016
CONTRIBUTING.md Updated documentation to point to the Haxe Foundations github repo, i… Jan 4, 2017
CONTRIBUTORS.md Prep (again) for 0.10.1 release. Dec 27, 2016
LICENSE.txt Added license Jun 14, 2013
Makefile Update default IDEA version for make. Nov 23, 2016
README.md Updated documentation to point to the Haxe Foundations github repo, i… Jan 4, 2017
build-haxe-protocol.sh added file to build JavaProtocol.hx class to Java Mar 13, 2015
build-test.xml Run grammar-kit to regenerate parser sources when building. Nov 23, 2016
build.sh Remove unused parameter from fetchGrammarKit.sh invocation. Nov 23, 2016
build.xml Run grammar-kit to regenerate parser sources when building. Nov 23, 2016
common.xml Run grammar-kit to regenerate parser sources when building. Nov 23, 2016
fetchGrammarKit.sh Always retrieve the requested version of GrammarKit during a make. Nov 23, 2016
fetchIdea.sh Revert recent change to disable plugins in fetchidea.sh. Apr 17, 2015
idea_v14.1.5.properties 0.10.1 release prep. Oct 11, 2016
idea_v14.1.properties Add support for Java8 compiler to build all targets. Sep 22, 2016
idea_v14.properties Add support for Java8 compiler to build all targets. Sep 22, 2016
idea_v15.properties Add support for Java8 compiler to build all targets. Sep 22, 2016
idea_v16.properties Update to 2016.3.2 Dec 27, 2016
intellij-haxe.iml Make v16.0 the default version for the project sources. Sep 27, 2016
travis.sh Add fetchGrammarKit.sh to travis build. Nov 23, 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, 15, IDEA 2016.1 through 2016.3.

We have moved!

The primary maintained branch of this plugin has moved to the HaxeFoundation. Please update your links and git clones to point to http://github.com/HaxeFoundation/intellij-haxe

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 within 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 8 or OpenJDK 8 (Versions 7 may be used with IDEA versions prior to 2016.x)
  • 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 (see Makefile) will build the plugin for Idea 2016.2.5. To override the default, set the IDEA_VERSION environment variable prior to executing make.

IDEA_VERSION=14.1.7 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 and prone to failure. 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.7 make test

Use the hxcpp debugger

NOTE: IDEA Community Edition currently will not start an IDE-based debugging session. For that, IDEA Ultimate is required. Command-line debugging is available because that is a feature of the Haxe language itself. See the hxcpp-debugger project for more information.

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

  haxelib git hxcpp-debugger <your_local_clone> protocol_v1.1

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.