Merge pull request orbitersim#458 from TheGondos/lua_ldoc

[Lua]Update API documentation

CMakeLists.txt

@@ -100,7 +100,7 @@ set(HTMLHELP_LIB_DIR ${HTMLHELP_DIR}/lib-${ARCH})
 set(HTMLHELP_LIB ${HTMLHELP_LIB_DIR}/Htmlhelp.lib)
 
 set(ORBITER_TOOL_MESHC "$<TARGET_FILE:meshc>")
-set(ldoc $<TARGET_FILE:lua::exe> ${LUA_DIR}/packages/LDoc/ldoc.lua)
+set(ldoc $<TARGET_FILE:lua_bin> ${ORBITER_BINARY_ROOT_DIR}/packages/LDoc/ldoc.lua -v --multimodule)
 
 find_package(OpenGL QUIET)
 find_package(HTMLHelp)

Extern/CMakeLists.txt

@@ -4,7 +4,9 @@ project(Extern)
 ## Lua
 
 file(GLOB LUA_FILES "Lua/*.c" "Lua/*.h")
-
+list(REMOVE_ITEM LUA_FILES ${CMAKE_CURRENT_SOURCE_DIR}/Lua/lua.c)
+list(REMOVE_ITEM LUA_FILES ${CMAKE_CURRENT_SOURCE_DIR}/Lua/luac.c)
+list(REMOVE_ITEM LUA_FILES ${CMAKE_CURRENT_SOURCE_DIR}/Lua/print.c)
 add_library(lua SHARED ${LUA_FILES})
 target_compile_definitions(lua PUBLIC LUA_BUILD_AS_DLL)
 
@@ -17,6 +19,48 @@ set_target_properties(lua PROPERTIES
 
 install(TARGETS lua RUNTIME DESTINATION ${ORBITER_INSTALL_ROOT_DIR})
 install(TARGETS lua DESTINATION ${ORBITER_INSTALL_SDK_DIR}/lib/Lua)
+install(TARGETS lua DESTINATION ${ORBITER_INSTALL_SDK_DIR}/Utils/)
+
+
+add_executable(lua_bin
+	${LUA_FILES} "Lua/lua.c"
+)
+set_target_properties(lua_bin
+	PROPERTIES
+	OUTPUT_NAME lua
+)
+set_target_properties(lua_bin PROPERTIES
+    ARCHIVE_OUTPUT_DIRECTORY ${ORBITER_BINARY_ROOT_DIR}
+    LIBRARY_OUTPUT_DIRECTORY ${ORBITER_BINARY_ROOT_DIR}
+    RUNTIME_OUTPUT_DIRECTORY ${ORBITER_BINARY_ROOT_DIR}
+)
+
+install(TARGETS lua_bin
+	DESTINATION ${ORBITER_BINARY_ROOT_DIR}
+)
+install(TARGETS lua_bin DESTINATION ${ORBITER_INSTALL_SDK_DIR}/Utils/)
+
+## LFS
+add_library(lfs SHARED luafilesystem/src/lfs.c)
+	install(TARGETS lfs	DESTINATION ${ORBITER_BINARY_ROOT_DIR})
+	install(TARGETS lfs DESTINATION ${ORBITER_INSTALL_SDK_DIR}/Utils/)
+	target_include_directories(lfs PUBLIC Lua)
+	target_link_libraries(lfs lua)
+	SET_TARGET_PROPERTIES(lfs PROPERTIES LINK_FLAGS "/DEF:\"${CMAKE_CURRENT_SOURCE_DIR}/luafilesystem/src/lfs.def\""
+)
+install(TARGETS lfs
+	DESTINATION ${ORBITER_BINARY_ROOT_DIR}
+)
+set_target_properties(lfs PROPERTIES
+    ARCHIVE_OUTPUT_DIRECTORY ${ORBITER_BINARY_ROOT_DIR}
+    LIBRARY_OUTPUT_DIRECTORY ${ORBITER_BINARY_ROOT_DIR}
+    RUNTIME_OUTPUT_DIRECTORY ${ORBITER_BINARY_ROOT_DIR}
+)
+
+add_custom_target(CopyLDoc ALL
+	COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/ldoc/ ${ORBITER_BINARY_ROOT_DIR}/packages/ldoc
+	COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/Penlight/lua/ ${ORBITER_BINARY_ROOT_DIR}/
+)
 
 ##########################################
 ## zlib

Extern/Penlight/.busted

@@ -0,0 +1,8 @@
+return {
+  default = {
+    verbose = true,
+    output = "gtest",
+    lpath = "./lua/?.lua;./lua/?/init.lua",
+  }
+}
+-- vim: ft=lua

Extern/Penlight/.editorconfig

@@ -0,0 +1,22 @@
+root                     = true
+
+[*]
+end_of_line              = lf
+insert_final_newline     = true
+trim_trailing_whitespace = true
+charset                  = utf-8
+
+[*.lua]
+indent_style             = space
+indent_size              = 2
+
+[kong/templates/nginx*]
+indent_style             = space
+indent_size              = 4
+
+[*.template]
+indent_style             = space
+indent_size              = 4
+
+[Makefile]
+indent_style             = tab

Extern/Penlight/.gitignore

@@ -0,0 +1,2 @@
+luacov.stats.out
+*.rock

Extern/Penlight/.luacheckrc

@@ -0,0 +1,40 @@
+unused_args     = false
+redefined       = false
+max_line_length = false
+
+globals = {
+    "ngx",
+}
+
+not_globals = {
+    "string.len",
+    "table.getn",
+}
+
+include_files = {
+  "**/*.lua",
+  "*.rockspec",
+  ".busted",
+  ".luacheckrc",
+}
+
+files["spec/**/*.lua"] = {
+    std = "+busted",
+}
+
+exclude_files = {
+    "tests/*.lua",
+    "tests/**/*.lua",
+    -- Travis Lua environment
+    "here/*.lua",
+    "here/**/*.lua",
+    -- GH Actions Lua Environment
+    ".lua",
+    ".luarocks",
+    ".install",
+
+    -- TODO: fix these files
+    "examples/symbols.lua",
+    "examples/test-symbols.lua",
+}
+

Extern/Penlight/.luacov

@@ -0,0 +1,4 @@
+modules = {
+   ["pl"] = "lua/pl/init.lua",
+   ["pl.*"] = "lua"
+}