FileIOFilter.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
// CV_DB_LIB
#include <ecvHObject.h>
 
// Local
#include "ecvGlobalShiftManager.h"
 
class QWidget;
class ccHObject;
 
enum CC_FILE_ERROR {
    CC_FERR_NO_ERROR,
    CC_FERR_BAD_ARGUMENT,
    CC_FERR_UNKNOWN_FILE,
    CC_FERR_WRONG_FILE_TYPE,
    CC_FERR_WRITING,
    CC_FERR_READING,
    CC_FERR_NO_SAVE,
    CC_FERR_NO_LOAD,
    CC_FERR_BAD_ENTITY_TYPE,
    CC_FERR_CANCELED_BY_USER,
    CC_FERR_NOT_ENOUGH_MEMORY,
    CC_FERR_MALFORMED_FILE,
    CC_FERR_CONSOLE_ERROR,
    CC_FERR_BROKEN_DEPENDENCY_ERROR,
    CC_FERR_FILE_WAS_WRITTEN_BY_UNKNOWN_PLUGIN,
    CC_FERR_THIRD_PARTY_LIB_FAILURE,
    CC_FERR_THIRD_PARTY_LIB_EXCEPTION,
    CC_FERR_NOT_IMPLEMENTED,
    CC_FERR_INTERNAL,
};
 
 
class FileIOFilter {
public:
    virtual ~FileIOFilter() = default;
 
    struct LoadParameters {
        LoadParameters()
            : shiftHandlingMode(ecvGlobalShiftManager::DIALOG_IF_NECESSARY),
              alwaysDisplayLoadDialog(true),
              coordinatesShiftEnabled(nullptr),
              coordinatesShift(nullptr),
              preserveShiftOnSave(true),
              autoComputeNormals(false),
              parentWidget(nullptr),
              sessionStart(true) {}
 
        ecvGlobalShiftManager::Mode shiftHandlingMode;
        bool alwaysDisplayLoadDialog;
        bool* coordinatesShiftEnabled;
        CCVector3d* coordinatesShift;
        bool preserveShiftOnSave;
        bool autoComputeNormals;
        QWidget* parentWidget;
        bool sessionStart;
    };
 
    struct SaveParameters {
        SaveParameters()
            : alwaysDisplaySaveDialog(true), parentWidget(nullptr) {}
 
        bool alwaysDisplaySaveDialog;
        QWidget* parentWidget;
    };
 
    using Shared = QSharedPointer<FileIOFilter>;
 
public:  // public interface
    CV_IO_LIB_API bool importSupported() const;
 
    CV_IO_LIB_API bool exportSupported() const;
 
 
    CV_IO_LIB_API const QStringList& getFileFilters(bool onImport) const;
 
    CV_IO_LIB_API QString getDefaultExtension() const;
 
public:  // public interface (to be reimplemented by each I/O filter)
 
    virtual CC_FILE_ERROR loadFile(const QString& filename,
                                   ccHObject& container,
                                   LoadParameters& parameters) {
        Q_UNUSED(filename);
        Q_UNUSED(container);
        Q_UNUSED(parameters);
 
        return CC_FERR_NOT_IMPLEMENTED;
    }
 
 
    virtual CC_FILE_ERROR saveToFile(ccHObject* entity,
                                     const QString& filename,
                                     const SaveParameters& parameters) {
        Q_UNUSED(entity);
        Q_UNUSED(filename);
        Q_UNUSED(parameters);
 
        return CC_FERR_NOT_IMPLEMENTED;
    }
 
 
    virtual bool canSave(CV_CLASS_ENUM type,
                         bool& multiple,
                         bool& exclusive) const {
        Q_UNUSED(type);
        Q_UNUSED(multiple);
        Q_UNUSED(exclusive);
 
        return false;
    }
 
public:  // static methods
    CV_IO_LIB_API static QStringList ImportFilterList();
 
 
    CV_IO_LIB_API static ccHObject* LoadFromFile(const QString& filename,
                                                 LoadParameters& parameters,
                                                 Shared filter,
                                                 CC_FILE_ERROR& result);
 
 
    CV_IO_LIB_API static ccHObject* LoadFromFile(
            const QString& filename,
            LoadParameters& parameters,
            CC_FILE_ERROR& result,
            const QString& fileFilter = QString());
 
 
    CV_IO_LIB_API static CC_FILE_ERROR SaveToFile(
            ccHObject* entities,
            const QString& filename,
            const SaveParameters& parameters,
            Shared filter);
 
 
    CV_IO_LIB_API static CC_FILE_ERROR SaveToFile(
            ccHObject* entities,
            const QString& filename,
            const SaveParameters& parameters,
            const QString& fileFilter);
 
 
    CV_IO_LIB_API static bool HandleGlobalShift(
            const CCVector3d& P,
            CCVector3d& Pshift,
            bool& preserveCoordinateShift,
            LoadParameters& loadParameters,
            bool useInputCoordinatesShiftIfPossible = false);
 
 
    CV_IO_LIB_API static void DisplayErrorMessage(CC_FILE_ERROR err,
                                                  const QString& action,
                                                  const QString& filename);
 
    CV_IO_LIB_API static bool CheckForSpecialChars(const QString& filename);
 
public:  // loading "sessions" management
    CV_IO_LIB_API static void ResetSesionCounter();
 
 
    CV_IO_LIB_API static unsigned IncreaseSesionCounter();
 
public:  // global filters registration mechanism
    CV_IO_LIB_API static void InitInternalFilters();
 
    CV_IO_LIB_API static void Register(Shared filter);
 
    CV_IO_LIB_API static Shared GetFilter(const QString& fileFilter,
                                          bool onImport);
 
    CV_IO_LIB_API static Shared FindBestFilterForExtension(const QString& ext);
 
    using FilterContainer = std::vector<FileIOFilter::Shared>;
 
    CV_IO_LIB_API static const FilterContainer& GetFilters();
 
 
    CV_IO_LIB_API static void UnregisterAll();
 
 
    virtual void unregister() {}
 
public:
    enum FilterFeature {
        NoFeatures = 0x0000,
 
        Import = 0x00001,  //< Imports data
        Export = 0x0002,   //< Exports data
 
        BuiltIn = 0x0004,  //< Implemented in the core
 
        DynamicInfo = 0x0008,  //< FilterInfo cannot be set statically (this is
                               // used for internal consistency checking)
    };
    Q_DECLARE_FLAGS(FilterFeatures, FilterFeature)
 
protected:
    static constexpr float DEFAULT_PRIORITY = 25.0f;
 
    struct FilterInfo {
        QString id;
 
        float priority;
 
        QStringList importExtensions;
 
        QString defaultExtension;
 
        QStringList importFileFilterStrings;
 
        QStringList exportFileFilterStrings;
 
        FilterFeatures features;
    };
 
    CV_IO_LIB_API explicit FileIOFilter(const FilterInfo& info);
 
    void setImportExtensions(const QStringList& extensions);
 
    void setImportFileFilterStrings(const QStringList& filterStrings);
 
    void setExportFileFilterStrings(const QStringList& filterStrings);
 
private:
    void checkFilterInfo() const;
 
    FilterInfo m_filterInfo;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS(FileIOFilter::FilterFeatures)