Differential D29051 Diff 80766 modules/ECMGenerateDBusServiceFile.cmake

Changeset View

Standalone View

View Options

modules/ECMGenerateDBusServiceFile.cmake

  • This file was added.
1​#.rst:
2​# ECMGenerateDBusServiceFile
3​# ---------------------------
4​#
5​# This module provides the ``ecm_generate_dbus_service_file`` function for
6​# generating a D-Bus service file.
kossebauUnsubmitted
Done

generate and install

kossebau: generate and install
7​#
8​# ::
9​#
10​# ecm_generate_dbus_service_file(
11​# NAME <service name>
12​# EXECUTABLE <executable>
13​# [SYSTEMD_SERVICE <systemd service>]
14​# )
15​#
16​# A D-Bus service file ``<service name>.service` will will be generated and installed
17​# in the relevant D-Bus config location. On Windows, only the file name of ``<executable>``
18​# is used since D-Bus service executables are to be installed in the same directory
kossebauUnsubmitted
Not Done

Computer says: .../extra-cmake-modules/modules/ECMGenerateDBusServiceFile.cmake:17: WARNING: Inline literal start-string without end-string.

kossebau: Computer says: .../extra-cmake-modules/modules/ECMGenerateDBusServiceFile.cmake:17: WARNING…
19​# as the D-Bus daemon. On other platforms ``<executable>`` must be an absolute path
20​# to the service executable. Optionally, a ``<systemd service>`` can be specified.
21​#
kossebauUnsubmitted
Not Done

I would propopse "to the installed service executable.", to avoid the misunderstanding this is about the copy in the build system.

kossebau: I would propopse "to the installed service executable.", to avoid the misunderstanding this is…
22​# Since 5.70.0.
kossebauUnsubmitted
Done

Would be nice to have an example.
Also having each argument discussed in an own section makes getting the docs easier,

kossebau: Would be nice to have an example. Also having each argument discussed in an own section makes…
kossebauUnsubmitted
Not Done

Same issue: KDEInstallDirs misses double single quotes after it.

kossebau: Same issue: KDEInstallDirs misses double single quotes after it.
23​
kossebauUnsubmitted
Not Done

This might be misunderstood that people on the caller side need to do an if/else switch for what to pass as EXECUTABLE.
Perhaps change to say this should be the absolute path (and give a hint that with KDEInstallDirs being used this should be then the _FULL variant of the variable.)
The actual special handling for the Windows case could be mentioned as a note only, for the curious user.

kossebau: This might be misunderstood that people on the caller side need to do an if/else switch for…
24​#=============================================================================
kossebauUnsubmitted
Not Done

Perhaps phrase it like: "Note: On Windows, the macro will only use the file name part of <executable> since D-Bus service executables are to be installed in the same directory as the D-Bus daemon."
Current text still leaves chance to misunderstand that the user in "is used" is the macro caller, not the macro itself :)

kossebau: Perhaps phrase it like: "Note: On Windows, the macro will only use the file name part of…
25​# Copyright 2020 Kai Uwe Broulik <kde@broulik.de>
kossebauUnsubmitted
Not Done

This leaves me puzzled what values are exactly accepted here, should get more details (and perhaps a separate example).

kossebau: This leaves me puzzled what values are exactly accepted here, should get more details (and…
26​#
27​# Redistribution and use in source and binary forms, with or without
28​# modification, are permitted provided that the following conditions
29​# are met:
30​#
31​# 1. Redistributions of source code must retain the copyright
32​# notice, this list of conditions and the following disclaimer.
33​# 2. Redistributions in binary form must reproduce the copyright
34​# notice, this list of conditions and the following disclaimer in the
35​# documentation and/or other materials provided with the distribution.
36​# 3. The name of the author may not be used to endorse or promote products
37​# derived from this software without specific prior written permission.
38​#
39​# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
40​# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
41​# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
42​# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
43​# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44​# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
45​# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
46​# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
47​# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
48​# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
49​
50​include(CMakeParseArguments)
51​
52​function(ecm_generate_dbus_service_file)
53​ set(options)
54​ set(oneValueArgs EXECUTABLE NAME SYSTEMD_SERVICE)
55​ set(multiValueArgs)
56​ cmake_parse_arguments(ARG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
57​
58​ if(ARG_UNPARSED_ARGUMENTS)
59​ message(FATAL_ERROR "Unexpected arguments to ecm_generate_dbus_service_file: ${ARG_UNPARSED_ARGUMENTS}")
60​ endif()
61​ if(NOT ARG_NAME)
62​ message(FATAL_ERROR "Missing NAME argument for ecm_generate_dbus_service_file")
63​ endif()
64​ if(NOT ARG_EXECUTABLE)
65​ message(FATAL_ERROR "Missing EXECUTABLE argument for ecm_generate_dbus_service_file")
66​ endif()
67​
68​ if(WIN32)
69​ get_filename_component(_exec "${ARG_EXECUTABLE}" NAME)
70​ else()
71​ if (NOT IS_ABSOLUTE ${ARG_EXECUTABLE})
72​ message(FATAL_ERROR "EXECUTABLE must be an absolute path in ecm_generate_dbus_service_file")
73​ else()
74​ set(_exec ${ARG_EXECUTABLE})
75​ endif()
76​ endif()
77​
78​ set(_service_file ${CMAKE_CURRENT_BINARY_DIR}/${ARG_NAME}.service)
79​
80​ file(WRITE ${_service_file}
81​ "[D-BUS Service]
82​Name=${ARG_NAME}
83​Exec=${_exec}
84​")
85​
86​ if (ARG_SYSTEMD_SERVICE)
87​ file(APPEND ${_service_file} "SystemdService=${ARG_SYSTEMD_SERVICE}\n")
88​ endif()
89​
90​ install(FILES ${_service_file} DESTINATION ${KDE_INSTALL_DBUSSERVICEDIR})
kossebauUnsubmitted
Done

Creates a dependecy on KDEInstallDirs.

ECM/Modules are supposed to be usable in non-KDE-typical setups. So like other places in this subfolder this macro needs an argument to pass the installation folder.

kossebau: Creates a dependecy on KDEInstallDirs. ECM/Modules are supposed to be usable in non-KDE…
91​endfunction()