DetailDialogBase.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
 *
 * This program 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 program 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 General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef ORES_QT_DETAIL_DIALOG_BASE_HPP
#define ORES_QT_DETAIL_DIALOG_BASE_HPP
 
#include <chrono>
#include <optional>
#include <string>
#include <string_view>
#include <QWidget>
#include "ores.qt/ChangeReasonDialog.hpp"
#include "ores.qt/export.hpp"
 
class QTabWidget;
 
namespace ores::qt {
 
class ChangeReasonCache;
class ProvenanceWidget;
 
class ORES_QT_API DetailDialogBase : public QWidget {
    Q_OBJECT
 
public:
    using QWidget::QWidget;
    ~DetailDialogBase() override;
 
    virtual bool hasUnsavedChanges() const { return false; }
 
    bool isCloseConfirmed() const { return closeConfirmed_; }
 
    void setChangeReasonCache(ChangeReasonCache* cache) { changeReasonCache_ = cache; }
 
signals:
    void closeRequested();
 
    void statusMessage(const QString& message);
 
    void errorMessage(const QString& message);
 
protected slots:
    void onCloseClicked();
 
protected:
    void requestClose() { emit closeRequested(); }
 
    void notifySaveSuccess(const QString& message) {
        emit statusMessage(message);
        requestClose();
    }
 
    // -------------------------------------------------------------------------
    // Pure-virtual accessors — each derived dialog provides one-liner overrides
    // that return the corresponding widget from its own ui_ object.
    // -------------------------------------------------------------------------
 
    virtual QTabWidget* tabWidget() const = 0;
 
    virtual QWidget* provenanceTab() const = 0;
 
    virtual ProvenanceWidget* provenanceWidget() const = 0;
 
    // -------------------------------------------------------------------------
    // Shared helpers — call from setCreateMode() and updateUiFrom*()
    // -------------------------------------------------------------------------
 
    template<typename T>
    static std::optional<T> nulloptIfZero(T v) {
        return v != T{} ? std::optional<T>(v) : std::nullopt;
    }
 
    void setProvenanceEnabled(bool enabled);
 
    void populateProvenance(int version,
                            const std::string& modified_by,
                            const std::string& performed_by,
                            std::chrono::system_clock::time_point recorded_at,
                            const std::string& change_reason_code,
                            const std::string& change_commentary);
 
    void clearProvenance();
 
    // -------------------------------------------------------------------------
    // Change reason prompt — centralised for all operation types
    // -------------------------------------------------------------------------
 
    struct change_reason_selection {
        std::string reason_code;
        std::string commentary;
    };
 
    std::optional<change_reason_selection>
    promptChangeReason(ChangeReasonDialog::OperationType opType,
                       bool isDirty,
                       std::string_view category = "system");
 
private:
    bool closeConfirmed_ = false;
    ChangeReasonCache* changeReasonCache_ = nullptr;
};
 
}
 
#endif