Feature: Improve CMake project structure (LiteLDev#787)

* Feature: Improve CMake project structure * Rename Test to test * Move RELEASE to assets * Rename Scripts to scripts * Fix CI * Merge PackOutput into CMake build workflow * Pack SDK wit CMake
PoiCraft · Sep 13, 2022 · 561a848 · 561a848
1 parent d6556b4
commit 561a848
Show file tree

Hide file tree

Showing 69 changed files with 182 additions and 185 deletions.
diff --git a/.github/workflows/cmake-self-hosted.yml b/.github/workflows/cmake-self-hosted.yml
@@ -36,14 +36,14 @@ jobs:
           path: |
             ${{ env.GITHUB_WORKSPACE }}LiteLoader/Lib/bedrock_server_api.lib
             ${{ env.GITHUB_WORKSPACE }}LiteLoader/Lib/bedrock_server_var.lib
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('Scripts/LINK.txt') }}
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('scripts/LINK.txt') }}
 
       - name: Download Server
         if: steps.cache-bds-lib.outputs.cache-hit != 'true'
         working-directory: ${{ env.GITHUB_WORKSPACE }}
         run: |
           mkdir Tools/Server
-          ServerLink=$(cat 'Scripts/LINK.txt')
+          ServerLink=$(cat 'scripts/LINK.txt')
           curl -L -o Tools/Server/server.zip "$ServerLink"
           unzip Tools/Server/server.zip -d Tools/Server/ > /dev/null
         shell: bash
@@ -107,39 +107,36 @@ jobs:
       - name: Build SymDBHelper
         run: cmake --build ${{github.workspace}}/build_clang --config ${{env.BUILD_TYPE}} --target SymDBHelper
 
-      - name: Compress Resource Packs
+      - name: Configure CMake(MSVC)
         run: |
-          cd RELEASE/plugins/LiteLoader/ResourcePacks
-          7z a LiteLoaderBDS-CUI.tar LiteLoaderBDS-CUI
-          rm -r LiteLoaderBDS-CUI
-        shell: bash
+          cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+        shell: cmd
 
-      - name: Copy Release
-        working-directory: ${{ env.GITHUB_WORKSPACE }}
+      - name: Pack output and SDK
         run: |
-          cd Scripts
-          ./CopyRelease.cmd action
+          cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} --target PackOutput
+          cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} --target PackSDK
         shell: cmd
 
-      - name: Move PDB to path
-        working-directory: ${{ env.GITHUB_WORKSPACE }}
+      - name: Compress Resource Packs
         run: |
