File.h

Go to the documentation of this file.

//
// File.h
//
// $Id: //poco/1.3/Foundation/include/Poco/File.h#7 $
//
// Library: Foundation
// Package: Filesystem
// Module:  File
//
// Definition of the File 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_File_INCLUDED
#define Foundation_File_INCLUDED


#include "Poco/Foundation.h"
#include "Poco/Timestamp.h"
#include <vector>


#if defined(POCO_OS_FAMILY_WINDOWS) && defined(POCO_WIN32_UTF8)
#include "Poco/File_WIN32U.h"
#elif defined(POCO_OS_FAMILY_WINDOWS)
#include "Poco/File_WIN32.h"
#elif defined(POCO_OS_FAMILY_UNIX)
#include "Poco/File_UNIX.h"
#else
#include "Poco/File_VMS.h"
#endif


namespace Poco {


class Path;


class Foundation_API File: private FileImpl
{
public:
        typedef FileSizeImpl FileSize;

        File();

        File(const std::string& path);
                
        File(const char* path);

        File(const Path& path);
                
        File(const File& file);

        virtual ~File();
        
        File& operator = (const File& file);

        File& operator = (const std::string& path);

        File& operator = (const char* path);

        File& operator = (const Path& path);
                
        void swap(File& file);

        const std::string& path() const;
        
        bool exists() const;
                
        bool canRead() const;
                
        bool canWrite() const;

        bool canExecute() const;

        bool isFile() const;
                
        bool isLink() const;
                
        bool isDirectory() const;
                
        bool isDevice() const;

        bool isHidden() const;

        Timestamp created() const;

        Timestamp getLastModified() const;
                
        void setLastModified(const Timestamp& ts);
                
        FileSize getSize() const;
                
        void setSize(FileSize size);
                
        void setWriteable(bool flag = true);
                
        void setReadOnly(bool flag = true);
                
        void setExecutable(bool flag = true);
                
        void copyTo(const std::string& path) const;

        void moveTo(const std::string& path);
                
        void renameTo(const std::string& path);
                
        void remove(bool recursive = false);
        
        bool createFile();
        
        bool createDirectory();
        
        void createDirectories();
                
        void list(std::vector<std::string>& files) const;

        void list(std::vector<File>& files) const;

        bool operator == (const File& file) const;
        bool operator != (const File& file) const;
        bool operator <  (const File& file) const;
        bool operator <= (const File& file) const;
        bool operator >  (const File& file) const;
        bool operator >= (const File& file) const;
        
        static void handleLastError(const std::string& path);

protected:
        void copyDirectory(const std::string& path) const;
};


//
// inlines
//
inline const std::string& File::path() const
{
        return getPathImpl();
}


inline bool File::operator == (const File& file) const
{
        return getPathImpl() == file.getPathImpl();
}


inline bool File::operator != (const File& file) const
{
        return getPathImpl() != file.getPathImpl();
}


inline bool File::operator < (const File& file) const
{
        return getPathImpl() < file.getPathImpl();
}


inline bool File::operator <= (const File& file) const
{
        return getPathImpl() <= file.getPathImpl();
}


inline bool File::operator > (const File& file) const
{
        return getPathImpl() > file.getPathImpl();
}


inline bool File::operator >= (const File& file) const
{
        return getPathImpl() >= file.getPathImpl();
}


inline void swap(File& f1, File& f2)
{
        f1.swap(f2);
}


} // namespace Poco


#endif // Foundation_File_INCLUDED