Move Catalyst fetching process to a macro

cmake/support_catalyst.cmake

@@ -0,0 +1,74 @@
+###############################################################################################
+# This file provides macros to process Catalyst.
+###############################################################################################
+
+# Include this only once
+include_guard()
+
+macro(FindCatalyst target_name)
+    if(LIGHTNING_CATALYST_SRC_PATH)
+        if(NOT IS_ABSOLUTE ${LIGHTNING_CATALYST_SRC_PATH})
+            message(FATAL_ERROR " LIGHTNING_CATALYST_SRC_PATH=${LIGHTNING_CATALYST_SRC_PATH} must be set to an absolute path")
+        endif()
+        if(CATALYST_GIT_TAG)
+            message(WARN " Setting `LIGHTNING_CATALYST_SRC_PATH=${LIGHTNING_CATALYST_SRC_PATH}` overrides `CATALYST_GIT_TAG=${CATALYST_GIT_TAG}`")
+        endif()
+
+        # Acquire local git hash and use for CATALYST_GIT_TAG
+        execute_process(COMMAND git rev-parse --short HEAD
+            WORKING_DIRECTORY ${LIGHTNING_CATALYST_SRC_PATH}
+            OUTPUT_VARIABLE CATALYST_GIT_TAG
+        )
+        message(INFO " Building against local Catalyst - path: ${LIGHTNING_CATALYST_SRC_PATH} - GIT TAG: ${CATALYST_GIT_TAG}")
+
+        target_include_directories(${target_name} PUBLIC ${LIGHTNING_CATALYST_SRC_PATH}/runtime/lib/backend/common)
+        target_include_directories(${target_name} PUBLIC ${LIGHTNING_CATALYST_SRC_PATH}/runtime/include)
+
+    else()
+        if(NOT CATALYST_GIT_TAG)
+            set(CATALYST_GIT_TAG "main" CACHE STRING "GIT_TAG value to build Catalyst")
+        endif()
+        message(INFO " Building against Catalyst GIT TAG ${CATALYST_GIT_TAG}")
+
+        # Fetching /lib/backend/common hpp headers
+        set(LIB_BACKEND_COMMON_HEADERS  CacheManager.hpp
+                                    QubitManager.hpp
+                                    Utils.hpp
+        )
+
+        foreach(HEADER ${LIB_BACKEND_COMMON_HEADERS})
+            string(REGEX REPLACE "\\.[^.]*$" "" HEADER_NAME ${HEADER})
+            FetchContent_Declare(
+                ${HEADER_NAME}
+                URL                 https://raw.githubusercontent.com/PennyLaneAI/catalyst/${CATALYST_GIT_TAG}/runtime/lib/backend/common/${HEADER}
+                DOWNLOAD_NO_EXTRACT True
+                SOURCE_DIR          ../../include
+            )
+
+            FetchContent_MakeAvailable(${HEADER_NAME})
+        endforeach()
+
+        # Fetching include hpp headers
+        set(INCLUDE_HEADERS DataView.hpp
+                        Exception.hpp
+                        QuantumDevice.hpp
+                        RuntimeCAPI.h
+                        Types.h
+        )
+
+        foreach(HEADER ${INCLUDE_HEADERS})
+            string(REGEX REPLACE "\\.[^.]*$" "" HEADER_NAME ${HEADER})
+            FetchContent_Declare(
+                ${HEADER_NAME}
+                URL                 https://raw.githubusercontent.com/PennyLaneAI/catalyst/${CATALYST_GIT_TAG}/runtime/include/${HEADER}
+                DOWNLOAD_NO_EXTRACT True
+                SOURCE_DIR          ../../include
+            )
+
+            FetchContent_MakeAvailable(${HEADER_NAME})
+        endforeach()
+
+        target_include_directories(${target_name} PUBLIC ${CMAKE_CURRENT_BINARY_DIR}/../../include)
+
+    endif()
+endmacro()

pennylane_lightning/core/src/simulators/lightning_kokkos/catalyst/CMakeLists.txt

@@ -7,71 +7,8 @@ add_library(lightning_kokkos_catalyst SHARED ${LK_CATALYST_FILES})
 
 include(FetchContent)
 
