1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of Qbs.
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 FILESAVER_H
41 #define FILESAVER_H
42 
43 #include "qbs_export.h"
44 
45 #include <memory>
46 #include <sstream>
47 #include <string>
48 #include <vector>
49 
50 namespace qbs {
51 namespace Internal {
52 
53 /*!
54  * QSaveFile wrapper which doesn't update the target file if the contents are unchanged.
55  */
56 class QBS_EXPORT FileSaver {
57 public:
58     FileSaver(std::string filePath, bool overwriteIfUnchanged = false);
59 
60     std::ostream *device();
61     bool open();
62     bool commit();
63     bool write(std::string_view data);
64 
65 private:
66     std::string m_oldFileContents;
67     std::shared_ptr<std::stringstream> m_memoryDevice;
68     const std::string m_filePath;
69     const bool m_overwriteIfUnchanged;
70 };
71 
72 } // namespace Internal
73 } // namespace qbs
74 
75 #endif // FILESAVER_H
76