1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtCore module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QFILESYSTEMENTRY_P_H
41#define QFILESYSTEMENTRY_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtCore/private/qglobal_p.h>
55#include <QtCore/qstring.h>
56#include <QtCore/qbytearray.h>
57
58#if defined(Q_OS_WIN)
59#define QFILESYSTEMENTRY_NATIVE_PATH_IS_UTF16
60#endif
61
62QT_BEGIN_NAMESPACE
63
64class QFileSystemEntry
65{
66public:
67
68#ifndef QFILESYSTEMENTRY_NATIVE_PATH_IS_UTF16
69 typedef QByteArray NativePath;
70#else
71 typedef QString NativePath;
72#endif
73 struct FromNativePath{};
74 struct FromInternalPath{};
75
76 QFileSystemEntry();
77 explicit QFileSystemEntry(const QString &filePath);
78
79 QFileSystemEntry(const QString &filePath, FromInternalPath dummy);
80 QFileSystemEntry(const NativePath &nativeFilePath, FromNativePath dummy);
81 QFileSystemEntry(const QString &filePath, const NativePath &nativeFilePath);
82
83 QString filePath() const;
84 QString fileName() const;
85 QString path() const;
86 NativePath nativeFilePath() const;
87 QString baseName() const;
88 QString completeBaseName() const;
89 QString suffix() const;
90 QString completeSuffix() const;
91 bool isAbsolute() const;
92 bool isRelative() const;
93 bool isClean() const;
94
95#if defined(Q_OS_WIN)
96 bool isDriveRoot() const;
97 static bool isDriveRootPath(const QString &path);
98#endif
99 bool isRoot() const;
100
101 bool isEmpty() const
102 {
103 return m_filePath.isEmpty() && m_nativeFilePath.isEmpty();
104 }
105 void clear()
106 {
107 *this = QFileSystemEntry();
108 }
109
110 Q_CORE_EXPORT static bool isRootPath(const QString &path);
111
112private:
113 // creates the QString version out of the bytearray version
114 void resolveFilePath() const;
115 // creates the bytearray version out of the QString version
116 void resolveNativeFilePath() const;
117 // resolves the separator
118 void findLastSeparator() const;
119 // resolves the dots and the separator
120 void findFileNameSeparators() const;
121
122 mutable QString m_filePath; // always has slashes as separator
123 mutable NativePath m_nativeFilePath; // native encoding and separators
124
125 mutable qint16 m_lastSeparator; // index in m_filePath of last separator
126 mutable qint16 m_firstDotInFileName; // index after m_filePath for first dot (.)
127 mutable qint16 m_lastDotInFileName; // index after m_firstDotInFileName for last dot (.)
128};
129
130QT_END_NAMESPACE
131
132#endif // include guard
133