Lua via sol2

.github/workflows/matrix.yml

@@ -31,6 +31,7 @@ jobs:
             cmake: 0
             tiles: 0
             sound: 0
+            lua: 0
             test-stage: 1
             title: GCC 12, Ubuntu, Curses
             native: linux64
@@ -39,14 +40,25 @@ jobs:
             cmake: 1
             tiles: 1
             sound: 1
+            lua: 1
             languages: all
             native: linux64
-            title: GCC 12, Ubuntu, Tiles, CMake, Languages
+            title: GCC 12, Ubuntu, Tiles, Sound, Lua, CMake, Languages
           - compiler: g++-12
+            os: ubuntu-22.04
+            cmake: 0
+            tiles: 1
+            sound: 1
+            lua: 1
+            test-stage: 1
+            title: GCC 11, Ubuntu, Tiles, Sound, Lua
+            native: linux64
+          - compiler: g++-11
             os: ubuntu-22.04
             cmake: 0
             tiles: 1
             sound: 0
+            lua: 0
             sanitize: address
             native: linux64
             title: GCC 12, Ubuntu, Tiles, NoSound, ASan
@@ -55,6 +67,7 @@ jobs:
             cmake: 0
             tiles: 1
             sound: 0
+            lua: 0
             sanitize: address,undefined
             native: linux64
             title: Clang 14, Ubuntu, Tiles, NoSound, ASan, UBSan
@@ -63,10 +76,11 @@ jobs:
             cmake: 0
             tiles: 1
             sound: 1
+            lua: 1
             test-stage: 1
             native: osx
             grep_clang_version_rxp: "14\\.[0-9]+\\.[0-9]+"
-            title: Clang 14, macOS 12, Tiles, Localize
+            title: Clang 14, macOS 12, Tiles, Sound, Localize, Lua
     name: ${{ matrix.title }}
     runs-on: ${{ matrix.os }}
     env:
@@ -76,6 +90,7 @@ jobs:
       OS: ${{ matrix.os }}
       TILES: ${{ matrix.tiles }}
       SOUND: ${{ matrix.sound }}
+      LUA: ${{ matrix.lua }}
       SANITIZE: ${{ matrix.sanitize }}
       TEST_STAGE: ${{ matrix.test-stage }}
       LANGUAGES: ${{ matrix.languages }}

.github/workflows/push-translation-template.yml

@@ -25,7 +25,7 @@ jobs:
       - name: "Install Python3"
         run: |
           sudo apt install python3-pip
-          sudo pip3 install polib
+          sudo pip3 install polib luaparser
       - name: "Checkout"
         uses: actions/checkout@v3
       - name: "Generate translation template"

.github/workflows/release.yml

@@ -224,14 +224,14 @@ jobs:
       - name: Build CBN (linux)
         if: runner.os == 'Linux' && matrix.mxe == 'none' && matrix.android == 'none'
         run: |
-          make -j$((`nproc`+0)) TILES=${{ matrix.tiles }} SOUND=${{ matrix.tiles }} RELEASE=1 LANGUAGES=all PCH=0 bindist
+          make -j$((`nproc`+0)) TILES=${{ matrix.tiles }} SOUND=${{ matrix.tiles }} LUA=1 RELEASE=1 LANGUAGES=all PCH=0 bindist
           mv cataclysmbn-unstable.tar.gz cbn-${{ matrix.artifact }}-${{ needs.release.outputs.timestamp }}.tar.gz
       - name: Build CBN (windows)
         if: matrix.mxe != 'none'
         env:
           PLATFORM: /opt/mxe/usr/bin/${{ matrix.mxe }}-w64-mingw32.static.gcc11-
         run: |
-          make -j$((`nproc`+0)) CROSS="${PLATFORM}" TILES=1 SOUND=1 RELEASE=1 LANGUAGES=all PCH=0 bindist
+          make -j$((`nproc`+0)) CROSS="${PLATFORM}" TILES=1 SOUND=1 LUA=1 RELEASE=1 LANGUAGES=all PCH=0 bindist
           mv cataclysmbn-unstable.zip cbn-${{ matrix.artifact }}-${{ needs.release.outputs.timestamp }}.zip
       - name: Build CBN (windows msvc)
         if: runner.os == 'Windows'
@@ -244,7 +244,7 @@ jobs:
       - name: Build CBN (osx)
         if: runner.os == 'macOS'
         run: |
