ammer

Overview

This document aims to be the definitive, exhaustive documentation for the ammer project and its associated repositories (ammer-core, HaxeAmmer/amlib-*). Knowledge of the Haxe language is assumed (see the Haxe manual), as well as some knowledge of the C language.

The sections are organised as follows:

• Introduction — General overview.
  • Overview
  • Terminology
  • Why ammer?
  • Installation
  • Getting started
• Definition — Guide-level explanation of writing library definitions using ammer.
  • Library definition
  • Datatypes
• Configuration — Guide-level explanation of library configuration.
  • Providing flags
  • Project-wide configuration
  • Library configuration
• Target details — Target-specific information.
  • Feature parity
  • C++
  • C#
  • Eval
  • HashLink (both JIT and HL/C)
  • Java (both Java and JVM)
  • Lua
  • Neko
  • Node.js
  • Python
• Reference — Full reference of the available APIs, metadata, and ammer types.
  • FFI types
  • ammer.def.* types
  • ammer.Lib
  • List of configuration flags
  • List of annotations
• amlib — Writing and publishing ammer libraries.
  • Conventions
  • CI
  • Baking
• Advanced topics — More advanced considerations when writing library definitions.
  • Type cycles
  • Garbage collection
  • String encoding
  • Static and dynamic linking
  • Packaging and distribution
  • Performance
• ammer-core — About the underlying framework.
  • Interface
  • Implementing new platforms