qSlicerCoreIOManager.h

Go to the documentation of this file.

/*==============================================================================
 
  Program: 3D Slicer
 
  Copyright (c) Kitware Inc.
 
  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.
 
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
 
  This file was originally developed by Jean-Christophe Fillion-Robin, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1
 
==============================================================================*/
 
#ifndef __qSlicerCoreIOManager_h
#define __qSlicerCoreIOManager_h
 
// Qt includes
#include <QFileInfo>
#include <QImage>
#include <QList>
#include <QMap>
#include <QObject>
#include <QRegularExpression>
#include <QString>
#include <QVariantMap>
 
// CTK includes
#include <ctkPimpl.h>
 
// QtCore includes
#include <qSlicerIO.h>
#include "qSlicerBaseQTCoreExport.h"
 
class vtkMRMLMessageCollection;
class vtkMRMLNode;
class vtkMRMLStorableNode;
class vtkMRMLStorageNode;
class vtkCollection;
class vtkObject;
class qSlicerCoreIOManagerPrivate;
class qSlicerFileReader;
class qSlicerFileWriter;
class vtkMRMLFileIOHandler;
class vtkMRMLFileIOManager;
class vtkMRMLOperationProgress;

class Q_SLICER_BASE_QTCORE_EXPORT qSlicerCoreIOManager : public QObject
{
  Q_OBJECT;
  Q_PROPERTY(QString defaultSceneFileType READ defaultSceneFileType WRITE setDefaultSceneFileType)
  Q_PROPERTY(int defaultMaximumFileNameLength READ defaultMaximumFileNameLength WRITE setDefaultMaximumFileNameLength)
 
public:
  qSlicerCoreIOManager(QObject* parent = nullptr);
  ~qSlicerCoreIOManager() override;

  Q_INVOKABLE vtkMRMLFileIOManager* fileIOManager() const;

  Q_INVOKABLE qSlicerIO::IOFileType fileType(const QString& file) const;
  Q_INVOKABLE QList<qSlicerIO::IOFileType> fileTypes(const QString& file) const;

  Q_INVOKABLE qSlicerIO::IOFileType fileTypeFromDescription(const QString& fileDescription) const;

  Q_INVOKABLE QStringList fileDescriptions(const QString& file) const;

  Q_INVOKABLE QStringList fileDescriptionsByType(const qSlicerIO::IOFileType fileType) const;

  Q_INVOKABLE qSlicerFileWriter* writer(vtkObject* object, const QString& extension = QString()) const;

  Q_INVOKABLE qSlicerIO::IOFileType fileWriterFileType(vtkObject* object, const QString& extension = QString()) const;
 
  Q_INVOKABLE QStringList fileWriterDescriptions(const qSlicerIO::IOFileType& fileType) const;
  Q_INVOKABLE QStringList fileWriterExtensions(vtkObject* object) const;
  Q_INVOKABLE QStringList allWritableFileExtensions() const;
  Q_INVOKABLE QStringList allReadableFileExtensions() const;

  qSlicerIOOptions* fileOptions(const QString& fileDescription) const;

  qSlicerIOOptions* fileWriterOptions(vtkObject* object, const QString& extension) const;

  Q_INVOKABLE QString completeSlicerWritableFileNameSuffix(vtkMRMLStorableNode* node) const;

  Q_INVOKABLE static QRegularExpression fileNameRegularExpression(const QString& extension = QString());

  Q_INVOKABLE static QString forceFileNameValidCharacters(const QString& filename);

  Q_INVOKABLE QString forceFileNameMaxLength(const QString& filename, int extensionLength, int maxLength = -1);

  int defaultMaximumFileNameLength() const;

  Q_INVOKABLE QString extractKnownExtension(const QString& fileName, vtkObject* object);

  Q_INVOKABLE QString stripKnownExtension(const QString& fileName, vtkObject* object);

  Q_INVOKABLE virtual bool loadNodes(const qSlicerIO::IOFileType& fileType,
                                     const qSlicerIO::IOProperties& parameters,
                                     vtkCollection* loadedNodes = nullptr,
                                     vtkMRMLMessageCollection* userMessages = nullptr);

