Merge github.com:HEP-SF/tools

Author: Benedikt Hegner

README.md

@@ -6,7 +6,7 @@ Software Foundation (HSF).
 ## create_project
 The tool create_project creates a template CMake project. The created project
 contains the standard use patterns for small CMake projects, plus support for
-Doxygen, CPack, and gtest. Further documentation is provided within the created
+Doxygen and CPack. Further documentation is provided within the created
 package itself inside the README.md.
 
 ## hsf_get_platform and hsf_platform_compatibility

create_project.py

@@ -104,6 +104,9 @@ def replace_templates(self):
         os.rename(join(self.target_dir,"cmake/PROJECTTEMPLATEConfig.cmake.in"),join(self.target_dir,"cmake/%sConfig.cmake.in" %self.name))
         os.rename(join(self.target_dir,"cmake/PROJECTTEMPLATECreateConfig.cmake"),join(self.target_dir,"cmake/%sCreateConfig.cmake" %self.name))
         os.rename(join(self.target_dir,"cmake/PROJECTTEMPLATEDoxygen.cmake"),join(self.target_dir,"cmake/%sDoxygen.cmake" %self.name))
+        os.rename(join(self.target_dir,"cmake/PROJECTTEMPLATEUninstall.cmake"),join(self.target_dir,"cmake/%sUninstall.cmake" %self.name))
+        os.rename(join(self.target_dir,"cmake/PROJECTTEMPLATE_uninstall.cmake.in"),join(self.target_dir,"cmake/%s_uninstall.cmake.in" %self.name))
+        os.rename(join(self.target_dir,"cmake/PROJECTTEMPLATE.pc.in"),join(self.target_dir,"cmake/%s.pc.in" %self.name))
         os.rename(join(self.target_dir,"PROJECTTEMPLATEVersion.h"),join(self.target_dir,"%sVersion.h" %self.name))
         os.rename(join(self.target_dir,"package/include/example"),join(self.target_dir,"package/include/%s" %self.name))
         os.rename(join(self.target_dir,"package"),join(self.target_dir,"%s" %self.subpackage_name))

project_template/CMakeLists.txt

@@ -73,3 +73,6 @@ install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/LICENSE
 
 #--- project specific subdirectories -------------------------------------------
 add_subdirectory(HSFSUBPACKAGE)
+
+#--- create uninstall target ---------------------------------------------------
+include(cmake/HSFTEMPLATEUninstall.cmake)

project_template/README.md

@@ -6,22 +6,26 @@ Please add some lines describing the project!
 
     mkdir build
     cd build
-    cmake -DCMAKE_INSTALL_PREFIX=<installdir>  <path to sources>
+    cmake -DCMAKE_INSTALL_PREFIX=<installdir> [-DPROJECTTEMPLATE_BUILD_DOCS=ON] <path to sources>
     make -j<number of cores on your machine>
     make install
 