-          make -j3 TILES=${{ matrix.tiles }} SOUND=${{ matrix.tiles }} RELEASE=1 LANGUAGES=all USE_HOME_DIR=1 OSX_MIN=11 PCH=0 dmgdist COMPILER=clang++
+          make -j3 TILES=${{ matrix.tiles }} SOUND=${{ matrix.tiles }} LUA=1 RELEASE=1 LANGUAGES=all USE_HOME_DIR=1 OSX_MIN=11 PCH=0 dmgdist COMPILER=clang++
           mv CataclysmBN-unstable.dmg cbn-${{ matrix.artifact }}-${{ needs.release.outputs.timestamp }}.dmg
       - name: Set up JDK 8 (android)
         if: runner.os == 'Linux' && matrix.android != 'none' && matrix.mxe == 'none'

CMakeLists.txt

@@ -16,6 +16,7 @@ SET(CMAKE_TLS_VERIFY ON)
 option(TILES        "Build graphical tileset version."   "OFF")
 option(CURSES       "Build curses version."   "ON")
 option(SOUND        "Support for in-game sounds & music."   "OFF")
+option(LUA          "Support for in-game scripting with Lua."   "OFF")
 option(BACKTRACE    "Support for printing stack backtraces on crash"   "ON")
 option(LIBBACKTRACE "Print backtrace with libbacktrace."    "OFF")
 option(USE_HOME_DIR "Use user's home directory for save files."   "ON")
@@ -201,6 +202,7 @@ ENDIF (CMAKE_BUILD_TYPE STREQUAL Debug)
     MESSAGE(STATUS "TILES                         : ${TILES}")
     MESSAGE(STATUS "CURSES                        : ${CURSES}")
     MESSAGE(STATUS "SOUND                         : ${SOUND}")
+    MESSAGE(STATUS "LUA                           : ${LUA}")
     MESSAGE(STATUS "BACKTRACE                     : ${BACKTRACE}")
     MESSAGE(STATUS "USE_HOME_DIR                  : ${USE_HOME_DIR}\n")
 

LICENSE.txt

@@ -10,6 +10,10 @@ PLF List and PLF Colony (src/list.h, src/colony.h) are licensed under the zLib l
 
 getpost (tools/json_tools/format/getpost.h) is licensed under the MIT license, see file for text of license.
 
