FileInfo.h

/*
 * Copyright (C) 2006-2013 Marc Boris Duerner
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * As a special exception, you may use this file as part of a free
 * software library without restriction. Specifically, if other files
 * instantiate templates or use macros or inline functions from this
 * file, or you compile this file and link it with other files to
 * produce an executable, this file does not by itself cause the
 * resulting executable to be covered by the GNU General Public
 * License. This exception does not however invalidate any other
 * reasons why the executable file might be covered by the GNU Library
 * General Public License.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef Pt_System_FileInfo_h
#define Pt_System_FileInfo_h
 
#include <Pt/System/Api.h>
#include <Pt/System/Path.h>
#include <Pt/DateTime.h>
#include <Pt/String.h>
#include <Pt/Types.h>
#include <string>
 
namespace Pt {
 
namespace System {

class PT_SYSTEM_API FileInfo
{
    public:
        enum Type
        {
            Invalid = 0,   
            Directory = 1, 
            File = 2,      
            Link = 4       
        };

        enum Perms
        {
            NoPerms     = 0,      
            OwnerRead   = 0400,   
            OwnerWrite  = 0200,   
            OwnerExec   = 0100,   
            OwnerAll    = 0700,   
            GroupRead   = 040,    
            GroupWrite  = 020,    
            GroupExec   = 010,    
            GroupAll    = 070,    
            OthersRead  = 04,     
            OthersWrite = 02,     
            OthersExec  = 01,     
            OthersAll   = 07,     
            AllPerms    = 0777,   
            SetUid      = 04000,  
            SetGid      = 02000,  
            StickyBit   = 01000,  
            PermMask    = 07777,  
            UnknownPerms = 0xFFFF 
        };

        enum PermOptions
        {
            PermReplace  = 1, 
            PermAdd      = 2, 
            PermRemove   = 4, 
            PermNoFollow = 8  
        };
 
    public:
        FileInfo()
        {}

        explicit FileInfo(const Path& path);

        explicit FileInfo(const Pt::String& path);

        explicit FileInfo(const char* path);

        ~FileInfo()
        {}

        void clear();

        const Path& path() const
        { return _path; }

        Pt::uint64_t size() const
        { return FileInfo::size(_path); }

        Type type() const
        { return FileInfo::type(_path); }
 
        bool isLink() const
        { return FileInfo::isLink(_path); }

        Perms permissions() const
        { return FileInfo::permissions(_path); }
 
    public:
        static Type type(const Path& path);
 
        static bool isLink(const Path& path);

        static Pt::uint64_t size(const Path& path);

        static DateTime lastModified(const Path& path);

        static Perms permissions(const Path& path);

        static void permissions(const Path& path, Perms prms,
                                PermOptions opts = PermReplace);

        static bool exists(const Path& path)
        { return type(path) != Invalid; }

        static void createFile(const Path& path);

        static void createSymlink(const Path& target, const Path& link);

        static void createHardlink(const Path& target, const Path& link);

        static void createDirectory(const Path& path);

        static void createDirectories(const Path& path);

        static void resize(const Path& path, Pt::uint64_t n);

        static void remove(const Path& path);

        static void removeAll(const Pt::System::Path& path);

        static void move(const Path& path, const Path& to);
 
    public:
        Path& path()
        { return _path; }
 
    private:
        Path _path;
};
 

inline FileInfo::Perms operator|(FileInfo::Perms a, FileInfo::Perms b)
{
    return static_cast<FileInfo::Perms>(static_cast<int>(a) | static_cast<int>(b));
}

inline FileInfo::Perms operator&(FileInfo::Perms a, FileInfo::Perms b)
{
    return static_cast<FileInfo::Perms>(static_cast<int>(a) & static_cast<int>(b));
}

inline FileInfo::Perms operator^(FileInfo::Perms a, FileInfo::Perms b)
{
    return static_cast<FileInfo::Perms>(static_cast<int>(a) ^ static_cast<int>(b));
}

inline FileInfo::Perms operator~(FileInfo::Perms a)
{
    return static_cast<FileInfo::Perms>(~static_cast<int>(a));
}

inline FileInfo::Perms& operator|=(FileInfo::Perms& a, FileInfo::Perms b)
{
    a = a | b;
    return a;
}

inline FileInfo::Perms& operator&=(FileInfo::Perms& a, FileInfo::Perms b)
{
    a = a & b;
    return a;
}

inline FileInfo::PermOptions operator|(FileInfo::PermOptions a, FileInfo::PermOptions b)
{
    return static_cast<FileInfo::PermOptions>(static_cast<int>(a) | static_cast<int>(b));
}
 

inline bool operator<(const FileInfo& a, const FileInfo& b)
{
    return a.path() < b.path();
}

inline bool operator==(const FileInfo& a, const FileInfo& b)
{
    return a.path() == b.path();
}

inline bool operator!=(const FileInfo& a, const FileInfo& b)
{
    return !(a == b);
}
 
} // namespace System
 
} // namespace Pt
 
#endif // Pt_System_FileInfo_h