The Lua Programming Language with Modern CMake

Introduction

This repository contains the CMake files for the Lua Programming Language aimed for those that wish to use the library in Modern CMake.

Note

The bundle provided here is aimed at modern CMake. CMake has come a long way as a build generation tool and most modern systems now ship with CMake versions 3.20+ by default. As a result, this bundle requires a minimum CMake version of 3.30+.

Usage Instructions

There are a couple of ways to integrate this bundle into your project. All of them will use the same linking code, so let's discuss how to include it first.

As a Subdirectory

The easiest way is to clone this repository directly into your source tree (i.e. under ./external/lua for example) and then adding this to your CMakelists.txt file

add_subdirectory(<path-to-lua-dir>)

You can also add this repository as a submodule using git.

Using FetchContent

An alternative use is to have CMake deal with downloading the code via FetchContent. To add this, add the following to your CMakelists.txt:

include(FetchContent)

FetchContent_Declare(
    lua
    GIT_REPOSITORY "https://github.com/marovira/lua"
    GIT_TAG "<latest-commit-hash>"
)

FetchContent_MakeAvailable(lua)

Where <latest-commit-hash> can be retrieved from this repository.

Installing

The final option is to directly install the bundle. To do this, you must install it as with any other CMake package (build and run the install target). Once that is done, you must copy ./cmake/Findlua.cmake file into your project's directory (ideally under ./cmake/Findlua.cmake) and then add the following to your CMakelists.txt:

set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} <your-cmake-dir>)
find_package(lua REQUIRED)

The reason why we need a separate Findlua.cmake file is very simple: CMake does ship with a FindLua.cmake, but that file is written using an older CMake style (so we can't link using target_link_libraries). Moreover, the way in which you must install Lua isn't entirely straight-forward (especially if you don't use a package manager) unless you read through the code and figure out which directories it looks for.

Linking

Once you have added Lua to your build, you can link against it by adding:

target_link_libraries(<your-target> PRIVATE lua::lua)

Once that is done you can include the Lua headers as follows:

#include <lua.h>

You will find an example executable under the ./test directory containing a sample CMake configuration for building with this bundle.

Licenses

Lua is published under the MIT license and can be viewed here. For more information, please see their official website here.

This bundle is published under the BSD-3 license can be viewed here