Cutelyst  1.5.0
dispatchtype.h
1 /*
2  * Copyright (C) 2013-2015 Daniel Nicoletti <dantti12@gmail.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB. If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19 
20 #ifndef DISPATCHTYPE_H
21 #define DISPATCHTYPE_H
22 
23 #include <QtCore/qobject.h>
24 #include <QtCore/qstringlist.h>
25 
26 #include <Cutelyst/cutelyst_global.h>
27 
28 namespace Cutelyst {
29 
30 class Context;
31 class Action;
32 class Request;
33 class CUTELYST_LIBRARY DispatchType : public QObject
34 {
35  Q_OBJECT
36 public:
37  enum MatchType {
38  NoMatch = 0,
39  PartialMatch,
40  ExactMatch
41  };
42  explicit DispatchType(QObject *parent = nullptr);
43  virtual ~DispatchType();
44 
49  virtual QByteArray list() const = 0;
50 
54  virtual MatchType match(Context *c, const QString &path, const QStringList &args) const = 0;
55 
59  virtual QString uriForAction(Action *action, const QStringList &captures) const = 0;
60 
61  virtual Action *expandAction(Context *c, Action *action) const;
62 
68  virtual bool registerAction(Action *action);
69 
80  virtual bool inUse() = 0;
81 
87  virtual bool isLowPrecedence() const;
88 
89 protected:
90  friend class Dispatcher;
91  friend class Application;
92 
93  void setupMatchedAction(Context *c, Action *action) const;
94 };
95 
96 }
97 
98 #endif // DISPATCHTYPE_H
This class represents a Cutelyst Action.
Definition: action.h:49
The Cutelyst Context.
Definition: context.h:52
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7
The Cutelyst Application.
Definition: application.h:55
The Cutelyst Dispatcher.
Definition: dispatcher.h:41