This class represents a Cutelyst Action. More...

#include <Cutelyst/Action>

Inheritance diagram for Cutelyst::Action:

[legend]

Public Member Functions
	Action (QObject *parent=nullptr)
virtual	~Action () override=default
QString	attribute (const QString &name, const QString &defaultValue={}) const
ParamsMultiMap	attributes () const noexcept
QString	className () const noexcept
Controller *	controller () const noexcept
bool	dispatch (Context *c)
virtual bool	match (int numberOfArgs) const noexcept
virtual bool	matchCaptures (int numberOfCaptures) const noexcept
virtual Modifiers	modifiers () const override
QString	ns () const noexcept
virtual qint8	numberOfArgs () const
virtual qint8	numberOfCaptures () const
void	setAttributes (const ParamsMultiMap &attributes)
Public Member Functions inherited from Cutelyst::Component
	Component (QObject *parent=nullptr)
virtual	~Component () override
bool	execute (Context *c)
virtual bool	init (Application *application, const QVariantHash &args)
QString	name () const noexcept
QString	reverse () const noexcept
void	setName (const QString &name)
void	setReverse (const QString &reverse)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char signal, const QObject receiver, const char *method) const const
bool	disconnect (const QObject receiver, const char method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject watched, QEvent event)
T	findChild (QAnyStringView name, Qt::FindChildOptions options) const const
T	findChild (Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (QAnyStringView name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQmlExposed () const const
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
void	killTimer (Qt::TimerId id)
virtual const QMetaObject *	metaObject () const const
bool	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_CONTEXTLESS_CONNECT QT_NO_CONTEXTLESS_CONNECT
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::nanoseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Protected Member Functions
	Action (ActionPrivate ptr, QObject parent=nullptr)
bool	doExecute (Context *c) override
void	setController (Controller *controller)
void	setMethod (const QMetaMethod &method)
void	setupAction (const QVariantHash &args, Application *app)
Protected Member Functions inherited from Cutelyst::Component
	Component (ComponentPrivate d, QObject parent=nullptr)
virtual bool	afterExecute (Context *c)
void	applyRoles (const QStack< Component * > &roles)
virtual bool	aroundExecute (Context c, QStack< Component > stack)
virtual bool	beforeExecute (Context *c)
virtual bool	dispatcherReady (const Dispatcher dispatch, Controller controller)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Friends
class	ControllerPrivate
class	Dispatcher

Additional Inherited Members
Public Types inherited from Cutelyst::Component
enum	Modifier { None , OnlyExecute , BeforeExecute , AroundExecute , AfterExecute }
Public Types inherited from QObject
enum	TimerId
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)
bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)
bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)
QString	tr (const char sourceText, const char disambiguation, int n)
Public Attributes inherited from QObject
	Invalid
typedef	QObjectList
Properties inherited from QObject
	objectName

Detailed Description

This class represents a Cutelyst Action.

It encapsulates a Controller method that was defined with C_ATTR() macro, it’s usually automatically created by Controller using it’s introspection information. This class allows Cutelyst to call a Controller method.

You can access the object for the currently dispatched action via c->action(). See the Dispatcher for more information on how actions are dispatched.

Definition at line 34 of file action.h.

Constructor & Destructor Documentation

◆ Action() [1/2]

Action::Action ( QObject * parent = nullptr )

explicit

Constructs an Action object with the given parent.

Definition at line 13 of file action.cpp.

References Cutelyst::Component::Component(), QObject::QObject(), and QObject::parent().

Referenced by Cutelyst::ActionChain::ActionChain(), Cutelyst::ActionREST::ActionREST(), Cutelyst::RenderView::RenderView(), attribute(), attributes(), className(), controller(), doExecute(), Cutelyst::ActionChain::doExecute(), Cutelyst::ActionREST::doExecute(), match(), matchCaptures(), ns(), numberOfArgs(), numberOfCaptures(), setAttributes(), setController(), setMethod(), and setupAction().

◆ ~Action()

virtual Cutelyst::Action::~Action ( )

overridevirtualdefault

Destroys the Action object.

References attribute(), attributes(), modifiers(), and Cutelyst::Component::name().

◆ Action() [2/2]

Action::Action	(	ActionPrivate *	ptr,
		QObject *	parent = nullptr )

explicitprotected

A derived class using pimpl should call this constructor, to reduce the number of memory allocations.

Definition at line 18 of file action.cpp.

References Cutelyst::Component::Component(), QObject::QObject(), and QObject::parent().

Member Function Documentation

◆ attribute()

QString Action::attribute	(	const QString &	name,
		const QString &	defaultValue = {} ) const

nodiscard

Returns the value attribute by it’s name, if not found defaultValue is returned.

Attributes can be defined using the C_ATTR macro on Controller’s method declaration.

Definition at line 74 of file action.cpp.

References Action(), and Cutelyst::Component::name().

Referenced by ~Action(), Cutelyst::DispatchTypeChained::expandAction(), and Cutelyst::DispatchTypePath::list().

◆ attributes()

ParamsMultiMap Action::attributes ( ) const

nodiscardnoexcept

Returns the attributes that are set for this action, like Local, Path, Private and so on. This determines how the action is dispatched to.

Definition at line 68 of file action.cpp.

References Action().

Referenced by ~Action(), Cutelyst::DispatchTypeChained::expandAction(), Cutelyst::RenderView::init(), Cutelyst::DispatchTypeChained::list(), Cutelyst::DispatchTypeChained::registerAction(), Cutelyst::DispatchTypePath::registerAction(), setAttributes(), Cutelyst::DispatchTypeChained::uriForAction(), and Cutelyst::DispatchTypePath::uriForAction().

