gentoo-x86/eclass/systemd.eclass

# Copyright 1999-2011 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/systemd.eclass,v 1.4 2011/06/16 16:39:18 mgorny Exp $

# @ECLASS: systemd.eclass
# @MAINTAINER:
# mgorny@gentoo.org
# @BLURB: helper functions to install systemd units
# @DESCRIPTION:
# This eclass provides a set of functions to install unit files for
# sys-apps/systemd within ebuilds.
# @EXAMPLE:
#
# @CODE
# inherit autotools-utils systemd
# 
# src_configure() {
#       local myeconfargs=(
#               --enable-foo
#               --disable-bar
#       )
#
#       systemd_to_myeconfargs
#       autotools-utils_src_configure
# }
# @CODE

case ${EAPI:-0} in
        0|1|2|3|4) ;;
        *) die "${ECLASS}.eclass API in EAPI ${EAPI} not yet established."
esac

# @FUNCTION: systemd_get_unitdir
# @DESCRIPTION:
# Output the path for the systemd unit directory (not including ${D}).
# This function always succeeds, even if systemd is not installed.
systemd_get_unitdir() {
        debug-print-function ${FUNCNAME} "${@}"

        echo -n /lib/systemd/system
}

# @FUNCTION: systemd_dounit
# @USAGE: unit1 [...]
# @DESCRIPTION:
# Install systemd unit(s). Uses doins, thus it is fatal in EAPI 4
# and non-fatal in earlier EAPIs.
systemd_dounit() {
        debug-print-function ${FUNCNAME} "${@}"

        (
                insinto "$(systemd_get_unitdir)"
                doins "${@}"
        )
}

# @FUNCTION: systemd_newunit
# @USAGE: oldname newname
# @DESCRIPTION:
# Install systemd unit with a new name. Uses newins, thus it is fatal
# in EAPI 4 and non-fatal in earlier EAPIs.
systemd_newunit() {
        debug-print-function ${FUNCNAME} "${@}"

        (
                insinto "$(systemd_get_unitdir)"
                newins "${@}"
        )
}

# @FUNCTION: systemd_dotmpfilesd
# @USAGE: tmpfilesd1 [...]
# @DESCRIPTION:
# Install systemd tmpfiles.d files. Uses doins, thus it is fatal
# in EAPI 4 and non-fatal in earlier EAPIs.
systemd_dotmpfilesd() {
        debug-print-function ${FUNCNAME} "${@}"

        (
                insinto /usr/lib/tmpfiles.d/
                doins "${@}"
        )
}

