Merge branch 'release/v3_10_00'

Author: knoepfel

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,17 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Please give instructions so we can reproduce this bug.
+
+**If this is a high-priority issue**
+Please add the "high priority" label to this issue.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature
+assignees: ''
+
+---
+
+**What problem are you trying to solve?**
+Please provide the context of this feature request--i.e. what issue has motivated you to file this request.
+
+**Describe your feature request**
+A clear and concise description of the requested feature.  Please describe *what* you want the feature to provide rather than implementation details.
+
+**If this is a high-priority issue**
+Please add the "high priority" label to this issue.

.github/ISSUE_TEMPLATE/general-issue.md

@@ -0,0 +1,14 @@
+---
+name: General issue
+about: Create an issue that doesn't fit in the other categories
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe your request or issue**
+A concise and clear description of your request or issue.
+
+**If this is a high-priority issue**
+Please add the "high priority" label to this issue.

CMakeLists.txt

@@ -14,13 +14,13 @@
 cmake_minimum_required(VERSION 3.19 FATAL_ERROR)
 
 find_package(cetmodules 2.13.00 REQUIRED)
-project(art VERSION 3.09.03 LANGUAGES CXX C)
+project(art VERSION 3.10.00 LANGUAGES CXX C)
 
 include(CetCMakeEnv)
 cet_cmake_env()
 
 # Find our own CMake modules, and tell everyone else where to find them.
