feather/src/utils/Utils.h

// SPDX-License-Identifier: BSD-3-Clause
// SPDX-FileCopyrightText: 2020-2024 The Monero Project

#ifndef FEATHER_UTILS_H
#define FEATHER_UTILS_H

#include <QRegularExpression>
#include <QTextCharFormat>
#include <QMessageBox>
#include <QSettings>
#include <QStandardItem>
#include <QMetaEnum>

#include "networktype.h"

class SubaddressIndex;

namespace Utils
{
    enum MessageType
    {
        INFO = 0,
        WARNING,
        ERROR
    };

    struct Message
    {
        QWidget *parent;
        MessageType type;
        QString title;
        QString description;
        QStringList helpItems;
        QString doc;
        QString highlight;
        QString link;

        QString toString() const {
            return QString("%1: %2").arg(title, description);
        }
    };

    bool fileExists(const QString &path);
    QByteArray fileOpen(const QString &path);
    QByteArray fileOpenQRC(const QString &path);
    QString loadQrc(const QString &qrc);
    bool fileWrite(const QString &path, const QString &data);
    bool pixmapWrite(const QString &path, const QPixmap &pixmap);
    QStringList fileFind(const QRegularExpression &pattern, const QString &baseDir, int level, int depth, int maxPerDir);

    QString getSaveFileName(QWidget *parent, const QString &caption, const QString &filename, const QString &filter);
    QString getOpenFileName(QWidget *parent, const QString &caption, const QString &filter);

    QString portablePath();
    bool isPortableMode();
    bool portableFileExists(const QString &dir);
    QString ringDatabasePath();

    bool dirExists(const QString &path);
    QString defaultWalletDir();
    QString applicationPath();
    QString applicationFilePath();

    bool validateJSON(const QByteArray &blob);
    bool readJsonFile(QIODevice &device, QSettings::SettingsMap &map);
    bool writeJsonFile(QIODevice &device, const QSettings::SettingsMap &map);

    void copyToClipboard(const QString &string);
    QString copyFromClipboard();
    void copyColumn(QModelIndex * index, int column);

    QString xdgDesktopEntry();
    bool xdgDesktopEntryWrite(const QString &path);
    void xdgRefreshApplications();
    bool xdgDesktopEntryRegister();

    bool portOpen(const QString &hostname, quint16 port);
    quint16 getDefaultRpcPort(NetworkType::Type type);
    bool isTorsocks();

    double roundSignificant(double N, double n);
    int maxLength(const QVector<QString> &array);
    QString formatBytes(quint64 bytes);

    QLocale getCurrencyLocale(const QString &currencyCode);
    QString amountToCurrencyString(double amount, const QString &currencyCode);

    QStandardItem *qStandardItem(const QString &text);
    QStandardItem *qStandardItem(const QString &text, QFont &font);

    QString blockExplorerLink(const QString &txid);
    void externalLinkWarning(QWidget *parent, const QString &url);

    QString displayAddress(const QString& address, int sections = 3, const QString & sep = " ");
    QTextCharFormat addressTextFormat(const SubaddressIndex &index, quint64 amount);

    QFont getMonospaceFont();
    QFont relativeFont(int delta);

    void applicationLogHandler(QtMsgType type, const QMessageLogContext &context, const QString &msg);
    QString barrayToString(const QByteArray &data);

    bool isLocalUrl(const QUrl &url);

    template<typename QEnum>
    QString QtEnumToString (QEnum value) {
        return QString::fromStdString(std::string(QMetaEnum::fromType<QEnum>().valueToKey(value)));
    }

    void showError(QWidget *parent, const QString &title, const QString &description = "", const QStringList &helpItems = {}, const QString &doc = "", const QString &highlight = "", const QString &link = "");
    void showInfo(QWidget *parent, const QString &title, const QString &description = "", const QStringList &helpItems = {}, const QString &doc = "", const QString &highlight = "", const QString &link = "");
    void showWarning(QWidget *parent, const QString &title, const QString &description = "", const QStringList &helpItems = {}, const QString &doc = "", const QString &highlight = "", const QString &link = "");
    void showMsg(QWidget *parent, QMessageBox::Icon icon, const QString &windowTitle, const QString &title, const QString &description, const QStringList &helpItems = {}, const QString &doc = "", const QString &highlight = "", const QString &link = "");
    void showMsg(const Message &message);

    void openDir(QWidget *parent, const QString &message, const QString& dir);

    QWindow* windowForQObject(QObject* object);
    void clearLayout(QLayout *layout, bool deleteWidgets = true);

    QString formatSyncStatus(quint64 height, quint64 target, bool daemonSync = false);
}

#endif //FEATHER_UTILS_H