eclass/udev.eclass

   1 # Copyright 1999-2018 Gentoo Authors
   2 # Distributed under the terms of the GNU General Public License v2
   3
   4 # @ECLASS: udev.eclass
   5 # @MAINTAINER:
   6 # udev-bugs@gentoo.org
   7 # @SUPPORTED_EAPIS: 0 1 2 3 4 5 6 7
   8 # @BLURB: Default eclass for determining udev directories.
   9 # @DESCRIPTION:
  10 # Default eclass for determining udev directories.
  11 # @EXAMPLE:
  12 #
  13 # @CODE
  14 # inherit udev
  15 #
  16 # # Example of the eclass usage:
  17 # RDEPEND="virtual/udev"
  18 # DEPEND="${RDEPEND}"
  19 #
  20 # src_configure() {
  21 #       econf --with-rulesdir="$(get_udevdir)"/rules.d
  22 # }
  23 #
  24 # src_install() {
  25 #       default
  26 #       # udev_dorules contrib/99-foomatic
  27 #       # udev_newrules contrib/98-foomatic 99-foomatic
  28 # }
  29 # @CODE
  30
  31 if [[ -z ${_UDEV_ECLASS} ]]; then
  32 _UDEV_ECLASS=1
  33
  34 inherit toolchain-funcs
  35
  36 case ${EAPI:-0} in
  37         0|1|2|3|4|5|6|7) ;;
  38         *) die "${ECLASS}.eclass API in EAPI ${EAPI} not yet established."
  39 esac
  40
  41 if [[ ${EAPI:-0} == [0123456] ]]; then
  42         RDEPEND=""
  43         DEPEND="virtual/pkgconfig"
  44 else
  45         BDEPEND="virtual/pkgconfig"
  46 fi
  47
  48 # @FUNCTION: _udev_get_udevdir
  49 # @INTERNAL
  50 # @DESCRIPTION:
  51 # Get unprefixed udevdir.
  52 _udev_get_udevdir() {
  53         if $($(tc-getPKG_CONFIG) --exists udev); then
  54                 local udevdir="$($(tc-getPKG_CONFIG) --variable=udevdir udev)"
  55                 echo "${udevdir#${EPREFIX%/}}"
  56         else
  57                 echo /lib/udev
  58         fi
  59 }
  60
  61 # @FUNCTION: udev_get_udevdir
  62 # @DESCRIPTION:
  63 # Use the short version $(get_udevdir) instead!
  64 udev_get_udevdir() {
  65         debug-print-function ${FUNCNAME} "${@}"
  66
  67         eerror "This ebuild should be using the get_udevdir() function instead of the deprecated udev_get_udevdir()"
  68         die "Deprecated function call: udev_get_udevdir(), please report to (overlay) maintainers."
  69 }
  70
  71 # @FUNCTION: get_udevdir
  72 # @DESCRIPTION:
  73 # Output the path for the udev directory (not including ${D}).
  74 # This function always succeeds, even if udev is not installed.
  75 # The fallback value is set to /lib/udev
  76 get_udevdir() {
  77         debug-print-function ${FUNCNAME} "${@}"
  78
  79         echo "$(_udev_get_udevdir)"
  80 }
  81
  82 # @FUNCTION: udev_dorules
  83 # @USAGE: <rule> [...]
  84 # @DESCRIPTION:
  85 # Install udev rule(s). Uses doins, thus it is fatal in EAPI 4
  86 # and non-fatal in earlier EAPIs.
  87 udev_dorules() {
  88         debug-print-function ${FUNCNAME} "${@}"
  89
  90         (
  91                 insopts -m 0644
  92                 insinto "$(_udev_get_udevdir)"/rules.d
  93                 doins "${@}"
  94         )
  95 }
  96
  97 # @FUNCTION: udev_newrules
  98 # @USAGE: <oldname> <newname>
  99 # @DESCRIPTION:
 100 # Install udev rule with a new name. Uses newins, thus it is fatal
 101 # in EAPI 4 and non-fatal in earlier EAPIs.
 102 udev_newrules() {
 103         debug-print-function ${FUNCNAME} "${@}"
 104
 105         (
 106                 insopts -m 0644
 107                 insinto "$(_udev_get_udevdir)"/rules.d
 108                 newins "${@}"
 109         )
 110 }
 111
 112 # @FUNCTION: udev_reload
 113 # @DESCRIPTION:
 114 # Run udevadm control --reload to refresh rules and databases
 115 udev_reload() {
 116         if [[ ${ROOT} != "" ]] && [[ ${ROOT} != "/" ]]; then
 117                 return 0
 118         fi
 119
 120         if [[ -d ${ROOT}/run/udev ]]; then
 121                 ebegin "Running udev control --reload for reloading rules and databases"
 122                 udevadm control --reload
 123                 eend $?
 124         fi
 125 }
 126
 127 fi