@hackage lua2.3.2

Lua, an embeddable scripting language

lua

Build status AppVeyor Status Hackage

The lua package provides a Lua interpreter as well as bindings, wrappers and types to combine Haskell and Lua.

Overview

Lua is a small, well-designed, embeddable scripting language. It has become the de-facto default to make programs extensible and is widely used everywhere from servers over games and desktop applications up to security software and embedded devices. This package provides Haskell bindings to Lua, enable coders to embed the language into their programs, making them scriptable.

This package ships with the official Lua interpreter, version 5.4.6. Cabal flags allow to compile against a system-wide Lua installation instead, if desired.

Build flags

The following cabal build flags are supported:

  • system-lua: Use the locally installed Lua version instead of the version shipped as part of this package.

  • pkg-config: Use pkg-config to discover library and include paths. Setting this flag implies system-lua.

  • allow-unsafe-gc: Allow optimizations which make Lua's garbage collection potentially unsafe; enabling this should be safe if there are no callbacks into Haskell during Lua garbage collection cycles. The flag should be disabled if Lua objects can have Haskell finalizers, i.e., __gc metamethods that call Haskell function.

    The flag is enabled per default, as Haskell functions are rarely used in finalizers. It can help to disable the flag if there are issues related to Lua's garbage collection.

  • apicheck: Compile Lua with its API checks enabled.

  • lua_32bits: Compile Lua for a 32-bits system (e.g., i386, PowerPC G4).

  • export-dynamic: Add all symbols to dynamic symbol table; disabling this will make it possible to create fully static binaries, but renders loading of dynamic C libraries impossible.

Example: using a different Lua version

To use a system-wide installed Lua when linking lua as a dependency, build/install your package using --constraint="lua +system-lua". For example, you can install Pandoc with hslua that uses system-wide Lua like this:

cabal install pandoc --constraint="lua +system-lua"

or with stack:

stack install pandoc --flag=lua:system-lua

  • Installation

  • Tested Compilers

  • Dependencies (1)

  • Dependents (8)

    @hackage/pandoc-lua-marshal, @hackage/lua-arbitrary, @hackage/hslua-cli, @hackage/lpeg, @hackage/hslua, @hackage/hslua-core, Show all…

    • Package Flags

      system-lua
       (off by default)

      Use the system-wide Lua instead of the bundled copy.

      apicheck
       (off by default)

      Compile Lua with -DLUA_USE_APICHECK.

      lua_32bits
       (off by default)

      Compile Lua with -DLUA_32BITS

      allow-unsafe-gc
       (on by default)

      Allow optimizations which make Lua's garbage collection potentially unsafe; enabling this should be safe if there are no callbacks into Haskell during Lua garbage collection cycles. The flag should be *disabled* if Lua objects can have Haskell finalizers, i.e., __gc metamethods that call Haskell function.

      export-dynamic
       (on by default)

      Add all symbols to dynamic symbol table; disabling this will make it possible to create fully static binaries, but renders loading of dynamic C libraries impossible.

      pkg-config
       (off by default)

      Use pkg-config to discover library and include paths. Setting this flag implies `system-lua`.

      cross-compile
       (off by default)

      Avoids constructs that would prevent cross-compilation. The Lua version constants may become inaccurate when this flag is enabled.