Haxe Documentation

Haxe is an open source toolkit for building cross-platform tools and applications. It consists of:

• The Haxe programming language: A modern, high-level, strictly-typed language.
• The Haxe cross-compiler: A high-speed compiler targeting multiple platforms.
• The Haxe standard library: A complete, cross-platform library of common functionality.

Supported compilation targets include:

• JavaScript
• C++
• JVM
• Lua
• PHP 7
• Python 3
• HashLink
• NekoVM
• Flash (SWF Bytecode)
• Haxe interpreter

The Haxe compiler is written in OCaml and requires OCaml version 5.0 or higher. It is recommended to use OPAM 2.x.

• Unix (Mac, Linux): Follow the official OPAM installation instructions.
• Windows: Use the Cygwin/MinGW-based OPAM environment provided by fdopen. Ensure you use 64-bit versions and OPAM 2.
• Docker/WSL Note: If you encounter errors related to bubblewrap or Linux user namespaces during opam init, use the --disable-sandboxing flag.

To use a plugin in a Haxe project, you must first set it up as a local Haxe library using haxelib dev. Once registered, you can access the plugin's functionality within a Haxe macro.

1. Register the plugin:

$ haxelib dev example path/to/haxe/plugins/example

2. Access it in a macro:

macro static public function testPlugin() {
	Example.plugin.hello();
	return macro {}
}

To build a plugin for your current operating system, use the make command with the PLUGIN variable set to your plugin name.

Example for a plugin named example:

$ make plugin PLUGIN=example

To build Haxe from source, clone the repository using the --recursive flag to ensure all necessary submodules are included. If downloading source archives (.zip or .tarballs) from GitHub releases, you must manually place the submodule source code into the appropriate sub-folders.

git clone --recursive https://github.com/HaxeFoundation/haxe.git

To update Flash Player signatures in Homebrew Cask, use a macOS machine to run the developer script provided by homebrew-cask. This semi-automates the update process.

Steps:

1. Clone the homebrew-cask repository: git clone https://github.com/Homebrew/homebrew-cask
2. Run the update script with the new version string: ./developer/bin/update_cask_family flash $NEW_VERSION_STRING

If the homebrew-cask CI passes, the Pull Request will be automatically merged by a bot.

Note: Adobe's appcast (used by homebrew-cask CI to verify version strings) is often outdated for approximately one day after a new Flash Player release. You may need to wait for the appcast to sync before the CI succeeds.

Run the compilation command from within the checked-out Haxe source directory based on your operating system.

# On Unix
make

# On Windows (Cygwin)
make -f Makefile.win

Before installing, remove any existing Haxe installations to avoid conflicts and ensure the HAXE_STD_PATH environment variable is not set.

• Unix (Mac/Linux): Run sudo make install.
• Windows: Add the checked-out Haxe source directory to the beginning of your PATH environment variable.

# On Unix
sudo make install

You can install Haxe by downloading pre-built binaries for your specific platform from the official download page.

Available platforms include:

• Windows: via .exe installer or .zip binaries.
• OSX: via .pkg installer or .tar.gz binaries.
• Linux: via software packages or .tar.gz binaries (32-bit and 64-bit).

For automated development builds, visit build.haxe.org.

The objsize library provides tools to compute the size of OCaml values. It can calculate:

• Count of words used for values.
• Count of values' headers.
• Maximal depth of values.
• Size of values in bytes.

For detailed API documentation, refer to the objsize.mli file in the library directory.