JS Factory

.github/workflows/ci.yml

@@ -46,13 +46,13 @@ jobs:
             name: Ubuntu Debug,
             os: ubuntu-22.04,
             buildtype: debugoptimized,
-            args: -Dwx_version=3.2.3
+            args: -Dwx_version=3.2.0
           }
           - {
             name: Ubuntu Release,
             os: ubuntu-22.04,
             buildtype: release,
-            args: -Dwx_version=3.2.3
+            args: -Dwx_version=3.2.0
           }
           #- {
           #  name: macOS Debug,
@@ -123,7 +123,7 @@ jobs:
         if: matrix.config.os == 'ubuntu-22.04'
         run: |
           sudo apt-get update
-          sudo apt-get install ninja-build build-essential libx11-dev gcc-13 g++-13 libwxgtk3.0-gtk3-dev libgtk-3-dev libfreetype6-dev pkg-config libfontconfig1-dev libass-dev libasound2-dev libffms2-dev intltool libboost-all-dev luarocks libcurl4-nss-dev lua5.1* -y
+          sudo apt-get install ninja-build build-essential libx11-dev gcc-13 g++-13 libwxgtk3.0-gtk3-dev libgtk-3-dev libfreetype6-dev pkg-config libfontconfig1-dev libass-dev libasound2-dev libffms2-dev intltool libboost-all-dev luarocks libcurl4-nss-dev lua5.1* libnode-dev -y
           sudo luarocks install moonscript
 
       - name: Configure

.gitignore

@@ -41,6 +41,7 @@ subprojects/zlib-*
 subprojects/dirent-*
 subprojects/hunspell-*
 subprojects/uchardet-*