# @FUNCTION: systemd_enable_service
# @USAGE: target service
# @DESCRIPTION:
# Enable service in desired target, e.g. install a symlink for it.
# Uses dosym, thus it is fatal in EAPI 4 and non-fatal in earlier
# EAPIs.
systemd_enable_service() {
        debug-print-function ${FUNCNAME} "${@}"

        [[ ${#} -eq 2 ]] || die "Synopsis: systemd_enable_service target service"

        local target=${1}
        local service=${2}
        local ud=$(systemd_get_unitdir)

        dodir "${ud}"/"${target}".wants && \
        dosym ../"${service}" "${ud}"/"${target}".wants
}

# @FUNCTION: systemd_with_unitdir
# @USAGE: [configure option]
# @DESCRIPTION:
# Output '--with-systemdsystemunitdir' as expected by systemd-aware configure
# scripts. This function always succeeds. Its output may be quoted in order
# to preserve whitespace in paths. systemd_to_myeconfargs() is preferred over
# this function.
#
# If upstream does use invalid configure option to handle installing systemd
# units (e.g. `--with-systemdunitdir'), you can pass the 'suffix' as an optional
# argument to this function (`$(systemd_with_unitdir systemdunitdir)'). Please
# remember to report a bug upstream as well.
systemd_with_unitdir() {
        debug-print-function ${FUNCNAME} "${@}"
        local optname=${1:-systemdsystemunitdir}

        echo -n --with-${optname}="$(systemd_get_unitdir)"
}

# @FUNCTION: systemd_to_myeconfargs
# @DESCRIPTION:
# Add '--with-systemdsystemunitdir' as expected by systemd-aware configure
# scripts to the myeconfargs variable used by autotools-utils eclass. Handles
# quoting automatically.
systemd_to_myeconfargs() {
        debug-print-function ${FUNCNAME} "${@}"

        myeconfargs=(
                "${myeconfargs[@]}"
                --with-systemdsystemunitdir="$(systemd_get_unitdir)"
        )
}
1	# Copyright 1999-2011 Gentoo Foundation
2	# Distributed under the terms of the GNU General Public License v2
3	# $Header: /var/cvsroot/gentoo-x86/eclass/systemd.eclass,v 1.4 2011/06/16 16:39:18 mgorny Exp $
4
5	# @ECLASS: systemd.eclass
6	# @MAINTAINER:
7	# mgorny@gentoo.org
8	# @BLURB: helper functions to install systemd units
9	# @DESCRIPTION:
10	# This eclass provides a set of functions to install unit files for
11	# sys-apps/systemd within ebuilds.
12	# @EXAMPLE:
13	#
14	# @CODE
15	# inherit autotools-utils systemd
16	#
17	# src_configure() {
18	# local myeconfargs=(
19	# --enable-foo
20	# --disable-bar
21	# )
22	#
23	# systemd_to_myeconfargs
24	# autotools-utils_src_configure
25	# }
26	# @CODE
27
28	case ${EAPI:-0} in
29	0\|1\|2\|3\|4) ;;
30	*) die "${ECLASS}.eclass API in EAPI ${EAPI} not yet established."
31	esac
32
33	# @FUNCTION: systemd_get_unitdir
34	# @DESCRIPTION:
35	# Output the path for the systemd unit directory (not including ${D}).
36	# This function always succeeds, even if systemd is not installed.
37	systemd_get_unitdir() {
38	debug-print-function ${FUNCNAME} "${@}"
39
40	echo -n /lib/systemd/system
41	}
42
43	# @FUNCTION: systemd_dounit
44	# @USAGE: unit1 [...]
45	# @DESCRIPTION:
46	# Install systemd unit(s). Uses doins, thus it is fatal in EAPI 4
47	# and non-fatal in earlier EAPIs.
48	systemd_dounit() {
49	debug-print-function ${FUNCNAME} "${@}"
50
51	(
52	insinto "$(systemd_get_unitdir)"
53	doins "${@}"
54	)
55	}
56
57	# @FUNCTION: systemd_newunit
58	# @USAGE: oldname newname
59	# @DESCRIPTION:
60	# Install systemd unit with a new name. Uses newins, thus it is fatal
61	# in EAPI 4 and non-fatal in earlier EAPIs.
62	systemd_newunit() {
63	debug-print-function ${FUNCNAME} "${@}"
64
65	(
66	insinto "$(systemd_get_unitdir)"
67	newins "${@}"
68	)
69	}
70
71	# @FUNCTION: systemd_dotmpfilesd
72	# @USAGE: tmpfilesd1 [...]
73	# @DESCRIPTION:
74	# Install systemd tmpfiles.d files. Uses doins, thus it is fatal
75	# in EAPI 4 and non-fatal in earlier EAPIs.
76	systemd_dotmpfilesd() {
77	debug-print-function ${FUNCNAME} "${@}"
78
79	(
80	insinto /usr/lib/tmpfiles.d/
81	doins "${@}"
82	)
83	}
84
85	# @FUNCTION: systemd_enable_service
86	# @USAGE: target service
87	# @DESCRIPTION:
88	# Enable service in desired target, e.g. install a symlink for it.
89	# Uses dosym, thus it is fatal in EAPI 4 and non-fatal in earlier
90	# EAPIs.
91	systemd_enable_service() {
92	debug-print-function ${FUNCNAME} "${@}"
93
94	[[ ${#} -eq 2 ]] \|\| die "Synopsis: systemd_enable_service target service"
95
96	local target=${1}
97	local service=${2}
98	local ud=$(systemd_get_unitdir)
99
100	dodir "${ud}"/"${target}".wants && \
101	dosym ../"${service}" "${ud}"/"${target}".wants
102	}
103
104	# @FUNCTION: systemd_with_unitdir
105	# @USAGE: [configure option]
106	# @DESCRIPTION:
107	# Output '--with-systemdsystemunitdir' as expected by systemd-aware configure
108	# scripts. This function always succeeds. Its output may be quoted in order
109	# to preserve whitespace in paths. systemd_to_myeconfargs() is preferred over
110	# this function.
111	#
112	# If upstream does use invalid configure option to handle installing systemd
113	# units (e.g. `--with-systemdunitdir'), you can pass the 'suffix' as an optional
114	# argument to this function (`$(systemd_with_unitdir systemdunitdir)'). Please
115	# remember to report a bug upstream as well.
116	systemd_with_unitdir() {
117	debug-print-function ${FUNCNAME} "${@}"
118	local optname=${1:-systemdsystemunitdir}
119
120	echo -n --with-${optname}="$(systemd_get_unitdir)"
121	}
122
123	# @FUNCTION: systemd_to_myeconfargs
124	# @DESCRIPTION:
125	# Add '--with-systemdsystemunitdir' as expected by systemd-aware configure
126	# scripts to the myeconfargs variable used by autotools-utils eclass. Handles
127	# quoting automatically.
128	systemd_to_myeconfargs() {
129	debug-print-function ${FUNCNAME} "${@}"
130
131	myeconfargs=(
132	"${myeconfargs[@]}"
133	--with-systemdsystemunitdir="$(systemd_get_unitdir)"
134	)
135	}