Merge lp:~sam-sgrs/click/cmake-modules into lp:ubuntu/utopic/click

[Sam Segers]

Cmake files for click packaging

CLICKDeployLibs - deploys libs that are not in the ubuntu touch manifest (or other manifest supplied)
CLICKInstallDirs - Like GNUInstallDirs but for Click
ResolveLibs - resolve libs absolute

[Colin Watson (cjwatson)]

Please propose click merges to lp:click, not lp:ubuntu/click.

I'm having a hard time understanding why this is needed. Please can you provide some background? We shouldn't be going anywhere near image manifests from cdimage.ubuntu.com for building click packages, and building packages must not require access to a specific site on the network.

This all seems to overlap heavily with "click chroot", the ubuntu-sdk-libs-dev package, and associated framework files.

review: Needs Information

[Sam Segers (sam-sgrs)]

Yes, maybe ubuntu-sdk-libs-dev would be better.

Unmerged revisions

45. By Sam Segers on 2014-05-14

Add CMake modules to be used in Click packaging

CLICKDeployLibs - Add libs to be included in the click package
CLICKDeployLibs - GNUInstallDirs but for click
ResolveLibs - Resolves Libs to be included in CLICKDeployLibs

=== modified file 'Makefile.am'
--- Makefile.am	2014-03-06 16:38:35 +0000
+++ Makefile.am	2014-05-14 19:52:17 +0000
@@ -1,4 +1,4 @@
-SUBDIRS = lib preload click conf debhelper init po schroot
+SUBDIRS = lib preload click conf debhelper init po schroot cmake
 if PACKAGEKIT
 SUBDIRS += pk-plugin
 endif

