File.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Niek Linnenbank
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __LIB_LIBFS_FILE_H
#define __LIB_LIBFS_FILE_H
 
#include <Types.h>
#include "FileSystemMessage.h"
#include "FileSystem.h"
#include "IOBuffer.h"
 
class File
{
  public:
 
    File(const u32 inode,
         const FileSystem::FileType type = FileSystem::RegularFile,
         const UserID uid = ZERO,
         const GroupID gid = ZERO);
 
    virtual ~File();
 
    u32 getInode() const;
 
    FileSystem::FileType getType() const;
 
    virtual FileSystem::Result read(IOBuffer & buffer,
                                    Size & size,
                                    const Size offset);
 
    virtual FileSystem::Result write(IOBuffer & buffer,
                                     Size & size,
                                     const Size offset);
 
    virtual FileSystem::Result status(FileSystem::FileStat &st);
 
    virtual bool canRead() const;
 
    virtual bool canWrite() const;
 
  protected:
 
    const u32 m_inode;
 
    const FileSystem::FileType m_type;
 
    UserID m_uid;
 
    GroupID m_gid;
 
    FileSystem::FileModes m_access;
 
    Size m_size;
};
 
#endif /* __LIB_LIBFS_FILE_H */