-          mkdir PDB
-          cp x64/Release/*.pdb PDB
+          cd build/output/plugins/LiteLoader/ResourcePacks
+          7z a LiteLoaderBDS-CUI.tar LiteLoaderBDS-CUI
+          rm -r LiteLoaderBDS-CUI
         shell: bash
 
-      - name: Pack PDB
+      - name: Pack PDB for Release
         working-directory: ${{ env.GITHUB_WORKSPACE }}
         if: startsWith(github.ref, 'refs/tags/')
-        run: 7z a -tzip PDB.zip PDB
+        run: 7z a -tzip PDB.zip build/pdb
         shell: bash
 
       - name: Update LiteLoaderSDK
         working-directory: ${{ env.GITHUB_WORKSPACE }}
         run: |
           git config --global user.name "github-actions[bot]"
           git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
-          cd Scripts
+          cd scripts
           ./UploadSDK.cmd action
         env:
           REPO_KEY: ${{secrets.PUSH_TOKEN}}
@@ -150,16 +147,16 @@ jobs:
         uses: actions/[email protected]
         with:
           name: LiteLoader
-          path: ${{ github.workspace }}\RELEASE\
+          path: ${{ github.workspace }}\build\output\
 
       - name: Upload PDB
         uses: actions/[email protected]
         with:
           name: PDB
-          path: ${{ github.workspace }}\PDB
+          path: ${{ github.workspace }}\build\pdb\
 
       - name: Pack Release
-        working-directory: ${{ env.GITHUB_WORKSPACE }}/RELEASE
+        working-directory: ${{ env.GITHUB_WORKSPACE }}/build/output
         id: rel
         if: startsWith(github.ref, 'refs/tags/')
         run: |

diff --git a/.github/workflows/cmake.yml b/.github/workflows/cmake.yml
@@ -37,14 +37,14 @@ jobs:
           path: |
             ${{ env.GITHUB_WORKSPACE }}LiteLoader/Lib/bedrock_server_api.lib
             ${{ env.GITHUB_WORKSPACE }}LiteLoader/Lib/bedrock_server_var.lib
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('Scripts/LINK.txt') }}
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('scripts/LINK.txt') }}
 
       - name: Download Server
         if: steps.cache-bds-lib.outputs.cache-hit != 'true'
         working-directory: ${{ env.GITHUB_WORKSPACE }}
         run: |
           mkdir Tools/Server
-          ServerLink=$(cat 'Scripts/LINK.txt')
+          ServerLink=$(cat 'scripts/LINK.txt')
           curl -L -o Tools/Server/server.zip "$ServerLink"
           unzip Tools/Server/server.zip -d Tools/Server/ > /dev/null
         shell: bash
@@ -97,28 +97,14 @@ jobs:
       - name: Build SymDBHelper
         run: cmake --build ${{github.workspace}}/build_clang --config ${{env.BUILD_TYPE}} --target SymDBHelper
 
-      - name: Copy Release
-        working-directory: ${{ env.GITHUB_WORKSPACE }}
-        run: |
-          cd Scripts
-          ./CopyRelease.cmd action
-        shell: cmd
-
-      - name: Move PDB to path
-        working-directory: ${{ env.GITHUB_WORKSPACE }}
-        run: |
-          mkdir PDB
-          cp x64/Release/*.pdb PDB
-        shell: bash
-
       - name: Upload LiteLoader
         uses: actions/[email protected]
         with:
           name: LiteLoader
-          path: ${{ github.workspace }}\RELEASE\
+          path: ${{ github.workspace }}\build\output\
 
       - name: Upload PDB
         uses: actions/[email protected]
         with:
           name: PDB
-          path: ${{ github.workspace }}\PDB
+          path: ${{ github.workspace }}\build\pdb\
diff --git a/.gitignore b/.gitignore
@@ -1,36 +1,19 @@
-x64/
-**/.vs/
-**/x64/
-**/*.user
-**/.vscode/
+# Visual Studio related
+/.vs/
+/CMakeSettings.json
 
-**/bedrock_server_api.lib
-**/bedrock_server_var.lib
-**/SymDB_DelayLoadHelper.lib
-LiteLoader/Lib/SymDBHelper.lib
-**/*.lastcodeanalysissucceeded
-*.zip
-
-/LiteLoader/out/
-LiteLoaderSDK/
-
-RELEASE/*.dll
-RELEASE/LLPeEditor.exe
-!RELEASE/ChakraCore.dll
-RELEASE/plugins/LiteLoader/LiteLoader.*.dll
-RELEASE/plugins/LiteLoader/LiteLoader.*.pdb
-RELEASE/plugins/LiteLoader/pdb
-!RELEASE/plugins/LiteLoader/CrashLogger.dll
+# Visual Studio Code related
+/.vscode/
 
+# Idea related
 .idea/**
 !.idea/cmake.xml
 
-cmake-build-release/
-/out
-LiteLoader/Lib/Demangler.pdb
-LiteLoader/Lib/Demangler.lib
-
+# Build related
 /build
-**/Directory.build.props
-RELEASE/plugins/lib/BaseLib.js
-RELEASE/plugins/lib/BaseLib.lua
+**/bedrock_server_api.lib
+**/bedrock_server_var.lib
+
+# Misc
+LiteLoaderSDK/
+/output/
diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +1,3 @@
-[submodule "RELEASE/plugins/LiteLoader/ResourcePacks/LiteLoaderBDS-CUI"]
-	path = RELEASE/plugins/LiteLoader/ResourcePacks/LiteLoaderBDS-CUI
+[submodule "assets/plugins/LiteLoader/ResourcePacks/LiteLoaderBDS-CUI"]
+	path = assets/plugins/LiteLoader/ResourcePacks/LiteLoaderBDS-CUI
 	url = https://github.com/OEOTYAN/LiteLoaderBDS-CUI.git
