Updated Meson configuration

- Added version and license metadata - Configuration data to be used in configured files to set metadata - Portable binary and directories in the main install directory - Binary file installed in correct places for all supported platforms - Freedesktop AppStream support - Added missing files install rules
2021-08-09 19:32:53 +02:00 · 2021-08-09 19:32:53 +02:00 · 3468164518
parent 0b2bf227a8
commit 3468164518
7 changed files with 132 additions and 40 deletions
--- a/.editorconfig
+++ b/.editorconfig
@ -6,3 +6,6 @@ indent_size = 2
 indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
+
+[meson.build]
+indent_size = 4
--- a/meson.build
+++ b/meson.build
@ -1,14 +1,61 @@
-project('lite-xl', 'c', 'cpp', default_options : ['c_std=gnu11', 'cpp_std=c++03'])
+project('lite-xl',
+    ['c', 'cpp'],
+    version : '2.0.0',
+    license : 'MIT',
+    meson_version : '>= 0.54',
+    default_options : ['c_std=gnu11', 'cpp_std=c++03']
+)
+# TODO: the project version could be automatically generated from git with:
+#   version : run_command('bash', 'scripts/version.sh').stdout(),

-version = get_option('version')
+#===============================================================================
+# Configuration
+#===============================================================================
 conf_data = configuration_data()
-conf_data.set('PROJECT_VERSION', version)
+conf_data.set('PROJECT_BUILD_DIR', meson.current_build_dir())
+conf_data.set('PROJECT_SOURCE_DIR', meson.current_source_dir())
+conf_data.set('PROJECT_VERSION', meson.project_version())

+configure_file(
+    input : 'scripts/start.lua.in',
+    output : 'start.lua',
+    configuration : conf_data
+)
+if host_machine.system() == 'windows'
+    configure_file(
+        input : 'scripts/innosetup/innosetup.iss.in',
+        output : 'innosetup.iss',
+        configuration : conf_data
+    )
+endif
+#===============================================================================
+# Compiler Settings
+#===============================================================================
 if host_machine.system() == 'darwin'
    add_languages('objc')
 endif

 cc = meson.get_compiler('c')
+
+lite_cargs = []
+# On macos we need to use the SDL renderer to support retina displays
+if get_option('renderer') or host_machine.system() == 'darwin'
+    lite_cargs += '-DLITE_USE_SDL_RENDERER'
+endif
+#===============================================================================
+# Linker Settings
+#===============================================================================
+lite_link_args = []
+if cc.get_id() == 'gcc' and get_option('buildtype') == 'release'
+    lite_link_args += ['-static-libgcc', '-static-libstdc++']
+endif
+
+if host_machine.system() == 'darwin'
+    lite_link_args += ['-framework', 'CoreServices', '-framework', 'Foundation']
+endif
+#===============================================================================
+# Dependencies
+#===============================================================================
 libm = cc.find_library('m', required : false)
 libdl = cc.find_library('dl', required : false)
 libx11 = dependency('x11', required : false)
@ -17,11 +64,18 @@ pcre2_dep = dependency('libpcre2-8')
 sdl_dep = dependency('sdl2', method: 'config-tool')

 if not lua_dep.found()
-    lua_subproject = subproject('lua', default_options: ['shared=false', 'use_readline=false', 'app=false'])
+    lua_subproject = subproject('lua',
+        default_options: ['shared=false', 'use_readline=false', 'app=false']
+    )
    lua_dep = lua_subproject.get_variable('lua_dep')
 endif

-reproc_subproject = subproject('reproc', default_options: ['default_library=static', 'multithreaded=false', 'reproc-cpp=false', 'examples=false'])
+reproc_subproject = subproject('reproc',
+    default_options: [
+        'default_library=static', 'multithreaded=false',
+        'reproc-cpp=false', 'examples=false'
+    ]
+)
 reproc_dep = reproc_subproject.get_variable('reproc_dep')

 lite_deps = [lua_dep, sdl_dep, reproc_dep, pcre2_dep, libm, libdl, libx11]
@ -31,44 +85,47 @@ if host_machine.system() == 'windows'
    # the pkg-config file from reproc does not include it.
    lite_deps += meson.get_compiler('cpp').find_library('ws2_32', required: true)
 endif
-
-lite_cargs = []
-if get_option('portable')
-    lite_docdir = 'doc'
-    lite_datadir = 'data'
+#===============================================================================
+# Install Configuration
+#===============================================================================
+if get_option('portable') or host_machine.system() == 'windows'
+    lite_bindir = '/'
+    lite_docdir = '/doc'
+    lite_datadir = '/data'
+elif host_machine.system() == 'darwin'
+    lite_bindir = 'Contents/MacOS'
+    lite_docdir = 'Contents/Resources'
+    lite_datadir = 'Contents/Resources'
+    install_data('resources/icons/icon.icns', install_dir : 'Contents/Resources')
+    install_data('resources/macos/Info.plist', install_dir : 'Contents')
 else
+    lite_bindir = 'bin'
    lite_docdir = 'share/doc/lite-xl'
    lite_datadir = 'share/lite-xl'
