version-pc-pid-upload/CPPWebFramework/cwf/cppwebapplication.h

/*
 Copyright 2017 Herik Lima de Castro and Marcelo Medeiros Eler
 Distributed under MIT license, or public domain if desired and
 recognized in your jurisdiction.
 See file LICENSE for detail.
*/

/**
  * @mainpage The C++ Web Framework
  *
  * ​​The C++ Web Framework (CWF) is a MVC web framework, Open Source, under MIT License, created by Herik Lima and Marcelo Eler,
  * using C++ with Qt to be used in the development of web applications. The CWF was designed to consume few computational resources,
  * such as memory and processing, and have a low response time for requests. With MVC (Model-View-Controller) architecture,
  * you can create classes to take care of the business layer (Model), use CSTL (C++ Server Pages Standard Tag Library)
  * within the Web Pages to take care of data presentation (View) and use the controllers as a between the two layers (Controller).
  *
  * Because it is created in Qt, the C++ Web Framework can run on the same platforms supported by Qt:
  *
  *
  * Desktop: Linux, OS X, Windows
  * Embedded and RTOS: Linux, QNX, VxWorks, Windows
  * Mobile: Android, iOS, Windows
  *
  *
  * The CWF has only one configuration file, called CPPWeb.ini and a policy of using only C++ and Qt in the development
  * of its components in order to avoid the installation of numerous libraries to avoid conflicts, maintain multiplatform characteristics,
  * facilitate installation and keep the learning curve low in order to make web development as simple as possible, even for beginners.
  */

#ifndef CPPWEBAPPLICATION_H
#define CPPWEBAPPLICATION_H

#include <QString>
#include <QCoreApplication>
#include <QMessageLogContext>
#include "cppwebserver.h"
#include "cppwebframework_global.h"

CWF_BEGIN_NAMESPACE
/**
 * @brief This class is responsible for encapsulating the QCoreApplication, the
 * CppWebServer and configure the server logging mechanism.
 */
class CPPWEBFRAMEWORKSHARED_EXPORT CppWebApplication
{
    Configuration    configuration;
    CppWebServer     *server;
    bool valid = false;
    CppWebApplication(const CppWebApplication &other) = delete;
    CppWebApplication &operator=(const CppWebApplication &other) = delete;        
public:
    /**
     * @brief Constructs a QCoreApplication, a CppWebServer and install the message handler.
     * if the server folder's path was not found in the serverPath, it will look into the executable's folder.
     * @param int argc                    : Main function parameter used to build QCoreApplication.
     * @param char *argv[]                : Main function parameter used to build QCoreApplication.
     * @param const Configuration &config : Used to set the parameters of the server.
     * @param Filter *filter              : Install a filter for requests on the server.
     */
    CppWebApplication(const QString &serverPath, Filter *filter = nullptr);
    /**
     * @brief Destroys the server dynamically allocated.
     */
    ~CppWebApplication();
    /**
     * @brief Hitches a url to a Controller.
     * @param const QString &url   : Url name.
     * @param Controller *controller : Controller that will answer requests made to url.
     * @par Example
     * @code
     * #include <QCoreApplication>
     * #include <controllers/helloworldcontroller.h>
     * #include <cwf/cppwebapplication.h>
     *
     * int main(int argc, char *argv[])
     * {
     *      CWF::CppWebApplication server(argc, argv, "/PATH_TO_EXAMPLE/server"));
     *      server.addUrlController<HelloWorldController>("/hello");
     *      return server.start();
     * }
     * @endcode
     */
    template<typename CONTROLLER>
    void addController(const QString &url) noexcept
    {
        server->addController<CONTROLLER>(url);
    }
    /**
     * @brief Starts the server and QCoreApplication.
     * @return int : Returns -1 if it fails.
     */
    int start();
    int start(const QHostAddress &host, const int &port);
    bool close();
};

CWF_END_NAMESPACE

#endif // CPPWEBAPPLICATION_H