Filesystem.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef FILESYSTEM_H
#define FILESYSTEM_H

#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/String.h"

class Disk;
class File;
class StringView;

class EXPORTED_PUBLIC Filesystem
{
    friend class VFS;

  public:
    //
    // Public interface
    //

    Filesystem();
    virtual ~Filesystem();

    virtual bool initialise(Disk *pDisk) = 0;

    typedef Filesystem *(*ProbeCallback)(Disk *);

    virtual File *find(const StringView &path);
    virtual File *find(const String &path);
    virtual File *find(const StringView &path, File *pStartNode);
    virtual File *find(const String &path, File *pStartNode);

    virtual File *getRoot() const = 0;

    virtual String getVolumeLabel() const = 0;

    bool
    createFile(const StringView &path, uint32_t mask, File *pStartNode = 0);

    bool createDirectory(
        const StringView &path, uint32_t mask, File *pStartNode = 0);

    bool createSymlink(
        const StringView &path, const String &value, File *pStartNode = 0);

    bool createLink(const StringView &path, File *target, File *pStartNode = 0);

    bool remove(const StringView &path, File *pStartNode = 0);

    Disk *getDisk()
    {
        return m_pDisk;
    }

    bool isReadOnly()
    {
        return m_bReadOnly;
    }

    virtual bool isCaseSensitive()
    {
        return true;
    }

    virtual bool remove(File *parent, File *file) = 0;

  protected:
    virtual bool
    createFile(File *parent, const String &filename, uint32_t mask) = 0;
    virtual bool
    createDirectory(File *parent, const String &filename, uint32_t mask) = 0;
    virtual bool createSymlink(
        File *parent, const String &filename, const String &value) = 0;
    virtual bool createLink(File *parent, const String &filename, File *target);
    bool m_bReadOnly;
    Disk *m_pDisk;

  private:
    File *getTrueRoot();

    File *findNode(File *pNode, StringView path);

    File *findParent(StringView path, File *pStartNode, String &filename);

    size_t m_nAliases;

    Filesystem(const Filesystem &);
    void operator=(const Filesystem &);
};

#endif