LibrePCB Developers Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
filepath.h
Go to the documentation of this file.
1 /*
2  * LibrePCB - Professional EDA for everyone!
3  * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
4  * https://librepcb.org/
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef LIBREPCB_FILEPATH_H
21 #define LIBREPCB_FILEPATH_H
22 
23 /*******************************************************************************
24  * Includes
25  ******************************************************************************/
26 #include <QtCore>
27 
28 /*******************************************************************************
29  * Namespace / Forward Declarations
30  ******************************************************************************/
31 namespace librepcb {
32 
33 /*******************************************************************************
34  * Class FilePath
35  ******************************************************************************/
36 
127 class FilePath final {
128 public: // Types
130  // spaces
132  ReplaceSpaces = 1 << 1,
133  // case
134  KeepCase = 0,
135  ToLowerCase = 1 << 2,
136  ToUpperCase = 1 << 3,
137  // default
139  };
140  Q_DECLARE_FLAGS(CleanFileNameOptions, CleanFileNameOption);
141 
142 public: // Methods
143  // Constructors / Destructor
144 
148  FilePath() noexcept;
149 
155  explicit FilePath(const QString& filepath) noexcept;
156 
162  FilePath(const FilePath& other) noexcept;
163 
164  // Setters
165 
177  bool setPath(const QString& filepath) noexcept;
178 
179  // Getters
180 
186  bool isValid() const noexcept { return mIsValid; }
187 
193  bool isExistingFile() const noexcept;
194 
200  bool isExistingDir() const noexcept;
201 
208  bool isEmptyDir() const noexcept;
209 
215  bool isRoot() const noexcept;
216 
223  bool isLocatedInDir(const FilePath& dir) const noexcept;
224 
231  QString toStr() const noexcept;
232 
240  QString toNative() const noexcept;
241 
257  FilePath toUnique() const noexcept;
258 
274  QString toRelative(const FilePath& base) const noexcept;
275 
281  QUrl toQUrl() const noexcept { return QUrl::fromLocalFile(toStr()); }
282 
288  QString getBasename() const noexcept;
289 
295  QString getCompleteBasename() const noexcept;
296 
302  QString getSuffix() const noexcept;
303 
309  QString getCompleteSuffix() const noexcept;
310 
316  QString getFilename() const noexcept;
317 
324  FilePath getParentDir() const noexcept;
325 
340  FilePath getPathTo(const QString& filename) const noexcept;
341 
342  // Static Methods
343 
359  static FilePath fromRelative(const FilePath& base,
360  const QString& relative) noexcept;
361 
367  static FilePath getTempPath() noexcept;
368 
375  static FilePath getApplicationTempPath() noexcept;
376 
382  static FilePath getRandomTempPath() noexcept;
383 
407  static QString cleanFileName(const QString& userInput,
408  CleanFileNameOptions options) noexcept;
409 
410  // Operator Overloadings
411 
415  FilePath& operator=(const FilePath& rhs) noexcept;
416 
424  bool operator==(const FilePath& rhs) const noexcept;
425 
433  bool operator!=(const FilePath& rhs) const noexcept;
434 
435 private:
436  // Private Methods
437 
447  static QString makeWellFormatted(const QString& filepath) noexcept;
448 
449  // Attributes
450 
451  bool mIsValid;
452  QFileInfo
454 };
455 
456 // Non-Member Functions
457 QDataStream& operator<<(QDataStream& stream, const FilePath& filepath);
458 QDebug& operator<<(QDebug& stream, const FilePath& filepath);
459 inline uint qHash(const FilePath& key, uint seed) noexcept {
460  return qHash(key.toStr(), seed);
461 }
462 
463 /*******************************************************************************
464  * End of File
465  ******************************************************************************/
466 
467 } // namespace librepcb
468 
469 Q_DECLARE_METATYPE(librepcb::FilePath)
470 Q_DECLARE_OPERATORS_FOR_FLAGS(librepcb::FilePath::CleanFileNameOptions)
471 
472 #endif // LIBREPCB_FILEPATH_H
Definition: filepath.h:136
bool isExistingFile() const noexcept
Check if the specified filepath is an existing file.
Definition: filepath.cpp:65
FilePath() noexcept
The default constructor (this will create an invalid object!)
Definition: filepath.cpp:36
bool isLocatedInDir(const FilePath &dir) const noexcept
Check if the filepath is located inside another directory.
Definition: filepath.cpp:91
static QString cleanFileName(const QString &userInput, CleanFileNameOptions options) noexcept
Clean a given string so that it becomes a valid filename.
Definition: filepath.cpp:221
QString getCompleteBasename() const noexcept
Get the complete basename of the file or directory.
Definition: filepath.cpp:133
QString getFilename() const noexcept
Get the whole filename (without the path) of the file or directory.
Definition: filepath.cpp:154
QString getBasename() const noexcept
Get the basename of the file or directory.
Definition: filepath.cpp:126
bool isRoot() const noexcept
Check if the specified filepath is the root directory.
Definition: filepath.cpp:85
Definition: filepath.h:134
static FilePath fromRelative(const FilePath &base, const QString &relative) noexcept
Build an absolute and well-formatted filepath from a relative filepath.
Definition: filepath.cpp:195
bool mIsValid
Definition: filepath.h:451
static FilePath getRandomTempPath() noexcept
Get a random temporary directory path (e.g. "/tmp/librepcb/42")
Definition: filepath.cpp:215
CleanFileNameOption
Definition: filepath.h:129
QString toRelative(const FilePath &base) const noexcept
Convert an absolute filepath to a relative filepath (relative to another filepath) ...
Definition: filepath.cpp:119
FilePath toUnique() const noexcept
Get a unique version of the filepath (resolve symbolic links if possible)
Definition: filepath.cpp:109
QFileInfo mFileInfo
the absolute and well-formatted filepath in a QFileInfo
Definition: filepath.h:453
bool isExistingDir() const noexcept
Check if the specified filepath is an existing directory.
Definition: filepath.cpp:71
FilePath getParentDir() const noexcept
Get the filepath of the parent directory of the file or directory.
Definition: filepath.cpp:161
bool isValid() const noexcept
Check whether this object contains a valid filepath or not.
Definition: filepath.h:186
This class represents absolute, well-formatted paths to files or directories.
Definition: filepath.h:127
QString toNative() const noexcept
Get the absolute filepath with native directory separators ("/" resp. "\")
Definition: filepath.cpp:103
bool isEmptyDir() const noexcept
Check if the specified filepath is an existing, empty directory.
Definition: filepath.cpp:77
Definition: filepath.h:131
FilePath getPathTo(const QString &filename) const noexcept
Get the filepath to a file or directory which is relative to this filepath.
Definition: filepath.cpp:167
static FilePath getApplicationTempPath() noexcept
Get the path to the temporary application directory (e.g. "/tmp/librepcb")
Definition: filepath.cpp:211
bool setPath(const QString &filepath) noexcept
Set a new filepath.
Definition: filepath.cpp:55
QString getCompleteSuffix() const noexcept
Get the complete suffix of the file or directory.
Definition: filepath.cpp:147
Q_DECLARE_FLAGS(CleanFileNameOptions, CleanFileNameOption)
static FilePath getTempPath() noexcept
Get the path to the temporary directory (e.g. "/tmp" on Unix/Linux)
Definition: filepath.cpp:202
Definition: filepath.h:138
QString getSuffix() const noexcept
Get the suffix of the file or directory.
Definition: filepath.cpp:140
static QString makeWellFormatted(const QString &filepath) noexcept
Make a filepath well-formatted (except making it absolute!)
Definition: filepath.cpp:240
Definition: filepath.h:132
QString toStr() const noexcept
Get the absolute and well-formatted filepath as a QString.
Definition: filepath.cpp:97
uint qHash(const AttributeKey &key, uint seed=0) noexcept
Definition: attributekey.h:119
Definition: filepath.h:135
QUrl toQUrl() const noexcept
Create and return a QUrl object with this filepath.
Definition: filepath.h:281