Rename DPPLSyclBEType to DPPLSyclBackendType. Drop superfluous enum specifier.

Author: Diptorup Deb

backends/include/dppl_sycl_context_interface.h

@@ -57,13 +57,14 @@ DPPL_API
 bool DPPLContext_IsHost (__dppl_keep const DPPLSyclContextRef CtxRef);
 
 /*!
- * @brief
+ * @brief Returns the sycl backend for the DPPLSyclContextRef pointer.
  *
  * @param    CtxRef         An opaque pointer to a sycl::context.
- * @return   {return}       My Param doc
+ * @return   The sycl backend for the DPPLSyclContextRef returned as 
+ * a DPPLSyclBackendType enum type.
  */
 DPPL_API
-DPPLSyclBEType
+DPPLSyclBackendType
 DPPLContext_GetBackend (__dppl_keep const DPPLSyclContextRef CtxRef);
 
 /*!

backends/include/dppl_sycl_enum_types.h

@@ -35,7 +35,7 @@ DPPL_C_EXTERN_C_BEGIN
  * @brief Redefinition of DPC++-specific Sycl backend types.
  *
  */
-enum DPPLSyclBEType
+enum DPPLSyclBackendType
 {
     DPPL_UNKNOWN_BACKEND = 0x0,
     DPPL_OPENCL          = 1 << 16,
@@ -57,7 +57,7 @@ enum DPPLSyclDeviceType
     DPPL_AUTOMATIC   = 1 << 4,
     DPPL_HOST_DEVICE = 1 << 5,
     DPPL_ALL         = 1 << 6
-    // IMP: before adding new values here look at DPPLSyclBEType enum. The
+    // IMP: before adding new values here look at DPPLSyclBackendType enum. The
     // values should not overlap.
 };
 

backends/include/dppl_sycl_platform_interface.h

@@ -51,20 +51,20 @@ DPPL_API
 size_t DPPLPlatform_GetNumBackends ();
 
 /*!
- * @brief Returns an array of the unique DPPLSyclBEType values on the system.
+ * @brief Returns an array of the unique DPPLSyclBackendType values on the system.
  *
- * @return   An array of DPPLSyclBEType enum values.
+ * @return   An array of DPPLSyclBackendType enum values.
  */
 DPPL_API
-__dppl_give enum DPPLSyclBEType* DPPLPlatform_GetListOfBackends ();
+__dppl_give DPPLSyclBackendType* DPPLPlatform_GetListOfBackends ();
 
 /*!
- * @brief Frees an array of DPPLSyclBEType enum values.
+ * @brief Frees an array of DPPLSyclBackendType enum values.
  *
- * @param    BEArr          An array of DPPLSyclBEType enum values to be freed.
+ * @param    BEArr      An array of DPPLSyclBackendType enum values to be freed.
  */
 DPPL_API
-void DPPLPlatform_DeleteListOfBackends (__dppl_take enum DPPLSyclBEType* BEArr);
+void DPPLPlatform_DeleteListOfBackends (__dppl_take DPPLSyclBackendType* BEArr);
 
 /*!
  * @brief Prints out some selected info about all sycl::platform on the system.

backends/include/dppl_sycl_queue_interface.h

@@ -59,10 +59,11 @@ bool DPPLQueue_AreEq (__dppl_keep const DPPLSyclQueueRef QRef1,
  * @brief Returns the Sycl backend for the provided sycl::queue.
  *
  * @param    QRef           An opaque pointer to the sycl queue.
- * @return   A enum DPPLSyclBEType corresponding to the backed for the queue.
+ * @return   A enum DPPLSyclBackendType corresponding to the backed for the
+ * queue.
  */
 DPPL_API
-enum DPPLSyclBEType DPPLQueue_GetBackend (__dppl_keep DPPLSyclQueueRef QRef);
+DPPLSyclBackendType DPPLQueue_GetBackend (__dppl_keep DPPLSyclQueueRef QRef);
 
 /*!
  * @brief Returns the Sycl context for the queue.

backends/include/dppl_sycl_queue_manager.h

@@ -65,8 +65,8 @@ __dppl_give DPPLSyclQueueRef DPPLQueueMgr_GetCurrentQueue ();
  */
 DPPL_API
 __dppl_give DPPLSyclQueueRef
