cutelyst 3.9.1
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
Public Member Functions | List of all members
Cutelyst::DispatchTypePath Class Referencefinal
Inheritance diagram for Cutelyst::DispatchTypePath:
Inheritance graph
[legend]

Public Member Functions

 DispatchTypePath (QObject *parent=nullptr)
 
virtual bool inUse () override
 
virtual QByteArray list () const override
 list the registered actions To be implemented by subclasses
 
virtual MatchType match (Context *c, const QString &path, const QStringList &args) const override
 
virtual bool registerAction (Action *action) override
 registerAction
 
virtual QString uriForAction (Action *action, const QStringList &captures) const override
 
- Public Member Functions inherited from Cutelyst::DispatchType
 DispatchType (QObject *parent=nullptr)
 
virtual ActionexpandAction (const Context *c, Action *action) const
 
virtual bool inUse ()=0
 
virtual bool isLowPrecedence () const
 
virtual QByteArray list () const =0
 list the registered actions To be implemented by subclasses
 
virtual MatchType match (Context *c, const QString &path, const QStringList &args) const =0
 
virtual bool registerAction (Action *action)
 registerAction
 
virtual QString uriForAction (Action *action, const QStringList &captures) const =0
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, 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
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_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_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
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 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)
 
QThreadthread () const const
 

Additional Inherited Members

- Public Types inherited from Cutelyst::DispatchType
enum  MatchType { NoMatch , PartialMatch , ExactMatch }
 
- 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)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from Cutelyst::DispatchType
void setupMatchedAction (Context *c, Action *action) const
 
- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Definition at line 15 of file dispatchtypepath.h.

Constructor & Destructor Documentation

◆ DispatchTypePath()

DispatchTypePath::DispatchTypePath ( QObject parent = nullptr)
explicit

Constructs a DispatchTypePath object with the given parent.

Definition at line 16 of file dispatchtypepath.cpp.

◆ ~DispatchTypePath()

DispatchTypePath::~DispatchTypePath ( )
overridevirtual

Definition at line 22 of file dispatchtypepath.cpp.

Member Function Documentation

◆ inUse()

bool DispatchTypePath::inUse ( )
overridevirtual

If false the dispatcher will be unregistered for performance reasons. This method can be used to prepare actions for dispatcher as in a Chain of Actions there is no garantee of registering order.

In the common case if the dispatcher has registered any action, or in some special case that it doesn't need actions it will return true.

Implements Cutelyst::DispatchType.

Definition at line 121 of file dispatchtypepath.cpp.

◆ list()

QByteArray DispatchTypePath::list ( ) const
overridevirtual

◆ match()

Cutelyst::DispatchType::MatchType DispatchTypePath::match ( Context c,
const QString path,
const QStringList args 
) const
overridevirtual

Return true if the dispatchType matches the given path

Implements Cutelyst::DispatchType.

Definition at line 65 of file dispatchtypepath.cpp.

References QString::isEmpty(), Cutelyst::Request::setArguments(), Cutelyst::Request::setMatch(), Cutelyst::DispatchType::setupMatchedAction(), and QList::size().

◆ registerAction()

bool DispatchTypePath::registerAction ( Action action)
overridevirtual
Parameters
action
Returns

Reimplemented from Cutelyst::DispatchType.

Definition at line 104 of file dispatchtypepath.cpp.

References Cutelyst::Action::attributes(), and QMap::equal_range().

◆ uriForAction()

QString DispatchTypePath::uriForAction ( Cutelyst::Action action,
const QStringList captures 
) const
overridevirtual

Get a URI part for an action Always returns NULL if captures is not empty since Path actions don't have captures

Implements Cutelyst::DispatchType.

Definition at line 127 of file dispatchtypepath.cpp.

References Cutelyst::Action::attributes(), QMultiMap::constFind(), QList::isEmpty(), QString::isEmpty(), and QString::startsWith().