Community Core Audio (Alpha)

//

// TemporaryFile.h

//

// $Id: //poco/1.3/Foundation/include/Poco/TemporaryFile.h#1 $

//

// Library: Foundation

// Package: Filesystem

// Module:  TemporaryFile

//

// Definition of the TemporaryFile class.

//

// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.

// and Contributors.

//

// Permission is hereby granted, free of charge, to any person or organization

// obtaining a copy of the software and accompanying documentation covered by

// this license (the "Software") to use, reproduce, display, distribute,

// execute, and transmit the Software, and to prepare derivative works of the

// Software, and to permit third-parties to whom the Software is furnished to

// do so, all subject to the following:

//

// The copyright notices in the Software and this entire statement, including

// the above license grant, this restriction and the following disclaimer,

// must be included in all copies of the Software, in whole or in part, and

// all derivative works of the Software, unless such copies or derivative

// works are solely in the form of machine-executable object code generated by

// a source language processor.

//

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT

// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE

// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,

// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER

// DEALINGS IN THE SOFTWARE.

//

#ifndef Foundation_TemporaryFile_INCLUDED

#define Foundation_TemporaryFile_INCLUDED

#include "Poco/Foundation.h"

#include "Poco/File.h"

namespace Poco {

class Foundation_API TemporaryFile: public File

        /// The TemporaryFile class helps with the handling

        /// of temporary files.

        /// A unique name for the temporary file is

        /// automatically chosen and the file is placed

        /// in the directory reserved for temporary

        /// files (see Path::temp()).

        /// Obtain the path by calling the path() method

        /// (inherited from File).

        ///

        /// The TemporaryFile class does not actually

        /// create the file - this is up to the application.

        /// The class does, however, delete the temporary

        /// file - either in the destructor, or immediately

        /// before the application terminates.

{

public:

        TemporaryFile();

                /// Creates the TemporaryFile.

        ~TemporaryFile();

                /// Destroys the TemporaryFile and

                /// deletes the corresponding file on

                /// disk unless keep() or keepUntilExit()

                /// has been called.

        void keep();

                /// Disables automatic deletion of the file in

                /// the destructor.

        void keepUntilExit();

                /// Disables automatic deletion of the file in

                /// the destructor, but registers the file

                /// for deletion at process termination.

        static void registerForDeletion(const std::string& path);

                /// Registers the given file for deletion

                /// at process termination.

        static std::string tempName();

                /// Returns a unique path name for a temporary

                /// file in the system's scratch directory

                /// (see Path::temp()).

private:

        bool _keep;

};

} // namespace Poco

#endif // Foundation_TemporaryFile_INCLUDED