+Lua (src/lua/*) is licensed under the MIT license, see src_lua/LICENSE.md for text of license.
+
+sol2 (src/sol/*) is licensed under the MIT license, see src/sol/sol.hpp for text of license.
+
 
 
 fmtlib (src/fmtlib_*) is licensed under the MIT license (https://github.com/fmtlib/fmt/blob/master/LICENSE.rst). The full license text is as follows:

Makefile

@@ -11,6 +11,7 @@
 #   LTO         Set to 1 to enable link-time optimization.
 #   TILES       Set to 1 to enable tiles. Requires SDL.
 #   SOUND       Set to 1 to enable sounds. Requires SDL.
+#   LUA         Set to 1 to enable Lua.
 #
 # Platforms:
 # Linux/Cygwin native
@@ -166,8 +167,11 @@ CHKJSON_BIN = $(BUILD_PREFIX)chkjson
 BINDIST_DIR = $(BUILD_PREFIX)bindist
 BUILD_DIR = $(CURDIR)
 SRC_DIR = src
+LUA_SRC_DIR = $(SRC_DIR)/lua
 ASTYLE_BINARY = astyle
 
+CXXFLAGS += -I$(SRC_DIR) -I$(LUA_SRC_DIR)
+
 # Enable astyle by default
 ifndef ASTYLE
   ASTYLE = 1
@@ -264,8 +268,10 @@ endif
 # when preprocessor defines change, but the source doesn't
 ODIR = $(BUILD_PREFIX)obj
 ODIRTILES = $(BUILD_PREFIX)obj/tiles
+ODIRLUA = $(BUILD_PREFIX)obj/lua
 W32ODIR = $(BUILD_PREFIX)objwin
 W32ODIRTILES = $(W32ODIR)/tiles
+W32ODIRLUA = $(W32ODIR)/lua
 
 ifdef AUTO_BUILD_PREFIX
   BUILD_PREFIX = $(if $(RELEASE),release-)$(if $(DEBUG_SYMBOLS),symbol-)$(if $(TILES),tiles-)$(if $(SOUND),sound-)$(if $(BACKTRACE),back-$(if $(LIBBACKTRACE),libbacktrace-))$(if $(SANITIZE),sanitize-)$(if $(MAPSIZE),map-$(MAPSIZE)-)$(if $(USE_XDG_DIR),xdg-)$(if $(USE_HOME_DIR),home-)$(if $(DYNAMIC_LINKING),dynamic-)$(if $(MSYS2),msys2-)
@@ -573,6 +579,7 @@ ifeq ($(TARGETSYSTEM),WINDOWS)
   BINDIST = $(W32BINDIST)
   BINDIST_CMD = $(W32BINDIST_CMD)
   ODIR = $(W32ODIR)
+  ODIRLUA = $(W32ODIRLUA)
   ifeq ($(DYNAMIC_LINKING), 1)
     # Windows isn't sold with programming support, these are static to remove MinGW dependency.
     LDFLAGS += -static-libgcc -static-libstdc++
@@ -794,6 +801,7 @@ TESTSRC := $(wildcard tests/*.cpp)
 TESTHDR := $(wildcard tests/*.h)
 JSON_FORMATTER_SOURCES := tools/format/format.cpp src/json.cpp
 CHKJSON_SOURCES := src/chkjson/chkjson.cpp src/json.cpp
+LUA_SOURCES := $(wildcard $(LUA_SRC_DIR)/*.c)
 CLANG_TIDY_PLUGIN_SOURCES := \
   $(wildcard tools/clang-tidy-plugin/*.cpp tools/clang-tidy-plugin/*/*.cpp)
 TOOLHDR := $(wildcard tools/*/*.h)
@@ -815,6 +823,13 @@ ifeq ($(TARGETSYSTEM),WINDOWS)
 endif
 OBJS = $(sort $(patsubst %,$(ODIR)/%,$(_OBJS)))
 
+ifeq ($(LUA), 1)
+  DEFINES += -DLUA
+  LUA_OBJS = $(sort $(LUA_SOURCES:$(LUA_SRC_DIR)/%.c=$(ODIRLUA)/%.o))
+else
+  LUA_OBJS = 
+endif
+
 ifdef LANGUAGES
   L10N = localization
 endif
@@ -872,12 +887,12 @@ endif
 all: version $(CHECKS) $(TARGET) $(L10N) $(TESTS)
 	@
 
-$(TARGET): $(OBJS)
+$(TARGET): $(OBJS) $(LUA_OBJS)
 ifeq ($(VERBOSE),1)
-	+$(LD) $(W32FLAGS) -o $(TARGET) $(OBJS) $(LDFLAGS)
+	+$(LD) $(W32FLAGS) -o $(TARGET) $(OBJS) $(LUA_OBJS) $(LDFLAGS)
 else
 	@echo "Linking $@..."
-	@+$(LD) $(W32FLAGS) -o $(TARGET) $(OBJS) $(LDFLAGS)
+	@+$(LD) $(W32FLAGS) -o $(TARGET) $(OBJS) $(LUA_OBJS) $(LDFLAGS)
 	@echo Done!
 endif
 
@@ -892,12 +907,12 @@ endif
 $(PCH_P): $(PCH_H)
 	-$(CXX) $(CPPFLAGS) $(DEFINES) $(subst -Werror,,$(CXXFLAGS)) -c $(PCH_H) -o $(PCH_P)
 
-$(BUILD_PREFIX)$(TARGET_NAME).a: $(OBJS)
+$(BUILD_PREFIX)$(TARGET_NAME).a: $(OBJS) $(LUA_OBJS)
 ifeq ($(VERBOSE),1)
-	$(AR) rcs $(BUILD_PREFIX)$(TARGET_NAME).a $(filter-out $(ODIR)/main.o $(ODIR)/messages.o,$(OBJS))
+	$(AR) rcs $(BUILD_PREFIX)$(TARGET_NAME).a $(filter-out $(ODIR)/main.o $(ODIR)/messages.o,$(OBJS)) $(LUA_OBJS)
 else
 	@echo "Creating $@..."
-	@$(AR) rcs $(BUILD_PREFIX)$(TARGET_NAME).a $(filter-out $(ODIR)/main.o $(ODIR)/messages.o,$(OBJS))
+	@$(AR) rcs $(BUILD_PREFIX)$(TARGET_NAME).a $(filter-out $(ODIR)/main.o $(ODIR)/messages.o,$(OBJS)) $(LUA_OBJS)
 endif
 
 .PHONY: version
@@ -911,6 +926,7 @@ version:
 
 # Unconditionally create the object dir on every invocation.
 $(shell mkdir -p $(ODIR))
+$(shell mkdir -p $(ODIRLUA))
 
 $(ODIR)/%.o: $(SRC_DIR)/%.cpp $(PCH_P)
 ifeq ($(VERBOSE), 1)
@@ -928,6 +944,14 @@ else
 	@$(RC) $(RFLAGS) $< -o $@
 endif
 
+$(ODIRLUA)/%.o: $(LUA_SRC_DIR)/%.c
+ifeq ($(VERBOSE), 1)
+	$(CXX) -xc -std=c11 -c $< -o $@
+else
+	@echo $(@F)
+	@$(CXX) -xc -std=c11 -c $< -o $@
+endif
+
 src/version.h: version
 
 src/version.cpp: src/version.h

build-scripts/build.sh

@@ -176,7 +176,13 @@ else
         # Use a blacklist of mods that currently fail to load cleanly.  Hopefully this list will
         # shrink over time.
         blacklist=build-scripts/mod_test_blacklist
-        mods="$(./build-scripts/get_all_mods.py $blacklist)"
+        if [ "$LUA" == "1" ]
+        then
+            do_lua="1"
+        else
+            do_lua="0"
+        fi
+        mods="$(./build-scripts/get_all_mods.py $blacklist $do_lua)"
         run_tests ./tests/cata_test --user-dir=all_modded --mods="$mods" '~*'
     fi
 fi

build-scripts/get_all_mods.py

@@ -4,7 +4,10 @@
 import glob
 import json
 
-blacklist_filename, = sys.argv[1:]
+assert(len(sys.argv) == 3)
+blacklist_filename = sys.argv[1]
+do_lua = sys.argv[2] == "1"
+
 with open(blacklist_filename) as blacklist_file:
     blacklist = {s.rstrip('\n') for s in blacklist_file.readlines()}
 
@@ -26,6 +29,8 @@ def add_mods(mods):
     mod_info = json.load(open(info))
     for e in mod_info:
         if e["type"] == "MOD_INFO":
+            if not do_lua and "lua_api_version" in e:
+                continue
             ident = e["id"]
             if not ident in blacklist:
                 all_mod_dependencies[ident] = e.get("dependencies", [])

build-scripts/requirements.sh

@@ -14,7 +14,7 @@ if [ -n "$CATA_CLANG_TIDY" ]; then
 fi
 
 if [ -n "$LANGUAGES" ]; then
-  pip install --user polib
+  pip install --user polib luaparser
 fi
 
 # Influenced by https://github.com/zer0main/battleship/blob/master/build/windows/requirements.sh

data/mods/saveload_lua_test/finalize.lua

@@ -0,0 +1 @@
+gdebug.log_info("SLT: finalize")

data/mods/saveload_lua_test/main.lua

@@ -0,0 +1,51 @@
+gdebug.log_info("SLT: main")
+
+local mod = game.mod_runtime[ game.current_mod ]
+local storage = game.mod_storage[ game.current_mod ]
+
+--[[
+    If we keep all our data simple and in mod.storage,
+    we won't even have to register save/load hooks,
+    it'll be saved/loaded automatically.
+]]--
+mod.storage = storage
+
+--[[
+    The following values are default, they'll be assigned on
+    new game start or on game init before save is loaded.
+]]
+-- Numeric data
+storage.num = 12.3
+-- Usertype
+storage.tri = Tripoint.new(3, 4, 5)
+-- String
+storage.tri_as_str = tostring( Tripoint.new(3, 4, 5) )
+
+--[[
+    If we want to build complex state out of loaded data
+    we may create a hook that would read loaded data from mod_storage
+    and create our complex state in the mod_runtime.
+]]--
+mod.on_game_load_hook = function()
+    gdebug.log_info("SLT: on_load")
+
+    if storage.num then
+        gdebug.log_info( "Data found! num = ", storage.num )
+    end
+    if storage.tri then
+        gdebug.log_info( "Data found! tri = ", storage.tri )
+    end
+end
+
+--[[
+    If we have complex enough state (e.g. recursive tables, or with custom metatables)
+    we may create a hook that would write a simplified version into mod_storage,
+    so the hardcoded JSON serializer would be able to handle it.
+]]--
+mod.on_game_save_hook = function()
+    gdebug.log_info("SLT: on_save")
+
+    if storage.num then
+        gdebug.log_info("Saving NUM value = ", storage.num)
+    end
+end

data/mods/saveload_lua_test/modinfo.json

@@ -0,0 +1,14 @@
+[
+  {
+    "type": "MOD_INFO",
+    "id": "saveload_lua_test",
+    "name": "SaveLoad Lua Test",
+    "authors": [ "Olanti" ],
+    "description": "Mod for testing Lua save/load API.",
+    "category": "content",
+    "lua_api_version": 1,
+    "//": "It's not really obsolete, but it's useful only for devs and modders, and not for player.",
+    "obsolete": true,
+    "dependencies": [ "bn" ]
+  }
+]

data/mods/saveload_lua_test/preload.lua

@@ -0,0 +1,11 @@
+gdebug.log_info("SLT: preload")
+
+local mod = game.mod_runtime[ game.current_mod ]
+
+game.hooks.on_game_load[ #game.hooks.on_game_load + 1 ] = function( ... )
+    return mod.on_game_load_hook( ... )
+end
+
+game.hooks.on_game_save[ #game.hooks.on_game_save + 1 ] = function( ... )
+    return mod.on_game_save_hook( ... )
+end

data/mods/smart_house_remotes/finalize.lua

@@ -0,0 +1,4 @@
+gdebug.log_info("SHR: finalize.")
+
+-- We're not finalizing anything.
+-- Besides, there's no finalizing API available yet.