diff options
Diffstat (limited to 'modules')
| -rw-r--r-- | modules/ECMInstallIcons.cmake | 157 |
1 files changed, 119 insertions, 38 deletions
diff --git a/modules/ECMInstallIcons.cmake b/modules/ECMInstallIcons.cmake index d83003ba..4255d98b 100644 --- a/modules/ECMInstallIcons.cmake +++ b/modules/ECMInstallIcons.cmake @@ -7,18 +7,46 @@ # # :: # -# ecm_install_icons(<icon_install_dir> [<l10n_code>]) +# ecm_install_icons(ICONS <icon> [<icon> [...]] +# DESTINATION <icon_install_dir> +# [LANG <l10n_code>] +# [THEME <theme>]) +# +# The given icons, whose names must match the pattern:: +# +# <size>-<group>-<name>.<ext> +# +# will be installed to the appropriate subdirectory of DESTINATION according to +# the FreeDesktop.org icon naming scheme. By default, they are installed to the +# "hicolor" theme, but this can be changed using the THEME argument. If the +# icons are localized, the LANG argument can be used to install them in a +# locale-specific directory. +# +# ``<size>`` is a numeric pixel size (typically 16, 22, 32, 48, 64, 128 or 256) +# or ``sc`` for scalable (SVG) files, ``<group>`` is one of the standard +# FreeDesktop.org icon groups (actions, animations, apps, categories, devices, +# emblems, emotes, intl, mimetypes, places, status) and ``<ext>`` is one of +# ``.png``, ``.mng`` or ``.svgz``. # -# Installs all icons found in ``CMAKE_CURRENT_SOURCE_DIR`` to the correct -# subdirectory of ``<icon_install_dir>``. ``<icon_install_dir>`` should -# typically be something like ``share/icons``, although users of the -# :kde-module:`KDEInstallDirs` module would normally do +# The typical installation directory is ``share/icons``. # # .. code-block:: cmake # -# ecm_install_icons(${ICON_INSTALL_DIR}) +# ecm_install_icons(ICONS 22-actions-menu_new.png +# DESTINATION share/icons) +# +# The above code will install the file ``22-actions-menu_new.png`` as +# ``${CMAKE_INSTALL_PREFIX}/share/icons/<theme>/22x22/actions/menu_new.png`` +# +# Users of the :kde-module:`KDEInstallDirs` module would normally use +# ``${ICON_INSTALL_DIR}`` as the DESTINATION, while users of the GNUInstallDirs +# module should use ``${CMAKE_INSTALL_DATAROOTDIR}/icons``. # -# The icons must be named in the form:: +# An old form of arguments will also be accepted:: +# +# ecm_install_icons(<icon_install_dir> [<l10n_code>]) +# +# This matches files named like:: # # <theme><size>-<group>-<name>.<ext> # @@ -28,16 +56,11 @@ # * ``cr`` for the Crystal icon theme # * ``ox`` for the Oxygen icon theme # -# ``<size>`` is a numeric pixel size (typically 16, 22, 32, 48, 64, 128 or 256) -# or ``sc`` for scalable (SVG) files, ``<group>`` is one of the standard -# FreeDesktop.org icon groups (actions, animations, apps, categories, devices, -# emblems, emotes, intl, mimetypes, places, status) and ``<ext>`` is one of -# ``.png``, ``.mng`` or ``.svgz``. -# -# For example the file ``hi22-action-menu_new.png`` would be installed into -# ``<icon_install_dir>/hicolor/22x22/actions/menu_new.png`` +# With this syntax, the file ``hi22-actions-menu_new.png`` would be installed +# into ``<icon_install_dir>/hicolor/22x22/actions/menu_new.png`` #============================================================================= +# Copyright 2014 Alex Merry <alex.merry@kde.org> # Copyright 2013 David Edmundson <kde@davidedmundson.co.uk> # Copyright 2008 Chusslove Illich <caslav.ilic@gmx.net> # Copyright 2006 Alex Neundorf <neundorf@kde.org> @@ -52,10 +75,10 @@ # (To distribute this file outside of extra-cmake-modules, substitute the full # License text for the above reference.) +include(CMakeParseArguments) -# a "map" of short type names to the directories -# unknown names should give empty results -# xdg icon naming specification compatibility +# A "map" of short type names to the directories. +# Unknown names produce a warning. set(_ECM_ICON_GROUP_mimetypes "mimetypes") set(_ECM_ICON_GROUP_places "places") set(_ECM_ICON_GROUP_devices "devices") @@ -68,16 +91,14 @@ set(_ECM_ICON_GROUP_emotes "emotes") set(_ECM_ICON_GROUP_animations "animations") set(_ECM_ICON_GROUP_intl "intl") -# FIXME: this is too KDE-specific; we should keep this map for compatibility, -# but get users to specify the full theme name -# a "map" of short theme names to the theme directory +# For the "compatibility" syntax: a "map" of short theme names to the theme +# directory set(_ECM_ICON_THEME_ox "oxygen") set(_ECM_ICON_THEME_cr "crystalsvg") set(_ECM_ICON_THEME_lo "locolor") set(_ECM_ICON_THEME_hi "hicolor") -macro (ECM_INSTALL_ICONS _defaultpath ) - +macro(_ecm_install_icons_v1 _defaultpath) # the l10n-subdir if language given as second argument (localized icon) set(_lang ${ARGV1}) if(_lang) @@ -96,7 +117,6 @@ macro (ECM_INSTALL_ICONS _defaultpath ) set(_group "${CMAKE_MATCH_3}") set(_name "${CMAKE_MATCH_4}") - # FIXME: don't use map set(_theme_GROUP ${_ECM_ICON_THEME_${_type}}) if( _theme_GROUP) _ECM_ADD_ICON_INSTALL_RULE(${CMAKE_CURRENT_BINARY_DIR}/install_icons.cmake @@ -140,35 +160,96 @@ macro (ECM_INSTALL_ICONS _defaultpath ) endif( _theme_GROUP) endforeach (_current_ICON) - ecm_update_iconcache() + _ecm_update_iconcache("${_defaultpath}" hicolor) -endmacro (ECM_INSTALL_ICONS) +endmacro() -# only used internally by ECM_INSTALL_ICONS -macro (_ECM_ADD_ICON_INSTALL_RULE _install_SCRIPT _install_PATH _group _orig_NAME _install_NAME _l10n_SUBDIR) +# only used internally by _ecm_install_icons_v1 +macro(_ecm_add_icon_install_rule _install_SCRIPT _install_PATH _group _orig_NAME _install_NAME _l10n_SUBDIR) # if the string doesn't match the pattern, the result is the full string, so all three have the same content if (NOT ${_group} STREQUAL ${_install_NAME} ) set(_icon_GROUP ${_ECM_ICON_GROUP_${_group}}) if(NOT _icon_GROUP) - # FIXME: print warning if not in map (and not "actions") set(_icon_GROUP "actions") endif(NOT _icon_GROUP) # message(STATUS "icon: ${_current_ICON} size: ${_size} group: ${_group} name: ${_name} l10n: ${_l10n_SUBDIR}") install(FILES ${_orig_NAME} DESTINATION ${_install_PATH}/${_icon_GROUP}/${_l10n_SUBDIR}/ RENAME ${_install_NAME} ) endif (NOT ${_group} STREQUAL ${_install_NAME} ) -endmacro (_ECM_ADD_ICON_INSTALL_RULE) +endmacro() -macro (ECM_UPDATE_ICONCACHE) - # Update mtime of hicolor icon theme dir. - # We don't always have touch command (e.g. on Windows), so instead create - # and delete a temporary file in the theme dir. - install(CODE " +# Updates the mtime of the icon theme directory, so caches that +# watch for changes to the directory will know to update. +function(_ecm_update_iconcache installdir theme) + # We don't always have touch command (e.g. on Windows), so instead + # create and delete a temporary file in the theme dir. + install(CODE " set(DESTDIR_VALUE \"\$ENV{DESTDIR}\") if (NOT DESTDIR_VALUE) - file(WRITE \"${ICON_INSTALL_DIR}/hicolor/temp.txt\" \"update\") - file(REMOVE \"${ICON_INSTALL_DIR}/hicolor/temp.txt\") + file(WRITE \"${installdir}/${theme}/temp.txt\" \"update\") + file(REMOVE \"${installdir}/${theme}/temp.txt\") endif (NOT DESTDIR_VALUE) ") -endmacro (ECM_UPDATE_ICONCACHE) +endfunction() + +function(ecm_install_icons) + set(options) + set(oneValueArgs DESTINATION LANG THEME) + set(multiValueArgs ICONS) + cmake_parse_arguments(ARG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) + + if(NOT ARG_ICONS AND NOT ARG_DESTINATION) + message(AUTHOR_WARNING "ecm_install_icons() with no ICONS argument is deprecated") + _ecm_install_icons_v1(${ARGN}) + return() + endif() + if(ARG_UNPARSED_ARGUMENTS) + message(FATAL_ERROR "Unexpected arguments to ecm_install_icons: ${ARG_UNPARSED_ARGUMENTS}") + endif() + if(NOT ARG_DESTINATION) + message(FATAL_ERROR "No DESTINATION argument given to ecm_install_icons") + endif() + if(NOT ARG_THEME) + set(ARG_THEME "hicolor") + endif() + if(ARG_LANG) + set(l10n_subdir "l10n/${ARG_LANG}/") + endif() + + foreach(icon ${ARG_ICONS}) + string(REGEX MATCH "([0-9sc]+)\\-([a-z]+)\\-([^/]+)\\.([a-z]+)$" + _dummy "${icon}") + set(size "${CMAKE_MATCH_1}") + set(group "${CMAKE_MATCH_2}") + set(name "${CMAKE_MATCH_3}") + set(ext "${CMAKE_MATCH_4}") + if(NOT size OR NOT group OR NOT name OR NOT ext) + message(WARNING "${icon} is not named correctly for ecm_install_icons - ignoring") + elseif(NOT size STREQUAL "sc" AND NOT size GREATER 0) + message(WARNING "${icon} size (${size}) is invalid - ignoring") + else() + if(NOT _ECM_ICON_GROUP_${group}) + message(WARNING "${icon} group (${group}) is not recognized") + endif() + if(size STREQUAL "sc") + if(NOT ext STREQUAL "svg" AND NOT ext STREQUAL "svgz") + message(WARNING "Scalable icon ${icon} is not SVG or SVGZ") + endif() + set(size_dir "scalable") + else() + if(NOT ext STREQUAL "png" AND NOT ext STREQUAL "mng") + message(WARNING "Fixed-size icon ${icon} is not PNG or MNG") + endif() + set(size_dir "${size}x${size}") + endif() + install( + FILES "${icon}" + DESTINATION "${ARG_DESTINATION}/${ARG_THEME}/${size_dir}/${group}/${l10n_subdir}" + RENAME "${name}.${ext}" + ) + endif() + endforeach() + _ecm_update_iconcache("${ARG_DESTINATION}" "${ARG_THEME}") +endfunction() + |