---

streams.File.h

/*----------------------------------------------------------------------------
  SWORD 2000 - Software With Objects for Rapid Development
  Copyright (C) 2003 Eric NICOLAS
  ----------------------------------------------------------------------------
  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_STREAMS_FILE_
#define _SWORD_STREAMS_FILE_

#include "sword/time.Time.h"

namespace sword {

        class SWORDDECL File {
        public:
                File();
                File(const char *pathname);
                File(const std::string &pathname);
                File(const File &file);
                File(const File &file, const std::string &pathname);
                File(const File &file, const char *pathname);

                void add(const std::string &pathname);
                void canonize() const;
                void canonize(const std::string &basepath) const;

                std::string pathname() const;
                std::string path()     const;
                std::string filename() const;
                std::string fileext()  const;

                bool exists()          const;
                bool isFile()          const;
                bool isDirectory()     const;
                bool isLink()          const;
                Time time()            const;
                word size()            const;

                // --- special directories factory

                enum Special
                {
                        spHome            = 0,    // Portable, $HOME or "My Documents"
                        spTemp            = 1,    // Portable
                        spCurrent         = 2,    // Portable, current working directory
                        spApplicationData = 3,    // MsWindows only
                        spStartMenu       = 4     // MsWindows only
                };

                static File special(Special which);

                // --- exceptions
                class NoEntryException : public Exception {};
                class SpecialDirException : public Exception {};

        private:
                mutable std::string pathname_;
                mutable bool        canonic_;
                //
                void canonize_(char *dest1) const;
                static bool exists_  (const std::string &pathname);
        };

} // namespace sword

#include "sword.private/streams.File.inl"

#endif // _SWORD_STREAMS_FILE_

---