filepath.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIBREPCB_CORE_FILEPATH_H
#define LIBREPCB_CORE_FILEPATH_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "../qtcompat.h"
 
#include <QtCore>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
/*******************************************************************************
 *  Class FilePath
 ******************************************************************************/
 
class FilePath final {
public:  // Types
  enum CleanFileNameOption {
    // spaces
    KeepSpaces = 0,
    ReplaceSpaces = 1 << 1,
    // case
    KeepCase = 0,
    ToLowerCase = 1 << 2,
    ToUpperCase = 1 << 3,
    // default
    Default = KeepSpaces | KeepCase,
  };
  Q_DECLARE_FLAGS(CleanFileNameOptions, CleanFileNameOption)
 
public:  // Methods
  // Constructors / Destructor
 
  FilePath() noexcept;
 
  explicit FilePath(const QString& filepath) noexcept;
 
  FilePath(const FilePath& other) noexcept;
 
  // Setters
 
  bool setPath(const QString& filepath) noexcept;
 
  // Getters
 
  bool isValid() const noexcept { return mIsValid; }
 
  bool isExistingFile() const noexcept;
 
  bool isExistingDir() const noexcept;
 
  bool isEmptyDir() const noexcept;
 
  bool isRoot() const noexcept;
 
  bool isLocatedInDir(const FilePath& dir) const noexcept;
 
  QString toStr() const noexcept;
 
  QString toNative() const noexcept;
 
  FilePath toUnique() const noexcept;
 
  QString toRelative(const FilePath& base) const noexcept;
 
  QString toRelativeNative(const FilePath& base) const noexcept;
 
  QUrl toQUrl() const noexcept { return QUrl::fromLocalFile(toStr()); }
 
  QString getBasename() const noexcept;
 
  QString getCompleteBasename() const noexcept;
 
  QString getSuffix() const noexcept;
 
  QString getCompleteSuffix() const noexcept;
 
  QString getFilename() const noexcept;
 
  FilePath getParentDir() const noexcept;
 
  FilePath getPathTo(const QString& filename) const noexcept;
 
  // Static Methods
 
  static FilePath fromRelative(const FilePath& base,
                               const QString& relative) noexcept;
 
  static FilePath getTempPath() noexcept;
 
  static FilePath getApplicationTempPath() noexcept;
 
  static FilePath getRandomTempPath() noexcept;
 
  static QString cleanFileName(const QString& userInput,
                               CleanFileNameOptions options) noexcept;
 
  // Operator Overloadings
 
  FilePath& operator=(const FilePath& rhs) noexcept;
 
  bool operator==(const FilePath& rhs) const noexcept;
 
  bool operator!=(const FilePath& rhs) const noexcept;
 
  bool operator<(const FilePath& rhs) const noexcept;
 
private:
  // Private Methods
 
  static QString makeWellFormatted(const QString& filepath) noexcept;
 
  // Attributes
 
  bool mIsValid;
  QFileInfo
      mFileInfo;  
};
 
// Non-Member Functions
QDataStream& operator<<(QDataStream& stream, const FilePath& filepath);
QDebug& operator<<(QDebug& stream, const FilePath& filepath);
inline QtCompat::Hash qHash(const FilePath& key,
                            QtCompat::Hash seed = 0) noexcept {
  return qHash(key.toStr(), seed);
}
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace librepcb
 
Q_DECLARE_METATYPE(librepcb::FilePath)
Q_DECLARE_OPERATORS_FOR_FLAGS(librepcb::FilePath::CleanFileNameOptions)
 
#endif