diff --git a/.idea/cmake.xml b/.idea/cmake.xml
diff --git a/CMake/CleanOutput.cmake b/CMake/CleanOutput.cmake
@@ -0,0 +1,8 @@
+add_custom_target(
+        CleanOutput
+        COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_BINARY_DIR}/output
+        COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_BINARY_DIR}/pdb
+        COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_BINARY_DIR}/sdk
+        COMMENT "Cleaning output/pdb/sdk directory"
+        VERBATIM
+)
diff --git a/CMake/PackOutput.cmake b/CMake/PackOutput.cmake
@@ -0,0 +1,29 @@
+execute_process(COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/pdb)
+execute_process(COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/output)
+execute_process(COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/output/plugins/LiteLoader/)
+
+add_custom_target(PackOutput)
+
+# Copy assets to output after build all.
+add_custom_command(
+        TARGET PackOutput POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/assets ${CMAKE_BINARY_DIR}/output/
+        COMMENT "Copying assets to output"
+        VERBATIM
+)
+
+# Copy ScriptEngine BaseLib to output after build all.
+add_custom_command(
+        TARGET PackOutput POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/ScriptEngine/BaseLib ${CMAKE_BINARY_DIR}/output/plugins/lib/
+        COMMENT "Copying ScriptEngine BaseLib to output"
+        VERBATIM
+)
+
+# Copy LLPeEditor to output after build all.
+add_custom_command(
+        TARGET PackOutput POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/Tools/LLPeEditor.exe ${CMAKE_BINARY_DIR}/output/
+        COMMENT "Copying LLPeEditor to output"
+        VERBATIM
+)
diff --git a/CMake/PackSDK.cmake b/CMake/PackSDK.cmake
@@ -0,0 +1,17 @@
+execute_process(COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/sdk)
+execute_process(COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/sdk/Tools)
+execute_process(COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/sdk/Lib)
+
+add_custom_target(PackSDK)
+
+add_custom_command(
+        TARGET PackSDK POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy_directory ${LiteLoader_SOURCE_DIR}/Header ${CMAKE_BINARY_DIR}/sdk/Header
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/Tools/LibraryBuilder.exe ${CMAKE_BINARY_DIR}/sdk/Tools/
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/Tools/LLPeEditor.exe ${CMAKE_BINARY_DIR}/sdk/Tools/
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/Tools/SDK-submodule-add.cmd ${CMAKE_BINARY_DIR}/sdk/Tools/
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/Tools/SDK-submodule-update.cmd ${CMAKE_BINARY_DIR}/sdk/Tools/
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/Tools/SDK-subtree.cmd ${CMAKE_BINARY_DIR}/sdk/Tools/
+        COMMENT "Copying SDK files"
+        VERBATIM
+)
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.21)
 project(LiteLoaderBDS)
 
 # Add sub directories
-add_subdirectory(PreLoader)
+add_subdirectory(LLPreLoader)
 add_subdirectory(LiteLoader)
 add_subdirectory(ScriptEngine/CMake/ScriptEngine-Lua)
 add_subdirectory(ScriptEngine/CMake/ScriptEngine-QuickJs)
@@ -11,4 +11,8 @@ add_subdirectory(Tools/Demangler)
 add_subdirectory(ScriptEngine/third-party/ScriptX/CMake/ScriptX-Lua)
 add_subdirectory(ScriptEngine/third-party/ScriptX/CMake/ScriptX-QuickJs)
 add_subdirectory(ScriptEngine/third-party/ScriptX/CMake/ScriptX-NodeJs)
