From ce4a32fe52ef09d8f5ff1dd22c001110902b60a2 Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- kdecore/ksavefile.h | 152 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 152 insertions(+) create mode 100644 kdecore/ksavefile.h (limited to 'kdecore/ksavefile.h') diff --git a/kdecore/ksavefile.h b/kdecore/ksavefile.h new file mode 100644 index 000000000..7e05aaa81 --- /dev/null +++ b/kdecore/ksavefile.h @@ -0,0 +1,152 @@ +/* + This file is part of the KDE libraries + Copyright (c) 1999 Waldo Bastian + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License version 2 as published by the Free Software Foundation. + + This library 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 + Library General Public License for more details. + + You should have received a copy of the GNU Library General Public License + along with this library; see the file COPYING.LIB. If not, write to + the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. +*/ + +#ifndef _KSAVEFILE_H_ +#define _KSAVEFILE_H_ + +#include +#include +#include +#include + +class KSaveFilePrivate; + +/** + * The KSaveFile class has been made to write out changes to an existing + * file atomically. + * This means that EITHER: + * a) + * All changes have been written successfully to the file. + * + * b) + * Some error occurred, no changes have been written whatsoever and the + * old file is still in place. + */ +class KDECORE_EXPORT KSaveFile +{ +public: + /** + * Creates a new KSaveFile with the given file name. + * @param filename the path of the file + * @param mode the mode of the file (see chmod(1)) + */ + KSaveFile(const QString &filename, int mode = 0666 ); + + /** + * The destructor closes the file. + * You might want to call close() explicitely though, to test whether it worked. + **/ + ~KSaveFile(); + + /** + * Returns the status of the file based on errno. (see errno.h) + * 0 means OK. + * + * You should check the status after object creation to check + * whether a file could be created in the first place. + * + * You may check the status after closing the file to verify that + * the file has indeed been written correctly. + * @return the errno status, 0 means ok + **/ + int status() const + { return mTempFile.status(); } + + /** + * The name of the file as passed to the constructor. + * @return The name of the file, or QString::null if opening the + * file has failed + **/ + QString name() const; + + /** + * An integer file descriptor open for writing to the file. + * @return The file descriptor, or a negative number if opening + * the temporary file failed + **/ + int handle() const + { return mTempFile.handle(); } + + /** + * A FILE* stream open for writing to the file. + * @return FILE* stream open for writing to the file, or 0 + * if opening the temporary file failed + **/ + FILE *fstream() + { return mTempFile.fstream(); } + + /** + * A QFile* open for writing to the file. + * @return A QFile open for writing to the file, or 0 if + * opening the temporary file failed. + **/ + QFile *file() + { return mTempFile.file(); } + + /** + * A QTextStream* open for writing to the file. + * @return A QTextStream that is open for writing to the file, or 0 + * if opening the temporary file failed + **/ + QTextStream *textStream() + { return mTempFile.textStream(); } + + /** + * A QDataStream* open for writing to the file. + * @return A QDataStream that is open for writing to the file, or 0 + * if opening the file failed + **/ + QDataStream *dataStream() + { return mTempFile.dataStream(); } + + /** + * Aborts the write operation and removes any intermediate files + * This implies a close. + **/ + void abort(); + + /** + * Closes the file and makes the changes definitive. + * Returns 'true' is successful, or 'false' if an error has occurred. + * See status() for details about errors. + * @return true if successful, or false if an error has occurred. + **/ + bool close(); + + /** + * Static method to create a backup file before saving. + * You can use this method even if you don't use KSaveFile. + * @param filename the file to backup + * @param backupDir optional directory where to save the backup file in. + * If empty (the default), the backup will be in the same directory as @p filename. + * @param backupExtension the extension to append to @p filename, "~" by default. + * @since 3.2 + */ + static bool backupFile( const QString& filename, + const QString& backupDir = QString::null, + const QString& backupExtension = QString::fromLatin1( "~" ) ); + +private: + QString mFileName; + KTempFile mTempFile; + + KSaveFilePrivate *d; +}; + +#endif -- cgit v1.2.1