Merge branch 'build' into 'master'

Rework build process

See merge request !2

.gitignore

 *.App
+*.AppImage
 *.[oadi]
 *.ass
 *.avi
@@ -36,6 +37,7 @@
 *.vsp
 *.y4m
 *.zip
+*.DirIcon
 *~
 
 /bin
@@ -66,6 +68,7 @@ packages/desktop/aegisub.desktop
 packages/desktop/aegisub.desktop.template
 packages/win_installer/vendor
 src/aegisub
+Aegisub/
 src/libresrc/bitmap.cpp
 src/libresrc/bitmap.h
 src/libresrc/default_config.cpp
@@ -75,6 +78,7 @@ svn-revision.h
 svn_revision
 tests/*.json
 tests/run
+tools/linuxdeploy
 tools/osx-bundle-restart-helper
 tools/osx-bundle.sed
 tools/repack-thes-dict
@@ -98,5 +102,3 @@ vendor/luajit/src/luajit
 *.tmp
 cscope.files
 tags
-config.guess
-config.sub

Makefile.inc.in

@@ -21,6 +21,7 @@ LIB := $(LIB)
 # PLATFORM SETTINGS
 ###################
 BUILD_DARWIN  = @build_darwin@
+BUILD_LINUX   = @build_linux@
 
 #######
 # FLAGS
@@ -138,3 +139,9 @@ BIN_ECHO     = echo
 BIN_TOUCH     = touch
 BIN_LUA       = @LUA@
 BIN_WX_CONFIG = @WX_CONFIG_PATH@
+
+################
+# APPIMAGE TOOLS
+################
+TOOL_LINUXDEPLOY = $(TOM)tools/linuxdeploy
+TOOL_APPIMAGE    = $(TOP)tools/appimagetool.AppImage

Makefile.target

 ifneq (yes, $(INCLUDING_CHILD_MAKEFILES))
 COMMANDS := all install clean distclean test depclean osx-bundle osx-dmg test-automation test-libaegisub style tags
+ifeq (yes, $(BUILD_LINUX))
+COMMANDS := $(COMMANDS) appimage
+endif
 .PHONY: $(COMMANDS)
 .DEFAULT_GOAL := all
 
@@ -41,10 +44,9 @@ endef
 $(foreach target,$(LIB),$(eval $(call set_target_flags,$(target),$(TOP)lib/lib$(target).a)))
 $(foreach target,$(PROGRAM),$(eval $(call set_target_flags,$(notdir $(target)),$(target))))
 
-# Create the build and install targets for programs
-# Not done with a pattern rule since the pattern would be just %: and doing that
-# leads to make trying to use gcc to make any nonexistent targets rather than
-# erroring
+# Create the build and install targets for programs.  Not done with a pattern
+# rule since the pattern would be just %: and doing that leads to make trying
+# to use gcc to make any nonexistent targets rather than erroring
 define create_program_targets
   ifdef $1_INSTALLNAME
 install: $(DESTDIR)$(P_BINDIR)/$($1_INSTALLNAME)
@@ -80,6 +82,7 @@ all: $(LIB_TARGETS)
 
 clean:
 	$(BIN_RM) -f $(OBJ) $(CLEANFILES) $(LIB_TARGETS)
+	$(BIN_RM) -rf $(CLEANDIRS)
 
 distclean: clean
 	$(BIN_RM) -rf $(DISTCLEANFILES) $(DEP)
@@ -90,10 +93,14 @@ depclean: clean
 install:
 
 style:
-	./tools/astyle.bash
+	$(TOP)tools/astyle.bash
 
 tags:
-	./tools/tags.bash
+	$(TOP)tools/tags.bash
+
+appimage: src/aegisub packages/desktop/Aegisub.desktop packages/desktop/aegisub.png install
+	$(TOOL_LINUXDEPLOY) --appdir Aegisub --desktop-file packages/desktop/Aegisub.desktop --icon-file packages/desktop/aegisub.png --executable src/aegisub
+	$(TOOL_APPIMAGE) Aegisub
 
 # The actual build rules
 .SUFFIXES:
@@ -115,9 +122,9 @@ POST_FLAGS = $($@_FLAGS) -c -o $@ $<
 
 .SECONDEXPANSION:
 
-# Libraries contain all object files they depend on (but they may depend on other files)
-# Not using libtool on OS X because it has an unsilenceable warning about a
-# compatibility issue with BSD 4.3 (wtf)
+# Libraries contain all object files they depend on (but they may depend on
+# other files). Not using libtool on OS X because it has an unsilenceable
+# warning about a compatibility issue with BSD 4.3 (wtf)
 lib%.a: $$($$*_OBJ)
 	@$(BIN_MKDIR_P) $(dir $@)
 	$(BIN_AR) cru $@ $(filter %.o,$^)

README.md

@@ -56,12 +56,15 @@ On debian buster, the packages are the following:
 - libboost-thread-dev
 - astyle
 
+### Build the binary
+
 Once all the dependencies are installed, run:
 
 ```bash
 autoreconf
-./configure --enable-debug --with-libpulse
+./configure --enable-debug --enable-debug-exceptions --with-libpulse --disable-update-checker --enable-silent-rules --without-system-luajit
 make -j$(nproc)
+make install
 ```
 
 You may also consider the following rules:
@@ -71,6 +74,24 @@ You may also consider the following rules:
 - `make tags` to build the ctags and cscope databases
 - `make style` to format your code with the right style
 
+### Build an appimage
+
+First, install `patchelf` (`apt install patchelf` or similar for your distro)
+and [linuxdeploy](https://github.com/linuxdeploy/linuxdeploy).  An AppImage of
+linuxdeploy can be found [here](https://martinm.iiens.net/linuxdeploy).  You
+will also need to download the appimagetool binary and save it to the
+[tools](tools) folder. If you don't do it manually, it will be done for you at
+some point by the build scripts.
+
+To build the AppImage, juste use the following commands:
+
+```bash
+autoreconf
+./configure --with-libpulse --enable-silent-rules --disable-update-checker --without-system-luajit --enable-appimage
+make -j$(nproc)
+make appimage
+```
+
 ### Windows
 
 Prerequisites:

configure.ac

@@ -7,12 +7,21 @@ AC_INIT([Aegisub], [aegisub_version],, [aegisub])
 : ${CFLAGS=""}
 : ${CXXFLAGS=""}
 AC_CONFIG_SRCDIR([src/main.cpp])
+AC_CONFIG_AUX_DIR([config])
 AC_CONFIG_HEADER([acconf.h])
 AC_CONFIG_MACRO_DIR([m4macros])
 AC_GNU_SOURCE
 AC_CANONICAL_HOST
 AM_SILENT_RULES([yes])
 
+##########################
+# Only run from source dir
+##########################
+AEGISUB_PATH_SOURCE="$(dirname $(readlink -f "$0"))"
+AEGISUB_PATH_BUILD="$(pwd)"
+AS_IF([! test "$AEGISUB_PATH_BUILD" = "$AEGISUB_PATH_BUILD"],
+      [AC_MSG_ERROR([The build directory must be the same as the source directory])])
+
 ###################
 # Required packages
 ###################
@@ -41,6 +50,7 @@ AS_CASE([$host],
         [*-*-linux*],  [build_linux="yes"])
 
 AC_SUBST(build_darwin)
+AC_SUBST(build_linux)
 
 ########################
 # Configurable variables
@@ -75,6 +85,48 @@ AC_SUBST(P_ICON)
 # set it to $ac_default_prefix if it hasn't been supplied.
 AS_CASE([x$prefix], [xNONE | x], [prefix="$ac_default_prefix"], [])
 
+# Build with appimage support
+# Do this here because we will override the install path
+AC_ARG_ENABLE([appimage],
+              [AS_HELP_STRING([--enable-appimage], [Build Aegisub as an AppImage. Defaults to no])],
+              [AEGISUB_APPIMAGE_ENABLED=$enableval],
+              [AEGISUB_APPIMAGE_ENABLED=no])
+AS_IF([test "x$AEGISUB_APPIMAGE_ENABLED" = "xyes"], [
+    # Check more binaries
+    AC_PATH_PROG([PATCHELF], [patchelf])
+    AC_PATH_PROG([WGET], [wget])
+    AC_PATH_PROG([CHMOD], [chmod])
+
+    AS_IF([test "$PATCHELF" = "notfound"],  [AC_MSG_ERROR([patchelf is required for AppImage generation])])
+    AS_IF([test "$WGET" = "notfound"],      [AC_MSG_ERROR([wget is required for AppImage generation])])
+    AS_IF([test "$CHMOD" = "notfound"],     [AC_MSG_ERROR([chmod is required for AppImage generation])])
+
+    # Download the AppImage creation tool, transforms the AppDir into an AppImage
+    AC_MSG_CHECKING([Downloading AppImage creation tool])
+    $WGET https://github.com/probonopd/AppImageKit/releases/download/continuous/appimagetool-`arch`.AppImage -O tools/appimagetool.AppImage -o config.wget.log
+    $CHMOD 00700 tools/appimagetool.AppImage
+    AS_IF([test $? -eq 0 ], [
+        AC_MSG_RESULT([done])
+    ], [
+        AC_MSG_FAILURE([failed])
+    ])
+
+    # Downlaod the AppDir management tool, create the AppDir
+    AC_MSG_CHECKING([Downloading LinuxDeploy creation tool])
+    $WGET https://martinm.iiens.net/linuxdeploy -O tools/linuxdeploy -a config.wget.log
+    $CHMOD 00700 tools/linuxdeploy
+    AS_IF([test $? -eq 0 ], [
+        AC_MSG_RESULT([done])
+    ], [
+        AC_MSG_FAILURE([failed])
+    ])
+
+    # Override prefix
+    prefix="$PWD/Aegisub/usr"
+], [
+    AC_MSG_NOTICE([Don't build with AppImage support])
+])
+
 # Install prefix used by wxStandardPaths::SetInstallPrefix.
 AC_DEFINE_UNQUOTED([INSTALL_PREFIX], ["$prefix"], [Default install prefix, or --prefix.])
 

header.mk

@@ -33,11 +33,22 @@ DISTCLEANFILES += \
 	$(TOP)build/git_version.h \
 	$(TOP)Makefile.inc \
 	$(TOP)config.log \
+	$(TOP)config.wget.log \
 	$(TOP)acconf.h.in \
 	$(TOP)config.status \
 	$(TOP)autom4te.cache \
 	$(TOP)aclocal.m4 \
 
+CLEANFILES += \
+	$(wildcard $(TOP)Aegisub/usr/lib/*) \
+	$(TOP)Aegisub-x86_64.AppImage \
+	$(TOP)cscope.files \
+	$(TOP)cscope.out \
+	$(TOP)tags \
+
+CLEANDIRS += \
+	$(TOP)Aegisub \
+
 define MKDIR_INSTALL
 @$(BIN_MKDIR_P) $(dir $@)
 $(BIN_INSTALL) -m644 $< $@

packages/desktop/Aegisub.desktop

+[Desktop Entry]
+Version=1.0
+Type=Application
+Name=Aegisub
+Icon=aegisub
+GenericName=Subtitle Editor
+Comment=Create and edit subtitles for film and videos.
+Keywords=subtitles;video;audio;text
+Terminal=false
+Categories=AudioVideo;AudioVideoEditing;
+MimeType=application/x-srt;text/plain;text/x-ass;text/x-microdvd;text/x-ssa;
+StartupNotify=true
+Exec=aegisub

packages/desktop/aegisub.png

+64x64.png
\ No newline at end of file

tools/copy-libs.lua

+#!/usr/bin/env lua
+-- Needs awk and a shell (usually bash / sh) and ldd, which is a Linux utility.
+-- Thus run only this script on a Linux env or where the .so files can be found
+-- with the ldd command.
+
+if not arg or #arg ~= 2 then os.exit(1) end
+
+io.stdout:write(string.format('Running for file %s\n', arg[1]))
+io.stdout:write(string.format('Dest folder is %s\n',   arg[2]))
+
+-- Libs tables
+LIBS_WRITE = {}
+LIBS_READ  = {}
+
+-- Capture the output of a command
+function os.capture(cmd)
+    local f = assert(io.popen(cmd, 'r'))
+    local s = assert(f:read('*a'))
+    f:close()
+    return s
+end
+
+-- Simple copy of a table, it doesn't work with metatables and recursive tables
+function copy_simple(obj)
+    if type(obj) ~= 'table' then return obj end
+    local res = {}
+    for k, v in pairs(obj) do res[copy_simple(k)] = copy_simple(v) end
+    return res
+end
+
+-- Add the content of t2 in t1
+function concatenate(t1, t2)
+    for name, file in pairs(t2) do
+        t1[name] = file
+    end
+end
+
+-- Get the number of elements in a table
+function tablelength(T)
+    local count = 0
+    for _ in pairs(T) do count = count + 1 end
+    return count
+end
+
+-- The ldd command line utility, but in lua
+function ldd(file)
+    local libs = {}
+    local cmd  = string.format('ldd %s | awk \'$2 = "=>" && $3 { print $1 " " $3 }\'', arg[1])
+    local out  = os.capture(cmd)
+
+    for name, file in out:gmatch("([^\n ]*) ([^\n ]*)[\n]") do
+        libs[name] = file
+    end
+
+    return libs
+end
+
+-- Add NEEDS for each lib while there are some added. It's like a dataflow algorithme.
+LIBS_WRITE = ldd(arg[1])
+while tablelength(LIBS_READ) ~= tablelength(LIBS_WRITE) do
+    LIBS_READ = copy_simple(LIBS_WRITE)
+
+    for name, file in pairs(LIBS_READ) do
+        concatenate(LIBS_WRITE, ldd(file))
+    end
+end
+
+io.stdout:write(string.format("Cleaning %s", arg[2]))
+os.execute(string.format("rm -f %s/*", arg[2]))
+
+for name, file in pairs(LIBS_WRITE) do
+    local cmd = string.format('cp %s %s/%s && chmod 555 %s/%s',
+                              file, arg[2], name, arg[2], name)
+    os.execute(cmd)
+end
+io.stdout:write(string.format("Copied %d libraries to %s\n", tablelength(LIBS_WRITE), arg[2]))