first push

Author: gnu-enjoyer

.clang-format

@@ -0,0 +1,8 @@
+---
+Language: Cpp
+BasedOnStyle: Google
+PointerAlignment: Left
+FixNamespaceComments: false
+CompactNamespaces: true
+ColumnLimit: 100
+...

.clangd

@@ -0,0 +1,5 @@
+CompileFlags:
+  Add:
+  [
+      '-std=c++23'
+  ]

.github/workflows/msvc.yml

@@ -0,0 +1,49 @@
+name: msvc
+
+on:
+  push:
+    branches: [ main ]
+        
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: windows-latest
+    
+    env:
+      VCPKG_ROOT: ${{ github.workspace }}/vcpkg
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/cache@v4
+        id: cache
+        with:
+          path: |
+            ${{ github.workspace }}/vcpkg/packages
+            ${{ github.workspace }}/vcpkg/downloads
+            ${{ github.workspace }}/vcpkg/buildtrees
+            ${{ github.workspace }}/build
+          key: ${{ runner.os }}-${{ hashFiles('vcpkg.json', 'vcpkg-configuration.json') }}
+
+      - name: vcpkg setup
+        run: |
+          git clone https://github.com/microsoft/vcpkg.git --depth 1 ${{ env.VCPKG_ROOT }}
+          .\vcpkg\bootstrap-vcpkg.bat -disableMetrics
+
+      - name: MSVC config
+        uses: ilammy/msvc-dev-cmd@v1
+
+      - name: CMake config
+        run: |
+          cmake --preset release -DCMAKE_TOOLCHAIN_FILE="${{ env.VCPKG_ROOT }}/scripts/buildsystems/vcpkg.cmake"
+
+      - name: CMake build
+        run: |
+          cmake --build build/release
+
+      - name: Save artifact
+        if: github.event_name == 'workflow_dispatch'
+        uses: actions/upload-artifact@v4
+        with:
+          name: upload-artefact
+          path: build/release/skylua.dll

.gitignore

@@ -0,0 +1 @@
+build/release

CMakeLists.txt

@@ -0,0 +1,22 @@
+cmake_minimum_required(VERSION 3.18)
+
+set(CMAKE_CXX_STANDARD 23)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_FLAGS_RELEASE "/O2 /Ob3 /DNDEBUG")
+set(CMAKE_INTERPROCEDURAL_OPTIMIZATION ON)
+
+project(skylua VERSION 0.1.0 LANGUAGES CXX)
+include(GNUInstallDirs)
+
+find_package(mimalloc CONFIG REQUIRED)
+find_package(CommonLibSSE CONFIG REQUIRED)
+find_package(PkgConfig REQUIRED)
+
+pkg_check_modules(LuaJIT REQUIRED IMPORTED_TARGET luajit)
+find_path(SOL2_INCLUDE_DIRS "sol/abort.hpp")
+
+add_commonlibsse_plugin(${PROJECT_NAME} SOURCES src/plugin.cpp)
+target_precompile_headers(${PROJECT_NAME} PRIVATE src/pch.h)
+target_include_directories(${PROJECT_NAME} PRIVATE ${SOL2_INCLUDE_DIRS} vendor)
+target_link_libraries(${PROJECT_NAME} PRIVATE mimalloc-static PkgConfig::LuaJIT)
+target_compile_features(${PROJECT_NAME} PRIVATE cxx_std_23)

CMakePresets.json

@@ -0,0 +1,34 @@
+{
+    "version": 3,
+    "configurePresets": [
+        {
+            "name": "base",
+            "hidden": true,
+            "generator": "Ninja",
+            "binaryDir": "${sourceDir}/build/${presetName}",
+            "installDir": "${sourceDir}/install/${presetName}",
+            "architecture": { "value": "x64", "strategy": "external" },
+            "cacheVariables": {
+                "CMAKE_CXX_COMPILER": "cl.exe",
+                "CMAKE_CXX_FLAGS": "/options:strict /Qpar /jumptablerdata /utf-8 /Zc:char8_t- /Zc:inline /std:c++latest /Zc:throwingNew /permissive- /WL /Zc:preprocessor /Zc:__cplusplus /fp:fast /O2 /Ob3 /EHsc /GL /Gw /GR- /MP /W4 -DWIN32_LEAN_AND_MEAN -DNOMINMAX -DUNICODE -D_UNICODE",
+                "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake",
+                "VCPKG_TARGET_TRIPLET": "x64-windows-static",
+                "VCPKG_OVERLAY_TRIPLETS": "${sourceDir}/cmake",
+                "CMAKE_MSVC_RUNTIME_LIBRARY": "MultiThreaded$<$<CONFIG:Debug>:Debug>",
+                "CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
+            }
+        },
+        {
+            "name": "debug",
+            "inherits": ["base"],
+            "displayName": "Debug",
+            "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug" }
+        },
+        {
+            "name": "release",
+            "inherits": ["base"],
+            "displayName": "Release",
+            "cacheVariables": { "CMAKE_BUILD_TYPE": "Release" }
+        }
+    ]
+}

README.md