-add_subdirectory(Tools/SymDBHelper)
+add_subdirectory(Tools/SymDBHelper)
+
+include(${CMAKE_SOURCE_DIR}/CMake/PackOutput.cmake)
+include(${CMAKE_SOURCE_DIR}/CMake/PackSDK.cmake)
+include(${CMAKE_SOURCE_DIR}/CMake/CleanOutput.cmake)
diff --git a/PreLoader/CMakeLists.txt → LLPreLoader/CMakeLists.txt b/PreLoader/CMakeLists.txt → LLPreLoader/CMakeLists.txt
@@ -3,7 +3,6 @@ project(LLPreLoader)
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_BUILD_TYPE Release)
-SET(LIBRARY_OUTPUT_PATH ${CMAKE_SOURCE_DIR}/x64/)
 
 add_definitions(-D"NDEBUG" -D"_WINDOWS" -D"_USRDLL" -D"_WINDLL" -D"_UNICODE" -D"UNICODE")
 
@@ -24,6 +23,16 @@ link_directories(${CMAKE_SOURCE_DIR}/x64/Release/)
 
 aux_source_directory(../LiteLoader/Lib/third-party/rawpdb DIR_LIB_SRCS)
 add_library(LLPreLoader SHARED dllmain.cpp SymDB.cpp PreLoader.cpp Utils.cpp ${DIR_LIB_SRCS})
-target_link_libraries(LLPreLoader SymDBHelper
+target_link_libraries(
+        LLPreLoader SymDBHelper Demangler
         "${CMAKE_SOURCE_DIR}/LiteLoader/Lib/third-party/detours/detours.lib"
-        "${CMAKE_SOURCE_DIR}/LiteLoader/Lib/Demangler.lib")
+)
+
+# Copy the dll and pdb to the output directory
+add_custom_command(
+        TARGET LLPreLoader POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:LLPreLoader> ${CMAKE_BINARY_DIR}/output/
+        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PDB_FILE:LLPreLoader> ${CMAKE_BINARY_DIR}/pdb/
+        COMMENT "Copying dll and pdb to output directory"
+        VERBATIM
+)
diff --git a/PreLoader/FakeSymbol.hpp → LLPreLoader/FakeSymbol.hpp b/PreLoader/FakeSymbol.hpp → LLPreLoader/FakeSymbol.hpp
diff --git a/PreLoader/Logger.h → LLPreLoader/Logger.h b/PreLoader/Logger.h → LLPreLoader/Logger.h
diff --git a/PreLoader/PreLoader.cpp → LLPreLoader/PreLoader.cpp b/PreLoader/PreLoader.cpp → LLPreLoader/PreLoader.cpp
diff --git a/PreLoader/SymDB.cpp → LLPreLoader/SymDB.cpp b/PreLoader/SymDB.cpp → LLPreLoader/SymDB.cpp
diff --git a/PreLoader/Utils.cpp → LLPreLoader/Utils.cpp b/PreLoader/Utils.cpp → LLPreLoader/Utils.cpp
diff --git a/PreLoader/Utils.h → LLPreLoader/Utils.h b/PreLoader/Utils.h → LLPreLoader/Utils.h
diff --git a/PreLoader/dllmain.cpp → LLPreLoader/dllmain.cpp b/PreLoader/dllmain.cpp → LLPreLoader/dllmain.cpp
diff --git a/PreLoader/pch.h → LLPreLoader/pch.h b/PreLoader/pch.h → LLPreLoader/pch.h
diff --git a/LiteLoader/CMakeLists.txt b/LiteLoader/CMakeLists.txt
@@ -4,11 +4,8 @@ project(LiteLoader)
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_BUILD_TYPE Release) # Always uses Release mode to build BDS plugin for ABI Compatibility
 