-## Building the documentation
+The `PROJECTTEMPLATE_BUILD_DOCS` variable is optional, and should be passed if you wish to
+build the Doxygen based API documentation. Please note that this requires an existing
+installation of [Doxygen](http://www.doxygen.org/index.html). If CMake cannot locate
+Doxygen, its install location should be added into `CMAKE_PREFIX_PATH`.
+For further details please have a look at [the CMake tutorial](http://www.cmake.org/cmake-tutorial/).
 
-The documentation of the project is based on doxygen.
-If you would like to build it, you have to configure the package with
+## Building the documentation
 
-    cmake -DPROJECTTEMPLATE_documentation -DCMAKE_INSTALL_PREFIX=<installdir>  <path to sources>
-Invoking
+The documentation of the project is based on doxygen. To build the documentation,
+the project must have been configured with `PROJECTTEMPLATE_BUILD_DOCS` enabled, as
+described earlier. It can then be built and installed:
 
     make doc
     make install
 
-installs the documentation into installdir/share/doc/.
+By default, this installs the documentation into `<installdir>/share/doc/HSFTEMPLATE/share/doc`.
 
 ## Creating a package with CPack
 
@@ -38,3 +42,7 @@ To run the tests of the project, first build it and then invoke
 ## Inclusion into other projects
 
 If you want to build your own project against PROJECTTEMPLATE, CMake may be the best option for you. Just add its location to _CMAKE_PREFIX_PATH_ and call _find_package(PROJECTTEMPLATE)_ within your CMakeLists.txt.
+
+A `pkg-config` `.pc` file is also installed if you do not use CMake.
+Simply add the location of the `.pc` file (nominally `<installdir>/lib/pkgconfig`) and run `pkg-config --cflags --libs HSFTEMPLATE` to get the
+include paths and libraries needed to compile and link to HSFTEMPLATE.

project_template/cmake/PROJECTTEMPLATE.pc.in

@@ -0,0 +1,9 @@
+prefix=${pcfiledir}/@HSFTEMPLATE_PCFILEDIR_TO_PREFIX@
+libdir=${prefix}@CMAKE_INSTALL_LIBDIR@
+includedir=${prefix}@CMAKE_INSTALL_INCLUDEDIR@
+
+Name: @PROJECT_NAME@
+Version: @PROJECT_VERSION@
+Description: "Description of @PROJECT_NAME@" 
+Libs: -L${libdir} -lexamplelibrary
+Cflags: -I${includedir}

project_template/cmake/PROJECTTEMPLATEUninstall.cmake

@@ -0,0 +1,46 @@
+#.rst:
+# HSFTEMPLATEUninstallTarget
+# ---------------------------
+# Add an `uninstall` target
+#
+
+#=============================================================================
+# Copyright 2015 Alex Merry <[email protected]>
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# 1. Redistributions of source code must retain the copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+# 3. The name of the author may not be used to endorse or promote products
+#    derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+if (NOT TARGET uninstall)
+    configure_file(
+      "${CMAKE_CURRENT_LIST_DIR}/HSFTEMPLATE_uninstall.cmake.in"
+      "${CMAKE_BINARY_DIR}/HSFTEMPLATE_uninstall.cmake"
+        IMMEDIATE
+        @ONLY
+    )
+
+    add_custom_target(uninstall
+      COMMAND "${CMAKE_COMMAND}" -P "${CMAKE_BINARY_DIR}/HSFTEMPLATE_uninstall.cmake"
+      WORKING_DIRECTORY "${CMAKE_BINARY_DIR}"
+    )
+endif()
+

project_template/cmake/PROJECTTEMPLATE_uninstall.cmake.in

@@ -0,0 +1,21 @@
+if(NOT EXISTS "@CMAKE_BINARY_DIR@/install_manifest.txt")
+    message(FATAL_ERROR "Cannot find install manifest: @CMAKE_BINARY_DIR@/install_manifest.txt")
+endif()
+
+file(READ "@CMAKE_BINARY_DIR@/install_manifest.txt" files)
+string(REGEX REPLACE "\n" ";" files "${files}")
+foreach(file ${files})
+    message(STATUS "Uninstalling $ENV{DESTDIR}${file}")
+    if(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}")
+        exec_program(
+            "@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\""
+            OUTPUT_VARIABLE rm_out
+            RETURN_VALUE rm_retval
+            )
+        if(NOT "${rm_retval}" STREQUAL 0)
+            message(FATAL_ERROR "Problem when removing $ENV{DESTDIR}${file}")
+        endif()
+    else()
+        message(STATUS "File $ENV{DESTDIR}${file} does not exist.")
+    endif()
+endforeach()

project_template/doc/CMakeLists.txt

@@ -0,0 +1,12 @@
+find_package(Doxygen)
+if(DOXYGEN_FOUND)
+  configure_file(Doxyfile.in Doxyfile @ONLY)
+  add_custom_target(doc
+                    ${DOXYGEN_EXECUTABLE} Doxyfile
+                    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+                    COMMENT "Generating API documentation with Doxygen" VERBATIM)
+
+  install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doxygen
+    DESTINATION ${CMAKE_INSTALL_DOCDIR}/doxygen
+    )
+endif()

project_template/doc/Doxyfile.in

@@ -32,13 +32,13 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "PROJECTTEMPLATE"
+PROJECT_NAME           = "@PROJECT_NAME@"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = @CMAKE_PROJECT_VERSION@
+PROJECT_NUMBER         = @PROJECT_VERSION@
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -58,7 +58,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = @CMAKE_BINARY_DIR@/doxygen
+OUTPUT_DIRECTORY       = @PROJECT_BINARY_DIR@/doc/doxygen
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and
@@ -144,7 +144,7 @@ FULL_PATH_NAMES        = YES
 # will be relative from the directory where doxygen is started.
 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
 
-STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@ @CMAKE_BINARY_DIR@
+STRIP_FROM_PATH        = @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@ 
 
 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
 # path mentioned in the documentation of a class, which tells the reader which
@@ -153,7 +153,7 @@ STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@ @CMAKE_BINARY_DIR@
 # specify the list of include paths that are normally passed to the compiler
 # using the -I flag.
 
-STRIP_FROM_INC_PATH    = @DOXYGEN_INCLUDE_DIRS@ @CMAKE_BINARY_DIR@/include
+STRIP_FROM_INC_PATH    = @DOXYGEN_INCLUDE_DIRS@ @PROJECT_BINARY_DIR@/include
 
 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
 # less readable) file names. This can be useful is your file systems doesn't
@@ -731,7 +731,7 @@ WARN_FORMAT            = "$file:$line: $text"
 # messages should be written. If left blank the output is written to standard
 # error (stderr).
 
-WARN_LOGFILE           = @CMAKE_BINARY_DIR@/doxygen-warnings.log
+WARN_LOGFILE           = @PROJECT_BINARY_DIR@/doxygen-warnings.log
 
 #---------------------------------------------------------------------------
 # Configuration options related to the input files
@@ -743,9 +743,8 @@ WARN_LOGFILE           = @CMAKE_BINARY_DIR@/doxygen-warnings.log
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = @CMAKE_SOURCE_DIR@
-INPUT                 += @CMAKE_BINARY_DIR@/include
-INPUT                 += @CMAKE_CURRENT_BINARY_DIR@
+INPUT                  = @PROJECT_SOURCE_DIR@
+INPUT                 += @PROJECT_BINARY_DIR@/include
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -801,7 +800,7 @@ EXCLUDE_SYMLINKS       = NO
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories for example use the pattern */test/*
 
-EXCLUDE_PATTERNS       =  */tests/* */dict/* */cmake/* @CMAKE_BINARY_DIR@
+EXCLUDE_PATTERNS       =  */tests/* */dict/* */cmake/* @PROJECT_BINARY_DIR@
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the
@@ -818,7 +817,7 @@ EXCLUDE_SYMBOLS        =
 # that contain example code fragments that are included (see the \include
 # command).
 
-EXAMPLE_PATH           = @CMAKE_SOURCE_DIR@
+EXAMPLE_PATH           = @PROJECT_SOURCE_DIR@
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
@@ -886,7 +885,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = README.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing
@@ -1096,7 +1095,7 @@ HTML_EXTRA_FILES       = @DOXYGEN_HTML_EXTRA_FILES@
 # Minimum value: 0, maximum value: 359, default value: 220.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_COLORSTYLE_HUE    = 0
+HTML_COLORSTYLE_HUE    = 220
 
 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
 # in the HTML output. For a value of 0 the output will use grayscales only. A