@@ -1 +1,22 @@
-# skylua
+# skylua
+
+skylua glues LuaJIT via sol2 and CommonLibSSE NG to provide an embedded, fast and lightweight scripting runtime for Skyrim
+
+## features
+
+* Lua 5.1 (JIT)
+  * bitwise support
+- hot reload
+
+## example
+
+```lua
+function SkyLua.OnTick()
+  SkyLua.notify("hello world")
+end
+```
+
+## requirements
+
+- SKSE to load .dll
+

src/cfg.hpp

@@ -0,0 +1,43 @@
+#pragma once
+
+#include "fs.hpp"
+
+namespace cfg {
+enum class LuaLibs { DEFAULT, FULL };
+
+static constexpr auto cfg_file_name = "skylua.json"sv;
+static inline const auto cfg_path =
+    fs::FindOrCreateDirectory<fs::Destination::RUNTIME>() / cfg_file_name;
+
+struct Config {
+  spdlog::level::level_enum log_level{spdlog::level::trace};
+  std::uint64_t tick_rate{1000};
+  bool enable_hot_reload{true};
+  LuaLibs lua_libs{LuaLibs::DEFAULT};
+};
+
+static const Config* LoadOrDefault(bool force_reload = false) {
+  static Config config{};
+  static bool first_load{true};
+
+  if (first_load || force_reload) {
+    auto _res = std::filesystem::exists(cfg_path)
+                    ? glz::read_file_json(config, cfg_path.string(), std::string{})
+                    : glz::write_file_json(config, cfg_path.string(), std::string{});
+    first_load = false;
+  }
+  return &config;
+}
+
+inline auto LoadLuaLibs(sol::state& lua) {
+  LoadOrDefault()->lua_libs == LuaLibs::DEFAULT
+      ? lua.open_libraries(sol::lib::bit32, sol::lib::table)
+      : lua.open_libraries();
+}
+}
+
+template <>
+struct glz::meta<cfg::LuaLibs> {
+  using enum cfg::LuaLibs;
+  static constexpr auto value = enumerate(DEFAULT, FULL);
+};

src/ecs.hpp

@@ -0,0 +1,81 @@
+#pragma once
+
+#include "entt.hpp"
+#include "fs.hpp"
+#include "lua.hpp"
+
+namespace ecs {
+typedef fs::LuaFile Fd;
+typedef std::unique_ptr<lua::ScopedState> State;
+typedef sol::protected_function Tick;
+
+inline entt::registry registry;
+
+template <glue::GameEvent>
+struct EventHandler {
+  sol::protected_function handler;
+};
+
+[[noreturn]] static void LatentTick() {
+  static const auto tick_rate = std::chrono::milliseconds(cfg::LoadOrDefault()->tick_rate);
+
+  for (;;) {
+    std::this_thread::sleep_for(tick_rate);
+
+    SKSE::GetTaskInterface()->AddTask([] {
+      auto view = registry.view<const Tick>();
+      for (auto [_, tick] : view.each()) tick();
+    });
+  }
+}
+
+inline auto EnableLatentTick() { std::jthread(&LatentTick).detach(); }
+
+inline auto BindEventHandlersToEntity(const entt::entity& ent,
+                                      std::unique_ptr<lua::ScopedState>& state) {
+  magic_enum::enum_for_each<glue::GameEvent>([&](auto val) {
+    constexpr auto func_name = glue::GetLuaFuncName<val>();
+    state->logger->trace("Checking handler: {}", func_name);
+    sol::protected_function func = state->skylua[func_name];
+    if (func.valid()) {
+      state->logger->info("Bound {}", func_name);
+      registry.emplace<EventHandler<val>>(ent, std::move(func));
+    }
+  });
+}
+
+inline auto AddLuaFileToRegistry(const fs::LuaFile& fd) {
+  const auto e = registry.create();
+  auto state = lua::ScopedState::FromPath(fd);
+  if (auto maybe_tick = state->MaybeGetTick()) {
+    state->logger->trace("Tick registered for: {}", state->name);
+    registry.emplace<Tick>(e, maybe_tick.value());
+  }
+  BindEventHandlersToEntity(e, state);
+  registry.emplace<State>(e, std::move(state));
+  registry.emplace<Fd>(e, fd);
+}
+
+inline auto UnbindAllEventHandlersForEntity(const entt::entity& e) {
+  magic_enum::enum_for_each<glue::GameEvent>([&](auto val) {
+    if (auto maybe_handler = registry.try_get<EventHandler<val>>(e)) {
+      maybe_handler->handler.abandon();
+    }
+  });
+
+  if (auto maybe_tick = registry.try_get<Tick>(e)) {
+    maybe_tick->abandon();
+  }
+}
+
+inline auto RebuildEntityForPath(const fs::LuaFile& fd) {
+  for (auto e : registry.view<const Fd>()) {
+    auto ent_fd = registry.get<const Fd>(e);
+    if (ent_fd.relative_path_str == fd.relative_path_str) {
+      UnbindAllEventHandlersForEntity(e);
+      registry.destroy(e);
+      AddLuaFileToRegistry(ent_fd);
+    }
+  }
+}
+}