FileName.h

Go to the documentation of this file.

#ifndef FileName_h
#define FileName_h
/* SPDX-License-Identifier: CC0-1.0 */
 
#include <QSharedData>
 
class QDate;
class QDir;
class QString;
 
template<typename A, typename B> struct QPair;
 
namespace Isis {
  class FileName {
    public:
      // Constructors
      FileName();
      FileName(const char *fileName);
      FileName(const QString &fileName);
 
      // Copy Constructor, creates a copy of a FileName object.
      FileName(const FileName &other);
 
      // Destroys the FileName Object
      ~FileName();
 
      // Methods
      QString originalPath() const;
      QString path() const;
      QString attributes() const;
      QString baseName() const;
      QString name() const;
      QString extension() const;
 
 
      QString expanded() const;
 
 
      QString original() const;
 
      FileName addExtension(const QString &extension) const;
      FileName removeExtension() const;
      FileName setExtension(const QString &extension) const;
 
      bool isVersioned() const;
      bool isNumericallyVersioned() const;
      bool isDateVersioned() const;
 
      FileName highestVersion() const;
      FileName newVersion() const;
 
      bool fileExists() const;
      QDir dir() const;
      static FileName createTempFile(FileName templateFileName = "$TEMPORARY/temp");
 
 
      QString toString() const;
      FileName &operator=(const FileName &rhs);
      bool operator==(const FileName &rhs);
      bool operator!=(const FileName &rhs);
 
 
    private:
      FileName version(long versionNumber) const;
      FileName version(QDate versionDate) const;
      QDate highestVersionDate() const;
      long highestVersionNum() const;
      void validateVersioningState() const;
      QString fileNameQDatePattern() const;
      QPair<QString, QString> splitNameAroundVersionNum() const;
 
    private:
      class Data : public QSharedData {
        public:
 
          // Constructors
          Data();
 
          // Copy Constructor, creates a copy of a Data object.
          Data(const Data &other);
 
          // Destroys the Data Object
          ~Data();
 
          // Methods
          QString original(bool includeAttributes) const;
          void setOriginal(const QString &originalStr);
          QString expanded(bool includeAttributes) const;
 
        private:
          // Holds the original file name.
          QString *m_originalFileNameString;
 
 
          // Holds the expanded file name.
          QString *m_expandedFileNameString;
      };
 
      // @see QSharedDataPointer
      QSharedDataPointer<Data> m_d;
  };
};
 
#endif