ENH: SEMMacroBuildCLI - Add possibility to associate FOLDER with CLI targets

In project building a lot of modules (i.e Slicer), whenever possible, it
is better to keep the huge list of targets organized. To help with this,
CMake allows to set a FOLDER target property.

See http://www.cmake.org/cmake/help/v2.8.3/cmake.html#prop_tgt:FOLDER

This commit extends the SEMMacroBuildCLI API to accept an optional FOLDER
parameter. If not set, the folder name will default to:

  <SlicerExecutionModel_DEFAULT_CLI_TARGETS_FOLDER_PREFIX><MODULE_NAME>

By default the prefix is set to an empty string and the folder will be
named after the module name.

There are two ways to specify a default prefix value:

 (1) Set the variable SlicerExecutionModel_DEFAULT_CLI_TARGETS_FOLDER_PREFIX
in the current scope before calling 'SEMMacroBuildCLI'

 (2) Configure the SlicerExecutionModel project with the option
SlicerExecutionModel_DEFAULT_CLI_TARGETS_FOLDER_PREFIX

Note that:
 - FOLDER support has been introduced in CMake >= 2.8.3
and
 - it can optionally be enabled in a project by setting the global
property named USE_FOLDERS.

See http://www.cmake.org/cmake/help/v2.8.3/cmake.html#prop_global:USE_FOLDERS

Finally, to associate CLI test expected to be in the same "FOLDER",
a variable named <MODULE_NAME>_TARGETS_FOLDER is conveniently set in the
current scope each time the macro SEMMacroBuildCLI is called.

Author: jcfr

CMake/SEMMacroBuildCLI.cmake

@@ -15,6 +15,7 @@ macro(SEMMacroBuildCLI)
     )
   set(oneValueArgs
     NAME LOGO_HEADER
+    FOLDER
     CLI_XML_FILE
     CLI_LIBRARY_WRAPPER_CXX
     CLI_SHARED_LIBRARY_WRAPPER_CXX # Deprecated
@@ -216,5 +217,14 @@ macro(SEMMacroBuildCLI)
       )
   endif()
 
+  # Folder
+  if(NOT DEFINED LOCAL_SEM_FOLDER)
+    set(LOCAL_SEM_FOLDER "${SlicerExecutionModel_DEFAULT_CLI_TARGETS_FOLDER_PREFIX}${LOCAL_SEM_NAME}")
+  endif()
+  foreach(target ${cli_targets})
+    set_target_properties(${target} PROPERTIES FOLDER ${LOCAL_SEM_FOLDER})
+  endforeach()
+  set(${MODULE_NAME}_TARGETS_FOLDER ${LOCAL_SEM_FOLDER})
+
 endmacro()
 

CMakeLists.txt

@@ -120,6 +120,13 @@ if(NOT DEFINED SlicerExecutionModel_DEFAULT_CLI_LIBRARY_WRAPPER_CXX)
     ${CMAKE_CURRENT_SOURCE_DIR}/CMake/SEMCommandLineLibraryWrapper.cxx)
 endif()
 
+#-----------------------------------------------------------------------------
+# Define default "cli targets folder prefix" used by SEMMacroBuildCLI.cmake
+#-----------------------------------------------------------------------------
+if(NOT DEFINED SlicerExecutionModel_DEFAULT_CLI_TARGETS_FOLDER_PREFIX)
+  set(SlicerExecutionModel_DEFAULT_CLI_TARGETS_FOLDER_PREFIX "")
+endif()
+
 #-----------------------------------------------------------------------------
 # Testing
 #-----------------------------------------------------------------------------

GenerateSlicerExecutionModelConfig.cmake

@@ -35,6 +35,10 @@ set(SlicerExecutionModel_DEFAULT_CLI_INSTALL_ARCHIVE_DESTINATION_CONFIG
   ${SlicerExecutionModel_DEFAULT_CLI_INSTALL_ARCHIVE_DESTINATION}
   )
 
+set(SlicerExecutionModel_DEFAULT_CLI_TARGETS_FOLDER_PREFIX_CONFIG
+  ${SlicerExecutionModel_DEFAULT_CLI_TARGETS_FOLDER_PREFIX}
+  )
+
 set(SlicerExecutionModel_LIBRARY_DIRS_CONFIG
   ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
   ${CMAKE_ARCHIVE_OUTPUT_DIRECTORY}

SlicerExecutionModelConfig.cmake.in

@@ -111,6 +111,13 @@ if(NOT DEFINED SlicerExecutionModel_DEFAULT_CLI_LIBRARY_WRAPPER_CXX)
     )
 endif()
 
+# If not already defined, set default "cli targets folder prefix" used by SEMMacroBuildCLI.cmake
+if(NOT DEFINED SlicerExecutionModel_DEFAULT_CLI_TARGETS_FOLDER_PREFIX)
+  set(SlicerExecutionModel_DEFAULT_CLI_TARGETS_FOLDER_PREFIX
+    "@SlicerExecutionModel_DEFAULT_CLI_TARGETS_FOLDER_PREFIX_CONFIG@"
+    )
+endif()
+
 # The SlicerExecutionModel targets file.
 if(NOT TARGET GenerateCLP AND EXISTS "@SlicerExecutionModel_EXPORT_FILE@")
   include("@SlicerExecutionModel_EXPORT_FILE@")