KviFileUtils.h

Go to the documentation of this file.

#ifndef _KVI_FILEUTILS_H_
#define _KVI_FILEUTILS_H_
//=============================================================================
//
//   File : KviFileUtils.h
//   Creation date : Fri Dec 25 1998 18:27:04 by Szymon Stefanek
//
//   This file is part of the KVIrc IRC client distribution
//   Copyright (C) 1998-2010 Szymon Stefanek (pragma at kvirc dot net)
//
//   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.
//
//   This program is distributed in the HOPE that it will be USEFUL,
//   but WITHOUT ANY WARRANTY; without even the implied warranty of
//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//   See the GNU General Public License for more details.
//
//   You should have received a copy of the GNU General Public License
//   along with this program. If not, write to the Free Software Foundation,
//   Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
//=============================================================================

#include "kvi_settings.h"
#include "KviCString.h"

#include <QFile>
#include <QStringList>

#include <time.h>

#if defined(COMPILE_ON_WINDOWS) || defined(COMPILE_ON_MINGW)
#define KVI_PATH_SEPARATOR "\\"
#define KVI_PATH_SEPARATOR_CHAR '\\'
#else
#define KVI_PATH_SEPARATOR "/"
#define KVI_PATH_SEPARATOR_CHAR '/'
#endif

// #warning "Add kvi_trashFile(const char * path) ? - is it needed in the whole app"
// #warning "or should it be available only for dirbrowser module?"
namespace KviFileUtils
{
        //KVILIB_API bool readLine(QFile * f,QString &szBuffer,bool bClearBuffer = true);
        //KVILIB_API bool loadFileStripCR(const QString &szPath,QString &szBuffer);

        KVILIB_API bool loadFile(const QString & szPath, QString & szBuffer, bool bUtf8 = true);

        KVILIB_API void adjustFilePath(QString & szPath);

        KVILIB_API bool directoryExists(const QString & szPath);

        inline bool fileExists(const QString & szPath) { return QFile::exists(szPath); }

        KVILIB_API bool removeFile(const QString & szPath);

        KVILIB_API bool removeFile(const char * pcPath);

        KVILIB_API bool removeDir(const QString & szPath);

        KVILIB_API bool removeDir(const char * pcPath);

        KVILIB_API bool deleteDir(const QString & szPath);

        KVILIB_API bool writeFile(const QString & szPath, const QByteArray & oData, bool bAppend = false);

        KVILIB_API bool writeFile(const QString & szPath, const QString & szData, bool bAppend = false);

        KVILIB_API bool writeFile(const char * pcPath, const QString & szData, bool bAppend = false);

        KVILIB_API bool writeFileLocal8Bit(const QString & szPath, const QString & szData, bool bAppend = false);

        KVILIB_API bool writeFileLocal8Bit(const char * pcPath, const QString & szData, bool bAppend = false);

        KVILIB_API bool readFile(const QString & szPath, QString & szBuffer, unsigned int uMaxSize = 65535);

        KVILIB_API bool readFile(const char * pcPath, QString & szBuffer, unsigned int uMaxSize = 65535);

        KVILIB_API QString extractFileName(const QString & szFileNameWithPath, bool bAllowEmpty = true);

        KVILIB_API QString extractFilePath(const QString & szFileNameWithPath);

        KVILIB_API bool copyFile(const QString & szSrc, const QString & szDst);

        KVILIB_API bool copyFile(const char * pcSrc, const char * pcDst);

        KVILIB_API bool renameFile(const QString & szSrc, const QString & szDst);

        KVILIB_API bool renameFile(const char * pcSrc, const char * pcDst);

        KVILIB_API bool makeDir(const QString & szPath);

        KVILIB_API bool makeDir(const char * pcPath);

        KVILIB_API bool readLine(QFile * pFile, QString & szBuffer, bool bUtf8 = true);

        KVILIB_API bool readLines(QFile * pFile, QStringList & buffer, int iStartLine = 0, int iCount = -1, bool bUtf8 = true);

        KVILIB_API bool isReadable(const QString & szFname);

        KVILIB_API bool isAbsolutePath(const QString & szPath);

        KVILIB_API void encodeFileName(QString & szPath);

        KVILIB_API void cleanFileName(QString & szPath);

        KVILIB_API QStringList getFileListing(const QString & szPath);
}

#endif //_KVI_FILEUTILS_H