Skip to content
Snippets Groups Projects
Commit 981a8309 authored by Gerhard Raven's avatar Gerhard Raven
Browse files

Modernize GaudiHandle 

   - pass sink arguments by value and std::move them im place
   - do not qualify by-value returned objects as const
   - prefer nullptr over 0
   - qualify implementations with 'override' instead of 'virtual'
   - prefer STL algorithms over raw loops
   - avoid 'if' statements in loops
parent 4de1b0aa
No related branches found
No related tags found
1 merge request!7C++11 modernization changes
Hide whitespace changes
Inline Side-by-side
GaudiKernel/GaudiKernel/GaudiHandle.h
+ 44
− 54
View file @ 981a8309
......@@ -21,8 +21,8 @@ protected:
PublicToolHandle,PrivateToolHandle,ServiceHandle
@param myParentName: Name of the parent that has this handle as a member. Used in printout.
*/
GaudiHandleInfo( const std::string& myComponentType, const std::string& myParentName )
: m_componentType(myComponentType), m_parentName(myParentName)
GaudiHandleInfo( std::string myComponentType, std::string myParentName )
: m_componentType(std::move(myComponentType)), m_parentName(std::move(myParentName))
{}
public:
/** virtual destructor so that derived class destructor is called. */
......@@ -40,8 +40,8 @@ public:
}
/** set name as used in declareProperty(name,gaudiHandle). Used in printout. */
void setPropertyName( const std::string& propName ) {
m_propertyName = propName;
void setPropertyName( std::string propName ) {
m_propertyName = std::move(propName);
}
/** The name of the parent */
......@@ -52,13 +52,13 @@ public:
/** The python class name for the property in the genconf-generated configurables.
The python class is defined in GaudiPython/python/GaudiHandles.py.
To be implemented in derived class. */
virtual const std::string pythonPropertyClassName() const = 0;
virtual std::string pythonPropertyClassName() const = 0;
/** Python representation of handle, i.e. python class name and argument.
Can be used in the genconf-generated configurables.
The corresponding python classes are defined in GaudiPython/GaudiHandles.py.
To be implemented in derived class. */
virtual const std::string pythonRepr() const = 0;
virtual std::string pythonRepr() const = 0;
private:
//
......@@ -93,11 +93,11 @@ protected:
PublicToolHandle,PrivateToolHandle,ServiceHandle
@param myParentName: Name of the parent that has this handle as a member. Used in printout.
*/
GaudiHandleBase( const std::string& myTypeAndName, const std::string& myComponentType,
const std::string& myParentName )
: GaudiHandleInfo(myComponentType,myParentName)
GaudiHandleBase( const std::string& myTypeAndName, std::string myComponentType,
std::string myParentName )
: GaudiHandleInfo(std::move(myComponentType),std::move(myParentName))
{
setTypeAndName(myTypeAndName);
setTypeAndName(std::move(myTypeAndName));
}
public:
//
......@@ -120,7 +120,7 @@ public:
}
/** The component "type/name" string */
void setTypeAndName( const std::string& myTypeAndName );
void setTypeAndName( std::string myTypeAndName );
/** Set the instance name (part after the '/') without changing the class type */
void setName( const std::string& myName );
......@@ -128,15 +128,15 @@ public:
/** Name of the componentType with "Handle" appended. Used as the python class name
for the property in the genconf-generated configurables.
The python class is defined in GaudiPython/python/GaudiHandles.py. */
const std::string pythonPropertyClassName() const;
std::string pythonPropertyClassName() const;
/** name used for printing messages */
const std::string messageName() const;
std::string messageName() const;
/** Python representation of handle, i.e. python class name and argument.
Can be used in the genconf-generated configurables.
The corresponding python classes are defined in GaudiPython/GaudiHandles.py */
virtual const std::string pythonRepr() const;
virtual std::string pythonRepr() const;
private:
//
......@@ -160,9 +160,9 @@ class GAUDI_API GaudiHandle: public GaudiHandleBase {
// Constructors etc.
//
protected:
GaudiHandle( const std::string& myTypeAndName, const std::string& myComponentType,
const std::string& myParentName )
: GaudiHandleBase(myTypeAndName, myComponentType, myParentName), m_pObject(0)
GaudiHandle( std::string myTypeAndName, std::string myComponentType,
std::string myParentName )
: GaudiHandleBase(std::move(myTypeAndName), std::move(myComponentType), std::move(myParentName))
{}
public:
......@@ -188,7 +188,7 @@ public:
StatusCode retrieve() const { // not really const, because it updates m_pObject
if ( m_pObject && release().isFailure() ) return StatusCode::FAILURE;
if ( retrieve( m_pObject ).isFailure() ) {
m_pObject = 0;
m_pObject = nullptr;
return StatusCode::FAILURE;
}
return StatusCode::SUCCESS;
......@@ -198,7 +198,7 @@ public:
StatusCode release() const { // not really const, because it updates m_pObject
if ( m_pObject ) {
StatusCode sc = release( m_pObject );
m_pObject = 0;
m_pObject = nullptr;
return sc;
}
return StatusCode::SUCCESS;
......@@ -290,7 +290,7 @@ private:
//
// Data members
//
mutable T* m_pObject;
mutable T* m_pObject = nullptr;
};
......@@ -302,8 +302,8 @@ private:
class GAUDI_API GaudiHandleArrayBase: public GaudiHandleInfo {
protected:
GaudiHandleArrayBase( const std::string& myComponentType, const std::string& myParentName )
: GaudiHandleInfo(myComponentType,myParentName)
GaudiHandleArrayBase( std::string myComponentType, std::string myParentName )
: GaudiHandleInfo(std::move(myComponentType),std::move(myParentName))
{}
public:
typedef std::vector< GaudiHandleBase* > BaseHandleArray;
......@@ -330,12 +330,12 @@ public:
/** Name of the componentType with "HandleArray" appended. Used as the python class name
for the property in the genconf-generated configurables.
The python class is defined in GaudiPython/python/GaudiHandles.py. */
virtual const std::string pythonPropertyClassName() const;
std::string pythonPropertyClassName() const override;
/** Python representation of array of handles, i.e. list of python handles.
Can be used in the genconf-generated configurables.
The corresponding python classes are defined in GaudiPython/GaudiHandles.py */
virtual const std::string pythonRepr() const;
std::string pythonRepr() const override;
/** Add a handle to the array with "type/name" given in &lt;myHandleTypeAndName&gt;.
Return whether addition was successful or not.
......@@ -384,8 +384,8 @@ protected:
for the list of tools
*/
GaudiHandleArray( const std::vector< std::string >& myTypesAndNamesList,
const std::string& myComponentType, const std::string& myParentName )
: GaudiHandleArrayBase(myComponentType,myParentName)
std::string myComponentType, std::string myParentName )
: GaudiHandleArrayBase(std::move(myComponentType),std::move(myParentName))
{
setTypesAndNames( myTypesAndNamesList );
}
......@@ -407,14 +407,14 @@ public:
return *this;
}
virtual GaudiHandleArrayBase::BaseHandleArray getBaseArray() {
GaudiHandleArrayBase::BaseHandleArray getBaseArray() override {
GaudiHandleArrayBase::BaseHandleArray baseArray;
iterator it = begin(), itEnd = end();
for ( ; it != itEnd; ++it ) baseArray.push_back( &*it );
return baseArray;
}
virtual GaudiHandleArrayBase::ConstBaseHandleArray getBaseArray() const {
GaudiHandleArrayBase::ConstBaseHandleArray getBaseArray() const override {
GaudiHandleArrayBase::ConstBaseHandleArray baseArray;
const_iterator it = begin(), itEnd = end();
for ( ; it != itEnd; ++it ) baseArray.push_back( &*it );
......@@ -452,11 +452,11 @@ public:
return m_handleArray.size();
}
virtual void clear() {
void clear() override {
m_handleArray.clear();
}
virtual bool empty() const {
bool empty() const override {
return m_handleArray.empty();
}
......@@ -470,22 +470,18 @@ public:
/** Get pointer (!) to ToolHandle by instance name. Returns zero pointer if not found */
T* operator[]( const std::string& name ) {
iterator it = begin(), itEnd = end();
for ( ; it != itEnd; ++it ) {
if ( it->name() == name ) return &*it;
}
// not found
return 0;
auto it = std::find_if(begin(),end(),[&](const_reference r) {
return r.name() == name;
} );
return it != end() ? &*it : nullptr;
}
/** Get const pointer (!) to ToolHandle by instance name. Returns zero pointer if not found */
const T* operator[]( const std::string& name ) const {
const_iterator it = begin(), itEnd = end();
for ( ; it != itEnd; ++it ) {
if ( it->name() == name ) return &*it;
}
// not found
return 0;
auto it = std::find_if(begin(),end(),[&](const_reference r) {
return r.name() == name;
} );
return it != end() ? &*it : nullptr;
}
/** Add a handle with given type and name. Can be overridden in derived class.
......@@ -498,12 +494,9 @@ public:
/** Retrieve all tools */
StatusCode retrieve() {
iterator it = begin(), itEnd = end();
for ( ; it != itEnd; ++it ) {
if ( it->retrieve().isFailure() ) {
// stop at first failure
return StatusCode::FAILURE;
}
for (auto& i : *this) {
// stop at first failure
if ( i.retrieve().isFailure() ) return StatusCode::FAILURE;
}
return StatusCode::SUCCESS;
}
......@@ -511,12 +504,9 @@ public:
/** Release all tools */
StatusCode release() {
StatusCode sc = StatusCode::SUCCESS;
iterator it = begin(), itEnd = end();
for ( ; it != itEnd; ++it ) {
if ( it->release().isFailure() ) {
// continue trying to release other tools
sc = StatusCode::FAILURE;
}
for (auto& i : *this ) {
// continue trying to release other tools even if we fail...
if ( i.release().isFailure() ) sc = StatusCode::FAILURE;
}
return sc;
}
......
GaudiKernel/src/Lib/GaudiHandle.cpp
+ 13
− 17
View file @ 981a8309
......@@ -6,8 +6,8 @@
// GaudiHandleBase implementation
//
void GaudiHandleBase::setTypeAndName( const std::string& myTypeAndName ) {
m_typeAndName = myTypeAndName;
void GaudiHandleBase::setTypeAndName( std::string myTypeAndName ) {
m_typeAndName = std::move(myTypeAndName);
}
std::string GaudiHandleBase::type() const {
......@@ -22,7 +22,7 @@ std::string GaudiHandleBase::type() const {
}
std::string GaudiHandleBase::name() const {
std::string::size_type slash = m_typeAndName.find('/');
auto slash = m_typeAndName.find('/');
if ( slash == std::string::npos ) {
// only type is given, or string is empty.
// return default name (=type or empty, in this case full string)
......@@ -41,11 +41,11 @@ void GaudiHandleBase::setName( const std::string& myName ) {
m_typeAndName = type() + '/' + myName;
}
const std::string GaudiHandleBase::pythonPropertyClassName() const {
std::string GaudiHandleBase::pythonPropertyClassName() const {
return componentType() + "Handle";
}
const std::string GaudiHandleBase::messageName() const {
std::string GaudiHandleBase::messageName() const {
std::string propName = propertyName();
if ( propName.empty() ) {
propName = pythonPropertyClassName() + "('" + m_typeAndName + "')";
......@@ -53,7 +53,7 @@ const std::string GaudiHandleBase::messageName() const {
return parentName() + "." + propName;
}
const std::string GaudiHandleBase::pythonRepr() const {
std::string GaudiHandleBase::pythonRepr() const {
return pythonPropertyClassName() + "('" + m_typeAndName + "')";
}
......@@ -87,24 +87,21 @@ const std::vector< std::string > GaudiHandleArrayBase::names() const {
return getBaseInfos( &GaudiHandleBase::name );
}
const std::string GaudiHandleArrayBase::pythonPropertyClassName() const {
std::string GaudiHandleArrayBase::pythonPropertyClassName() const {
return componentType() + "HandleArray";
}
const std::string GaudiHandleArrayBase::pythonRepr() const {
std::string GaudiHandleArrayBase::pythonRepr() const {
std::string repr = pythonPropertyClassName() + "([";
const auto& theList = typesAndNames();
auto itEnd = theList.end();
auto itLast = std::prev(itEnd);
for (auto it = theList.begin() ; it != itEnd; ++it ) {
repr += "'" + *it + "'";
if ( it != itLast ) repr += ",";
}
auto theList = typesAndNames();
auto first = theList.begin();
auto last = theList.end();
if ( first != last ) { repr += "'" + *first + "'"; ++first; }
for (;first!=last;++first) repr += ",'" + *first + "'";
repr += "])";
return repr;
}
//
// Public functions
//
......@@ -116,4 +113,3 @@ std::ostream& operator<<( std::ostream& os, const GaudiHandleInfo& handle ) {
os << msg;
return os;
}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment