Skip to content

Action register #935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GiovanniBussi merged 10 commits into from
May 19, 2023
Merged

Action register #935

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
841cba1
PLUMED_REGISTER_ACTION overhaul, plus sed applied to the actions
Iximiel May 12, 2023
550c70b
Merge remote-tracking branch 'upstream/c++17'
Iximiel May 12, 2023
91b5280
astyled and polished the class
Iximiel May 12, 2023
5c5ba2f
small aestetic changes
Iximiel May 12, 2023
1a69fd0
starting to revert to quotes
Iximiel May 12, 2023
3a14e0f
readded the quotes
Iximiel May 12, 2023
2b9345b
removed some spaces
Iximiel May 12, 2023
f6909bf
removed spaces
Iximiel May 12, 2023
e4213a7
reverted the documentation
Iximiel May 12, 2023
7016c11
moved the definitions outside the PLMD namespace
Iximiel May 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 29 additions & 10 deletions src/core/ActionRegister.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,36 @@ ActionRegister& actionRegister();

std::ostream & operator<<(std::ostream &log,const ActionRegister&ar);

}
template<typename T>
inline constexpr bool isActionType = std::is_base_of<Action, T>::value;
//in C++20 you we'll make this a concept
//template<typename T>
//concept ActionType = std::is_base_of<::PLMD::Action, T>::value;
//so the template will be template<ActionType ActionType>class ActionRegistration{...}
//without the explicit need of the static assert

///Each instance of this specialized class represents an action that can be called
///with the specified directive.
///As soon it goes out of scope it will deregister the directive from the singleton ActionRegister
template<typename ActionClass>
class ActionRegistration {
static std::unique_ptr<Action> create(const ActionOptions&ao) {
return std::make_unique<ActionClass>(ao);
}
public:
///On construction register the ActionClass with the wanted directive
ActionRegistration(std::string_view directive) {
static_assert(isActionType<ActionClass>,
"ActionRegistration accepts only class that inherit from Action");
actionRegister().add(directive.data(),create,ActionClass::registerKeywords);
}
///On destruction deregister the ActionClass (useful when you unload a shared object)
~ActionRegistration() {actionRegister().remove(create);}
};
} //PLMD

#define PLUMED_CONCATENATE_DIRECT(s1, s2) s1##s2
#define PLUMED_CONCATENATE(s1, s2) PLUMED_CONCATENATE_DIRECT(s1, s2)
#define PLUMED_UNIQUENAME(str) PLUMED_CONCATENATE(str, __LINE__)
Copy link
Member

@GiovanniBussi GiovanniBussi May 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You eliminated an indirection. I honestly do not remember anymore why it was there. Are you sure this is ok?

Copy link
Member

@GiovanniBussi GiovanniBussi May 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's correct. You are just using PLUMED_CONCATENATE below..


/// Shortcut for Action registration
/// \relates PLMD::ActionRegister
Expand All @@ -101,13 +126,7 @@ std::ostream & operator<<(std::ostream &log,const ActionRegister&ar);
/// \param directive a string containing the corresponding directive
/// This macro should be used in the .cpp file of the corresponding class
#define PLUMED_REGISTER_ACTION(classname,directive) \
namespace { class PLUMED_UNIQUENAME(classname##RegisterMe){ \
static std::unique_ptr<PLMD::Action> create(const PLMD::ActionOptions&ao){return std::make_unique<classname>(ao);} \
public: \
PLUMED_UNIQUENAME(classname##RegisterMe)(){PLMD::actionRegister().add(directive,create,classname::registerKeywords);} \
~PLUMED_UNIQUENAME(classname##RegisterMe)(){PLMD::actionRegister().remove(create);} \
} PLUMED_UNIQUENAME(classname##RegisterMe); }


namespace {::PLMD::ActionRegistration<classname> \
PLUMED_CONCATENATE(classname##Registerer,__LINE__)(directive);}
#endif