=== added directory 'cmake'
=== added file 'cmake/CLICKDeployLibs.cmake'
--- cmake/CLICKDeployLibs.cmake	1970-01-01 00:00:00 +0000
+++ cmake/CLICKDeployLibs.cmake	2014-05-14 19:52:17 +0000
@@ -0,0 +1,138 @@
+# - Help functions for including libs for click packages
+# It makes use of the latest manifest file provided on the Ubuntu website
+#  http://cdimage.ubuntu.com/ubuntu-touch/daily-preinstalled/current/
+# Following cmake files need to be included:
+#  ResolveLibs.cmake
+# You can change the url for lookup with:
+#  MANIFEST_URL_PREFIX - defaults to http://cdimage.ubuntu.com/ubuntu-touch/daily-preinstalled/current/trusty-preinstalled-touch-
+#  MANIFEST_URL_SUFFIX - defaults to .manifest
+#  MANIFEST_USE_ARCH - defaults to true
+#
+# Other variables that are used:
+#  CLICK_DEPLOY_ONLY_LIBS - defaults to true
+#  CLICK_DEPLOY_STATIC_LIBS - defaults to false
+#  CLICK_DEPLOY_INCLUDE_NO_MANIFEST - Include the libs when no manifest was found,
+#    defaults to true
+
+
+include(ResolveLibs)
+
+if(NOT DEFINED DPKG_BUILD_ARCH)
+    execute_process(COMMAND dpkg-architecture -qDEB_HOST_ARCH
+        OUTPUT_VARIABLE BUILD_ARCH_TEMP
+        OUTPUT_STRIP_TRAILING_WHITESPACE
+    )
+    set(DPKG_BUILD_ARCH ${BUILD_ARCH_TEMP} CACHE PATH "Debian arch")
+endif()
+
+if(NOT DEFINED MANIFEST_URL_PREFIX)
+    set(MANIFEST_URL_PREFIX "http://cdimage.ubuntu.com/ubuntu-touch/daily-preinstalled/current/trusty-preinstalled-touch-")
+endif()
+
+if(NOT DEFINED MANIFEST_URL_SUFFIX)
+    set(MANIFEST_URL_SUFFIX ".manifest")
+endif()
+
+if(NOT DEFINED MANIFEST_USE_ARCH)
+    set(MANIFEST_USE_ARCH true)
+endif()
+
+if(NOT DEFINED CLICK_DEPLOY_ONLY_LIBS)
+    set(CLICK_DEPLOY_ONLY_LIBS true)
+endif()
+
+if(NOT DEFINED CLICK_DEPLOY_STATIC_LIBS)
+    set(CLICK_DEPLOY_STATIC_LIBS false)
+endif()
+
+if(NOT DEFINED CLICK_DEPLOY_INCLUDE_NO_MANIFEST)
+    set(CLICK_DEPLOY_INCLUDE_NO_MANIFEST true)
+endif()
+
+set(MANIFEST_URL "${MANIFEST_URL_PREFIX}")
+if(MANIFEST_USE_ARCH)
+    set(MANIFEST_URL "${MANIFEST_URL}${DPKG_BUILD_ARCH}")
+endif()
+set(MANIFEST_URL "${MANIFEST_URL}${MANIFEST_URL_SUFFIX}")
+
+message(STATUS "MANIFEST_URL: ${MANIFEST_URL}")
+execute_process(
+    COMMAND curl -s "${MANIFEST_URL}"
+    COMMAND cut -f 1
+    OUTPUT_VARIABLE PACKAGES
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+
+if(${PACKAGES} MATCHES "^<" OR NOT PACKAGES) # It's a HTML page or nothing returned
+    message(STATUS "Error retreiving manifest")
+    set(PACKAGES "")
+    set(PACKAGES_LIST "")
+else()
+    STRING(REGEX REPLACE "\n" ";" PACKAGES_LIST ${PACKAGES})
+endif()
+
+function(deploy_lib lib)
+    message(STATUS "Mark ${lib} for install")
+    install(FILES ${lib}
+        DESTINATION ${CMAKE_INSTALL_LIBDIR}/)
+endfunction()
+
+function(deploy_libs libs)
+    message(STATUS "Deploy Libs")
+    set(error false)
+    if(NOT PACKAGES_LIST) # If manifest was not downloaded
+        if(NOT ${CLICK_DEPLOY_INCLUDE_NO_MANIFEST})
+            set(error true)
+            message(STATUS "  No manifest found")
+        endif()
+    endif()
+    if(NOT error)
+        foreach(lib ${ARGN})
+            set(error false)
+            message(STATUS "  LIB: ${lib}")
+            resolve_lib(${lib} resolved found_lib)
+            if(found_lib)
+                message(STATUS "    RESOLVED: ${resolved}")
+                if(NOT ${CLICK_DEPLOY_STATIC_LIBS})
+                    if(${resolved} MATCHES "^.*\\.a([0-9]|\\.)*$") # If it's a static lib
+                        set(error true)
+                        message(STATUS "    Not deploying static libs")
+                    endif()
+                endif(NOT ${CLICK_DEPLOY_STATIC_LIBS})
+                if(${CLICK_DEPLOY_ONLY_LIBS})
+                    if(${resolved} MATCHES "^.*\\.(so|a)([0-9]|\\.)*$") # If it's a static or dynamic lib
+                    else()
+                        set(error true)
+                        message(STATUS "    Only deploy libs")
+                    endif()
+                endif(${CLICK_DEPLOY_ONLY_LIBS})
+            endif(found_lib)
+            if(found_lib AND NOT error)
+                if(NOT PACKAGES_LIST)
+                    deploy_lib(${resolved})
+                else(NOT PACKAGES_LIST)
+                    execute_process(
+                        COMMAND dpkg -S ${resolved}
+                        COMMAND sed "s/^\\(.*\\):.*$/\\1/"
+                        COMMAND sed "s/^\\(.*\\):${DPKG_BUILD_ARCH}\$/\\1/"
+                        OUTPUT_VARIABLE PACKAGE
+                        OUTPUT_STRIP_TRAILING_WHITESPACE)
+                    message(STATUS "    PACKAGE: ${PACKAGE}")
+                    list(FIND PACKAGES_LIST ${PACKAGE} index) # Search for package in manifest list
+                    if(index EQUAL -1)
+                        list(FIND PACKAGES_LIST "${PACKAGE}:${DPKG_BUILD_ARCH}" index) # Search for package:architecture in manifest
+                    endif(index EQUAL -1)
+                    if(index EQUAL -1)
+                        deploy_lib(${resolved})
+                    else(index EQUAL -1)
+                        message(STATUS "    In manifest")
+                    endif(index EQUAL -1)
+                endif(NOT PACKAGES_LIST)
+            else(found_lib AND NOT error)
+                if(NOT error)
+                    message(STATUS "    Lib not found")
+                endif(NOT error)
+            endif(found_lib AND NOT error)
+        endforeach(lib ${ARGN})
+    endif(NOT error)
+endfunction()

=== added file 'cmake/CLICKInstallDirs.cmake'
--- cmake/CLICKInstallDirs.cmake	1970-01-01 00:00:00 +0000
+++ cmake/CLICKInstallDirs.cmake	2014-05-14 19:52:17 +0000
@@ -0,0 +1,55 @@
+# - Define CLICK installation directories when CLICK_MODE set
+#  otherwise defaults to GNU default installation directories
+# Provides install directory variables as defined for GNU software:
+#  http://www.gnu.org/prep/standards/html_node/Directory-Variables.html
+# Inclusion of this module defines the following variables:
+#  CMAKE_INSTALL_<dir>      - destination for files of a given type
+#  CMAKE_INSTALL_FULL_<dir> - corresponding absolute path
+# where <dir> is one of:
+#  BINDIR           - user executables (bin)
+#  SBINDIR          - system admin executables (sbin)
+#  LIBEXECDIR       - program executables (libexec)
+#  SYSCONFDIR       - read-only single-machine data (etc)
+#  SHAREDSTATEDIR   - modifiable architecture-independent data (com)
+#  LOCALSTATEDIR    - modifiable single-machine data (var)
+#  LIBDIR           - object code libraries (lib or lib64 or lib/<multiarch-tuple> on Debian)
+#  INCLUDEDIR       - C header files (include)
+#  OLDINCLUDEDIR    - C header files for non-gcc (/usr/include)
+#  DATAROOTDIR      - read-only architecture-independent data root (share)
+#  DATADIR          - read-only architecture-independent data (DATAROOTDIR)
+#  INFODIR          - info documentation (DATAROOTDIR/info)
+#  LOCALEDIR        - locale-dependent data (DATAROOTDIR/locale)
+#  MANDIR           - man documentation (DATAROOTDIR/man)
+#  DOCDIR           - documentation root (DATAROOTDIR/doc/PROJECT_NAME)
+# Each CMAKE_INSTALL_<dir> value may be passed to the DESTINATION options of
+# install() commands for the corresponding file type.  If the includer does
+# not define a value the above-shown default will be used and the value will
+# appear in the cache for editing by the user.
+# Each CMAKE_INSTALL_FULL_<dir> value contains an absolute path constructed
+# from the corresponding destination by prepending (if necessary) the value
+# of CMAKE_INSTALL_PREFIX.
+
+option(CLICK_MODE "Installs to a contained location" off)
+if(CLICK_MODE)
+    execute_process(COMMAND dpkg-architecture -qDEB_HOST_MULTIARCH
+        OUTPUT_VARIABLE BUILD_ARCH_TEMP
+        OUTPUT_STRIP_TRAILING_WHITESPACE
+        )
+    set(BUILD_ARCH_TRIPLET "${BUILD_ARCH_TEMP}" CACHE PATH "Debian multiarch triplet")
+
+    if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
+        set(CMAKE_INSTALL_PREFIX "" CACHE PATH "Click install prefix" FORCE)
+    endif(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
+
+    set(CMAKE_INSTALL_BINDIR "${CMAKE_INSTALL_PREFIX}/lib/${BUILD_ARCH_TRIPLET}" CACHE PATH "user executables")
+    set(CMAKE_INSTALL_SBINDIR "${CMAKE_INSTALL_BINDIR}" CACHE PATH "system admin executables")
+    set(CMAKE_INSTALL_LIBEXECDIR "${CMAKE_INSTALL_BINDIR}" CACHE PATH "program executables")
+    set(CMAKE_INSTALL_SYSCONFDIR "${CMAKE_INSTALL_BINDIR}" CACHE PATH "read-only single-machine data")
+    set(CMAKE_INSTALL_SHAREDSTATEDIR "${CMAKE_INSTALL_BINDIR}" CACHE PATH "modifiable architecture-independent data")
+    set(CMAKE_INSTALL_LOCALSTATEDIR "${CMAKE_INSTALL_BINDIR}" CACHE PATH "modifiable single-machine data")
+    set(CMAKE_INSTALL_LIBDIR "${CMAKE_INSTALL_BINDIR}" CACHE PATH "object code libraries")
+
+    set(CMAKE_INSTALL_DATAROOTDIR "${CMAKE_INSTALL_PREFIX}" CACHE PATH "read-only architecture-independent data root")
+endif(CLICK_MODE)
+
+include(GNUInstallDirs)

=== added file 'cmake/Makefile.am'
--- cmake/Makefile.am	1970-01-01 00:00:00 +0000
+++ cmake/Makefile.am	2014-05-14 19:52:17 +0000
@@ -0,0 +1,3 @@
+cmakedir = $(datadir)/cmake-2.8/Modules
+
+cmake_DATA = CLICKDeployLibs.cmake  CLICKInstallDirs.cmake  ResolveLibs.cmake

=== added file 'cmake/ResolveLibs.cmake'
--- cmake/ResolveLibs.cmake	1970-01-01 00:00:00 +0000
+++ cmake/ResolveLibs.cmake	2014-05-14 19:52:17 +0000
@@ -0,0 +1,51 @@
+# Resolve the library (or other files) path
+# Resolved_lib is defined to the lib or the lib it links to
+# It follows multiple links
+# Linking files are not processed
+
+function(resolve_lib lib resolved_lib success)
+    set(${success} true)
+    if(${lib} MATCHES "^-l(.*)$")
+        STRING(REGEX REPLACE "^-l" "" lib_name "${lib}")
+        if(lib_name)
+            find_library(temp_lib NAMES ${lib_name})
+            if(temp_lib)
+                set(lib ${temp_lib})
+            else()
+                set(${success} false PARENT_SCOPE)
+            endif()
+        else()
+            set(${resolved_lib} ${lib} PARENT_SCOPE)
+            set(${success} false PARENT_SCOPE)
+        endif()
+    endif()
+    if(${success})
+        get_filename_component(resolved ${lib}
+            REALPATH)
+        if(EXISTS ${resolved})
+            if(NOT ${resolved} STREQUAL ${lib})
+                resolve_lib(${resolved} resolved temp)
+            endif()
+            set(${resolved_lib} ${resolved} PARENT_SCOPE)
+            set(${success} true PARENT_SCOPE)
+        else()
+            set(${resolved_lib} ${lib} PARENT_SCOPE)
+            set(${success} false PARENT_SCOPE)
+        endif()
+    endif()
+endfunction(resolve_lib)
+
+function(resolve_libs resolved_libs libs)
+    foreach(lib ${ARGN})
+        resolve_lib(${lib} resolved temp)
+        list(APPEND ${resolved_libs} ${resolved})
+    endforeach()
+endfunction(resolve_libs)
+
+function(remove_unexisting result_list lib_list)
+    foreach(lib ${ARGN})
+        if(EXISTS ${lib})
+            list(APPEND ${result_list})
+        endif()
+    endforeach()
+endfunction(remove_unexisting)

=== modified file 'configure.ac'
--- configure.ac	2014-03-06 16:38:35 +0000
+++ configure.ac	2014-05-14 19:52:17 +0000
@@ -140,6 +140,7 @@
 	po/Makefile.in
 	preload/Makefile
 	schroot/Makefile
+	cmake/Makefile
 	])
 AC_CONFIG_FILES([lib/click/valac-wrapper], [chmod +x lib/click/valac-wrapper])
 AC_CONFIG_FILES([setup.py], [chmod +x setup.py])

=== modified file 'debian/click-dev.install'
--- debian/click-dev.install	2013-11-21 14:46:16 +0000
+++ debian/click-dev.install	2014-05-14 19:52:17 +0000
@@ -1,5 +1,6 @@
 etc/schroot/click
 usr/bin/dh_click
 usr/share/debhelper
+usr/share/cmake-2.8/Modules
 usr/share/man/man1/dh_click.1
 usr/share/perl5