agent.hpp

Go to the documentation of this file.

/*
Copyright (c) 2025 acrion innovations GmbH
Authors: Stefan Zipproth, s.zipproth@acrion.ch
 
This file is part of nexuslua, see https://github.com/acrion/nexuslua and https://nexuslua.org
 
nexuslua is offered under a commercial and under the AGPL license.
For commercial licensing, contact us at https://acrion.ch/sales. For AGPL licensing, see below.
 
AGPL licensing:
 
nexuslua is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
 
nexuslua 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. See the
GNU Affero General Public License for more details.
 
You should have received a copy of the GNU Affero General Public License
along with nexuslua. If not, see <https://www.gnu.org/licenses/>.
*/
 
#pragma once
 
#include "agent_message.hpp"
 
#include "lua_table.hpp"
 
#include "agents.hpp"
#include "cpp_handler.hpp"
#include "message.hpp"
 
#include "nexuslua_export.h"
 
#include <filesystem>
#include <functional>
#include <map>
#include <memory>
#include <string>

namespace nexuslua
{
    class Agent;
    class Configuration;
 
    namespace LuaExtension
    {
        void AddMessage(Agent* agent, const std::string& luaPath, const std::string& messageName, const LuaTable& parameters);
        void RegisterTableForAgent(const Agent* agent, const nexuslua::LuaTable& table);
    }

    class NEXUSLUA_EXPORT Agent
    {
        struct Impl;
        std::unique_ptr<Impl> _impl;
 
    public:
        Agent(const std::shared_ptr<agents>& agents);
        virtual ~Agent();
 
        virtual std::string                                GetName() const = 0;                              
        virtual std::filesystem::path                      GetInstallFolder() const;                         
        virtual std::filesystem::path                      GetPersistentFolder() const;                      
        virtual std::string                                GetVersionOnline() const;                         
        virtual std::string                                GetVersionInstalled() const;                      
        virtual bool                                       IsFreeware() const;                               
        virtual std::string                                GetUrlHelp() const;                               
        virtual std::string                                GetUrlDownload() const;                           
        virtual std::string                                GetUrlLicense() const;                            
        virtual std::string                                GetUrlPurchase() const;                           
        virtual std::string                                GetLicensee() const;                              
        virtual const std::map<std::string, AgentMessage>& GetMessages() const;                              
        virtual const AgentMessage&                        GetMessage(const std::string& messageName) const; 
        int                                                GetId() const;                                    
 
        Configuration&          GetConfiguration();
        std::shared_ptr<agents> GetAgents();
 
    protected:
        void         Start(const std::filesystem::path& luaPath, const std::string& luaCode);
        void         Start(const CppHandler& cppHandler);
        virtual void AddMessage(const std::string& messageName, const LuaTable::nested_tables& parameterDescriptions, const std::string& displayName, const std::string& description, const std::string& icon);
 
        std::map<std::string, AgentMessage> _messages;
        friend void ::nexuslua::LuaExtension::AddMessage(Agent* agent, const std::string& luaPath, const std::string& messageName, const LuaTable& parameters);
    };
}