---

base.FileSystem.h

/*----------------------------------------------------------------------------
  SWORD 2000 - Software With Objects for Rapid Development
  Copyright (C) 2003 David Jobet
  ----------------------------------------------------------------------------
  SWORD 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 of the License, or
  (at your option) any later version.

  SWORD 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 SWORD; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  --------------------------------------------------------------------------*/
#ifndef _SWORD_BASE_FILESYSTEM_
#define _SWORD_BASE_FILESYSTEM_

#include "sword/streams.File.h"
#include <vector>

namespace sword {

        class SWORDDECL FileSystem {
        public:
                FileSystem(const std::string& path);
                FileSystem(const File& file);
                FileSystem();

                void chdir(const std::string& path);
                void chdir(const File& file);

                void mkdir(const std::string& path) const;
                void mkdir(const File& path) const;
                static void remove(const std::string& path);
                static void remove(const File& path);
                static void removeFile(const std::string& path);
                static void removeFile(const File& path);
                static void removeDirectory(const std::string& path);
                static void removeDirectory(const File& path);

                // --- Different ways of accessing a disk file

                enum Mode
                {
                        // File reading modes
                        open           = 1,       // Open an existing file (the file *must* exist)
                        openOrCreate   = 2,       // Open a file or create it empty if it was not there

                        // File writing modes
                        create         = 3,       // Create a new file (there *must not* be a file already there)
                        createAlways   = 4,       // Create a new file always (if there is already one, truncate it)
                        append         = 5,       // Append to a file (there *must* be a file already there)
                        appendOrCreate = 6,       // Append to a file or create it if it was not there

                        // File reading and writing additional options (hints)
                        inherit        = 0x0100,  // Child process will inherit it
                        random         = 0x0200,  // Will do only random access
                        sequential     = 0x0400   // Will do only sequential access
                };

                // --- exceptions
                class RemoveException : public Exception {};
                class MkdirException : public Exception {};

                class const_iterator
                {
                public :
                        const_iterator(const FileSystem *fileSystem, int index = 0);
                        const_iterator(const const_iterator &it);

                        ~const_iterator();

                        const File &operator *()  const;
                        const File *operator ->() const;
                        bool operator ==(const const_iterator &it) const;
                        bool operator !=(const const_iterator &it) const;
                        const_iterator &operator ++();
                        const_iterator &operator --();

                private :
                        const FileSystem *fileSystem_;
                int index_;
                };
                friend class const_iterator;

                const_iterator begin() const;
                const_iterator end() const;

        private:
                File current_;
                mutable word nbLiveIterator_;
                mutable std::vector<File> cache_;

                static void mkdir_   (const std::string &path);
                void cacheFiles_() const;
        };

} // namespace sword

#include "sword.private/base.FileSystem.inl"

#endif // _SWORD_BASE_FILESYSTEM_

---