qgsfileutils.h

Go to the documentation of this file.

/***************************************************************************
                             qgsfileutils.h
                             ---------------------------
    begin                : November 2017
    copyright            : (C) 2017 by Etienne Trimaille
    email                : etienne dot trimaille at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSFILEUTILS_H
#define QGSFILEUTILS_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QString>

class CORE_EXPORT QgsFileUtils
{
    Q_GADGET
 
  public:
    static QString representFileSize( qint64 bytes );
 

    static QStringList extensionsFromFilter( const QString &filter );

    static QString wildcardsFromFilter( const QString &filter );

    static bool fileMatchesFilter( const QString &fileName, const QString &filter );

    static QString ensureFileNameHasExtension( const QString &fileName, const QStringList &extensions );

    static QString addExtensionFromFilter( const QString &fileName, const QString &filter );

    static QString stringToSafeFilename( const QString &string );

    static QString findClosestExistingPath( const QString &path );

    static QStringList findFile( const QString &file, const QString &basepath = QString(), int maxClimbs = 4, int searchCeiling = 4, const QString &currentDir = QString() );

    static Qgis::DriveType driveType( const QString &path ) SIP_THROW( QgsNotSupportedException );

    static bool pathIsSlowDevice( const QString &path );

    static QSet< QString > sidecarFilesForPath( const QString &path );

    static bool renameDataset(
      const QString &oldPath, const QString &newPath, QString &error SIP_OUT, Qgis::FileOperationFlags flags = Qgis::FileOperationFlag::IncludeMetadataFile | Qgis::FileOperationFlag::IncludeStyleFile
    );

    static int openedFileLimit() SIP_SKIP;

    static int openedFileCount() SIP_SKIP;

    static bool isCloseToLimitOfOpenedFiles( int filesToBeOpened = 1 ) SIP_SKIP;

    static QStringList splitPathToComponents( const QString &path );

    static QString uniquePath( const QString &path );

    enum class CopyFlag : int SIP_ENUM_BASETYPE( IntFlag )
    {
      NoSymLinks = 1 << 0, 
    };
    Q_ENUM( CopyFlag )
 
    
    Q_DECLARE_FLAGS( CopyFlags, CopyFlag )
    Q_FLAG( CopyFlags )

    static bool copyDirectory( const QString &source, const QString &destination, QgsFileUtils::CopyFlags flags = QgsFileUtils::CopyFlags() );

    static bool replaceTextInFile( const QString &path, const QString &searchString, const QString &replacement );
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsFileUtils::CopyFlags )
 
#endif // QGSFILEUTILS_H