ss/include/s/s_FStateID.hpp
Elijah Thomas 26af4db82d
update from dtk-template - clangd :) (#66)
* update from dtk-template and start work towards using clangd

* include <a> -> "a"

* Update build.yml

* remove/add non-trivial class in union warning
2024-10-16 15:36:02 -04:00

69 lines
2.3 KiB
C++

#ifndef S_FSTATEID_H
#define S_FSTATEID_H
#include "s/s_StateID.hpp"
#include "string.h"
// Note: Ported from https://github.com/NSMBW-Community/NSMBW-Decomp/tree/master/include/dol/sLib
// See include/s/README.txt for changes made
/// @brief An implementation of a state ID for a given class.
/// @details It adds the ability to call the three state methods on a state owner class.
/// @tparam T The class that this state belongs to.
/// @ingroup state
template <class T>
class sFStateID_c : public sStateID_c {
public:
typedef void (T::*stateFunc)();
/**
* @brief Constructs a new sFStateID_c instance.
*
* @param name The name of this state ID.
* @param initialize The initialize method for this state ID.
* @param execute The execute method for this state ID.
* @param finalize The finalize method for this state ID.
*/
sFStateID_c(const char *name, stateFunc initialize, stateFunc execute, stateFunc finalize)
: sStateID_c(name), mpInitialize(initialize), mpExecute(execute), mpFinalize(finalize) {}
/// @brief Returns true if the given name matches this state ID's name.
virtual bool isSameName(const char *otherName) const {
char *part = strrchr(otherName, ':');
if (part != nullptr) {
otherName = part + 1;
}
const char *thisName = strrchr(name(), ':') + 1;
if (strcmp(thisName, otherName) == 0) {
return true;
} else {
return false;
}
}
/// @brief Calls the initialize method on the owner.
/// @param owner The owner of this state ID.
virtual void initializeState(T &owner) const {
(owner.*mpInitialize)();
}
/// @brief Calls the execute method on the owner.
/// @param owner The owner of this state ID.
virtual void executeState(T &owner) const {
(owner.*mpExecute)();
}
/// @brief Calls the finalize method on the owner.
/// @param owner The owner of this state ID.
virtual void finalizeState(T &owner) const {
(owner.*mpFinalize)();
}
private:
stateFunc mpInitialize; ///< The initialize method for this state ID.
stateFunc mpExecute; ///< The execute method for this state ID.
stateFunc mpFinalize; ///< The finalize method for this state ID.
};
#endif