context.h

/*******************************************************************************
 * Copyright (C) 2015-2024 Commissariat a l'energie atomique et aux energies alternatives (CEA)
 * Copyright (C) 2021 Institute of Bioorganic Chemistry Polish Academy of Science (PSNC)
 * Copyright (C) 2026 Julien Bigot <julien@julien-bigot.fr>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * * Neither the name of CEA nor the names of its contributors may be used to
 *   endorse or promote products derived from this software without specific
 *   prior written permission.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 ******************************************************************************/
 
#ifndef PDI_CONTEXT_H_
#define PDI_CONTEXT_H_
 
#include <functional>
#include <memory>
#include <string>
#include <unordered_map>
 
#include <pdi/pdi_fwd.h>
#include <pdi/data_descriptor.h>
#include <pdi/datatype_template.h>
#include <pdi/ref_any.h>
 
namespace PDI {
 
class PDI_EXPORT Context
{
public:
    class Iterator
    {
        friend class Context;
        std::unordered_map<std::string, std::unique_ptr<Data_descriptor>>::iterator m_data;
        Iterator(const std::unordered_map<std::string, std::unique_ptr<Data_descriptor>>::iterator& data);
        Iterator(std::unordered_map<std::string, std::unique_ptr<Data_descriptor>>::iterator&& data);
 
    public:
        Data_descriptor* operator->();
        Data_descriptor& operator* ();
        Iterator& operator++ ();
        bool operator!= (const Iterator&);
        bool operator== (const Iterator&);
    };

    typedef std::function<Datatype_template_sptr(Context&, PC_tree_t)> Datatype_template_parser;
 
protected:
    Iterator get_iterator(const std::unordered_map<std::string, std::unique_ptr<Data_descriptor>>::iterator& data);
 
    Iterator get_iterator(std::unordered_map<std::string, std::unique_ptr<Data_descriptor>>::iterator&& data);
 
public:
    virtual ~Context();

    virtual Data_descriptor& desc(const std::string& name) = 0;

    virtual Data_descriptor& desc(const char* name) = 0;

    virtual Data_descriptor& operator[] (const std::string& name) = 0;

    virtual Data_descriptor& operator[] (const char* name) = 0;

    virtual Iterator begin() = 0;

    virtual Iterator end() = 0;

    virtual Iterator find(const std::string& name) = 0;

    virtual void event(const char* name) = 0;

    virtual Datatype_template_sptr datatype(PC_tree_t node) = 0;

    virtual void add_datatype(const std::string& name, Datatype_template_parser parser) = 0;

    virtual std::function<void()> on_init(const std::function<void()>& callback) = 0;

    virtual std::function<void()> on_data(const std::function<void(const std::string&, Ref)>& callback, const std::string& name = {}) = 0;

    virtual std::function<void()> on_data_remove(const std::function<void(const std::string&, Ref)>& callback, const std::string& name = {}) = 0;

    virtual std::function<void()> on_event(const std::function<void(const std::string&)>& callback, const std::string& name = {}) = 0;

    virtual std::function<void()> on_missing_data(const std::function<void(const std::string&)>& callback, const std::string& name = {}) = 0;
};

class PDI_EXPORT Timer_event_handler
{
private:
    Context& m_ctx;
 
    const std::string m_plugin_name;
 
public:
    Timer_event_handler(Context& ctx, const std::string& plugin_name);

    ~Timer_event_handler();
};

using TimerEventHandler [[deprecated("use Timer_event_handler instead")]] = Timer_event_handler;
 
} // namespace PDI
 
#endif // PDI_CONTEXT_H_