Merge pull request #658 from georgik/feature/lua

Add Lua component (IEC-470)

Author: suda-morris

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -54,6 +54,7 @@ body:
         - led_strip
         - libpng
         - libsodium
+        - lua
         - esp_linenoise
         - network_provisioning
         - nghttp

.github/workflows/upload_component.yml

@@ -57,6 +57,7 @@ jobs:
             json_parser
             led_strip
             libsodium
+            lua
             network_provisioning
             nghttp
             onewire_bus

.gitmodules

@@ -77,3 +77,7 @@
 [submodule "cjson/cJSON"]
 	path = cjson/cJSON
 	url = https://github.com/DaveGamble/cJSON.git
+
+[submodule "lua/lua"]
+	path = lua/lua
+	url = https://github.com/lua/lua.git

.idf_build_apps.toml

@@ -28,6 +28,7 @@ manifest_file = [
     "json_parser/.build-test-rules.yml",
     "libpng/.build-test-rules.yml",
     "libsodium/.build-test-rules.yml",
+    "lua/.build-test-rules.yml",
     "onewire_bus/.build-test-rules.yml",
     "pcap/.build-test-rules.yml",
     "pid_ctrl/.build-test-rules.yml",

lua/.build-test-rules.yml

@@ -0,0 +1,4 @@
+lua/examples/lua_example:
+  enable:
+    - if: IDF_TARGET in ["esp32", "esp32c3"]
+      reason: "Sufficient to test on one Xtensa and one RISC-V target"

lua/CMakeLists.txt

@@ -0,0 +1,45 @@
+idf_component_register(
+    SRCS
+        "lua/lapi.c"
+        "lua/lauxlib.c"
+        "lua/lbaselib.c"
+        "lua/lcode.c"
+        "lua/lctype.c"
+        "lua/lcorolib.c"
+        "lua/ldblib.c"
+        "lua/ldebug.c"
+        "lua/ldo.c"
+        "lua/lfunc.c"
+        "lua/lgc.c"
+        "lua/linit.c"
+        "lua/liolib.c"
+        "lua/llex.c"
+        "lua/lmathlib.c"
+        "lua/lmem.c"
+        "lua/lopcodes.c"
+        "lua/loadlib.c"
+        "lua/loslib.c"
+        "lua/lstate.c"
+        "lua/ltable.c"
+        "lua/ltm.c"
+        "lua/lvm.c"
+        "lua/lobject.c"
+        "lua/lparser.c"
+        "lua/lstrlib.c"
+        "lua/lstring.c"
+        "lua/ltablib.c"
+        "lua/ldump.c"
+        "lua/lundump.c"
+        "lua/lutf8lib.c"
+        "lua/lzio.c"
+    INCLUDE_DIRS
+        "port/include"
+        "lua"
+)
+
+# Enable 32-bit mode for Lua (required for ESP32 and Xtensa/RISC-V architectures)
+target_compile_definitions(${COMPONENT_LIB} PRIVATE LUA_32BITS=1)
+
+# Suppress compiler warnings from upstream Lua code
+target_compile_options(${COMPONENT_LIB} PRIVATE -Wno-unused-function)
+

lua/Kconfig

@@ -0,0 +1,11 @@
+menu "Lua"
+    config LUA_MAXSTACK
+        int "Stack size limit"
+        default 1000000
+        help
+            Limits the size of the Lua stack.
+            Change it if you need a different limit. This limit is arbitrary;
+            its only purpose is to stop Lua from consuming unlimited stack
+            space (and to reserve some numbers for pseudo-indices).
+
+endmenu

lua/LICENSE

@@ -0,0 +1,22 @@
+Lua is licensed under the MIT license.
+
+Copyright (C) 1994-2025 Lua.org, PUC-Rio.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

lua/README.md

@@ -0,0 +1,59 @@
+# Lua - ESP-IDF Component
+
+ESP-IDF component which wraps Lua from upstream repository - https://www.lua.org/
+
+This component provides Lua, a powerful, efficient, lightweight, embeddable scripting language.
+
+## Features
+
+- Suitable for embedding Lua code inside ESP-IDF applications
+- Configurable stack size limit
+- MIT license
+
+## Configuration option
+
+- `LUA_MAXSTACK` - default value: 1000000 - Limits the size of the Lua stack.
+
+Modify values:
+
+```shell
+idf.py menuconfig
+```
+
+## Usage
+
+This component is suitable for embedding Lua scripts in ESP-IDF applications. For a complete example, see the `examples/lua_example` directory.
+
+### Basic Usage
+
+```c
+#include "lua.h"
+#include "lualib.h"
+#include "lauxlib.h"
+
+void run_lua() {
+    lua_State *L = luaL_newstate();
+    luaL_openlibs(L);
+
+    // Run a simple Lua script
+    if (luaL_dostring(L, "print('Hello from Lua!')") != LUA_OK) {
+        printf("Error: %s\n", lua_tostring(L, -1));
+    }
+
+    lua_close(L);
+}
+```
+
+## Changes to upstream
+
+This component uses header injection to provide ESP-IDF specific configuration overrides without modifying the upstream Lua source code. The platform-specific settings (such as `LUA_32BITS` for ESP32 and Xtensa/RISC-V architectures) are defined in `lua/port/include/luaconf.h`.
+
+## License
+
+Lua is licensed under the MIT license. See LICENSE file for details.
+
+## Upstream
+
+- Lua: https://www.lua.org/
+- Repository: https://github.com/lua/lua
+

lua/examples/lua_example/CMakeLists.txt

@@ -0,0 +1,4 @@
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(lua_example)