IgnConfigureProject: add INCLUDE_DIR option

The include paths are now configurable and default
to ignition/${IGN_DESIGNATION} to match existing
behavior.

Signed-off-by: Steve Peters <scpeters@openrobotics.org>

Author: scpeters

cmake/IgnConfigureBuild.cmake

@@ -169,7 +169,7 @@ macro(ign_configure_build)
     set (CPPCHECK_INCLUDE_DIRS)
     set (potential_cppcheck_include_dirs
       ${CMAKE_BINARY_DIR}
-      ${CMAKE_SOURCE_DIR}/include/ignition/${IGN_DESIGNATION}
+      ${CMAKE_SOURCE_DIR}/include/${PROJECT_INCLUDE_DIR}
       ${CMAKE_SOURCE_DIR}/test/integration
       ${CMAKE_SOURCE_DIR}/test/regression
       ${CMAKE_SOURCE_DIR}/test/performance)
@@ -323,8 +323,8 @@ function(_ign_find_include_script)
       add_subdirectory("${include_start}/include")
     elseif(EXISTS "${include_start}/include/ignition/CMakeLists.txt")
       add_subdirectory("${include_start}/include/ignition")
-    elseif(EXISTS "${include_start}/include/ignition/${IGN_DESIGNATION}/CMakeLists.txt")
-      add_subdirectory("${include_start}/include/ignition/${IGN_DESIGNATION}")
+    elseif(EXISTS "${include_start}/include/${PROJECT_INCLUDE_DIR}/CMakeLists.txt")
+      add_subdirectory("${include_start}/include/${PROJECT_INCLUDE_DIR}")
     else()
       message(AUTHOR_WARNING
         "You have an include directory [${include_start}/include] without a "

cmake/IgnConfigureProject.cmake

@@ -6,8 +6,10 @@
 #
 # Sets up an ignition library project.
 #
+# INCLUDE_DIR: Optional. Specify include folder names. Defaults to
+#     ignition/${IGN_DESIGNATION}
 # NO_IGNITION_PREFIX: Optional. Don't use ignition as prefix in
-#                     cmake project name.
+#     cmake project name.
 # VERSION_SUFFIX: Optional. Specify a prerelease version suffix.
 #
 #===============================================================================
@@ -32,7 +34,7 @@ macro(ign_configure_project)
   #------------------------------------
   # Define the expected arguments
   set(options NO_IGNITION_PREFIX)
-  set(oneValueArgs VERSION_SUFFIX)
+  set(oneValueArgs INCLUDE_DIR VERSION_SUFFIX)
   set(multiValueArgs) # We are not using multiValueArgs yet
 
   #------------------------------------
@@ -82,6 +84,12 @@ macro(ign_configure_project)
   set(PROJECT_EXPORT_NAME ${PROJECT_NAME_LOWER})
   set(PROJECT_LIBRARY_TARGET_NAME ${PROJECT_NAME_LOWER})
 
+  if(ign_configure_project_INCLUDE_DIR)
+    set(PROJECT_INCLUDE_DIR ${ign_configure_project_INCLUDE_DIR})
+  else()
+    set(PROJECT_INCLUDE_DIR ignition/${IGN_DESIGNATION})
+  endif()
+
   # version <major>.<minor>
   set(PROJECT_VERSION ${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR})
 

cmake/IgnUtils.cmake

@@ -682,13 +682,13 @@ function(ign_install_all_headers)
 
     # Add each header, prefixed by its directory, to the auto headers variable
     foreach(header ${headers})
-      set(ign_headers "${ign_headers}#include <ignition/${IGN_DESIGNATION}/${header}>\n")
+      set(ign_headers "${ign_headers}#include <${PROJECT_INCLUDE_DIR}/${header}>\n")
     endforeach()
 
     if("." STREQUAL ${dir})
-      set(destination "${IGN_INCLUDE_INSTALL_DIR_FULL}/ignition/${IGN_DESIGNATION}")
+      set(destination "${IGN_INCLUDE_INSTALL_DIR_FULL}/${PROJECT_INCLUDE_DIR}")
     else()
-      set(destination "${IGN_INCLUDE_INSTALL_DIR_FULL}/ignition/${IGN_DESIGNATION}/${dir}")
+      set(destination "${IGN_INCLUDE_INSTALL_DIR_FULL}/${PROJECT_INCLUDE_DIR}/${dir}")
     endif()
 
     install(
@@ -700,15 +700,15 @@ function(ign_install_all_headers)
 
   # Add generated headers to the list of includes
   foreach(header ${ign_install_all_headers_GENERATED_HEADERS})
-      set(ign_headers "${ign_headers}#include <ignition/${IGN_DESIGNATION}/${header}>\n")
+      set(ign_headers "${ign_headers}#include <${PROJECT_INCLUDE_DIR}/${header}>\n")
   endforeach()
 
   if(ign_install_all_headers_COMPONENT)
 
     set(component_name ${ign_install_all_headers_COMPONENT})
 
     # Define the install directory for the component meta header
-    set(meta_header_install_dir ${IGN_INCLUDE_INSTALL_DIR_FULL}/ignition/${IGN_DESIGNATION}/${component_name})
+    set(meta_header_install_dir ${IGN_INCLUDE_INSTALL_DIR_FULL}/${PROJECT_INCLUDE_DIR}/${component_name})
 
     # Define the input/output of the configuration for the component "master" header
     set(master_header_in ${IGNITION_CMAKE_DIR}/ign_auto_headers.hh.in)
@@ -717,7 +717,7 @@ function(ign_install_all_headers)
   else()
 
     # Define the install directory for the core master meta header
-    set(meta_header_install_dir ${IGN_INCLUDE_INSTALL_DIR_FULL}/ignition/${IGN_DESIGNATION})
+    set(meta_header_install_dir ${IGN_INCLUDE_INSTALL_DIR_FULL}/${PROJECT_INCLUDE_DIR})
 
     # Define the input/output of the configuration for the core "master" header
     set(master_header_in ${IGNITION_CMAKE_DIR}/ign_auto_headers.hh.in)
@@ -936,7 +936,7 @@ function(ign_create_core_library)
   # Create the target for the core library, and configure it to be installed
   _ign_add_library_or_component(
     LIB_NAME ${PROJECT_LIBRARY_TARGET_NAME}
-    INCLUDE_DIR "ignition/${IGN_DESIGNATION_LOWER}"
+    INCLUDE_DIR "${PROJECT_INCLUDE_DIR}"
     EXPORT_BASE IGNITION_${IGN_DESIGNATION_UPPER}
     SOURCES ${sources}
     ${interface_option})
@@ -1120,7 +1120,7 @@ function(ign_add_component component_name)
   # Create the target for this component, and configure it to be installed
   _ign_add_library_or_component(
     LIB_NAME ${component_target_name}
-    INCLUDE_DIR "ignition/${IGN_DESIGNATION_LOWER}/${include_subdir}"
+    INCLUDE_DIR "${PROJECT_INCLUDE_DIR}/${include_subdir}"
     EXPORT_BASE IGNITION_${IGN_DESIGNATION_UPPER}_${component_name_upper}
     SOURCES ${sources}
     ${interface_option})

examples/no_ignition_prefix/CMakeLists.txt

@@ -1,7 +1,9 @@
 cmake_minimum_required(VERSION 3.10.2 FATAL_ERROR)
 project(no_ignition_prefix VERSION 0.1.0)
 find_package(ignition-cmake2 REQUIRED)
-ign_configure_project(NO_IGNITION_PREFIX)
+ign_configure_project(
+  INCLUDE_DIR no_ign
+  NO_IGNITION_PREFIX)
 ign_configure_build(QUIT_IF_BUILD_ERRORS)
 ign_create_packages()
 ign_create_docs()

examples/no_ignition_prefix/src/AlmostEmpty.cc

@@ -15,14 +15,11 @@
  *
 */
 
-#include <ignition/no_ignition_prefix/Export.hh>
+#include <no_ign/Export.hh>
 
-namespace ignition
+namespace no_ignition_prefix
 {
-  namespace no_ignition_prefix
+  class IGNITION_NO_IGNITION_PREFIX_VISIBLE AlmostEmpty
   {
-    class IGNITION_NO_IGNITION_PREFIX_VISIBLE AlmostEmpty
-    {
-    };
-  }
+  };
 }