cafApplication.h

// ##################################################################################################
//
//    Caffa Toolkit
//    Copyright (C) Kontur AS
//
//    This library may be used under the terms of either the GNU General Public License or
//    the GNU Lesser General Public License as follows:
//
//    GNU General Public License Usage
//    This library is free software: you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation, either version 3 of the License, or
//    (at your option) any later version.
//
//    This library is distributed in the hope that it will be useful, but WITHOUT ANY
//    WARRANTY; without even the implied warranty of MERCHANTABILITY or
//    FITNESS FOR A PARTICULAR PURPOSE.
#pragma once
 
#include <nlohmann/json.hpp>
 
#include <list>
#include <set>
#include <string>
 
namespace caffa
{
class Document;
 
struct AppInfo
{
    enum class AppCapability : unsigned int
    {
        CONSOLE = 0x00, 
        SERVER  = 0x01, 
        CLIENT  = 0x02, 
        GUI     = 0x04 
    };
 
    std::string name;
    int majorVersion;
    int minorVersion;
    int patchVersion;
    unsigned int appType;
 
    bool hasCapability( AppCapability typeToCheck ) const
    {
        return ( appType & static_cast<unsigned int>( typeToCheck ) ) != 0u;
    }
 
    std::string version_string() const
    {
        return std::to_string( majorVersion ) + "." + std::to_string( minorVersion ) + "." + std::to_string( patchVersion );
    }
};
 
void to_json( nlohmann::json& jsonValue, const AppInfo& appInfo );
void from_json( const nlohmann::json& jsonValue, AppInfo& appInfo );
 
class Application
{
public:
    Application( unsigned int capabilities );
    Application( AppInfo::AppCapability capability );
    virtual ~Application();
 
    virtual std::string name() const = 0;
    bool                hasCapability( AppInfo::AppCapability typeToCheck ) const;
    AppInfo             appInfo() const;
 
    virtual int majorVersion() const = 0;
    virtual int minorVersion() const = 0;
    virtual int patchVersion() const = 0;
 
    static Application* instance();
    static void         registerInstance( Application* instance );
 
    static void assertCapability( AppInfo::AppCapability typeToAssert );
 
private:
    static Application* s_instance;
 
    unsigned int m_capabilities;
};
 
} // namespace caffa