Holds a chain of Cutelyst actions. More...

#include <Cutelyst/ActionChain>

Inheritance diagram for Cutelyst::ActionChain:

[legend]

Public Member Functions
	ActionChain (const ActionList &chain, QObject *parent=nullptr)

virtual	~ActionChain () override=default

ActionList	chain () const noexcept

qint8	numberOfCaptures () const noexcept override

Public Member Functions inherited from Cutelyst::Action
	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

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)

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 (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &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	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	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_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	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_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	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Protected Member Functions
bool	doExecute (Context *c) override

Protected Member Functions inherited from Cutelyst::Action
	Action (ActionPrivate ptr, QObject parent=nullptr)

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)

Additional Inherited Members
Public Types inherited from Cutelyst::Component
enum	Modifier { None , OnlyExecute , BeforeExecute , AroundExecute , AfterExecute }

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
typedef	QObjectList

Properties inherited from QObject
	objectName

Detailed Description

This class represents a chain of Cutelyst actions. It behaves exactly like the action at the end of the chain except on dispatch it will execute all the actions in the chain in order.

Definition at line 25 of file actionchain.h.

Constructor & Destructor Documentation

◆ ActionChain()

ActionChain::ActionChain	(	const ActionList &	chain,
		QObject *	parent = `nullptr`
	)

explicit

Constructs a new ActionChain object with the given chain and parent.

Definition at line 11 of file actionchain.cpp.

References chain(), Cutelyst::Action::setAttributes(), Cutelyst::Action::setController(), Cutelyst::Component::setName(), Cutelyst::Component::setReverse(), and Cutelyst::Action::setupAction().

◆ ~ActionChain()

virtual Cutelyst::ActionChain::~ActionChain ( )

overridevirtualdefault

Destroys the ActionChain object.

Member Function Documentation

◆ chain()

ActionList ActionChain::chain ( ) const

noexcept

Returns a list of Action objects encapsulated by this chain.

Definition at line 36 of file actionchain.cpp.

Referenced by ActionChain(), and doExecute().

◆ doExecute()

bool ActionChain::doExecute ( Context * c )

overrideprotectedvirtual

Execute this action against context c.

Reimplemented from Cutelyst::Action.

Definition at line 48 of file actionchain.cpp.

References QList::append(), QList::at(), Cutelyst::Request::captures(), chain(), Cutelyst::Action::dispatch(), QList::last(), Cutelyst::Action::numberOfCaptures(), Cutelyst::Context::request, Cutelyst::Request::setArguments(), and QList::size().

◆ numberOfCaptures()

qint8 ActionChain::numberOfCaptures ( ) const

overridevirtualnoexcept

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

Reimplemented from Cutelyst::Action.

Definition at line 42 of file actionchain.cpp.

Public Member Functions

Protected Member Functions

Additional Inherited Members