-set(LIBRARY_OUTPUT_PATH ${CMAKE_SOURCE_DIR}/x64/)
-
-set(TARGET_DIR ${CMAKE_SOURCE_DIR}/x64/Release/)
-
-file(GLOB_RECURSE SRC_FILES
+file(
+        GLOB_RECURSE SRC_FILES
         ${PROJECT_SOURCE_DIR}/Lib/third-party/nbt-cpp/*.cpp
         ${PROJECT_SOURCE_DIR}/Header/*.cpp
         ${PROJECT_SOURCE_DIR}/Header/*.hpp
@@ -51,7 +48,8 @@ link_directories(${CMAKE_SOURCE_DIR}/x64/Release)
 
 add_library(LiteLoader SHARED ${SRC_FILES})
 
-target_link_libraries(LiteLoader
+target_link_libraries(
+        LiteLoader
         "${PROJECT_SOURCE_DIR}/Lib/third-party/leveldb/leveldb.lib"
         "${PROJECT_SOURCE_DIR}/Lib/third-party/openssl/libcrypto.lib"
         "${PROJECT_SOURCE_DIR}/Lib/third-party/openssl/libssl.lib"
@@ -70,6 +68,24 @@ target_link_libraries(LiteLoader
         LLPreLoader
 )
 
-add_custom_command(TARGET LiteLoader PRE_BUILD
+add_custom_command(
+        TARGET LiteLoader PRE_BUILD
         COMMAND cmd /c ${CMAKE_SOURCE_DIR}/Scripts/PrepareLibraries.cmd ${CMAKE_SOURCE_DIR}
-        )
+)
+
+# Copy the built DLL and PDB to the output directory
+add_custom_command(
+        TARGET LiteLoader POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:LiteLoader> ${CMAKE_BINARY_DIR}/output/
+        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PDB_FILE:LiteLoader> ${CMAKE_BINARY_DIR}/pdb/
+        COMMENT "Copying LiteLoader DLL and PDB to output directory"
+        VERBATIM
+)
+
+# Copy the built lib to the SDK directory
+add_custom_command(
+        TARGET LiteLoader POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_LINKER_FILE:LiteLoader> ${CMAKE_BINARY_DIR}/sdk/lib/
+        COMMENT "Copying LiteLoader Lib to SDK directory"
+        VERBATIM
+)
diff --git a/ScriptEngine/CMake/ScriptEngine-Lua/CMakeLists.txt b/ScriptEngine/CMake/ScriptEngine-Lua/CMakeLists.txt
@@ -9,3 +9,12 @@ set(SCRIPTX_BACKEND Lua)
 set(LLSE_BACKEND_LIBRARY Lua)
 
 include(../../CMakeLists.txt)
+
+# copy target DLL and PDB to output directory
+add_custom_command(
+        TARGET LiteLoader.Lua POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:LiteLoader.Lua> ${CMAKE_BINARY_DIR}/output/plugins/LiteLoader/
+        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PDB_FILE:LiteLoader.Lua> ${CMAKE_BINARY_DIR}/pdb/
+        COMMENT "Copying LiteLoader.Lua DLL and PDB to output directory"
+        VERBATIM
+)
diff --git a/ScriptEngine/CMake/ScriptEngine-NodeJs/CMakeLists.txt b/ScriptEngine/CMake/ScriptEngine-NodeJs/CMakeLists.txt
@@ -9,3 +9,12 @@ set(SCRIPTX_BACKEND V8)
 set(LLSE_BACKEND_LIBRARY NodeJs)
 
 include(../../CMakeLists.txt)
+
+# copy target DLL and PDB to output directory
+add_custom_command(
+        TARGET LiteLoader.NodeJs POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:LiteLoader.NodeJs> ${CMAKE_BINARY_DIR}/output/plugins/LiteLoader/
+        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PDB_FILE:LiteLoader.NodeJs> ${CMAKE_BINARY_DIR}/pdb/
+        COMMENT "Copying LiteLoader.NodeJs DLL and PDB to output directory"
+        VERBATIM
+)
diff --git a/ScriptEngine/CMake/ScriptEngine-QuickJs/CMakeLists.txt b/ScriptEngine/CMake/ScriptEngine-QuickJs/CMakeLists.txt
@@ -9,3 +9,12 @@ set(SCRIPTX_BACKEND QuickJs)
 set(LLSE_BACKEND_LIBRARY QuickJs)
 
 include(../../CMakeLists.txt)
+
+# copy target DLL and PDB to output directory
+add_custom_command(
+        TARGET LiteLoader.Js POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:LiteLoader.Js> ${CMAKE_BINARY_DIR}/output/plugins/LiteLoader/
+        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PDB_FILE:LiteLoader.Js> ${CMAKE_BINARY_DIR}/pdb/
+        COMMENT "Copying LiteLoader.Js DLL and PDB to output directory"
+        VERBATIM
+)