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 QTEMPORARYFILE_H
41 #define QTEMPORARYFILE_H
42 
43 #include <QtCore/qiodevice.h>
44 #include <QtCore/qfile.h>
45 
46 #ifdef open
47 #error qtemporaryfile.h must be included before any header file that defines open
48 #endif
49 
50 QT_BEGIN_NAMESPACE
51 
52 
53 #ifndef QT_NO_TEMPORARYFILE
54 
55 class QTemporaryFilePrivate;
56 class QLockFilePrivate;
57 
58 class Q_CORE_EXPORT QTemporaryFile : public QFile
59 {
60 #ifndef QT_NO_QOBJECT
61     Q_OBJECT
62 #endif
63     Q_DECLARE_PRIVATE(QTemporaryFile)
64 
65 public:
66     QTemporaryFile();
67     explicit QTemporaryFile(const QString &templateName);
68 #ifndef QT_NO_QOBJECT
69     explicit QTemporaryFile(QObject *parent);
70     QTemporaryFile(const QString &templateName, QObject *parent);
71 #endif
72     ~QTemporaryFile();
73 
74     bool autoRemove() const;
75     void setAutoRemove(bool b);
76 
77     // ### Hides open(flags)
open()78     bool open() { return open(QIODevice::ReadWrite); }
79 
80     QString fileName() const override;
81     QString fileTemplate() const;
82     void setFileTemplate(const QString &name);
83 
84     // Hides QFile::rename
85     bool rename(const QString &newName);
86 
87 #if QT_DEPRECATED_SINCE(5,1)
createLocalFile(const QString & fileName)88     QT_DEPRECATED inline static QTemporaryFile *createLocalFile(const QString &fileName)
89         { return createNativeFile(fileName); }
createLocalFile(QFile & file)90     QT_DEPRECATED inline static QTemporaryFile *createLocalFile(QFile &file)
91         { return createNativeFile(file); }
92 #endif
createNativeFile(const QString & fileName)93     inline static QTemporaryFile *createNativeFile(const QString &fileName)
94         { QFile file(fileName); return createNativeFile(file); }
95     static QTemporaryFile *createNativeFile(QFile &file);
96 
97 protected:
98     bool open(OpenMode flags) override;
99 
100 private:
101     friend class QFile;
102     friend class QLockFilePrivate;
103     Q_DISABLE_COPY(QTemporaryFile)
104 };
105 
106 #endif // QT_NO_TEMPORARYFILE
107 
108 QT_END_NAMESPACE
109 
110 #endif // QTEMPORARYFILE_H
111