-cet_cmake_module_directories(Modules)
+cet_cmake_module_directories(Modules BINARY)
 
 cet_set_compiler_flags(DIAGS VIGILANT
   WERROR
@@ -49,16 +49,16 @@ cet_report_compiler_flags(REPORT_THRESHOLD VERBOSE)
 
 cet_register_export_set(SET_NAME art NAMESPACE art)
 
+# source
+add_subdirectory(art)
+
+# CMake modules -- must be after plugin builders have been defined.
+add_subdirectory(Modules)
+
 # Plugin skeleton generators for cetskelgen.
 add_subdirectory(perllib)
 
 # tools
 add_subdirectory(tools)
 
-# source
-add_subdirectory(art)
-
-# CMake modules
-add_subdirectory(Modules)
-
 cet_cmake_config()

Modules/ArtMake.cmake

@@ -1,4 +1,8 @@
 ### MIGRATE-NO-ACTION
+#[================================================================[.rst:
+X
+=
+#]================================================================]
 # art_make
 #
 # Identify the files in the current source directory and build
@@ -100,7 +104,7 @@
 #
 ########################################################################
 
-include_guard(DIRECTORY)
+include_guard()
 
 cmake_policy(PUSH)
 cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
@@ -138,22 +142,25 @@ endmacro()
 # art_make
 ####################################
 function(art_make)
-  set(flags BASENAME_ONLY LIB_ONLY NO_DICTIONARY NO_INSTALL NO_LIB NO_PLUGINS
-    USE_PRODUCT_NAME USE_PROJECT_NAME)
+  set(flags LIB_ONLY NO_LIB NO_PLUGINS USE_PRODUCT_NAME USE_PROJECT_NAME)
   cet_regex_escape(VAR flags_regex ${flags})
   list(JOIN flags_regex "|" tmp)
   set(flags_regex "^(${tmp})$")
   set(seen_art_make_flags "${ARGV}")
   list(FILTER seen_art_make_flags INCLUDE REGEX "${flags_regex}")
-  list(REMOVE_DUPLICATES seen_art_make_flags)
-  list(TRANSFORM ARGV REPLACE "${flags_regex}" "NOP")
   if ("USE_PRODUCT_NAME" IN_LIST seen_art_make_flags AND
       "USE_PROJECT_NAME" IN_LIST seen_art_make_flags)
     message(WARNING "USE_PRODUCT_NAME and USE_PROJECT_NAME are synonymous")
-    list(REMOVE_ITEM seen_art_make_flags "USE_PRODUCT_NAME")
+  endif()
+  list(TRANSFORM seen_art_make_flags REPLACE "^USE_PRODUCT_NAME$" "USE_PROJECT_NAME")
+  list(REMOVE_DUPLICATES seen_art_make_flags)
+  list(TRANSFORM ARGN REPLACE "${flags_regex}" "NOP")
+  if ("USE_PROJECT_NAME" IN_LIST seen_art_make_flags)
+    list(APPEND ARGN "USE_PROJECT_NAME")
+    list(REMOVE_ITEM seen_art_make_flags "USE_PROJECT_NAME")
   endif()
   foreach (flag IN LISTS seen_art_make_flags)
-    set(AM_${flag} ${flag})
+    set(AM_${flag} TRUE)
   endforeach()
   if (AM_LIB_ONLY AND AM_NO_LIB)
     # Nothing to do except hold up tea and no tea to confuse the GPP door
@@ -169,8 +176,9 @@ function(art_make)
   set(flags "${flag_keywords_dict}")
   set(one_arg_options "${one_arg_option_keywords_dict}")
   set(list_options "${list_option_keywords_dict}")
-  list(APPEND flags ${_cet_make_flags})
-  list(APPEND one_arg_options ${_cet_make_one_arg_options})
+  list(APPEND flags ${_cet_make_flags} ALLOW_UNDERSCORES BASENAME_ONLY
+    NO_DICTIONARY NO_EXPORT NO_INSTALL USE_BOOST_UNIT USE_PROJECT_NAME VERSION)
+  list(APPEND one_arg_options ${_cet_make_one_arg_options} EXPORT_SET LIB_TYPE SOVERSION)
   list(APPEND list_options ${_cet_make_list_options})
 
   # Identify caller-specified plugin types.
@@ -185,7 +193,10 @@ function(art_make)
   list(TRANSFORM plugin_types REPLACE "^(.+)$" "*_\\1.cc"
     OUTPUT_VARIABLE plugin_glob)
   list(TRANSFORM plugin_types TOUPPER OUTPUT_VARIABLE plugin_prefixes)
-  set(flags_plugin USE_BOOST_UNIT VERSION)
+
+  # Identify plugin-specific options and add them to the parsing lists.
+  set(flags_plugin ALLOW_UNDERSCORES BASENAME_ONLY USE_BOOST_UNIT
+    USE_PRODUCT_NAME USE_PROJECT_NAME VERSION)
   set(one_arg_options_plugin EXPORT_SET LIB_TYPE SOVERSION)
   set(list_options_plugin LIBRARIES)
   foreach (option_type IN ITEMS flags one_arg_options list_options)
@@ -196,10 +207,12 @@ function(art_make)
     endforeach()
     list(REMOVE_DUPLICATES ${option_type})
   endforeach()
+
   # We have to parse everything at once and pass through to the right
   # place if we need to otherwise we could get confused with argument /
   # option boundaries with multiple parsing passes.
-  cmake_parse_arguments(PARSE_ARGV 0 AM "${flags}" "${one_arg_options}" "${list_options}")
+  cmake_parse_arguments(AM "${flags}" "${one_arg_options}"
+    "${list_options}" ${ARGN})
   # Identify plugin sources.
   set(plugins_glob ${plugin_glob})
   foreach(subdir IN LISTS AM_SUBDIRS)
@@ -214,6 +227,7 @@ function(art_make)
   # whether we're making the plugin.
   cet_passthrough(APPEND KEYWORD EXCLUDE plugin_sources AM_EXCLUDE)
   set(flag_flag FLAG) # Flags are handled differently to the others.
+  set(cet_make_args)
   foreach (option_type IN ITEMS flag one_arg_option list_option)
     # Dictionaries.
     foreach (keyword opt IN ZIP_LISTS ${option_type}_keywords_dict ${option_type}s_dict)
@@ -234,16 +248,24 @@ function(art_make)
   # Common options.
   foreach (type IN ITEMS dict LISTS plugin_types)
     string(TOUPPER "${type}" TYPE)
-    cet_passthrough(FLAG APPEND AM_NO_INSTALL ${type}_args)
-    if (NOT VERSION IN_LIST ${type}_args)
-      cet_passthrough(FLAG APPEND AM_VERSION ${type}_args)
-    endif()
-    if (NOT (AM_NO_INSTALL OR EXPORT_SET IN_LIST ${type}_args))
-      cet_passthrough(APPEND AM_EXPORT_SET ${type}_args)
+    foreach (common_opt IN ITEMS NO_EXPORT NO_INSTALL USE_PROJECT_NAME VERSION)
+      if (AM_${common_opt} AND NOT "${common_opt}" IN_LIST ${type}_args)
+        list(APPEND ${type}_args "${common_opt}")
+      endif()
+    endforeach()
+    if (DEFINED AM_EXPORT_SET AND
+        NOT (AM_NO_INSTALL OR EXPORT_SET IN_LIST ${type}_args))
+      list(APPEND ${type}_args EXPORT_SET ${AM_EXPORT_SET})
     endif()
-    cet_passthrough(FLAG APPEND AM_USE_PROJECT_NAME ${type}_args)
     if (NOT type STREQUAL "dict")
-      cet_passthrough(FLAG APPEND AM_BASENAME_ONLY ${type}_args)
+      foreach (plugin_opt IN ITEMS ALLOW_UNDERSCORES BASENAME_ONLY USE_BOOST_UNIT)
+        if (AM_${plugin_opt} AND NOT ${plugin_opt} IN_LIST ${type}_args)
+          list(APPEND ${type}_args ${plugin_opt})
+        endif()
+      endforeach()
+      if (DEFINED AM_SOVERSION AND NOT SOVERSION IN_LIST ${type}_args)
+        list(APPEND ${type}_args SOVERSION ${AM_SOVERSION})
+      endif()
     endif()
   endforeach()
 

Modules/BuildPlugins.cmake

@@ -1,3 +1,7 @@
+#[================================================================[.rst:
+X
+=
+#]================================================================]
 # macros for building plugin libraries
 #
 # The plugin type is expected to be service, source, or module, but we
@@ -20,7 +24,7 @@
 # cetbuildtools/Modules/BasicPlugin.cmake ### MIGRATE-NO-ACTION
 # (https://cdcvs.fnal.gov/redmine/projects/cetbuildtools/repository/revisions/master/entry/Modules/BasicPlugin.cmake). ### MIGRATE-NO-ACTION
 ########################################################################
-include_guard(DIRECTORY)
+include_guard()
 
 cmake_policy(PUSH)
 cmake_minimum_required(VERSION 3.18.2 FATAL_ERROR)
@@ -38,46 +42,53 @@ set(_simple_plugin_var_list CETLIB_EXCEPT HEP_CONCURRENCY CETLIB FHICLCPP
   ROOT_CORE_LIBRARY)
 
 find_package(messagefacility PRIVATE QUIET)
-include(mfPlugin OPTIONAL)
-include(mfStatsPlugin OPTIONAL)
-include(modulePlugin)
-include(pluginPlugin)
-include(servicePlugin)
-include(sourcePlugin)
-include(toolPlugin)
+if (messagefacility_FOUND)
+  include(MessagefacilityPlugins)
+endif()
+find_package(art PRIVATE QUIET)
+if (art_FOUND)
+  include(ArtPlugins)
+endif()
 
 # Simple plugin libraries - art suite packages are found automatically.
-function(simple_plugin)
-  foreach (pkg tgt var IN ZIP_LISTS
-      _simple_plugin_pkg_list _simple_plugin_target_list _simple_plugin_var_list)
-    if (NOT (TARGET ${tgt} OR var))
-      find_package(${pkg} PRIVATE QUIET REQUIRED)
+macro(simple_plugin NAME SUFFIX)
+  foreach (_sp_pkg _sp_tgt _sp_var IN ZIP_LISTS
+      _simple_plugin_pkg_list
+      _simple_plugin_target_list
+      _simple_plugin_var_list)
+    if (NOT (TARGET ${_sp_tgt} OR _sp_var))
+      find_package(${_sp_pkg} PRIVATE QUIET REQUIRED)
     endif()
   endforeach()
+  unset(_sp_pkg)
+  unset(_sp_tgt)
+  unset(_sp_var)
   build_plugin(${ARGV})
-endfunction()
+endmacro()
 
 # Per simple_plugin() without the overhead of finding packages one may
-# not need.
-function(build_plugin NAME SUFFIX)
-  set(liblist)
-  _get_plugin_base(BASE ARGN ${ARGN})
-  if (BASE AND COMMAND "${BASE}")
-    cmake_language(CALL "${BASE}" ${NAME} ${ARGN})
-    return()
-  elseif (BASE AND ${BASE}_LIBRARIES)
-    set(liblist "${${BASE}_LIBRARIES}")
-  elseif (COMMAND "${SUFFIX}")
-    cmake_language(CALL "${SUFFIX}" ${NAME} ${ARGN})
-    return()
-  elseif (COMMAND "${SUFFIX}_plugin")
-    cmake_language(CALL "${SUFFIX}_plugin" ${NAME} "${BASE}" ${ARGN})
-    return()
-  elseif (${SUFFIX}_LIBRARIES)
-    set(liblist "${${SUFFIX}_LIBRARIES}")
+# not need (historical).
+macro(build_plugin NAME SUFFIX)
+  _get_plugin_base(_bp_base _bp_args ${ARGN})
+  if ("${_bp_base}" STREQUAL "")
+    set(_bp_base ${SUFFIX})
   endif()
-  basic_plugin(${NAME} ${SUFFIX} ${liblist} NOP ${ARGN})
-endfunction()
+  if (_bp_base MATCHES "^[A-Z]")
+    string(PREPEND _bp_base "art::")
+  else()
+    string(REGEX REPLACE "^(module|plugin|service|source|tool)$"
+      "art::\\1"
+      _bp_base
+      "${_bp_base}")
+  endif()
+  string(JOIN " " _bp_arg_string ${NAME} ${_bp_base} ${_bp_args})
+  warn_deprecated(build_plugin NEW "cet_build_plugin(${_bp_arg_string})"
+    SINCE "cetmodules 2.25.00")
+  cet_build_plugin(${NAME} ${_bp_base} ${_bp_args})
+  unset(_bp_base)
+  unset(_bp_args)
+  unset(_bp_arg_string)
+endmacro()
 
 function(_get_plugin_base RESULT_VAR REMAINDER_VAR)
   set(result)

Modules/CMakeLists.txt

@@ -1,2 +1,4 @@
 install(DIRECTORY ./ DESTINATION Modules
   FILES_MATCHING PATTERN "*.cmake" PATTERN "[.#]*.cmake" EXCLUDE)
+file(COPY . DESTINATION .
+  FILES_MATCHING PATTERN "*.cmake" PATTERN "[.#]*.cmake" EXCLUDE)

Modules/art::module.cmake

@@ -0,0 +1,35 @@
+#[================================================================[.rst:
+X
+=
+#]================================================================]
+include_guard()
+
+cmake_policy(PUSH)
+cmake_minimum_required(VERSION 3.18.2 FATAL_ERROR)
+
+include(BasicPlugin)
+
+macro(art::module NAME)
+  if (TARGET art_plugin_types::module)
+    set(_art_module_deps LIBRARIES REG art_plugin_types::module)
+  else()
+    set(_art_module_deps LIBRARIES CONDITIONAL
+      art_Framework_Core
+      art_Framework_Principal
+      art_Framework_Services_Registry
+      art_Persistency_Common
+      art_Persistency_Provenance
+      art_Utilities
+      canvas
+      fhiclcpp
+      cetlib
+      cetlib_except
+      ROOT::Core
+      Boost::filesystem
+    )
+  endif()
+  basic_plugin(${NAME} module ${ARGN} ${_art_module_deps})
+  unset(_art_module_deps)
+endmacro()
+
+cmake_policy(POP)

Modules/art::plugin.cmake

@@ -0,0 +1,30 @@
+#[================================================================[.rst:
+X
+=
+#]================================================================]
+include_guard()
+
+cmake_policy(PUSH)
+cmake_minimum_required(VERSION 3.18.2...3.20 FATAL_ERROR)
+
+include(BasicPlugin)
+
+macro(art::plugin NAME)
+  if (TARGET art_plugin_support::plugin_config_macros)
+    set(_art_plugin_deps LIBRARIES REG
+      art_plugin_support::plugin_config_macros
+      art_plugin_support::support_macros
+      )
+  else()
+    set(_art_plugin_deps LIBRARIES CONDITIONAL
+      art_Utilities
+      fhiclcpp
+      cetlib
+      cetlib_except
+      Boost::filesystem)
+  endif()
+  basic_plugin(${NAME} plugin ${ARGN} ${_art_plugin_deps})
+  unset(_art_plugin_deps)
+endmacro()
+
+cmake_policy(POP)