+    if host_machine.system() == 'linux'
+        install_data('resources/icons/lite-xl.svg',
+            install_dir : 'share/icons/hicolor/scalable/apps'
+        )
+        install_data('resources/linux/org.lite-xl.lite-xl.desktop',
+            install_dir : 'share/applications'
+        )
+        install_data('resources/linux/org.lite-xl.lite-xl.appdata.xml',
+            install_dir : 'share/metainfo'
+        )
+    endif
 endif

-lite_include = include_directories('src')
+install_data('licenses/licenses.md', install_dir : lite_docdir)
+
 foreach data_module : ['core', 'fonts', 'plugins', 'colors']
    install_subdir('data' / data_module , install_dir : lite_datadir)
 endforeach

-install_data('licenses/licenses.md', install_dir : lite_docdir)
-
-lite_link_args = []
-if cc.get_id() == 'gcc' and get_option('buildtype') == 'release'
-    lite_link_args += ['-static-libgcc', '-static-libstdc++']
-endif
-if host_machine.system() == 'darwin'
-    lite_link_args += ['-framework', 'CoreServices', '-framework', 'Foundation']
-endif
-
-lite_rc = []
-if host_machine.system() == 'windows'
-    windows = import('windows')
-    lite_rc += windows.compile_resources('resources/icons/icon.rc')
-    iss = configure_file(input : 'scripts/innosetup/innosetup.iss.in',
-        output : 'innosetup.iss',
-        configuration : conf_data)
-endif
-
-# On macos we need to use the SDL renderer to support retina displays
-if get_option('renderer') or host_machine.system() == 'darwin'
-    lite_cargs += '-DLITE_USE_SDL_RENDERER'
-endif
-
+install_data(
+    meson.current_build_dir() / 'start.lua', install_dir : lite_datadir / 'core'
+)
+#===============================================================================
+# Targets
+#===============================================================================
 subdir('lib/font_renderer')
 subdir('src')
--- a/meson_options.txt
+++ b/meson_options.txt
@ -1,4 +1,2 @@
-option('innosetup', type : 'boolean', value : false, description: 'Build Windows setup package')
 option('portable', type : 'boolean', value : false, description: 'Portable install')
 option('renderer', type : 'boolean', value : false, description: 'Use SDL renderer')
-option('version', type : 'string', value : '0.0.0', description: 'Project version')
--- a/resources/linux/org.lite-xl.lite-xl.appdata.xml
+++ b/resources/linux/org.lite-xl.lite-xl.appdata.xml
@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<component type="desktop">
+  <id>org.lite-xl.lite-xl</id>
+  <metadata_license>MIT</metadata_license>
+  <project_license>MIT</project_license>
+  <name>Lite XL</name>
+  <summary>A lightweight text editor written in Lua</summary>
+
+  <description>
+    <p>
+      Lite XL is a text editor and development tool written mainly in Lua,
+      on top of a minimalistic C core using the SDL2 graphics library.
+    </p>
+  </description>
+
+  <screenshots>
+    <screenshot type="default">
+      <caption>The editor window</caption>
+      <image>https://lite-xl.github.io/assets/img/screenshots/editor.png</image>
+    </screenshot>
+  </screenshots>
+
+  <url type="homepage">https://lite-xl.github.io</url>
+
+  <provides>
+    <binary>lite-xl</binary>
+  </provides>
+</component>
--- a/resources/linux/org.lite-xl.lite-xl.desktop
+++ b/resources/linux/org.lite-xl.lite-xl.desktop
--- a/scripts/start.lua.in
+++ b/scripts/start.lua.in
@ -1,5 +1,5 @@
 -- this file is used by lite-xl to setup the Lua environment when starting
-VERSION = "2.0-beta1"
+VERSION = "@PROJECT_VERSION@"
 MOD_VERSION = "1"

 SCALE = tonumber(os.getenv("LITE_SCALE")) or SCALE
@ -19,4 +19,3 @@ package.path = DATADIR .. '/?.lua;' .. package.path
 package.path = DATADIR .. '/?/init.lua;' .. package.path
 package.path = USERDIR .. '/?.lua;' .. package.path
 package.path = USERDIR .. '/?/init.lua;' .. package.path
-
--- a/src/meson.build
+++ b/src/meson.build
@ -13,10 +13,16 @@ lite_sources = [
    'main.c',
 ]

-if host_machine.system() == 'darwin'
+lite_rc = []
+if host_machine.system() == 'windows'
+    windows = import('windows')
+    lite_rc += windows.compile_resources('../resources/icons/icon.rc')
+elif host_machine.system() == 'darwin'
    lite_sources += 'bundle_open.m'
 endif

+lite_include = include_directories('.')
+
 executable('lite-xl',
    lite_sources + lite_rc,
    include_directories: [lite_include, font_renderer_include],
@ -24,6 +30,7 @@ executable('lite-xl',
    c_args: lite_cargs,
    link_with: libfontrenderer,
    link_args: lite_link_args,
+    install_dir: lite_bindir,
    install: true,
    gui_app: true,
 )