◆ className()

QString Action::className ( ) const

nodiscardnoexcept

Returns the name of the component where this action is defined.

Definition at line 86 of file action.cpp.

References Action().

Referenced by Cutelyst::RenderView::RenderView().

◆ controller()

Controller * Action::controller ( ) const

nodiscardnoexcept

Returns the controller where this action is defined.

Definition at line 92 of file action.cpp.

References Action().

Referenced by Cutelyst::Dispatcher::dispatch(), and setController().

◆ dispatch()

bool Cutelyst::Action::dispatch ( Context * c )

inline

Dispatch this action against context c.

Definition at line 88 of file action.h.

References dispatch().

Referenced by Cutelyst::Controller::_DISPATCH(), dispatch(), Cutelyst::ActionChain::doExecute(), and Cutelyst::Dispatcher::forward().

◆ doExecute()

bool Action::doExecute ( Context * c )

overrideprotectedvirtual

Execute this action against context c.

Reimplemented from Cutelyst::Component.

Reimplemented in Cutelyst::ActionChain, Cutelyst::ActionREST, and Cutelyst::RenderView.

Definition at line 136 of file action.cpp.

References Action(), QList::append(), QList::at(), Cutelyst::Context::detach(), Cutelyst::Context::detached(), Qt::DirectConnection, Cutelyst::Context::request, Cutelyst::Context::setState(), and QList::value().

Referenced by Cutelyst::ActionREST::doExecute(), and Cutelyst::RenderView::doExecute().

◆ match()

bool Action::match ( int numberOfArgs ) const

nodiscardvirtualnoexcept

Check Args attribute, and makes sure number of args matches the setting. Always returns true if Args is omitted.

Definition at line 98 of file action.cpp.

References Action(), and numberOfArgs().

◆ matchCaptures()

bool Action::matchCaptures ( int numberOfCaptures ) const

nodiscardvirtualnoexcept

Can be implemented by action class and action role authors. If the method exists, then it will be called with the request context and an array reference of the captures for this action.

Returning true from this method causes the chain match to continue, returning false makes the chain not match (and alternate, less preferred chains will be attempted).

Definition at line 108 of file action.cpp.

References Action(), and numberOfCaptures().

◆ modifiers()

Component::Modifiers Action::modifiers ( ) const

overridevirtual

Always returns Component::OnlyExecute.

Reimplemented from Cutelyst::Component.

Definition at line 23 of file action.cpp.

Referenced by ~Action().

◆ ns()

QString Action::ns ( ) const

nodiscardnoexcept

Returns the private namespace this action lives in.

Definition at line 118 of file action.cpp.

References Action().

◆ numberOfArgs()

qint8 Action::numberOfArgs ( ) const

nodiscardvirtual

Returns the number of args this action expects. This is 0 if the action doesn’t take any arguments and undef if it will take any number of arguments.

Definition at line 124 of file action.cpp.

References Action().

Referenced by Cutelyst::DispatchTypePath::list(), match(), and Cutelyst::DispatchTypePath::match().

◆ numberOfCaptures()

qint8 Action::numberOfCaptures ( ) const

nodiscardvirtual

Returns the number of captures this action expects for Chained actions.

Reimplemented in Cutelyst::ActionChain.

Definition at line 130 of file action.cpp.

References Action().

Referenced by Cutelyst::ActionChain::doExecute(), Cutelyst::DispatchTypeChained::list(), matchCaptures(), Cutelyst::Context::uriFor(), and Cutelyst::DispatchTypeChained::uriForAction().

◆ setAttributes()

void Action::setAttributes ( const ParamsMultiMap & attributes )

Defines the action’s attibutes that were defined using the C_ATTR macro on Controller’s method declaration.

Definition at line 80 of file action.cpp.

References Action(), and attributes().

Referenced by Cutelyst::ActionChain::ActionChain(), and Cutelyst::DispatchTypeChained::registerAction().

◆ setController()

void Action::setController ( Controller * controller )

protected

Sets the controller which this action belongs to.

Definition at line 41 of file action.cpp.

References Action(), and controller().

Referenced by Cutelyst::ActionChain::ActionChain().

◆ setMethod()

void Action::setMethod ( const QMetaMethod & method )

protected

Sets the method to be invoked by this action.

Definition at line 28 of file action.cpp.

References Action(), QMetaType::Bool, QMetaMethod::parameterCount(), QMetaMethod::parameterType(), QMetaType::QStringList, and QMetaMethod::returnType().

◆ setupAction()

void Action::setupAction	(	const QVariantHash &	args,
		Application *	app )

protected

Called by dispatcher to setup the action.

Definition at line 47 of file action.cpp.

References Action(), Cutelyst::Component::init(), QString::isEmpty(), and QString::toInt().

Referenced by Cutelyst::ActionChain::ActionChain().

◆ ControllerPrivate

friend class ControllerPrivate

friend

Definition at line 128 of file action.h.

◆ Dispatcher

friend class Dispatcher

friend

Definition at line 127 of file action.h.

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Action() [1/2]

◆ ~Action()

◆ Action() [2/2]

Member Function Documentation

◆ attribute()

◆ attributes()

◆ className()

◆ controller()

◆ dispatch()

◆ doExecute()

◆ match()

◆ matchCaptures()

◆ modifiers()

◆ ns()

◆ numberOfArgs()

◆ numberOfCaptures()

◆ setAttributes()

◆ setController()

◆ setMethod()

◆ setupAction()

Friends And Related Symbol Documentation

◆ ControllerPrivate

◆ Dispatcher