Line data    Source code

       1             : /* Copyright (C) 2021 Wildfire Games.
       2             :  *
       3             :  * Permission is hereby granted, free of charge, to any person obtaining
       4             :  * a copy of this software and associated documentation files (the
       5             :  * "Software"), to deal in the Software without restriction, including
       6             :  * without limitation the rights to use, copy, modify, merge, publish,
       7             :  * distribute, sublicense, and/or sell copies of the Software, and to
       8             :  * permit persons to whom the Software is furnished to do so, subject to
       9             :  * the following conditions:
      10             :  *
      11             :  * The above copyright notice and this permission notice shall be included
      12             :  * in all copies or substantial portions of the Software.
      13             :  *
      14             :  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
      15             :  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
      16             :  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
      17             :  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
      18             :  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
      19             :  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
      20             :  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
      21             :  */
      22             : 
      23             : #ifndef INCLUDED_REAL_DIRECTORY
      24             : #define INCLUDED_REAL_DIRECTORY
      25             : 
      26             : #include "lib/file/common/file_loader.h"
      27             : #include "lib/sysdep/dir_watch.h"
      28             : 
      29        1718 : class RealDirectory : public IFileLoader
      30             : {
      31             :     NONCOPYABLE(RealDirectory);
      32             : public:
      33             :     RealDirectory(const OsPath& path, size_t priority, size_t flags);
      34             : 
      35        3729 :     size_t Priority() const
      36             :     {
      37        3729 :         return m_priority;
      38             :     }
      39             : 
      40        1212 :     size_t Flags() const
      41             :     {
      42        1212 :         return m_flags;
      43             :     }
      44             : 
      45             :     // IFileLoader
      46             :     virtual size_t Precedence() const;
      47             :     virtual wchar_t LocationCode() const;
      48        2130 :     virtual OsPath Path() const
      49             :     {
      50        2130 :         return m_path;
      51             :     }
      52             :     virtual Status Load(const OsPath& name, const std::shared_ptr<u8>& buf, size_t size) const;
      53             : 
      54             :     Status Store(const OsPath& name, const std::shared_ptr<u8>& fileContents, size_t size);
      55             : 
      56             :     void Watch();
      57             : 
      58             : private:
      59             :     // note: paths are relative to the root directory, so storing the
      60             :     // entire path instead of just the portion relative to the mount point
      61             :     // is not all too wasteful.
      62             :     const OsPath m_path;
      63             : 
      64             :     const size_t m_priority;
      65             : 
      66             :     const size_t m_flags;
      67             : 
      68             :     // note: watches are needed in each directory because some APIs
      69             :     // (e.g. FAM) cannot watch entire trees with one call.
      70             :     PDirWatch m_watch;
      71             : };
      72             : 
      73             : typedef std::shared_ptr<RealDirectory> PRealDirectory;
      74             : 
      75             : extern PRealDirectory CreateRealSubdirectory(const PRealDirectory& realDirectory, const OsPath& subdirectoryName);
      76             : 
      77             : #endif  // #ifndef INCLUDED_REAL_DIRECTORY