minor changes to comply with the cms coding rules

Author: Mario Gonzalez

FWCore/TestModules/plugins/GenericCloner.cc

@@ -138,14 +138,16 @@ namespace edmtest {
 
       event.getByToken(product.getToken_, handle);
 
+      // create a "wrapper", whose wrapped product will be cloned into "clone"
       edm::WrapperBase const* wrapper = handle.product();
       std::unique_ptr<edm::WrapperBase> clone(static_cast<edm::WrapperBase*>(product.wrappedType_.getClass()->New()));
 
-      // Object from which, for a given type, we can initialize both a const and a mutable serialiser.
+      // get a "serialiserSource" object from the plugin factory.
+      // serializeSource objects can produce, for a given type, both const and mutable TrivialSerialisers.
       std::unique_ptr<ngt::TrivialSerialiserSourceBase> serialiserSource{
           ngt::TrivialSerialiserSourceFactory::get()->create(product.objectType_.typeInfo().name())};
 
-      // initialise a const and a mutable serialisers.
+      // initialise a const and a mutable TrivialSerialisers.
       auto const_serialiser = serialiserSource->initialize(*wrapper);
       auto mutable_serialiser = serialiserSource->initialize(*clone);
 

TrivialSerialisation/Common/interface/TrivialCopyTraits.h

@@ -1,5 +1,5 @@
-#ifndef DataFormats_Common_interface_TrivialCopyTraits_h
-#define DataFormats_Common_interface_TrivialCopyTraits_h
+#ifndef TrivialSerialisation_Common_interface_TrivialCopyTraits_h
+#define TrivialSerialisation_Common_interface_TrivialCopyTraits_h
 
 #include <cassert>
 #include <span>
@@ -89,4 +89,4 @@ namespace edm {
 
 }  // namespace edm
 
-#endif  // DataFormats_Common_interface_TrivialCopyTraits_h
+#endif  // TrivialSerialisation_Common_interface_TrivialCopyTraits_h

TrivialSerialisation/Common/interface/TrivialSerialiser.h

@@ -3,11 +3,8 @@
 
 #include <cstdio>
 #include "DataFormats/Common/interface/Wrapper.h"
-#include "DataFormats/Common/interface/WrapperBase.h"
 #include "TrivialSerialisation/Common/interface/TrivialSerialiserBase.h"
 #include "TrivialSerialisation/Common/interface/TrivialCopyTraits.h"
-#include "TrivialSerialisation/Common/interface/TrivialSerialiserSourceBase.h"
-#include "DataFormats/Common/interface/Uninitialized.h"
 
 // defines all methods of TrivialSerialiserBase
 
@@ -28,24 +25,16 @@ namespace ngt {
     void trivialCopyFinalize() override;
 
   private:
-    constexpr T construct_() {
-      if constexpr (requires { T(); }) {
-        return T();
-      } else {
-        return T(edm::kUninitialized);
-      }
-    }
-
     const T& getWrappedObj_(WrapperType const& w) const {
       if (not w.isPresent()) {
-        throw edm::Exception(edm::errors::LogicError) << "Attempt to access an empty Wrapper aa";
+        throw edm::Exception(edm::errors::LogicError) << "Attempt to access an empty Wrapper";
       }
       return *w.product();
     }
 
     T& getWrappedObj_(WrapperType& w) {
       if (not w.isPresent()) {
-        throw edm::Exception(edm::errors::LogicError) << "Attempt to access an empty Wrapper bb";
+        throw edm::Exception(edm::errors::LogicError) << "Attempt to access an empty Wrapper";
       }
       return w.bareProduct();
     }
@@ -75,6 +64,9 @@ namespace ngt {
       return;
     } else {
       auto& w = static_cast<WrapperType const&>(*getWrapperBasePtr());
+      // Each serialiser stores a pointer to the wrapper used to initialize it as "const edm::WrapperBase*"
+      // For serialisers used for writing, that were initialized with a non-const wrapper, the const_cast below is safe because the wrapper was originally non-const.
+      // For serialisers used for reading, that were initialized with a const wrapper, this function cannot be called because it is not marked as const.
       if constexpr (std::is_same_v<typename edm::TrivialCopyTraits<T>::Properties, void>) {
         // if edm::TrivialCopyTraits<T>::Properties is void, call initialize() without any additional arguments
         edm::TrivialCopyTraits<T>::initialize(const_cast<WrapperType&>(w).bareProduct());
@@ -120,7 +112,7 @@ namespace ngt {
   template <typename T>
   inline std::vector<std::span<std::byte>> TrivialSerialiser<T>::trivialCopyRegions() {
     if constexpr (requires(T& t) { edm::TrivialCopyTraits<T>::regions(t); }) {
-      auto& w = const_cast<edm::Wrapper<T>&>(static_cast<edm::Wrapper<T> const&>(*getWrapperBasePtr()));
+      auto& w = const_cast<WrapperType&>(static_cast<WrapperType const&>(*getWrapperBasePtr()));
       T& obj = getWrappedObj_(w);
       return edm::TrivialCopyTraits<T>::regions(obj);
     } else {
@@ -140,19 +132,6 @@ namespace ngt {
     }
   }
 
-  template <typename T>
-  class TrivialSerialiserSource : public TrivialSerialiserSourceBase {
-  public:
-    std::unique_ptr<TrivialSerialiserBase> initialize(edm::WrapperBase& wrapper) override {
-      edm::Wrapper<T>& w = dynamic_cast<edm::Wrapper<T>&>(wrapper);
-      return std::make_unique<TrivialSerialiser<T>>(w);
-    }
-    std::unique_ptr<const TrivialSerialiserBase> initialize(edm::WrapperBase const& wrapper) override {
-      edm::Wrapper<T> const& w = dynamic_cast<edm::Wrapper<T> const&>(wrapper);
-      return std::make_unique<const TrivialSerialiser<T>>(w);
-    }
-  };
-
 }  // namespace ngt
 
-#endif
+#endif  // TrivialSerialisation_Common_TrivialSerialiser_h

TrivialSerialisation/Common/interface/TrivialSerialiserBase.h

@@ -2,10 +2,7 @@
 #define TrivialSerialisation_Common_interface_TrivialSerialiserBase_h
 
 #include "DataFormats/Common/interface/AnyBuffer.h"
-#include "DataFormats/Common/interface/Wrapper.h"
 #include "DataFormats/Common/interface/WrapperBase.h"
-// #include "TrivialSerialisation/Common/interface/TrivialSerialiser.h"
-// #include "TrivialSerialisation/Common/interface/TrivialSerialiserSourceFactory.h"
 
 #include <span>
 #include <vector>

TrivialSerialisation/Common/interface/TrivialSerialiserSourceBase.h

@@ -9,14 +9,11 @@ namespace ngt {
   public:
     TrivialSerialiserSourceBase() {};
 
-    virtual std::unique_ptr<TrivialSerialiserBase> initialize (edm::WrapperBase& wrapper) = 0;
-    virtual std::unique_ptr<const TrivialSerialiserBase> initialize (const edm::WrapperBase& wrapper) = 0;
+    virtual std::unique_ptr<TrivialSerialiserBase> initialize(edm::WrapperBase& wrapper) = 0;
+    virtual std::unique_ptr<const TrivialSerialiserBase> initialize(const edm::WrapperBase& wrapper) = 0;
 
     virtual ~TrivialSerialiserSourceBase() = default;
   };
 }  // namespace ngt
 
 #endif  // TrivialSerialisation_Common_TrivialSerialiserSourceBase_h
-
-
-

TrivialSerialisation/Common/interface/TrivialSerialiserSourceFactory.h

@@ -5,7 +5,6 @@
 #include "FWCore/PluginManager/interface/PluginFactory.h"
 
 namespace ngt {
-    using TrivialSerialiserSourceFactory = edmplugin::PluginFactory<ngt::TrivialSerialiserSourceBase *(void)>;
-    // TODO: is the "void" necessary?
+    using TrivialSerialiserSourceFactory = edmplugin::PluginFactory<ngt::TrivialSerialiserSourceBase *()>;
 }
-#endif
+#endif // TrivialSerialisation_src_TrivialSerialiserSourceFactory_h