jit.h

/*
** Copyright 2007-2024, RTE (https://www.rte-france.com)
** See AUTHORS.txt
** SPDX-License-Identifier: MPL-2.0
** This file is part of Antares-Simulator,
** Adequacy and Performance assessment for interconnected energy networks.
**
** Antares_Simulator is free software: you can redistribute it and/or modify
** it under the terms of the Mozilla Public Licence 2.0 as published by
** the Mozilla Foundation, either version 2 of the License, or
** (at your option) any later version.
**
** Antares_Simulator 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
** Mozilla Public Licence 2.0 for more details.
**
** You should have received a copy of the Mozilla Public Licence 2.0
** along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
*/
#ifndef __ANTARES_LIBS_JIT_JIT_H__
#define __ANTARES_LIBS_JIT_JIT_H__
 
#include <yuni/core/fwd.h>
#include <yuni/core/string/string.h>
 
namespace Antares
{
template<class T, class ReadWriteT>
class Matrix;
}
 
class JIT final
{
public:
    // Forward declaration
    class Informations;
 
    static Informations* Reset(Informations* jit, const AnyString& filename);
 
    static Informations* Reset(Informations* jit);
 
    static void MarkAsNotLoaded(Informations* j);
 
    static void Invalidate(Informations* j);
 
    static bool IsReady(Informations* j);
 
public:
    class just_in_time_manager
    {
    public:
        just_in_time_manager(JIT::Informations* jit, const AnyString filename):
            jit_(jit),
            file_name_(filename)
        {
        }
 
        void record_current_jit_state(unsigned width, unsigned height);
 
        inline JIT::Informations* jit_recorded_state()
        {
            return jit_record_;
        }
 
        bool matrix_content_in_memory_is_same_as_on_disk()
        {
            return not jit_->modified;
        }
 
        bool jit_activated()
        {
            return jit_;
        }
 
        bool do_we_force_matrix_load_from_disk();
 
        template<class T, class ReadWriteT>
        void load_matrix(const Antares::Matrix<T, ReadWriteT>* mtx);
 
        template<class T, class ReadWriteT>
        void clear_matrix(const Antares::Matrix<T, ReadWriteT>* mtx);
 
        template<class T, class ReadWriteT>
        void unload_matrix_properly_from_memory(const Antares::Matrix<T, ReadWriteT>* mtx);
 
        ~just_in_time_manager()
        {
            delete jit_record_;
        }
 
    private:
        JIT::Informations* jit_;
        JIT::Informations* jit_record_;
        AnyString file_name_;
    };
 
public:
    class Informations final
    {
    public:
 
 
        Informations();
        Informations(const Informations& rhs);
        ~Informations();
 
        void markAsModified();
 
    public:
        YString sourceFilename;
 
        bool alreadyLoaded;
        bool modified;
        // The item will be considered as modified
        bool loadDataIfNotAlreadyDone;
 
        unsigned options;
        unsigned minWidth;
        unsigned maxHeight;
 
        unsigned estimatedSize[2];
 
        int64_t lastModification;
 
    }; // class Informations
 
public:
    static bool enabled;
 
    static bool usedFromGUI;
 
}; // class JIT
 
#include "jit.hxx"
 
#endif // __ANTARES_LIBS_JIT_JIT_H__