studylogs.h

/*
 * Copyright 2007-2025, 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_APPLICATION_WINDOWS_STUDY_LOGS_H__
#define __ANTARES_APPLICATION_WINDOWS_STUDY_LOGS_H__
 
#include <mutex>
#include <antares/study/study.h>
#include <yuni/core/event.h>
 
#include <wx/htmllbox.h>
#include <wx/html/htmlwin.h>
#include <wx/stattext.h>
#include <wx/timer.h>
#include <wx/treectrl.h>
 
#include "../application/study.h"
#include "../toolbox/components/datagrid/renderer/logfile.h"
#include <ui/common/component/frame/local-frame.h>
#include <ui/common/component/spotlight.h>
 
namespace Antares::Window
{
class CompareDesc final
{
public:
    bool operator()(const wxString& s1, const wxString& s2) const;
};
 
using MapFileList = std::map<wxString, YString, CompareDesc>;
 
class StudyLogs;
 
class FileListProvider final: public Component::Spotlight::IProvider
{
public:
    using Spotlight = Antares::Component::Spotlight;
    using Ptr = std::shared_ptr<FileListProvider>;
 
    explicit FileListProvider(StudyLogs& frame);
    ~FileListProvider() override;
 
    FileListProvider(const FileListProvider&) = delete;
    FileListProvider& operator=(const FileListProvider&) = delete;
 
    void search(Spotlight::IItem::Vector& out,
                const Spotlight::SearchToken::Vector& tokens,
                const Yuni::String& text = "") override;
    bool onSelect(Spotlight::IItem::Ptr& item) override;
    bool onSelect(const Spotlight::IItem::Vector&) override;
    void refreshFileList(bool showAll);
 
private:
    StudyLogs& pFrame;
    bool pAutoTriggerSelection;
    bool pShowAll;
    MapFileList pAllSimuLogs;
    MapFileList pAllUILogs;
    std::shared_ptr<wxBitmap> pBmpFile;
}; // class FileListProvider
 
class StudyLogs final: public Component::Frame::WxLocalFrame
{
public:
    using LogEntry = Component::Datagrid::Renderer::LogEntry;
    using LogEntryContainer = Component::Datagrid::Renderer::LogEntryContainer;
 
    class LogFilenameInfo final
    {
    public:
        struct ltstr final
        {
            bool operator()(const Yuni::String& s1, const Yuni::String& s2) const
            {
                return s2 < s1;
            }
        };
 
        using Map = std::map<Yuni::String, LogFilenameInfo, ltstr>;
 
    public:
        wxString html;
        wxClientData* clientData;
    };
 
public:
    // \name Constructors & Destructor
 
    StudyLogs(wxFrame* parent);
    virtual ~StudyLogs();
 
    void refreshListOfAllAvailableLogs();
 
    void loadFromFile(const Yuni::String& filename);
 
    const Yuni::String& lastLogFile() const
    {
        return pLastLogFile;
    }
 
    void reloadFromData(LogEntryContainer::Ptr entries, LogEntryContainer::Ptr errors);
 
private:
    void onButtonRefreshFileList(void*);
    void onReloadLogFile(void*);
 
    void onClose(wxCloseEvent& evt);
 
    void enterLoadingMode(const Yuni::String& filename);
 
    void onChangeShowAllAdvanced(wxCommandEvent&);
 
private:
    Yuni::String pLastLogFile;
    Component::Button* pBtnLogFilenameRefresh;
    wxStaticText* pTxtFromFolder;
    Component::Datagrid::Component* pLogDisplay;
    Component::Datagrid::Component* pLogDisplayErrors;
    Component::Notebook* pNotebook;
 
    Component::Datagrid::Renderer::LogFile* pRendererEntries;
    Component::Datagrid::Renderer::LogFile* pRendererEntriesErrors;
    wxSplitterWindow* pSplitter;
 
    bool pCanCloseTheWindow;
 
    LogFilenameInfo::Map pLogFilenameInfo;
 
    std::mutex pLoadingMutex;
 
    bool pShowAllLogsFiles;
 
    FileListProvider::Ptr mProvider;
 
    Yuni::Event<void(bool)> onRefreshListOfFiles;
 
    // Event Table
    DECLARE_EVENT_TABLE()
 
}; // class StudyLogs
 
} // namespace Antares::Window
 
#endif // __ANTARES_APPLICATION_WINDOWS_STUDY_LOGS_H__