1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
|
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtCore module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qplatformdefs.h"
#include "qfileinfo.h"
#include "qglobal.h"
#include "qdir.h"
#include "qfileinfo_p.h"
QT_BEGIN_NAMESPACE
QFileInfoPrivate::QFileInfoPrivate(const QFileInfo *copy)
{
if (copy) {
copy->d_func()->data->ref.ref();
data = copy->d_func()->data;
} else {
data = new QFileInfoPrivate::Data;
}
}
QFileInfoPrivate::~QFileInfoPrivate()
{
if (!data->ref.deref())
delete data;
data = 0;
}
void QFileInfoPrivate::initFileEngine(const QString &file)
{
detach();
delete data->fileEngine;
data->fileEngine = 0;
data->clear();
data->fileEngine = QAbstractFileEngine::create(file);
data->fileName = file;
}
void QFileInfoPrivate::detach()
{
qAtomicDetach(data);
}
QString QFileInfoPrivate::getFileName(QAbstractFileEngine::FileName name) const
{
if (data->cache_enabled && !data->fileNames[(int)name].isNull())
return data->fileNames[(int)name];
QString ret = data->fileEngine->fileName(name);
if (ret.isNull())
ret = QLatin1String("");
if (data->cache_enabled)
data->fileNames[(int)name] = ret;
return ret;
}
QString QFileInfoPrivate::getFileOwner(QAbstractFileEngine::FileOwner own) const
{
if (data->cache_enabled && !data->fileOwners[(int)own].isNull())
return data->fileOwners[(int)own];
QString ret = data->fileEngine->owner(own);
if (ret.isNull())
ret = QLatin1String("");
if (data->cache_enabled)
data->fileOwners[(int)own] = ret;
return ret;
}
uint QFileInfoPrivate::getFileFlags(QAbstractFileEngine::FileFlags request) const
{
// We split the testing into tests for for LinkType, BundleType, PermsMask
// and the rest.
// Tests for file permissions on Windows can be slow, expecially on network
// paths and NTFS drives.
// In order to determine if a file is a symlink or not, we have to lstat().
// If we're not interested in that information, we might as well avoid one
// extra syscall. Bundle detecton on Mac can be slow, expecially on network
// paths, so we separate out that as well.
QAbstractFileEngine::FileFlags req = 0;
uint cachedFlags = 0;
if (request & (QAbstractFileEngine::FlagsMask | QAbstractFileEngine::TypesMask)) {
if (!data->getCachedFlag(CachedFileFlags)) {
req |= QAbstractFileEngine::FlagsMask;
req |= QAbstractFileEngine::TypesMask;
req &= (~QAbstractFileEngine::LinkType);
req &= (~QAbstractFileEngine::BundleType);
cachedFlags |= CachedFileFlags;
}
if (request & QAbstractFileEngine::LinkType) {
if (!data->getCachedFlag(CachedLinkTypeFlag)) {
req |= QAbstractFileEngine::LinkType;
cachedFlags |= CachedLinkTypeFlag;
}
}
if (request & QAbstractFileEngine::BundleType) {
if (!data->getCachedFlag(CachedBundleTypeFlag)) {
req |= QAbstractFileEngine::BundleType;
cachedFlags |= CachedBundleTypeFlag;
}
}
}
if (request & QAbstractFileEngine::PermsMask) {
if (!data->getCachedFlag(CachedPerms)) {
req |= QAbstractFileEngine::PermsMask;
cachedFlags |= CachedPerms;
}
}
if (req) {
if (data->cache_enabled)
req &= (~QAbstractFileEngine::Refresh);
else
req |= QAbstractFileEngine::Refresh;
QAbstractFileEngine::FileFlags flags = data->fileEngine->fileFlags(req);
data->fileFlags |= uint(flags);
data->setCachedFlag(cachedFlags);
}
return data->fileFlags & request;
}
QDateTime &QFileInfoPrivate::getFileTime(QAbstractFileEngine::FileTime request) const
{
if (!data->cache_enabled)
data->clearFlags();
uint cf;
if (request == QAbstractFileEngine::CreationTime)
cf = CachedCTime;
else if (request == QAbstractFileEngine::ModificationTime)
cf = CachedMTime;
else
cf = CachedATime;
if (!data->getCachedFlag(cf)) {
data->fileTimes[request] = data->fileEngine->fileTime(request);
data->setCachedFlag(cf);
}
return data->fileTimes[request];
}
//************* QFileInfo
/*!
\class QFileInfo
\reentrant
\brief The QFileInfo class provides system-independent file information.
\ingroup io
\ingroup shared
QFileInfo provides information about a file's name and position
(path) in the file system, its access rights and whether it is a
directory or symbolic link, etc. The file's size and last
modified/read times are also available. QFileInfo can also be
used to obtain information about a Qt \l{resource
system}{resource}.
A QFileInfo can point to a file with either a relative or an
absolute file path. Absolute file paths begin with the directory
separator "/" (or with a drive specification on Windows). Relative
file names begin with a directory name or a file name and specify
a path relative to the current working directory. An example of an
absolute path is the string "/tmp/quartz". A relative path might
look like "src/fatlib". You can use the function isRelative() to
check whether a QFileInfo is using a relative or an absolute file
path. You can call the function makeAbsolute() to convert a
relative QFileInfo's path to an absolute path.
The file that the QFileInfo works on is set in the constructor or
later with setFile(). Use exists() to see if the file exists and
size() to get its size.
The file's type is obtained with isFile(), isDir() and
isSymLink(). The symLinkTarget() function provides the name of the file
the symlink points to.
On Unix (including Mac OS X), the symlink has the same size() has
the file it points to, because Unix handles symlinks
transparently; similarly, opening a symlink using QFile
effectively opens the link's target. For example:
\snippet doc/src/snippets/code/src_corelib_io_qfileinfo.cpp 0
On Windows, symlinks (shortcuts) are \c .lnk files. The reported
size() is that of the symlink (not the link's target), and
opening a symlink using QFile opens the \c .lnk file. For
example:
\snippet doc/src/snippets/code/src_corelib_io_qfileinfo.cpp 1
Elements of the file's name can be extracted with path() and
fileName(). The fileName()'s parts can be extracted with
baseName(), suffix() or completeSuffix(). QFileInfo objects to
directories created by Qt classes will not have a trailing file
separator. If you wish to use trailing separators in your own file
info objects, just append one to the file name given to the constructors
or setFile().
The file's dates are returned by created(), lastModified() and
lastRead(). Information about the file's access permissions is
obtained with isReadable(), isWritable() and isExecutable(). The
file's ownership is available from owner(), ownerId(), group() and
groupId(). You can examine a file's permissions and ownership in a
single statement using the permission() function.
\section1 Performance Issues
Some of QFileInfo's functions query the file system, but for
performance reasons, some functions only operate on the
file name itself. For example: To return the absolute path of
a relative file name, absolutePath() has to query the file system.
The path() function, however, can work on the file name directly,
and so it is faster.
\note To speed up performance, QFileInfo caches information about
the file.
To speed up performance, QFileInfo caches information about the
file. Because files can be changed by other users or programs, or
even by other parts of the same program, there is a function that
refreshes the file information: refresh(). If you want to switch
off a QFileInfo's caching and force it to access the file system
every time you request information from it call setCaching(false).
\sa QDir, QFile
*/
/*!
Constructs an empty QFileInfo object.
Note that an empty QFileInfo object contain no file reference.
\sa setFile()
*/
QFileInfo::QFileInfo() : d_ptr(new QFileInfoPrivate())
{
}
/*!
Constructs a new QFileInfo that gives information about the given
file. The \a file can also include an absolute or relative path.
\sa setFile(), isRelative(), QDir::setCurrent(), QDir::isRelativePath()
*/
QFileInfo::QFileInfo(const QString &file) : d_ptr(new QFileInfoPrivate())
{
d_ptr->initFileEngine(file);
}
/*!
Constructs a new QFileInfo that gives information about file \a
file.
If the \a file has a relative path, the QFileInfo will also have a
relative path.
\sa isRelative()
*/
QFileInfo::QFileInfo(const QFile &file) : d_ptr(new QFileInfoPrivate())
{
d_ptr->initFileEngine(file.fileName());
}
/*!
Constructs a new QFileInfo that gives information about the given
\a file in the directory \a dir.
If \a dir has a relative path, the QFileInfo will also have a
relative path.
If \a file is an absolute path, then the directory specified
by \a dir will be disregarded.
\sa isRelative()
*/
QFileInfo::QFileInfo(const QDir &dir, const QString &file) : d_ptr(new QFileInfoPrivate())
{
d_ptr->initFileEngine(dir.filePath(file));
}
/*!
Constructs a new QFileInfo that is a copy of the given \a fileinfo.
*/
QFileInfo::QFileInfo(const QFileInfo &fileinfo) : d_ptr(new QFileInfoPrivate(&fileinfo))
{
}
/*!
Destroys the QFileInfo and frees its resources.
*/
QFileInfo::~QFileInfo()
{
}
/*!
\fn bool QFileInfo::operator!=(const QFileInfo &fileinfo)
Returns true if this QFileInfo object refers to a different file
than the one specified by \a fileinfo; otherwise returns false.
\sa operator==()
*/
/*!
\overload
\fn bool QFileInfo::operator!=(const QFileInfo &fileinfo) const
*/
/*!
\overload
*/
bool QFileInfo::operator==(const QFileInfo &fileinfo) const
{
Q_D(const QFileInfo);
// ### Qt 5: understand long and short file names on Windows
// ### (GetFullPathName()).
if (fileinfo.d_func()->data == d->data)
return true;
if (!d->data->fileEngine || !fileinfo.d_func()->data->fileEngine)
return false;
if (d->data->fileEngine->caseSensitive() != fileinfo.d_func()->data->fileEngine->caseSensitive())
return false;
if (fileinfo.size() == size()) { //if the size isn't the same...
QString file1 = canonicalFilePath(),
file2 = fileinfo.canonicalFilePath();
if (file1.length() == file2.length()) {
if (!fileinfo.d_func()->data->fileEngine->caseSensitive()) {
for (int i = 0; i < file1.length(); i++) {
if (file1.at(i).toLower() != file2.at(i).toLower())
return false;
}
return true;
}
return (file1 == file2);
}
}
return false;
}
/*!
Returns true if this QFileInfo object refers to a file in the same
location as \a fileinfo; otherwise returns false.
Note that the result of comparing two empty QFileInfo objects,
containing no file references, is undefined.
\warning This will not compare two different symbolic links
pointing to the same file.
\warning Long and short file names that refer to the same file on Windows
are treated as if they referred to different files.
\sa operator!=()
*/
bool QFileInfo::operator==(const QFileInfo &fileinfo)
{
return const_cast<const QFileInfo *>(this)->operator==(fileinfo);
}
/*!
Makes a copy of the given \a fileinfo and assigns it to this QFileInfo.
*/
QFileInfo &QFileInfo::operator=(const QFileInfo &fileinfo)
{
Q_D(QFileInfo);
qAtomicAssign(d->data, fileinfo.d_func()->data);
return *this;
}
/*!
Sets the file that the QFileInfo provides information about to \a
file.
The \a file can also include an absolute or relative file path.
Absolute paths begin with the directory separator (e.g. "/" under
Unix) or a drive specification (under Windows). Relative file
names begin with a directory name or a file name and specify a
path relative to the current directory.
Example:
\snippet doc/src/snippets/code/src_corelib_io_qfileinfo.cpp 2
\sa isRelative(), QDir::setCurrent(), QDir::isRelativePath()
*/
void QFileInfo::setFile(const QString &file)
{
*this = QFileInfo(file);
}
/*!
\overload
Sets the file that the QFileInfo provides information about to \a
file.
If \a file includes a relative path, the QFileInfo will also have
a relative path.
\sa isRelative()
*/
void QFileInfo::setFile(const QFile &file)
{
*this = QFileInfo(file.fileName());
}
/*!
\overload
Sets the file that the QFileInfo provides information about to \a
file in directory \a dir.
If \a file includes a relative path, the QFileInfo will also
have a relative path.
\sa isRelative()
*/
void QFileInfo::setFile(const QDir &dir, const QString &file)
{
*this = QFileInfo(dir.filePath(file));
}
/*!
Returns an absolute path including the file name.
The absolute path name consists of the full path and the file
name. On Unix this will always begin with the root, '/',
directory. On Windows this will always begin 'D:/' where D is a
drive letter, except for network shares that are not mapped to a
drive letter, in which case the path will begin '//sharename/'.
QFileInfo will uppercase drive letters. Note that QDir does not do
this. The code snippet below shows this.
\snippet doc/src/snippets/code/src_corelib_io_qfileinfo.cpp newstuff
This function returns the same as filePath(), unless isRelative()
is true. In contrast to canonicalFilePath(), symbolic links or
redundant "." or ".." elements are not necessarily removed.
If the QFileInfo is empty it returns QDir::currentPath().
\sa filePath(), canonicalFilePath(), isRelative()
*/
QString QFileInfo::absoluteFilePath() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QLatin1String("");
return d->getFileName(QAbstractFileEngine::AbsoluteName);
}
/*!
Returns the canonical path including the file name, i.e. an absolute
path without symbolic links or redundant "." or ".." elements.
If the file does not exist, canonicalFilePath() returns an empty
string.
\sa filePath(), absoluteFilePath(), dir()
*/
QString QFileInfo::canonicalFilePath() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QLatin1String("");
return d->getFileName(QAbstractFileEngine::CanonicalName);
}
/*!
Returns a file's path absolute path. This doesn't include the
file name.
On Unix the absolute path will always begin with the root, '/',
directory. On Windows this will always begin 'D:/' where D is a
drive letter, except for network shares that are not mapped to a
drive letter, in which case the path will begin '//sharename/'.
In contrast to canonicalPath() symbolic links or redundant "." or
".." elements are not necessarily removed.
\warning If the QFileInfo object was created with an empty QString,
the behavior of this function is undefined.
\sa absoluteFilePath(), path(), canonicalPath(), fileName(), isRelative()
*/
QString QFileInfo::absolutePath() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine) {
return QLatin1String("");
} else if (d->data->fileName.isEmpty()) {
qWarning("QFileInfo::absolutePath: Constructed with empty filename");
return QLatin1String("");
}
return d->getFileName(QAbstractFileEngine::AbsolutePathName);
}
/*!
Returns the file's path canonical path (excluding the file name),
i.e. an absolute path without symbolic links or redundant "." or ".." elements.
If the file does not exist, canonicalPath() returns an empty string.
\sa path(), absolutePath()
*/
QString QFileInfo::canonicalPath() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QLatin1String("");
return d->getFileName(QAbstractFileEngine::CanonicalPathName);
}
/*!
Returns the file's path. This doesn't include the file name.
Note that, if this QFileInfo object is given a path ending in a
slash, the name of the file is considered empty and this function
will return the entire path.
\sa filePath(), absolutePath(), canonicalPath(), dir(), fileName(), isRelative()
*/
QString QFileInfo::path() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QLatin1String("");
return d->getFileName(QAbstractFileEngine::PathName);
}
/*!
\fn bool QFileInfo::isAbsolute() const
Returns true if the file path name is absolute, otherwise returns
false if the path is relative.
\sa isRelative()
*/
/*!
Returns true if the file path name is relative, otherwise returns
false if the path is absolute (e.g. under Unix a path is absolute
if it begins with a "/").
\sa isAbsolute()
*/
bool QFileInfo::isRelative() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return true;
return d->data->fileEngine->isRelativePath();
}
/*!
Converts the file's path to an absolute path if it is not already in that form.
Returns true to indicate that the path was converted; otherwise returns false
to indicate that the path was already absolute.
\sa filePath(), isRelative()
*/
bool QFileInfo::makeAbsolute()
{
Q_D(QFileInfo);
if (!d->data->fileEngine || !d->data->fileEngine->isRelativePath())
return false;
QString absFileName = d->getFileName(QAbstractFileEngine::AbsoluteName);
d->initFileEngine(absFileName);
return true;
}
/*!
Returns true if the file exists; otherwise returns false.
\note If the file is a symlink that points to a non existing
file, false is returned.
*/
bool QFileInfo::exists() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return false;
return d->getFileFlags(QAbstractFileEngine::ExistsFlag);
}
/*!
Refreshes the information about the file, i.e. reads in information
from the file system the next time a cached property is fetched.
\note On Windows CE, there might be a delay for the file system driver
to detect changes on the file.
*/
void QFileInfo::refresh()
{
Q_D(QFileInfo);
d->reset();
}
/*!
Returns the file name, including the path (which may be absolute
or relative).
\sa absoluteFilePath(), canonicalFilePath(), isRelative()
*/
QString QFileInfo::filePath() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QLatin1String("");
return d->getFileName(QAbstractFileEngine::DefaultName);
}
/*!
Returns the name of the file, excluding the path.
Example:
\snippet doc/src/snippets/code/src_corelib_io_qfileinfo.cpp 3
Note that, if this QFileInfo object is given a path ending in a
slash, the name of the file is considered empty.
\sa isRelative(), filePath(), baseName(), extension()
*/
QString QFileInfo::fileName() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QLatin1String("");
return d->getFileName(QAbstractFileEngine::BaseName);
}
/*!
\since 4.3
Returns the name of the bundle.
On Mac OS X this returns the proper localized name for a bundle if the
path isBundle(). On all other platforms an empty QString is returned.
Example:
\snippet doc/src/snippets/code/src_corelib_io_qfileinfo.cpp 4
\sa isBundle(), filePath(), baseName(), extension()
*/
QString QFileInfo::bundleName() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QLatin1String("");
return d->getFileName(QAbstractFileEngine::BundleName);
}
/*!
Returns the base name of the file without the path.
The base name consists of all characters in the file up to (but
not including) the \e first '.' character.
Example:
\snippet doc/src/snippets/code/src_corelib_io_qfileinfo.cpp 5
The base name of a file is computed equally on all platforms, independent
of file naming conventions (e.g., ".bashrc" on Unix has an empty base
name, and the suffix is "bashrc").
\sa fileName(), suffix(), completeSuffix(), completeBaseName()
*/
QString QFileInfo::baseName() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QLatin1String("");
return d->getFileName(QAbstractFileEngine::BaseName).section(QLatin1Char('.'), 0, 0);
}
/*!
Returns the complete base name of the file without the path.
The complete base name consists of all characters in the file up
to (but not including) the \e last '.' character.
Example:
\snippet doc/src/snippets/code/src_corelib_io_qfileinfo.cpp 6
\sa fileName(), suffix(), completeSuffix(), baseName()
*/
QString QFileInfo::completeBaseName() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QLatin1String("");
QString name = d->getFileName(QAbstractFileEngine::BaseName);
int index = name.lastIndexOf(QLatin1Char('.'));
return (index == -1) ? name : name.left(index);
}
/*!
Returns the complete suffix of the file.
The complete suffix consists of all characters in the file after
(but not including) the first '.'.
Example:
\snippet doc/src/snippets/code/src_corelib_io_qfileinfo.cpp 7
\sa fileName(), suffix(), baseName(), completeBaseName()
*/
QString QFileInfo::completeSuffix() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QLatin1String("");
QString fileName = d->getFileName(QAbstractFileEngine::BaseName);
int firstDot = fileName.indexOf(QLatin1Char('.'));
if (firstDot == -1)
return QLatin1String("");
return fileName.mid(firstDot + 1);
}
/*!
Returns the suffix of the file.
The suffix consists of all characters in the file after (but not
including) the last '.'.
Example:
\snippet doc/src/snippets/code/src_corelib_io_qfileinfo.cpp 8
The suffix of a file is computed equally on all platforms, independent of
file naming conventions (e.g., ".bashrc" on Unix has an empty base name,
and the suffix is "bashrc").
\sa fileName(), completeSuffix(), baseName(), completeBaseName()
*/
QString QFileInfo::suffix() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QLatin1String("");
QString fileName = d->getFileName(QAbstractFileEngine::BaseName);
int lastDot = fileName.lastIndexOf(QLatin1Char('.'));
if (lastDot == -1)
return QLatin1String("");
return fileName.mid(lastDot + 1);
}
/*!
Returns the path of the object's parent directory as a QDir object.
\bold{Note:} The QDir returned always corresponds to the object's
parent directory, even if the QFileInfo represents a directory.
For each of the following, dir() returns a QDir for
\c{"~/examples/191697"}.
\snippet doc/src/snippets/fileinfo/main.cpp 0
For each of the following, dir() returns a QDir for
\c{"."}.
\snippet doc/src/snippets/fileinfo/main.cpp 1
\sa absolutePath(), filePath(), fileName(), isRelative(), absoluteDir()
*/
QDir QFileInfo::dir() const
{
// ### Qt5: Maybe rename this to parentDirectory(), considering what it actually do?
return QDir(path());
}
/*!
Returns the file's absolute path as a QDir object.
\sa dir(), filePath(), fileName(), isRelative()
*/
QDir QFileInfo::absoluteDir() const
{
return QDir(absolutePath());
}
#ifdef QT3_SUPPORT
/*!
Use absoluteDir() or the dir() overload that takes no parameters
instead.
*/
QDir QFileInfo::dir(bool absPath) const
{
if (absPath)
return absoluteDir();
return dir();
}
#endif //QT3_SUPPORT
/*!
Returns true if the user can read the file; otherwise returns false.
\sa isWritable(), isExecutable(), permission()
*/
bool QFileInfo::isReadable() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return false;
return d->getFileFlags(QAbstractFileEngine::ReadUserPerm);
}
/*!
Returns true if the user can write to the file; otherwise returns false.
\sa isReadable(), isExecutable(), permission()
*/
bool QFileInfo::isWritable() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return false;
return d->getFileFlags(QAbstractFileEngine::WriteUserPerm);
}
/*!
Returns true if the file is executable; otherwise returns false.
\sa isReadable(), isWritable(), permission()
*/
bool QFileInfo::isExecutable() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return false;
return d->getFileFlags(QAbstractFileEngine::ExeUserPerm);
}
/*!
Returns true if this is a `hidden' file; otherwise returns false.
\bold{Note:} This function returns true for the special entries
"." and ".." on Unix, even though QDir::entryList threats them as shown.
*/
bool QFileInfo::isHidden() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return false;
return d->getFileFlags(QAbstractFileEngine::HiddenFlag);
}
/*!
Returns true if this object points to a file or to a symbolic
link to a file. Returns false if the
object points to something which isn't a file, such as a directory.
\sa isDir(), isSymLink(), isBundle()
*/
bool QFileInfo::isFile() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return false;
return d->getFileFlags(QAbstractFileEngine::FileType);
}
/*!
Returns true if this object points to a directory or to a symbolic
link to a directory; otherwise returns false.
\sa isFile(), isSymLink(), isBundle()
*/
bool QFileInfo::isDir() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return false;
return d->getFileFlags(QAbstractFileEngine::DirectoryType);
}
/*!
\since 4.3
Returns true if this object points to a bundle or to a symbolic
link to a bundle on Mac OS X; otherwise returns false.
\sa isDir(), isSymLink(), isFile()
*/
bool QFileInfo::isBundle() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return false;
return d->getFileFlags(QAbstractFileEngine::BundleType);
}
/*!
Returns true if this object points to a symbolic link (or to a
shortcut on Windows); otherwise returns false.
On Unix (including Mac OS X), opening a symlink effectively opens
the \l{symLinkTarget()}{link's target}. On Windows, it opens the \c
.lnk file itself.
Example:
\snippet doc/src/snippets/code/src_corelib_io_qfileinfo.cpp 9
\note If the symlink points to a non existing file, exists() returns
false.
\sa isFile(), isDir(), symLinkTarget()
*/
bool QFileInfo::isSymLink() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return false;
return d->getFileFlags(QAbstractFileEngine::LinkType);
}
/*!
Returns true if the object points to a directory or to a symbolic
link to a directory, and that directory is the root directory; otherwise
returns false.
*/
bool QFileInfo::isRoot() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return true;
return d->getFileFlags(QAbstractFileEngine::RootFlag);
}
/*!
\fn QString QFileInfo::symLinkTarget() const
\since 4.2
Returns the absolute path to the file or directory a symlink (or shortcut
on Windows) points to, or a an empty string if the object isn't a symbolic
link.
This name may not represent an existing file; it is only a string.
QFileInfo::exists() returns true if the symlink points to an
existing file.
\sa exists(), isSymLink(), isDir(), isFile()
*/
/*!
\obsolete
Use symLinkTarget() instead.
*/
QString QFileInfo::readLink() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QLatin1String("");
return d->getFileName(QAbstractFileEngine::LinkName);
}
/*!
Returns the owner of the file. On systems where files
do not have owners, or if an error occurs, an empty string is
returned.
This function can be time consuming under Unix (in the order of
milliseconds).
\sa ownerId(), group(), groupId()
*/
QString QFileInfo::owner() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QLatin1String("");
return d->getFileOwner(QAbstractFileEngine::OwnerUser);
}
/*!
Returns the id of the owner of the file.
On Windows and on systems where files do not have owners this
function returns ((uint) -2).
\sa owner(), group(), groupId()
*/
uint QFileInfo::ownerId() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return 0;
return d->data->fileEngine->ownerId(QAbstractFileEngine::OwnerUser);
}
/*!
Returns the group of the file. On Windows, on systems where files
do not have groups, or if an error occurs, an empty string is
returned.
This function can be time consuming under Unix (in the order of
milliseconds).
\sa groupId(), owner(), ownerId()
*/
QString QFileInfo::group() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QLatin1String("");
return d->getFileOwner(QAbstractFileEngine::OwnerGroup);
}
/*!
Returns the id of the group the file belongs to.
On Windows and on systems where files do not have groups this
function always returns (uint) -2.
\sa group(), owner(), ownerId()
*/
uint QFileInfo::groupId() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return 0;
return d->data->fileEngine->ownerId(QAbstractFileEngine::OwnerGroup);
}
/*!
Tests for file permissions. The \a permissions argument can be
several flags of type QFile::Permissions OR-ed together to check
for permission combinations.
On systems where files do not have permissions this function
always returns true.
Example:
\snippet doc/src/snippets/code/src_corelib_io_qfileinfo.cpp 10
\sa isReadable(), isWritable(), isExecutable()
*/
bool QFileInfo::permission(QFile::Permissions permissions) const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return false;
return d->getFileFlags(QAbstractFileEngine::FileFlags((int)permissions)) == (uint)permissions;
}
/*!
Returns the complete OR-ed together combination of
QFile::Permissions for the file.
*/
QFile::Permissions QFileInfo::permissions() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return 0;
return QFile::Permissions(d->getFileFlags(QAbstractFileEngine::PermsMask) & QAbstractFileEngine::PermsMask);
}
/*!
Returns the file size in bytes. If the file does not exist or cannot be
fetched, 0 is returned.
\sa exists()
*/
qint64 QFileInfo::size() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return 0;
if (!d->data->getCachedFlag(QFileInfoPrivate::CachedSize)) {
d->data->setCachedFlag(QFileInfoPrivate::CachedSize);
d->data->fileSize = d->data->fileEngine->size();
}
return d->data->fileSize;
}
/*!
Returns the date and time when the file was created.
On most Unix systems, this function returns the time of the last
status change. A status change occurs when the file is created,
but it also occurs whenever the user writes or sets inode
information (for example, changing the file permissions).
If neither creation time nor "last status change" time are not
available, returns the same as lastModified().
\sa lastModified() lastRead()
*/
QDateTime QFileInfo::created() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QDateTime();
return d->getFileTime(QAbstractFileEngine::CreationTime);
}
/*!
Returns the date and time when the file was last modified.
\sa created() lastRead()
*/
QDateTime QFileInfo::lastModified() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QDateTime();
return d->getFileTime(QAbstractFileEngine::ModificationTime);
}
/*!
Returns the date and time when the file was last read (accessed).
On platforms where this information is not available, returns the
same as lastModified().
\sa created() lastModified()
*/
QDateTime QFileInfo::lastRead() const
{
Q_D(const QFileInfo);
if (!d->data->fileEngine)
return QDateTime();
return d->getFileTime(QAbstractFileEngine::AccessTime);
}
/*! \internal
Detaches all internal data.
*/
void QFileInfo::detach()
{
Q_D(QFileInfo);
d->detach();
}
/*!
Returns true if caching is enabled; otherwise returns false.
\sa setCaching(), refresh()
*/
bool QFileInfo::caching() const
{
Q_D(const QFileInfo);
return d->data->cache_enabled;
}
/*!
If \a enable is true, enables caching of file information. If \a
enable is false caching is disabled.
When caching is enabled, QFileInfo reads the file information from
the file system the first time it's needed, but generally not
later.
Caching is enabled by default.
\sa refresh(), caching()
*/
void QFileInfo::setCaching(bool enable)
{
Q_D(QFileInfo);
detach();
d->data->cache_enabled = enable;
}
/*!
\fn QString QFileInfo::baseName(bool complete)
Use completeBaseName() or the baseName() overload that takes no
parameters instead.
*/
/*!
\fn QString QFileInfo::extension(bool complete = true) const
Use completeSuffix() or suffix() instead.
*/
/*!
\fn QString QFileInfo::absFilePath() const
Use absoluteFilePath() instead.
*/
/*!
\fn QString QFileInfo::dirPath(bool absPath) const
Use absolutePath() if the absolute path is wanted (\a absPath
is true) or path() if it's not necessary (\a absPath is false).
*/
/*!
\fn bool QFileInfo::convertToAbs()
Use makeAbsolute() instead.
*/
/*!
\enum QFileInfo::Permission
\compat
\value ReadOwner
\value WriteOwner
\value ExeOwner
\value ReadUser
\value WriteUser
\value ExeUser
\value ReadGroup
\value WriteGroup
\value ExeGroup
\value ReadOther
\value WriteOther
\value ExeOther
*/
/*!
\fn bool QFileInfo::permission(PermissionSpec permissions) const
\compat
Use permission() instead.
*/
/*!
\typedef QFileInfoList
\relates QFileInfo
Synonym for QList<QFileInfo>.
*/
QT_END_NAMESPACE
|