-DPPLQueueMgr_GetQueue (enum DPPLSyclBEType BETy,
-                       enum DPPLSyclDeviceType DeviceTy,
+DPPLQueueMgr_GetQueue (DPPLSyclBackendType BETy,
+                       DPPLSyclDeviceType DeviceTy,
                        size_t DNum);
 
 /*!
@@ -88,8 +88,8 @@ size_t DPPLQueueMgr_GetNumActivatedQueues ();
  * @return   The number of available queues.
  */
 DPPL_API
-size_t DPPLQueueMgr_GetNumQueues (enum DPPLSyclBEType BETy,
-                                  enum DPPLSyclDeviceType DeviceTy);
+size_t DPPLQueueMgr_GetNumQueues (DPPLSyclBackendType BETy,
+                                  DPPLSyclDeviceType DeviceTy);
 
 /*!
  * @brief Returns True if the passed in queue and the current queue are the
@@ -115,8 +115,8 @@ bool DPPLQueueMgr_IsCurrentQueue (__dppl_keep const DPPLSyclQueueRef QRef);
 */
 DPPL_API
 __dppl_give DPPLSyclQueueRef
-DPPLQueueMgr_SetAsDefaultQueue (enum DPPLSyclBEType BETy,
-                                enum DPPLSyclDeviceType DeviceTy,
+DPPLQueueMgr_SetAsDefaultQueue (DPPLSyclBackendType BETy,
+                                DPPLSyclDeviceType DeviceTy,
                                 size_t DNum);
 
 /*!
@@ -141,8 +141,8 @@ DPPLQueueMgr_SetAsDefaultQueue (enum DPPLSyclBEType BETy,
  */
 DPPL_API
 __dppl_give DPPLSyclQueueRef
-DPPLQueueMgr_PushQueue (enum DPPLSyclBEType BETy,
-                        enum DPPLSyclDeviceType DeviceTy,
+DPPLQueueMgr_PushQueue (DPPLSyclBackendType BETy,
+                        DPPLSyclDeviceType DeviceTy,
                         size_t DNum);
 
 /*!

backends/source/dppl_sycl_context_interface.cpp

@@ -55,7 +55,7 @@ void DPPLContext_Delete (__dppl_take DPPLSyclContextRef CtxRef)
     delete unwrap(CtxRef);
 }
 
-DPPLSyclBEType
+DPPLSyclBackendType
 DPPLContext_GetBackend (__dppl_keep const DPPLSyclContextRef CtxRef)
 {
     auto BE = unwrap(CtxRef)->get_platform().get_backend();

backends/source/dppl_sycl_platform_interface.cpp

@@ -36,27 +36,27 @@ using namespace cl::sycl;
 
 namespace
 {
-std::set<DPPLSyclBEType>
+std::set<DPPLSyclBackendType>
 get_set_of_backends ()
 {
-    std::set<DPPLSyclBEType> be_set;
+    std::set<DPPLSyclBackendType> be_set;
     for (auto p : platform::get_platforms()) {
 		if(p.is_host())
 			continue;
         auto be = p.get_backend();
         switch (be)
         {
         case backend::host:
-            be_set.insert(DPPLSyclBEType::DPPL_HOST);
+            be_set.insert(DPPLSyclBackendType::DPPL_HOST);
             break;
         case backend::cuda:
-            be_set.insert(DPPLSyclBEType::DPPL_CUDA);
+            be_set.insert(DPPLSyclBackendType::DPPL_CUDA);
             break;
         case backend::level_zero:
-            be_set.insert(DPPLSyclBEType::DPPL_LEVEL_ZERO);
+            be_set.insert(DPPLSyclBackendType::DPPL_LEVEL_ZERO);
             break;
         case backend::opencl:
-            be_set.insert(DPPLSyclBEType::DPPL_OPENCL);
+            be_set.insert(DPPLSyclBackendType::DPPL_OPENCL);
             break;
         default:
             break;
@@ -164,14 +164,14 @@ size_t DPPLPlatform_GetNumBackends ()
     return get_set_of_backends().size();
 }
 
-__dppl_give enum DPPLSyclBEType *DPPLPlatform_GetListOfBackends ()
+__dppl_give DPPLSyclBackendType *DPPLPlatform_GetListOfBackends ()
 {
     auto be_set = get_set_of_backends();
 
     if (be_set.empty())
         return nullptr;
 
-    DPPLSyclBEType *BEArr = new DPPLSyclBEType[be_set.size()];
+    DPPLSyclBackendType *BEArr = new DPPLSyclBackendType[be_set.size()];
 
     auto i = 0ul;
     for (auto be : be_set) {
@@ -182,7 +182,7 @@ __dppl_give enum DPPLSyclBEType *DPPLPlatform_GetListOfBackends ()
     return BEArr;
 }
 
-void DPPLPlatform_DeleteListOfBackends (__dppl_take enum DPPLSyclBEType *BEArr)
+void DPPLPlatform_DeleteListOfBackends (__dppl_take DPPLSyclBackendType *BEArr)
 {
     delete[] BEArr;
 }

backends/source/dppl_sycl_queue_interface.cpp

@@ -128,7 +128,7 @@ bool DPPLQueue_AreEq (__dppl_keep const DPPLSyclQueueRef QRef1,
     return (*unwrap(QRef1) == *unwrap(QRef2));
 }
 
-enum DPPLSyclBEType DPPLQueue_GetBackend (__dppl_keep DPPLSyclQueueRef QRef)
+DPPLSyclBackendType DPPLQueue_GetBackend (__dppl_keep DPPLSyclQueueRef QRef)
 {
     auto Q = unwrap(QRef);
     auto C = Q->get_context();
@@ -197,11 +197,11 @@ DPPLQueue_SubmitRange (__dppl_keep const DPPLSyclKernelRef KRef,
                                          "dimensions.");
             }
         });
-    } catch (runtime_error re) {
+    } catch (runtime_error &re) {
         // \todo fix error handling
         std::cerr << re.what() << '\n';
         return nullptr;
-    } catch (std::runtime_error sre) {
+    } catch (std::runtime_error &sre) {
         std::cerr << sre.what() << '\n';
         return nullptr;
     }
@@ -258,11 +258,11 @@ DPPLQueue_SubmitNDRange(__dppl_keep const DPPLSyclKernelRef KRef,
                                          "dimensions.");
             }
         });
-    } catch (runtime_error re) {
+    } catch (runtime_error &re) {
         // \todo fix error handling
         std::cerr << re.what() << '\n';
         return nullptr;
-    } catch (std::runtime_error sre) {
+    } catch (std::runtime_error &sre) {
         std::cerr << sre.what() << '\n';
         return nullptr;
     }