File indexing completed on 2024-04-14 14:20:07

 /*
    This file is part of the KDE libraries
    Copyright (c) 2003 Joseph Wenninger <jowenn@kde.org>
 
    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 KTEMPDIR_H
 #define KTEMPDIR_H
 
 #include <kdelibs4support_export.h>
 #include <QString>
 
 /**
  * \class KTempDir ktempdir.h <KTempDir>
  *
  * @deprecated use QTemporaryDir
  *
  * @brief Create a unique directory for temporary use.
  *
  * The KTempDir class creates a unique directory for temporary use.
  *
  * Porting to QTemporaryDir goes as follows:
  * - Replace KTempDir with QTemporaryDir
  * - Replace name() with path(), but keep in mind that name ended with a '/', while path does not.
  * - Replace status() with isValid()
  *
  * A typical usage of KTempDir was
  *    KTempDir(KStandardDirs::locateLocal("tmp", prefix));
  * This should be ported to
  *    QTemporaryDir(QDir::tempPath() + QLatin1Char('/') + prefix);
  *
  * Note: KTempDir does not create any missing directories, but
  * KStandardDirs::locateLocal() does.
  *
  * @see QTemporaryDir
  */
 class KDELIBS4SUPPORT_DEPRECATED_EXPORT KTempDir
 {
 public:
     /**
      * Creates a temporary directory with the name:
      *  \p \<directoryPrefix\>\<six letters\>
      *
      * The default \p directoryPrefix is "/tmp/appname"
      *
      * @param directoryPrefix the prefix of the file name, or
      *        QString() for the default value
      * @param mode the file permissions,
      * almost always in octal. The first digit selects permissions for
      * the user who owns the file: read (4), write (2), and execute
      * (1); the second selects permissions for other users in the
      * file's group, with the same values; and the third for other
      * users not in the file's group, with the same values.
      *
      * @deprecated Use QTemporaryDir() or QTemporaryDir(directoryPrefix).
      * If a specific mode was set, you'll need to use QFile::setPermissions on the temporary dir path.
      */
     KDELIBS4SUPPORT_DEPRECATED explicit KTempDir(const QString &directoryPrefix = QString(),
                       int mode = 0700);
 
     /**
      * The destructor deletes the directory and its contents if autoRemove
      * is set to true.
      * @see setAutoRemove.
      **/
     ~KTempDir();
 
     /**
      * Turn automatic deletion of the directory on or off.
      * Automatic deletion is on by default.
      * @param autoRemove toggle automatic deletion on or off
      **/
     void setAutoRemove(bool autoRemove);
 
     /**
      * @return whether auto remove is active
      * @see setAutoRemove
      **/
     bool autoRemove() const;
 
     /**
      * Returns the status of the directory creation  based on errno.
      * (see errno.h)
      *
      * @note You should check the status after object creation to check
      * whether the directory could be created.
      *
      * @return the errno status, 0 means ok
      *
      * @deprecated use QTemporaryDir::isValid()
      */
     int status() const;
 
     /**
      * Returns the full path and name of the directory, including a
      * trailing '/'.
      * @return The name of the directory, or QString() if creating the
      *         directory has failed or the directory has been unlinked
      *
      * @deprecated use QTemporaryDir::path()
      */
     QString name() const;
 
     /**
      * Deletes the directory recursively
      *
      * @deprecated use QTemporaryDir::remove()
      */
     void unlink();
 
     /**
      * Returns true if a temporary directory has successfully been created
      * and has not been unlinked yet.
      *
      * @deprecated use QTemporaryDir::isValid() + QDir::exists(path) if there's really
      * a doubt that it might have been deleted meanwhile.
      */
     bool exists() const;
 
     /**
      * @brief Remove a directory and all its contents
      *
      * Remove recursively a directory, even if it is not empty
      * or contains other directories.
      *
      * However the function works too when the @p path given
      * is a non-directory file. In that case it simply remove that file.
      *
      * The function stops on the first error.
      *
      * @note This function is more meant for removing a directory
      * not created by the user. For user-created directories,
      * using KIO::del() is recommended instead,
      * especially as it has user feedback for long operations.
      *
      * @param path Path of the directory to delete
      * @return true if successful, otherwise false
      * (Use errno for more details about the error.)
      *
      * @deprecated use QDir(path)::removeRecursively in Qt 5.
      */
     static bool removeDir(const QString &path);
 
 protected:
 
     /**
      * Creates a "random" directory with specified mode
      * @param directoryPrefix to use when creating temp directory
      *       (the rest is generated randomly)
      * @param mode directory permissions
      * @return true upon success
      */
     bool create(const QString &directoryPrefix,  int mode);
 
 private:
     class Private;
     Private *const d;
 };
 
 #endif