Add cmake install target #926
Conversation
|
Sorry for not working on this lately. I almost forgot that I need to change |
This allows Luau to be included in other projects.
|
I forgot that cmake projects tend to provide some kind of .cmake file that can be used with find_package. I will try to figure this out soon. |
|
I have added find_package support, however it has required a few additional changes to the CMakeLists.txt file to provide the ability to require a minimum version of Luau and to install the headers properly. The project VERSION variable would have to be updated every time a new version is released. If Luau is not found it will error when configuring an example project. The prefix required for CMake to find Luau can be specified with CMAKE_PREFIX_PATH or specified in a FindLuau.cmake file that is able to be included with CMAKE_MODULE_PATH. cmake_minimum_required(VERSION 3.27)
project(test LANGUAGES CXX VERSION 0.0.1)
find_package(Luau REQUIRED)
add_executable(test main.cpp)
target_link_libraries(
test PRIVATE
Luau.VM
Luau.Compiler
Luau.Ast
Luau.Config
Luau.CodeGen
Luau.Analysis
)
target_compile_features(test PRIVATE cxx_std_23) |
| @@ -21,7 +21,7 @@ if(LUAU_STATIC_CRT) | |||
| set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>") | |||
| endif() | |||
|
|
|||
| project(Luau LANGUAGES CXX C) | |||
| project(Luau LANGUAGES CXX C VERSION 0.607) | |||
There was a problem hiding this comment.
I don't think we can include a version.
Even with automation (worse with manual update) it will require a commit to this CMake file basically each week.
| write_basic_package_version_file( | ||
| "${CMAKE_CURRENT_BINARY_DIR}/LuauConfigVersion.cmake" | ||
| VERSION "${PROJECT_VERSION}" | ||
| COMPATIBILITY AnyNewerVersion | ||
| ) |
There was a problem hiding this comment.
Same problem for the version here I assume.
| COMPATIBILITY AnyNewerVersion | ||
| ) | ||
| export( | ||
| TARGETS Luau.Ast Luau.Analysis Luau.CodeGen Luau.VM Luau.Compiler Luau.Config Luau.Common Luau.VM.Internals |
There was a problem hiding this comment.
Luau.VM.Internals should not be included.
There was a problem hiding this comment.
I think the problem I had before when it wasn't there was this:
export called with target "Luau.CodeGen" which requires target
"Luau.VM.Internals" that is not in any export set.
I'm not sure what the best way to deal with this is yet.
There was a problem hiding this comment.
It looks like a bunch of headers, which would be exported with this, make use of VM internals.
Until that gets resolved Luau.VM.Internals needs to be exported.
| ) | ||
|
|
||
| install( | ||
| TARGETS Luau.Ast Luau.Analysis Luau.CodeGen Luau.VM Luau.Compiler Luau.Config Luau.Common Luau.VM.Internals |
There was a problem hiding this comment.
Luau.VM.Internals should not be included.
| "${CMAKE_CURRENT_SOURCE_DIR}/Analysis/include/" | ||
| "${CMAKE_CURRENT_SOURCE_DIR}/CodeGen/include/" | ||
| "${CMAKE_CURRENT_SOURCE_DIR}/VM/include/" | ||
| "${CMAKE_CURRENT_SOURCE_DIR}/VM/src/" |
There was a problem hiding this comment.
Don't include this src.
I added a cmake install target that installs the libraries, headers and the CLI binaries to CMAKE_INSTALL_PREFIX.
This is how I built and installed luau with this PR (on a linux machine):