-if(LIGHTNING_CATALYST_SRC_PATH)
-    if(NOT IS_ABSOLUTE ${LIGHTNING_CATALYST_SRC_PATH})
-        message(FATAL_ERROR " LIGHTNING_CATALYST_SRC_PATH=${LIGHTNING_CATALYST_SRC_PATH} must be set to an absolute path")
-    endif()
-    if(CATALYST_GIT_TAG)
-        message(WARN " Setting `LIGHTNING_CATALYST_SRC_PATH=${LIGHTNING_CATALYST_SRC_PATH}` overrides `CATALYST_GIT_TAG=${CATALYST_GIT_TAG}`")
-    endif()
-
-    # Acquire local git hash and use for CATALYST_GIT_TAG
-    execute_process(COMMAND git rev-parse --short HEAD
-        WORKING_DIRECTORY ${LIGHTNING_CATALYST_SRC_PATH}
-        OUTPUT_VARIABLE CATALYST_GIT_TAG
-    )
-    message(INFO " Building against local Catalyst - path: ${LIGHTNING_CATALYST_SRC_PATH} - GIT TAG: ${CATALYST_GIT_TAG}")
-
-    target_include_directories(lightning_kokkos_catalyst PUBLIC ${LIGHTNING_CATALYST_SRC_PATH}/runtime/lib/backend/common)
-    target_include_directories(lightning_kokkos_catalyst PUBLIC ${LIGHTNING_CATALYST_SRC_PATH}/runtime/include)
-
-else()
-    if(NOT CATALYST_GIT_TAG)
-        set(CATALYST_GIT_TAG "main" CACHE STRING "GIT_TAG value to build Catalyst")
-    endif()
-    message(INFO " Building against Catalyst GIT TAG ${CATALYST_GIT_TAG}")
-
-    # Fetching /lib/backend/common hpp headers
-    set(LIB_BACKEND_COMMON_HEADERS  CacheManager.hpp
-                                    QubitManager.hpp
-                                    Utils.hpp
-    )
-
-    foreach(HEADER ${LIB_BACKEND_COMMON_HEADERS})
-        string(REGEX REPLACE "\\.[^.]*$" "" HEADER_NAME ${HEADER})
-        FetchContent_Declare(
-            ${HEADER_NAME}
-            URL                 https://raw.githubusercontent.com/PennyLaneAI/catalyst/${CATALYST_GIT_TAG}/runtime/lib/backend/common/${HEADER}
-            DOWNLOAD_NO_EXTRACT True
-            SOURCE_DIR          ../../include
-        )
-
-        FetchContent_MakeAvailable(${HEADER_NAME})
-    endforeach()
-
-    # Fetching include hpp headers
-    set(INCLUDE_HEADERS DataView.hpp
-                        Exception.hpp
-                        QuantumDevice.hpp
-                        RuntimeCAPI.h
-                        Types.h
-    )
-
-    foreach(HEADER ${INCLUDE_HEADERS})
-        string(REGEX REPLACE "\\.[^.]*$" "" HEADER_NAME ${HEADER})
-        FetchContent_Declare(
-            ${HEADER_NAME}
-            URL                 https://raw.githubusercontent.com/PennyLaneAI/catalyst/${CATALYST_GIT_TAG}/runtime/include/${HEADER}
-            DOWNLOAD_NO_EXTRACT True
-            SOURCE_DIR          ../../include
-        )
-
-        FetchContent_MakeAvailable(${HEADER_NAME})
-    endforeach()
-
-    target_include_directories(lightning_kokkos_catalyst PUBLIC ${CMAKE_CURRENT_BINARY_DIR}/../../include)
-
-endif()
+include("${pennylane_lightning_SOURCE_DIR}/cmake/support_catalyst.cmake")
+FindCatalyst(lightning_kokkos_catalyst)
 
 target_include_directories(lightning_kokkos_catalyst INTERFACE  ${CMAKE_CURRENT_SOURCE_DIR})
 target_link_libraries(lightning_kokkos_catalyst PUBLIC  lightning_compile_options

pennylane_lightning/core/src/simulators/lightning_qubit/catalyst/CMakeLists.txt

@@ -7,71 +7,8 @@ add_library(lightning_qubit_catalyst SHARED ${LQ_CATALYST_FILES})
 
 include(FetchContent)
 
-if(LIGHTNING_CATALYST_SRC_PATH)
-    if(NOT IS_ABSOLUTE ${LIGHTNING_CATALYST_SRC_PATH})
-        message(FATAL_ERROR " LIGHTNING_CATALYST_SRC_PATH=${LIGHTNING_CATALYST_SRC_PATH} must be set to an absolute path")
-    endif()
-    if(CATALYST_GIT_TAG)
-        message(WARN " Setting `LIGHTNING_CATALYST_SRC_PATH=${LIGHTNING_CATALYST_SRC_PATH}` overrides `CATALYST_GIT_TAG=${CATALYST_GIT_TAG}`")
-    endif()
-
-    # Acquire local git hash and use for CATALYST_GIT_TAG
-    execute_process(COMMAND git rev-parse --short HEAD
-        WORKING_DIRECTORY ${LIGHTNING_CATALYST_SRC_PATH}
-        OUTPUT_VARIABLE CATALYST_GIT_TAG
-    )
-    message(INFO " Building against local Catalyst - path: ${LIGHTNING_CATALYST_SRC_PATH} - GIT TAG: ${CATALYST_GIT_TAG}")
-
-    target_include_directories(lightning_qubit_catalyst PUBLIC ${LIGHTNING_CATALYST_SRC_PATH}/runtime/lib/backend/common)
-    target_include_directories(lightning_qubit_catalyst PUBLIC ${LIGHTNING_CATALYST_SRC_PATH}/runtime/include)
-
-else()
-    if(NOT CATALYST_GIT_TAG)
-        set(CATALYST_GIT_TAG "main" CACHE STRING "GIT_TAG value to build Catalyst")
-    endif()
-    message(INFO " Building against Catalyst GIT TAG ${CATALYST_GIT_TAG}")
-
-    # Fetching /lib/backend/common hpp headers
-    set(LIB_BACKEND_COMMON_HEADERS  CacheManager.hpp
-                                    QubitManager.hpp
-                                    Utils.hpp
-    )
-
-    foreach(HEADER ${LIB_BACKEND_COMMON_HEADERS})
-        string(REGEX REPLACE "\\.[^.]*$" "" HEADER_NAME ${HEADER})
-        FetchContent_Declare(
-            ${HEADER_NAME}
-            URL                 https://raw.githubusercontent.com/PennyLaneAI/catalyst/${CATALYST_GIT_TAG}/runtime/lib/backend/common/${HEADER}
-            DOWNLOAD_NO_EXTRACT True
-            SOURCE_DIR          ../../include
-        )
-
-        FetchContent_MakeAvailable(${HEADER_NAME})
-    endforeach()
-
-    # Fetching include hpp headers
-    set(INCLUDE_HEADERS DataView.hpp
-                        Exception.hpp
-                        QuantumDevice.hpp
-                        RuntimeCAPI.h
-                        Types.h
-    )
-
-    foreach(HEADER ${INCLUDE_HEADERS})
-        string(REGEX REPLACE "\\.[^.]*$" "" HEADER_NAME ${HEADER})
-        FetchContent_Declare(
-            ${HEADER_NAME}
-            URL                 https://raw.githubusercontent.com/PennyLaneAI/catalyst/${CATALYST_GIT_TAG}/runtime/include/${HEADER}
-            DOWNLOAD_NO_EXTRACT True
-            SOURCE_DIR          ../../include
-        )
-
-        FetchContent_MakeAvailable(${HEADER_NAME})
-    endforeach()
-
-    target_include_directories(lightning_qubit_catalyst PUBLIC ${CMAKE_CURRENT_BINARY_DIR}/../../include)
-
-endif()
+include("${pennylane_lightning_SOURCE_DIR}/cmake/support_catalyst.cmake")
+FindCatalyst(lightning_qubit_catalyst)
 
 target_include_directories(lightning_qubit_catalyst INTERFACE  ${CMAKE_CURRENT_SOURCE_DIR})
 target_link_libraries(lightning_qubit_catalyst PUBLIC  lightning_compile_options