+subprojects/expected-*
 
 .vscode/*
 

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "idl-generator"]
+	path = src/automation/factories/js/idl-generator
+	url = https://github.com/Totto16/aegisub-idl-generator.git

compile.sh

@@ -78,24 +78,19 @@ fi
 
 # CONFIGURE
 
-bash -c "meson setup build -Dbuildtype=$buildtype -Dwx_version=3.2.3 -Dcredit='Totto local build'"
+bash -c "meson setup build -Dbuildtype=$buildtype -Dprefix=/usr -Dwx_version=3.2.0 -Dcredit='Totto local build' -Denable_js_automation=enabled"
 
 if [ $DEBUG == "true" ]; then
-    nodemon --watch src/ -e .cpp,.h --exec "sudo meson compile -C build && ./build/aegisub || exit 1"
+    nodemon --watch src/ -e .cpp,.h,.hpp --exec "meson compile -C build && ./build/aegisub || exit 1"
     exit 0
 fi
 
-# COMPILE
-
-## maybe this has to be done:  git config --global --add safe.directory $PWD
-
+## COMPILE
 meson compile -C build
 
 ## run tests
 meson test -C build --verbose "gtest main"
 
-# PACK into DEB
-
 if [ ! -f "build/aegisub" ]; then
     echo "Failed to build aegisub. Aborting"
     exit 4
@@ -125,6 +120,4 @@ fi
 #icons for .ass .ssa
 #mime type,
 
-#TODO create flatpak: https://docs.flatpak.org/en/latest/first-build.html
-
 # TODO compile each dependency local with the newest (stable?) version and then distruibute them as deb, and their also gonna be neede for flatpak support!

libaegisub/lua/utils.cpp

@@ -230,6 +230,7 @@ int exception_wrapper(lua_State *L, int (*func)(lua_State *L)) {
 		return lua_error(L);
 	}
 	catch (...) {
+		LOG_E("lua/utils/exception_wrapper") << "An Unknow type of Exception occurred: this is likely not an issue on your side, but on teh packager / maintainer!\n"; 
 		std::terminate();
 	}
 }

meson.build

@@ -13,7 +13,11 @@ project(
 cmake = import('cmake')
 
 if host_machine.system() == 'windows'
-    add_project_arguments('-DNOMINMAX', '-D_WIN32_WINNT=0x0601', language: 'cpp')
+    add_project_arguments(
+        '-DNOMINMAX',
+        '-D_WIN32_WINNT=0x0601',
+        language: 'cpp',
+    )
 
     if not get_option('csri').disabled()
         add_global_arguments('-DCSRI_NO_EXPORT', language: 'c')
@@ -224,7 +228,11 @@ else
     wx = cmake.subproject('wxWidgets', options: opt_var)
 
 
-    deps += [wx.dependency('wxmono'), wx.dependency('wxregex'), wx.dependency('wxscintilla')]
+    deps += [
+        wx.dependency('wxmono'),
+        wx.dependency('wxregex'),
+        wx.dependency('wxscintilla'),
+    ]
 
     wx.target_list()
 
@@ -248,7 +256,9 @@ else
         if cc.has_header('commctrl.h')
             deps += cc.find_library('comctl32', required: true)
         else
-            error('Missing Windows SDK Common Controls Library (commctrl.h / comctl32.lib)')
+            error(
+                'Missing Windows SDK Common Controls Library (commctrl.h / comctl32.lib)',
+            )
         endif
     endif
 endif
@@ -291,7 +301,7 @@ foreach dep : [
             )
         endif
 
-        if not d.found() and dep[4].length() > 0 and host_machine.system() == 'darwin'
+        if (not d.found() and dep[4].length() > 0 and host_machine.system() == 'darwin')
             d = dependency(
                 'appleframeworks',
                 modules: dep[4],
@@ -313,7 +323,7 @@ if host_machine.system() == 'windows' and get_option('avisynth').enabled()
     conf.set('WITH_AVISYNTH', 1) # bundled separately with installer
 endif
 
-if host_machine.system() == 'windows' and not get_option('directsound').disabled()
+if (host_machine.system() == 'windows' and not get_option('directsound').disabled())
     dsound_dep = cc.find_library('dsound', required: get_option('directsound'))
     winmm_dep = cc.find_library('winmm', required: get_option('directsound'))
     ole32_dep = cc.find_library('ole32', required: get_option('directsound'))
@@ -349,7 +359,11 @@ endif
 def_audio = get_option('default_audio_output')
 if def_audio != 'auto'
     if not dep_avail.contains(def_audio)
-        error('Default audio output "@0@" selected but not available'.format(def_audio))
+        error(
+            'Default audio output "@0@" selected but not available'.format(
+                def_audio,
+            ),
+        )
     endif
 elif dep_avail.length() != 0
     def_audio = dep_avail[0]
@@ -383,7 +397,9 @@ int main(void)
         if get_option('system_luajit')
             error('System luajit found but not compiled in 5.2 mode')
         else
-            message('System luajit found but not compiled in 5.2 mode; using built-in luajit')
+            message(
+                'System luajit found but not compiled in 5.2 mode; using built-in luajit',
+            )
         endif
     else
         deps += luajit
@@ -430,11 +446,105 @@ if not get_option('csri').disabled() and host_machine.system() == 'windows'
     deps += csri_sp.get_variable('csri_dep')
 endif
 
+enable_js_automation = false
+
+js_deps = []
+js_include_dirs = []
+
+if get_option('enable_js_automation').allowed()
+    cpp = meson.get_compiler('cpp')
+
+    all_deps_found = true
+
+    foreach dep_name : ['v8', 'v8_libbase', 'v8_libplatform', 'v8_libsampler', 'node', 'uv']
+        local_dep = cpp.find_library(
+            dep_name,
+            required: get_option('enable_js_automation').enabled(),
+        )
+
+        if not local_dep.found()
+            all_deps_found = false
+        else
+            js_deps += local_dep
+        endif
+
+    endforeach
+
+    found_include_dirs = true
+
+    fs = import('fs')
+
+    foreach def : [['node', 'node.h'], ['node', 'v8.h'], ['nodejs/deps/uv/include/', 'uv.h']]
+        local_found = false
+        foreach idir : ['/usr/include', '/usr/local/include']
+
+            subdir = def[0]
+            header = def[1]
+
+            dir = idir / subdir
+
+            if not local_found and fs.is_dir(dir) and cpp.has_header(header, args: '-I' + dir)
+                js_include_dirs += dir
+                local_found = true
+            endif
+        endforeach
+
+        if not local_found
+            found_include_dirs = false
+        endif
+    endforeach
+
+    if not found_include_dirs and get_option('enable_js_automation').enabled()
+        error('Not all headers could be found!')
+    endif
+
+    if all_deps_found and found_include_dirs
+        enable_js_automation = true
+        js_include_dirs = include_directories(js_include_dirs)
+        deps += js_deps
+    endif
+endif
+
+deps += dependency(
+    'tl-expected',
+    required: true,
+    fallback: ['tl-expected'],
+)
+
+
+if enable_js_automation
+    conf.set('ENABLE_JS_AUTOMATION', true)
+
+    node_js_version = 18
+
+    if (
+        not cpp.compiles(
+            '''
+#include "node_version.h"
+
+int main(void){
+static_assert(NODE_MAJOR_VERSION == ''' + node_js_version.to_string() + ''', "Wrong node js version");
+}
+''',
+            dependencies: js_deps,
+            include_directories: js_include_dirs,
+        )
+    )
+        error('Required node.js version ' + node_js_version.to_string())
+
+    endif
+
+
+endif
+
+
 acconf = configure_file(
     output: 'acconf.h',
     configuration: conf,
 )
 
+general_inc = []
+
 subdir('automation')
 subdir('libaegisub')
 subdir('packages')
@@ -455,10 +565,12 @@ aegisub = executable(
     acconf,
     link_with: [libresrc, libluabins, libaegisub],
     include_directories: [
+        general_inc,
         libaegisub_inc,
         libresrc_inc,
         version_inc,
         deps_inc,
+        js_include_dirs,
         include_directories('src'),
     ],
     cpp_pch: aegisub_cpp_pch,
@@ -471,7 +583,9 @@ aegisub = executable(
 
 if host_machine.system() == 'windows'
     mt_exe = find_program('mt.exe')
-    apply_manifest = find_program(meson.project_source_root() / 'tools/apply-manifest.py')
+    apply_manifest = find_program(
+        meson.project_source_root() / 'tools/apply-manifest.py',
+    )
     custom_target(
         'apply-manifest',
         input: aegisub,

meson_options.txt

@@ -30,3 +30,5 @@ option('build_osx_bundle', type: 'boolean', value: false, description: 'Package
 option('build_flatpak_bundle', type: 'boolean', value: false, description: 'enable flatpak bundle build')
 
 option('tests', type: 'feature', value: 'auto', description: 'enable tests')
+
+option('enable_js_automation', type: 'feature', value: 'auto', description: 'Enable the js automation plugin via v8 (chromium engine)')

org.aegisub.Aegisub.yml

@@ -4,15 +4,15 @@ runtime-version: "23.08"
 sdk: org.freedesktop.Sdk
 command: aegisub
 modules:
-    - name: lua
+    - name: lua5.1
       buildsystem: simple
       sources:
           - type: archive
-            url: https://www.lua.org/ftp/lua-5.4.6.tar.gz
-            sha256: 7d5ea1b9cb6aa0b59ca3dde1c6adcb57ef83a1ba8e5432c0ecd06bf439b3ad88
+            url: https://www.lua.org/ftp/lua-5.1.5.tar.gz
+            sha256: 2640fc56a795f29d28ef15e13c34a47e223960b0240e8cb0a82d9b0738695333
       build-commands:
           - sed -i 's/INSTALL_TOP= \/usr\/local/INSTALL_TOP= \/app/g' Makefile
-          - make
+          - make linux
           - make install
 
     - name: glu
@@ -70,7 +70,7 @@ modules:
           - type: git
             url: https://github.com/Totto16/ffi-experiments.git
       build-commands:
-          - luarocks install moonscript --dev ## we need the dev version for lua 5.4!
+          - luarocks install moonscript
           - make -B lua
           #  - luarocks remove moonscript # remove again, to not end in the final pack
           - make -B all

src/auto4_base.cpp → src/automation/auto4_base.cpp

@@ -314,7 +314,7 @@ namespace Automation4 {
 	AutoloadScriptManager::AutoloadScriptManager(std::string path)
 	: path(std::move(path))
 	{
-		// Before Loading Plugins, save the current path, that could be changed by lua
+		// Before Loading Plugins, save the current path, that could be changed by lua or any factory
 		auto cwd = boost::filesystem::current_path();
 
 		Reload();
@@ -457,6 +457,13 @@ namespace Automation4 {
 		Factories().emplace_back(std::move(factory));
 	}
 
+	void ScriptFactory::RegisterMany(std::vector<std::unique_ptr<ScriptFactory>> factories)
+	{
+                for (auto& factory : factories) {
+                        ScriptFactory::Register(std::move(factory));
+                }
+        }
+
 	std::unique_ptr<Script> ScriptFactory::CreateFromFile(agi::fs::path const& filename, bool complain_about_unrecognised, bool create_unknown)
 	{
 		for (auto& factory : Factories()) {

src/auto4_base.h → src/automation/auto4_base.h

@@ -259,6 +259,8 @@ namespace Automation4 {
 		/// Register an automation engine.
 		static void Register(std::unique_ptr<ScriptFactory> factory);
 
+		static void RegisterMany(std::vector<std::unique_ptr<ScriptFactory>> factories);
+
 		/// Get the full wildcard string for all loaded engines
 		static std::string GetWildcardStr();
 

src/automation/factories/auto4_factories.cpp

@@ -0,0 +1,28 @@
+
+
+#include <memory>
+#include <vector>
+
+#include "auto4_base.h"
+#include "auto4_factories.hpp"
+#include "auto4_lua_factory.h"
+
+#ifdef ENABLE_JS_AUTOMATION
+#include "auto4_js_factory.h"
+#endif
+
+#include <libaegisub/make_unique.h>
+
+namespace Automation4 {
+
+std::vector<std::unique_ptr<ScriptFactory>> Factories::createAll() {
+  auto all = std::vector<std::unique_ptr<ScriptFactory>>{};
+  all.push_back(agi::make_unique<Automation4::LuaScriptFactory>());
+#ifdef ENABLE_JS_AUTOMATION
+  all.push_back(agi::make_unique<Automation4::JS::JavaScriptFactory>());
+#endif
+
+  return all;
+}
+
+} // namespace Automation4