  Q_INVOKABLE virtual bool loadNodes(const QList<qSlicerIO::IOProperties>& files, vtkCollection* loadedNodes = nullptr, vtkMRMLMessageCollection* userMessages = nullptr);

  Q_INVOKABLE vtkMRMLNode* loadNodesAndGetFirst(qSlicerIO::IOFileType fileType, const qSlicerIO::IOProperties& parameters, vtkMRMLMessageCollection* userMessages = nullptr);

  Q_INVOKABLE bool loadScene(const QString& fileName, bool clear = true, vtkMRMLMessageCollection* userMessages = nullptr);

  Q_INVOKABLE bool loadFile(const QString& fileName, vtkMRMLMessageCollection* userMessages = nullptr);

  Q_INVOKABLE bool saveNodes(qSlicerIO::IOFileType fileType,
                             const qSlicerIO::IOProperties& parameters,
                             vtkMRMLMessageCollection* userMessages = nullptr,
                             vtkMRMLScene* scene = nullptr);

  Q_INVOKABLE bool exportNodes(const QList<qSlicerIO::IOProperties>& parameterMaps, bool hardenTransforms, vtkMRMLMessageCollection* userMessages = nullptr);

  Q_INVOKABLE bool exportNodes(const QStringList& nodeIDs,
                               const QStringList& fileNames,
                               const qSlicerIO::IOProperties& commonParameterMap,
                               bool hardenTransforms,
                               vtkMRMLMessageCollection* userMessages = nullptr);

  Q_INVOKABLE bool saveScene(const QString& fileName, QImage screenShot, vtkMRMLMessageCollection* userMessages = nullptr);

  Q_INVOKABLE void addDefaultStorageNodes();

  Q_INVOKABLE void registerIO(qSlicerIO* io);

  Q_INVOKABLE int registeredFileReaderCount(const qSlicerIO::IOFileType& fileType) const;
  Q_INVOKABLE int registeredFileWriterCount(const qSlicerIO::IOFileType& fileType) const;

  Q_INVOKABLE static vtkMRMLStorageNode* createAndAddDefaultStorageNode(vtkMRMLStorableNode* node);

  Q_INVOKABLE void emitNewFileLoaded(const QVariantMap& loadedFileParameters);

  Q_INVOKABLE void emitFileSaved(const QVariantMap& savedFileParameters);

  Q_INVOKABLE QString defaultSceneFileType() const;

  Q_INVOKABLE bool examineFileInfoList(QFileInfoList& fileInfoList, QFileInfo& archetypeEntry, QString& readerDescription, qSlicerIO::IOProperties& ioProperties) const;
 
public slots:

  void setDefaultSceneFileType(QString);

  void setDefaultMaximumFileNameLength(int);
 
signals:

  void newFileLoaded(const qSlicerIO::IOProperties& loadedFileParameters);

  void fileSaved(const qSlicerIO::IOProperties& savedFileParameters);
 
public:
  Q_INVOKABLE QList<qSlicerFileReader*> readers() const;

  Q_INVOKABLE QList<qSlicerFileWriter*> writers() const;
  Q_INVOKABLE QList<qSlicerFileWriter*> writers(const qSlicerIO::IOFileType& fileType) const;

  Q_INVOKABLE QList<qSlicerFileReader*> readers(const qSlicerIO::IOFileType& fileType) const;
  Q_INVOKABLE qSlicerFileReader* reader(const QString& ioDescription) const;
 
protected:
  virtual void startProgress(vtkMRMLOperationProgress* progress);
  virtual void updateProgress(vtkMRMLOperationProgress* progress);
  virtual void endProgress(vtkMRMLOperationProgress* progress);

  virtual qSlicerIOOptions* createGenericOptions(vtkMRMLFileIOHandler* ioHandler) const;
 
protected:
  QScopedPointer<qSlicerCoreIOManagerPrivate> d_ptr;
 
private:
  Q_DECLARE_PRIVATE(qSlicerCoreIOManager);
  Q_DISABLE_COPY(qSlicerCoreIOManager);
};
 
#endif