ExerciseTourResources.h

Go to the documentation of this file.

// Copyright 2015 - 2026, GIBIS-UNIFESP and the wiRedPanda contributors
// SPDX-License-Identifier: GPL-3.0-or-later

 
#pragma once
 
#include <QString>
#include <QStringList>
#include <QVector>

struct ExerciseTourResourceEntry {
    QString path;          
    QString id;            
    QString title;         
    QString description;   
};

class ExerciseTourResources
{
public:
    ExerciseTourResources() = delete;

    static QVector<ExerciseTourResourceEntry> scan(const QString &directory);

    static QVector<ExerciseTourResourceEntry> discover(const QString &category);

    static QString managedContentDir(const QString &category);

    static QString preferredContentDir(const QString &category);

    static QVector<ExerciseTourResourceEntry> mergeUnique(QVector<ExerciseTourResourceEntry> base,
                                                           const QVector<ExerciseTourResourceEntry> &additional);

    static QString translate(const QString &key, const QString &fallbackEnglish);

    static QString translateFromCatalog(const QString &catalogPath, const QString &key,
                                         const QString &fallbackEnglish);

    static QString resolveWritableDir(const QStringList &candidates, const QString &documentsFallback);
 
private:
    static QString documentsFallbackDir(const QString &category);
};