FatDirectory.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 FAT_DIRECTORY_H
#define FAT_DIRECTORY_H
 
#include "pedigree/kernel/process/Mutex.h"
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/String.h"
 
#include "fat.h"
#include "modules/system/vfs/Directory.h"
 
class File;
 
class FatDirectory : public Directory {
  friend class FatFilesystem;
 
 private:
  FatDirectory(const FatDirectory& file);
  FatDirectory& operator=(const FatDirectory&);
 
 public:
  FatDirectory(String name, uintptr_t cluster, class FatFilesystem* pFs, File* pParent,
               FatFileInfo& info, uint32_t dirClus = 0, uint32_t dirOffset = 0);
  ~FatDirectory() override;
 
  void truncate() override {}
 
  void cacheDirectoryContents() override;
 
  virtual bool addEntry(String filename, File* pFile, size_t type, bool publish = true);
  virtual bool removeEntry(const String& filename, File* pFile);
 
  void fileAttributeChanged() override;
  bool sync() override;
  bool sync(size_t, bool) override {
    return sync();
  }
  Attributes getAttributes() const override;
 
  void setInode(uintptr_t inode) override;
 
  uint32_t getDirCluster() {
    return m_DirClus;
  }
  void setDirCluster(uint32_t custom) {
    m_DirClus = custom;
  }
  uint32_t getDirOffset() {
    return m_DirOffset;
  }
  void setDirOffset(uint32_t custom) {
    m_DirOffset = custom;
  }
 
  static const String& symlinkSuffix() {
    static String s(".__sym");
    return s;
  }
 
 private:
  class NamespaceEdit;
  bool encodeEntrySet(const String& filename, const Dir& metadata, Vector<Dir>& entries);
 
  struct ScannedEntry {
    String name;
    Dir entry;
    uint32_t directoryCluster;
    uint32_t directoryOffset;
    Directory::EntryType type;
  };
 
  using ScanEmitter = bool (*)(void*, const ScannedEntry&, uint64_t, uint64_t);
 
  LookupStatus resolveChild(const StringView& name, File*& child) override;
  LookupStatus resolveChildAt(uint64_t cookie, const StringView& name, File*& child) override;
  ReadStatus readDirectory(uint64_t& cookie, DirectoryEntryEmitter emitter, void* context) override;
 
  ReadStatus scanDirectory(uint64_t& cookie, ScanEmitter emitter, void* context);
  File* materialize(const ScannedEntry& entry);
 
  uint32_t m_DirClus;
  uint32_t m_DirOffset;
  bool m_Unlinked;
 
  FatType m_Type;
  uintptr_t m_BlockSize;
  bool m_bRootDir;
 
  Mutex m_Lock;
 
  uint32_t m_DirBlockSize;
};
 
#endif