TarEntry.h

/* Copyright (C) 2008 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_TAR_ENTRY_H
#define PT_SYSTEM_TAR_ENTRY_H
 
#include <Pt/System/Api.h>
#include <Pt/System/FileInfo.h>
#include <Pt/System/Path.h>
#include <Pt/DateTime.h>
 
#include <cstddef>
 
namespace Pt {
 
namespace System {
 
class TarEntry
{
  public:
    enum Type
    {
        Invalid   = 0, 
        File      = 1, 
        Directory = 2, 
        Link      = 3, 
        Hardlink  = 4  
    };
 
    TarEntry() = default;
 
    TarEntry(TarEntry&&) = default;
 
    TarEntry& operator=(TarEntry&&) = default;
 
    ~TarEntry() = default;
 
    void clear()
    { *this = TarEntry(); }
 
    bool isEnd() const
    { return _avail == _remaining; }
 
    const Pt::System::Path& path() const
    { return _path; }
 
    std::size_t size() const
    { return _size; }
 
    std::size_t remaining() const
    { return _remaining; }
 
    std::size_t avail() const
    { return _avail; }
 
    const char* data() const
    { return _data; }
 
    Type type() const
    { return _type; }
 
    const Pt::System::Path& linkTarget() const
    { return _linkTarget; }
 
    Pt::System::FileInfo::Perms permissions() const
    { return _permissions; }
 
    const Pt::DateTime& mtime() const
    { return _mtime; }
 
    void setPath(const Pt::System::Path& path)
    { _path = path; }
 
    void setSize(std::size_t size)
    { _size = size; }
 
    void setRemaining(std::size_t remaining)
    { _remaining   = remaining; }
 
    void setData(const char* data, std::size_t avail)
    { _data = data; _avail = avail; }
 
    void setType(Type type)
    { _type = type; }
 
    void setLinkTarget(const Pt::System::Path& target)
    { _linkTarget = target; }
 
    void setPermissions(Pt::System::FileInfo::Perms p)
    { _permissions = p; }
 
    void setMtime(const Pt::DateTime& mtime)
    { _mtime = mtime; }
 
  private:
    TarEntry(const TarEntry&) = delete;
 
    TarEntry& operator=(const TarEntry&) = delete;
 
  private:
    Pt::System::Path             _path;
    std::size_t                  _size        = 0;
    std::size_t                  _remaining   = 0;
    std::size_t                  _avail       = 0;
    const char*                  _data        = 0;
    Type                         _type        = Invalid;
    Pt::System::Path             _linkTarget;
    Pt::System::FileInfo::Perms  _permissions;
    Pt::DateTime                 _mtime;
};
 
} // namespace System
 
} // namespace Pt
 
#endif // include guard