summaryrefslogtreecommitdiffstats
path: root/installerbuilder/common/fileutils.h
blob: efed7930e16d5778e0181461d9321c6544719714 (plain)
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
/**************************************************************************
**
** This file is part of Qt SDK**
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).*
**
** Contact:  Nokia Corporation qt-info@nokia.com**
**
** GNU Lesser General Public License Usage
**
** 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 are unsure which license is appropriate for your use, please contact
** (qt-info@nokia.com).
**
**************************************************************************/
#ifndef QINSTALLER_FILEUTILS_H
#define QINSTALLER_FILEUTILS_H

#include <QtCore/QString>
#include <QtCore/QStringList>

#include "installer_global.h"

class QByteArray;
class QIODevice;
class QUrl;

namespace QInstaller {
    void INSTALLER_EXPORT openForWrite(QIODevice* dev, const QString& name);
    void INSTALLER_EXPORT openForRead(QIODevice* dev, const QString& name);

    qint64 INSTALLER_EXPORT blockingRead( QIODevice* in, char *buffer, qint64 size );
    qint64 INSTALLER_EXPORT blockingWrite( QIODevice* out, const char* buffer, qint64 size);
    qint64 INSTALLER_EXPORT blockingWrite( QIODevice* out, const QByteArray& ba );
    void INSTALLER_EXPORT blockingCopy( QIODevice* in, QIODevice* out, qint64 size );

    /**
     * Removes the directory at \a path recursively.
     * @param path The directory to remove
     * @param ignoreErrors if @p true, errors will be silently ignored. Otherwise an exception will be thrown if removing fails.
     *
     * @throws QInstaller::Error if the directory cannot be removed and ignoreErrors is @p false
     */
    void INSTALLER_EXPORT removeDirectory( const QString& path, bool ignoreErrors = false );
    void INSTALLER_EXPORT removeDirectoryThreaded( const QString& path, bool ignoreErrors = false );

    /**
     * Creates a temporary directory
     * @throws QInstaller::Error if creating the temporary directory fails
     */
     QString INSTALLER_EXPORT createTemporaryDirectory( const QString& templ=QString() );

     QString INSTALLER_EXPORT generateTemporaryFileName( const QString& templ=QString() );

     void INSTALLER_EXPORT moveDirectoryContents( const QString& sourceDir, const QString& targetDir );
     void INSTALLER_EXPORT copyDirectoryContents( const QString& sourceDir, const QString& targetDir );

     bool INSTALLER_EXPORT isLocalUrl( const QUrl& url );
     QString INSTALLER_EXPORT pathFromUrl( const QUrl& url );

     void INSTALLER_EXPORT mkdir( const QString& path );
     void INSTALLER_EXPORT mkpath( const QString& path );

#ifdef Q_WS_WIN
     /**
       * Sets the .ico file at \a icon as application icon for \a application.
       */
     void INSTALLER_EXPORT setApplicationIcon( const QString& application, const QString& icon );

#endif

    class INSTALLER_EXPORT TempDirDeleter
    {
    public:
        explicit TempDirDeleter( const QString& path );
        explicit TempDirDeleter( const QStringList& paths = QStringList() );
        ~TempDirDeleter();
        void releaseAll();
        void release( const QString& path );
        void passAndReleaseAll( TempDirDeleter& tdd );
        void passAndRelease( TempDirDeleter& tdd, const QString& path );

        void add( const QString& path );
        void add( const QStringList& paths );
        QStringList paths() const;

    private:
        Q_DISABLE_COPY(TempDirDeleter)
        QStringList m_paths;
    };
}

#endif // QINSTALLER_FILEUTILS_H