Chris@16: //  boost/filesystem/operations.hpp  ---------------------------------------------------//
Chris@16: 
Chris@16: //  Copyright Beman Dawes 2002-2009
Chris@16: //  Copyright Jan Langer 2002
Chris@16: //  Copyright Dietmar Kuehl 2001                                        
Chris@16: //  Copyright Vladimir Prus 2002
Chris@16:    
Chris@16: //  Distributed under the Boost Software License, Version 1.0.
Chris@16: //  See http://www.boost.org/LICENSE_1_0.txt
Chris@16: 
Chris@16: //  Library home page: http://www.boost.org/libs/filesystem
Chris@16: 
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: 
Chris@16: #ifndef BOOST_FILESYSTEM3_OPERATIONS_HPP
Chris@16: #define BOOST_FILESYSTEM3_OPERATIONS_HPP
Chris@16: 
Chris@16: #include <boost/config.hpp>
Chris@16: 
Chris@16: # if defined( BOOST_NO_STD_WSTRING )
Chris@16: #   error Configuration not supported: Boost.Filesystem V3 and later requires std::wstring support
Chris@16: # endif
Chris@16: 
Chris@16: #include <boost/filesystem/config.hpp>
Chris@16: #include <boost/filesystem/path.hpp>
Chris@16: 
Chris@16: #include <boost/detail/scoped_enum_emulation.hpp>
Chris@16: #include <boost/detail/bitmask.hpp>
Chris@16: #include <boost/system/error_code.hpp>
Chris@16: #include <boost/system/system_error.hpp>
Chris@16: #include <boost/shared_ptr.hpp>
Chris@16: #include <boost/utility/enable_if.hpp>
Chris@16: #include <boost/type_traits/is_same.hpp>
Chris@16: #include <boost/iterator.hpp>
Chris@16: #include <boost/cstdint.hpp>
Chris@101: #include <boost/range/mutable_iterator.hpp>
Chris@101: #include <boost/range/const_iterator.hpp>
Chris@16: #include <boost/assert.hpp>
Chris@16: #include <string>
Chris@16: #include <utility> // for pair
Chris@16: #include <ctime>
Chris@16: #include <vector>
Chris@16: #include <stack>
Chris@16: 
Chris@16: #ifdef BOOST_WINDOWS_API
Chris@16: #  include <fstream>
Chris@16: #endif
Chris@16: 
Chris@16: #include <boost/config/abi_prefix.hpp> // must be the last #include
Chris@16: 
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: 
Chris@16: namespace boost
Chris@16: {
Chris@16:   namespace filesystem
Chris@16:   {
Chris@16: 
Chris@101:     //--------------------------------------------------------------------------------------//
Chris@101:     //                                                                                      //
Chris@101:     //                            class filesystem_error                                    //
Chris@101:     //                                                                                      //
Chris@101:     //--------------------------------------------------------------------------------------//
Chris@101: 
Chris@101:     class BOOST_SYMBOL_VISIBLE filesystem_error : public system::system_error
Chris@101:     {
Chris@101:       // see http://www.boost.org/more/error_handling.html for design rationale
Chris@101: 
Chris@101:       // all functions are inline to avoid issues with crossing dll boundaries
Chris@101: 
Chris@101:       // functions previously throw() are now BOOST_NOEXCEPT_OR_NOTHROW
Chris@101:       // functions previously without throw() are now BOOST_NOEXCEPT
Chris@101: 
Chris@101:     public:
Chris@101:       // compiler generates copy constructor and copy assignment
Chris@101: 
Chris@101:       filesystem_error(
Chris@101:         const std::string & what_arg, system::error_code ec) BOOST_NOEXCEPT
Chris@101:         : system::system_error(ec, what_arg)
Chris@101:       {
Chris@101:         try
Chris@101:         {
Chris@101:           m_imp_ptr.reset(new m_imp);
Chris@101:         }
Chris@101:         catch (...) { m_imp_ptr.reset(); }
Chris@101:       }
Chris@101: 
Chris@101:       filesystem_error(
Chris@101:         const std::string & what_arg, const path& path1_arg,
Chris@101:         system::error_code ec) BOOST_NOEXCEPT
Chris@101:         : system::system_error(ec, what_arg)
Chris@101:       {
Chris@101:         try
Chris@101:         {
Chris@101:           m_imp_ptr.reset(new m_imp);
Chris@101:           m_imp_ptr->m_path1 = path1_arg;
Chris@101:         }
Chris@101:         catch (...) { m_imp_ptr.reset(); }
Chris@101:       }
Chris@101: 
Chris@101:       filesystem_error(
Chris@101:         const std::string & what_arg, const path& path1_arg,
Chris@101:         const path& path2_arg, system::error_code ec) BOOST_NOEXCEPT
Chris@101:         : system::system_error(ec, what_arg)
Chris@101:       {
Chris@101:         try
Chris@101:         {
Chris@101:           m_imp_ptr.reset(new m_imp);
Chris@101:           m_imp_ptr->m_path1 = path1_arg;
Chris@101:           m_imp_ptr->m_path2 = path2_arg;
Chris@101:         }
Chris@101:         catch (...) { m_imp_ptr.reset(); }
Chris@101:       }
Chris@101: 
Chris@101:       ~filesystem_error() BOOST_NOEXCEPT_OR_NOTHROW{}
Chris@101: 
Chris@101:         const path& path1() const BOOST_NOEXCEPT
Chris@101:       {
Chris@101:         static const path empty_path;
Chris@101:         return m_imp_ptr.get() ? m_imp_ptr->m_path1 : empty_path;
Chris@101:       }
Chris@101:         const path& path2() const  BOOST_NOEXCEPT
Chris@101:       {
Chris@101:         static const path empty_path;
Chris@101:         return m_imp_ptr.get() ? m_imp_ptr->m_path2 : empty_path;
Chris@101:       }
Chris@101: 
Chris@101:         const char* what() const BOOST_NOEXCEPT_OR_NOTHROW
Chris@101:       {
Chris@101:         if (!m_imp_ptr.get())
Chris@101:         return system::system_error::what();
Chris@101: 
Chris@101:         try
Chris@101:         {
Chris@101:           if (m_imp_ptr->m_what.empty())
Chris@101:           {
Chris@101:             m_imp_ptr->m_what = system::system_error::what();
Chris@101:             if (!m_imp_ptr->m_path1.empty())
Chris@101:             {
Chris@101:               m_imp_ptr->m_what += ": \"";
Chris@101:               m_imp_ptr->m_what += m_imp_ptr->m_path1.string();
Chris@101:               m_imp_ptr->m_what += "\"";
Chris@101:             }
Chris@101:             if (!m_imp_ptr->m_path2.empty())
Chris@101:             {
Chris@101:               m_imp_ptr->m_what += ", \"";
Chris@101:               m_imp_ptr->m_what += m_imp_ptr->m_path2.string();
Chris@101:               m_imp_ptr->m_what += "\"";
Chris@101:             }
Chris@101:           }
Chris@101:           return m_imp_ptr->m_what.c_str();
Chris@101:         }
Chris@101:         catch (...)
Chris@101:         {
Chris@101:           return system::system_error::what();
Chris@101:         }
Chris@101:       }
Chris@101: 
Chris@101:     private:
Chris@101:       struct m_imp
Chris@101:       {
Chris@101:         path         m_path1; // may be empty()
Chris@101:         path         m_path2; // may be empty()
Chris@101:         std::string  m_what;  // not built until needed
Chris@101:       };
Chris@101:       boost::shared_ptr<m_imp> m_imp_ptr;
Chris@101:     };
Chris@101: 
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: //                                     file_type                                        //
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: 
Chris@16:   enum file_type
Chris@16:   { 
Chris@16:     status_error,
Chris@16: #   ifndef BOOST_FILESYSTEM_NO_DEPRECATED
Chris@16:     status_unknown = status_error,
Chris@16: #   endif
Chris@16:     file_not_found,
Chris@16:     regular_file,
Chris@16:     directory_file,
Chris@16:     // the following may not apply to some operating systems or file systems
Chris@16:     symlink_file,
Chris@16:     block_file,
Chris@16:     character_file,
Chris@16:     fifo_file,
Chris@16:     socket_file,
Chris@16:     reparse_file,  // Windows: FILE_ATTRIBUTE_REPARSE_POINT that is not a symlink
Chris@16:     type_unknown,  // file does exist, but isn't one of the above types or
Chris@16:                    // we don't have strong enough permission to find its type
Chris@16: 
Chris@16:     _detail_directory_symlink  // internal use only; never exposed to users
Chris@16:   };
Chris@16: 
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: //                                       perms                                          //
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: 
Chris@16:   enum perms
Chris@16:   {
Chris@16:     no_perms = 0,       // file_not_found is no_perms rather than perms_not_known
Chris@16: 
Chris@16:     // POSIX equivalent macros given in comments.
Chris@16:     // Values are from POSIX and are given in octal per the POSIX standard.
Chris@16: 
Chris@16:     // permission bits
Chris@16:     
Chris@16:     owner_read = 0400,  // S_IRUSR, Read permission, owner
Chris@16:     owner_write = 0200, // S_IWUSR, Write permission, owner
Chris@16:     owner_exe = 0100,   // S_IXUSR, Execute/search permission, owner
Chris@16:     owner_all = 0700,   // S_IRWXU, Read, write, execute/search by owner
Chris@16: 
Chris@16:     group_read = 040,   // S_IRGRP, Read permission, group
Chris@16:     group_write = 020,  // S_IWGRP, Write permission, group
Chris@16:     group_exe = 010,    // S_IXGRP, Execute/search permission, group
Chris@16:     group_all = 070,    // S_IRWXG, Read, write, execute/search by group
Chris@16: 
Chris@16:     others_read = 04,   // S_IROTH, Read permission, others
Chris@16:     others_write = 02,  // S_IWOTH, Write permission, others
Chris@16:     others_exe = 01,    // S_IXOTH, Execute/search permission, others
Chris@16:     others_all = 07,    // S_IRWXO, Read, write, execute/search by others
Chris@16: 
Chris@101:     all_all = 0777,     // owner_all|group_all|others_all
Chris@16: 
Chris@16:     // other POSIX bits
Chris@16: 
Chris@16:     set_uid_on_exe = 04000, // S_ISUID, Set-user-ID on execution
Chris@16:     set_gid_on_exe = 02000, // S_ISGID, Set-group-ID on execution
Chris@16:     sticky_bit     = 01000, // S_ISVTX,
Chris@16:                             // (POSIX XSI) On directories, restricted deletion flag 
Chris@101:                             // (V7) 'sticky bit': save swapped text even after use 
Chris@16:                             // (SunOS) On non-directories: don't cache this file
Chris@16:                             // (SVID-v4.2) On directories: restricted deletion flag
Chris@16:                             // Also see http://en.wikipedia.org/wiki/Sticky_bit
Chris@16: 
Chris@101:     perms_mask = 07777,     // all_all|set_uid_on_exe|set_gid_on_exe|sticky_bit
Chris@16: 
Chris@16:     perms_not_known = 0xFFFF, // present when directory_entry cache not loaded
Chris@16: 
Chris@16:     // options for permissions() function
Chris@16: 
Chris@16:     add_perms = 0x1000,     // adds the given permission bits to the current bits
Chris@16:     remove_perms = 0x2000,  // removes the given permission bits from the current bits;
Chris@16:                             // choose add_perms or remove_perms, not both; if neither add_perms
Chris@16:                             // nor remove_perms is given, replace the current bits with
Chris@16:                             // the given bits.
Chris@16: 
Chris@16:     symlink_perms = 0x4000  // on POSIX, don't resolve symlinks; implied on Windows
Chris@16:   };
Chris@16: 
Chris@16:   BOOST_BITMASK(perms)
Chris@16: 
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: //                                    file_status                                       //
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: 
Chris@16:   class BOOST_FILESYSTEM_DECL file_status
Chris@16:   {
Chris@16:   public:
Chris@16:              file_status()            : m_value(status_error), m_perms(perms_not_known) {}
Chris@16:     explicit file_status(file_type v, perms prms = perms_not_known)
Chris@16:                                       : m_value(v), m_perms(prms) {}
Chris@16: 
Chris@16:     // observers
Chris@16:     file_type  type() const                       { return m_value; }
Chris@16:     perms      permissions() const                { return m_perms; } 
Chris@16: 
Chris@16:     // modifiers
Chris@16:     void       type(file_type v)                  { m_value = v; }
Chris@16:     void       permissions(perms prms)            { m_perms = prms; }
Chris@16: 
Chris@16:     bool operator==(const file_status& rhs) const { return type() == rhs.type() && 
Chris@16:                                                     permissions() == rhs.permissions(); }
Chris@16:     bool operator!=(const file_status& rhs) const { return !(*this == rhs); }
Chris@16: 
Chris@16:   private:
Chris@16:     file_type   m_value;
Chris@16:     enum perms  m_perms;
Chris@16:   };
Chris@16: 
Chris@16:   inline bool type_present(file_status f) { return f.type() != status_error; }
Chris@16:   inline bool permissions_present(file_status f)
Chris@16:                                           {return f.permissions() != perms_not_known;}
Chris@16:   inline bool status_known(file_status f) { return type_present(f) && permissions_present(f); }
Chris@16:   inline bool exists(file_status f)       { return f.type() != status_error
Chris@16:                                                 && f.type() != file_not_found; }
Chris@16:   inline bool is_regular_file(file_status f){ return f.type() == regular_file; }
Chris@16:   inline bool is_directory(file_status f) { return f.type() == directory_file; }
Chris@16:   inline bool is_symlink(file_status f)   { return f.type() == symlink_file; }
Chris@16:   inline bool is_other(file_status f)     { return exists(f) && !is_regular_file(f)
Chris@16:                                                 && !is_directory(f) && !is_symlink(f); }
Chris@16: 
Chris@16: # ifndef BOOST_FILESYSTEM_NO_DEPRECATED
Chris@16:   inline bool is_regular(file_status f)   { return f.type() == regular_file; }
Chris@16: # endif
Chris@16: 
Chris@16:   struct space_info
Chris@16:   {
Chris@16:     // all values are byte counts
Chris@16:     boost::uintmax_t capacity;
Chris@16:     boost::uintmax_t free;      // <= capacity
Chris@16:     boost::uintmax_t available; // <= free
Chris@16:   };
Chris@16: 
Chris@16:   BOOST_SCOPED_ENUM_START(copy_option)
Chris@101:     {none=0, fail_if_exists = none, overwrite_if_exists};
Chris@16:   BOOST_SCOPED_ENUM_END
Chris@16: 
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: //                             implementation details                                   //
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: 
Chris@16:   namespace detail
Chris@16:   {
Chris@101:     //  We cannot pass a BOOST_SCOPED_ENUM to a compled function because it will result
Chris@101:     //  in an undefined reference if the library is compled with -std=c++0x but the use
Chris@101:     //  is compiled in C++03 mode, or visa versa. See tickets 6124, 6779, 10038.
Chris@101:     enum copy_option {none=0, fail_if_exists = none, overwrite_if_exists};
Chris@101: 
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     file_status status(const path&p, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     file_status symlink_status(const path& p, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     bool is_empty(const path& p, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     path initial_path(system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     path canonical(const path& p, const path& base, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     void copy(const path& from, const path& to, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     void copy_directory(const path& from, const path& to, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@101:     void copy_file(const path& from, const path& to,  // See ticket #2925
Chris@101:                    detail::copy_option option, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     void copy_symlink(const path& existing_symlink, const path& new_symlink, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     bool create_directories(const path& p, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     bool create_directory(const path& p, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     void create_directory_symlink(const path& to, const path& from,
Chris@16:                                   system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     void create_hard_link(const path& to, const path& from, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     void create_symlink(const path& to, const path& from, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     path current_path(system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     void current_path(const path& p, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     bool equivalent(const path& p1, const path& p2, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     boost::uintmax_t file_size(const path& p, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     boost::uintmax_t hard_link_count(const path& p, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     std::time_t last_write_time(const path& p, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     void last_write_time(const path& p, const std::time_t new_time,
Chris@16:                          system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     void permissions(const path& p, perms prms, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     path read_symlink(const path& p, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:       // For standardization, if the committee doesn't like "remove", consider "eliminate"
Chris@16:     bool remove(const path& p, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     boost::uintmax_t remove_all(const path& p, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     void rename(const path& old_p, const path& new_p, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     void resize_file(const path& p, uintmax_t size, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     space_info space(const path& p, system::error_code* ec=0); 
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     path system_complete(const path& p, system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     path temp_directory_path(system::error_code* ec=0);
Chris@16:     BOOST_FILESYSTEM_DECL
Chris@16:     path unique_path(const path& p, system::error_code* ec=0);
Chris@16:   }  // namespace detail
Chris@16: 
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: //                                                                                      //
Chris@16: //                             status query functions                                   //
Chris@16: //                                                                                      //
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: 
Chris@16:   inline
Chris@16:   file_status status(const path& p)    {return detail::status(p);}
Chris@16:   inline 
Chris@16:   file_status status(const path& p, system::error_code& ec)
Chris@16:                                        {return detail::status(p, &ec);}
Chris@16:   inline 
Chris@16:   file_status symlink_status(const path& p) {return detail::symlink_status(p);}
Chris@16:   inline
Chris@16:   file_status symlink_status(const path& p, system::error_code& ec)
Chris@16:                                        {return detail::symlink_status(p, &ec);}
Chris@16:   inline 
Chris@16:   bool exists(const path& p)           {return exists(detail::status(p));}
Chris@16:   inline 
Chris@16:   bool exists(const path& p, system::error_code& ec)
Chris@16:                                        {return exists(detail::status(p, &ec));}
Chris@16:   inline 
Chris@16:   bool is_directory(const path& p)     {return is_directory(detail::status(p));}
Chris@16:   inline 
Chris@16:   bool is_directory(const path& p, system::error_code& ec)
Chris@16:                                        {return is_directory(detail::status(p, &ec));}
Chris@16:   inline 
Chris@16:   bool is_regular_file(const path& p)  {return is_regular_file(detail::status(p));}
Chris@16:   inline 
Chris@16:   bool is_regular_file(const path& p, system::error_code& ec)
Chris@16:                                        {return is_regular_file(detail::status(p, &ec));}
Chris@16:   inline 
Chris@16:   bool is_other(const path& p)         {return is_other(detail::status(p));}
Chris@16:   inline 
Chris@16:   bool is_other(const path& p, system::error_code& ec)
Chris@16:                                        {return is_other(detail::status(p, &ec));}
Chris@16:   inline
Chris@16:   bool is_symlink(const path& p)       {return is_symlink(detail::symlink_status(p));}
Chris@16:   inline 
Chris@16:   bool is_symlink(const path& p, system::error_code& ec)
Chris@16:                                        {return is_symlink(detail::symlink_status(p, &ec));}
Chris@16: # ifndef BOOST_FILESYSTEM_NO_DEPRECATED
Chris@16:   inline
Chris@16:   bool is_regular(const path& p)       {return is_regular(detail::status(p));}
Chris@16:   inline
Chris@16:   bool is_regular(const path& p, system::error_code& ec)
Chris@16:                                        {return is_regular(detail::status(p, &ec));}
Chris@16: # endif
Chris@16: 
Chris@16:   inline
Chris@16:   bool is_empty(const path& p)         {return detail::is_empty(p);}
Chris@16:   inline
Chris@16:   bool is_empty(const path& p, system::error_code& ec)
Chris@16:                                        {return detail::is_empty(p, &ec);}
Chris@16: 
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: //                                                                                      //
Chris@16: //                             operational functions                                    //
Chris@16: //                  in alphabetical order, unless otherwise noted                       //
Chris@16: //                                                                                      //
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16:  
Chris@16:   //  forward declarations
Chris@16:   path current_path();  // fwd declaration
Chris@16:   path initial_path();
Chris@16: 
Chris@16:   BOOST_FILESYSTEM_DECL
Chris@16:   path absolute(const path& p, const path& base=current_path());
Chris@16:   //  If base.is_absolute(), throws nothing. Thus no need for ec argument
Chris@16: 
Chris@16:   inline
Chris@16:   path canonical(const path& p, const path& base=current_path())
Chris@16:                                        {return detail::canonical(p, base);}
Chris@16:   inline
Chris@16:   path canonical(const path& p, system::error_code& ec)
Chris@16:                                        {return detail::canonical(p, current_path(), &ec);}
Chris@16:   inline
Chris@16:   path canonical(const path& p, const path& base, system::error_code& ec)
Chris@16:                                        {return detail::canonical(p, base, &ec);}
Chris@16: 
Chris@16: # ifndef BOOST_FILESYSTEM_NO_DEPRECATED
Chris@16:   inline
Chris@16:   path complete(const path& p)
Chris@16:   {
Chris@16:     return absolute(p, initial_path());
Chris@16:   }
Chris@16: 
Chris@16:   inline
Chris@16:   path complete(const path& p, const path& base)
Chris@16:   {
Chris@16:     return absolute(p, base);
Chris@16:   }
Chris@16: # endif
Chris@16: 
Chris@16:   inline
Chris@16:   void copy(const path& from, const path& to) {detail::copy(from, to);}
Chris@16: 
Chris@16:   inline
Chris@16:   void copy(const path& from, const path& to, system::error_code& ec) 
Chris@16:                                        {detail::copy(from, to, &ec);}
Chris@16:   inline
Chris@16:   void copy_directory(const path& from, const path& to)
Chris@16:                                        {detail::copy_directory(from, to);}
Chris@16:   inline
Chris@16:   void copy_directory(const path& from, const path& to, system::error_code& ec)
Chris@16:                                        {detail::copy_directory(from, to, &ec);}
Chris@16:   inline
Chris@16:   void copy_file(const path& from, const path& to,   // See ticket #2925
Chris@16:                  BOOST_SCOPED_ENUM(copy_option) option)
Chris@101:   {
Chris@101:     detail::copy_file(from, to, static_cast<detail::copy_option>(option));
Chris@101:   }
Chris@16:   inline
Chris@16:   void copy_file(const path& from, const path& to)
Chris@101:   {
Chris@101:     detail::copy_file(from, to, detail::fail_if_exists);
Chris@101:   }
Chris@16:   inline
Chris@16:   void copy_file(const path& from, const path& to,   // See ticket #2925
Chris@16:                  BOOST_SCOPED_ENUM(copy_option) option, system::error_code& ec)
Chris@101:   {
Chris@101:     detail::copy_file(from, to, static_cast<detail::copy_option>(option), &ec);
Chris@101:   }
Chris@16:   inline
Chris@16:   void copy_file(const path& from, const path& to, system::error_code& ec)
Chris@101:   {
Chris@101:     detail::copy_file(from, to, detail::fail_if_exists, &ec);
Chris@101:   }
Chris@16:   inline
Chris@101:   void copy_symlink(const path& existing_symlink,
Chris@101:                     const path& new_symlink) {detail::copy_symlink(existing_symlink, new_symlink);}
Chris@16: 
Chris@16:   inline
Chris@16:   void copy_symlink(const path& existing_symlink, const path& new_symlink, system::error_code& ec)
Chris@16:                                        {detail::copy_symlink(existing_symlink, new_symlink, &ec);}
Chris@16:   inline
Chris@16:   bool create_directories(const path& p) {return detail::create_directories(p);}
Chris@16: 
Chris@16:   inline
Chris@16:   bool create_directories(const path& p, system::error_code& ec)
Chris@16:                                        {return detail::create_directories(p, &ec);}
Chris@16:   inline
Chris@16:   bool create_directory(const path& p) {return detail::create_directory(p);}
Chris@16: 
Chris@16:   inline
Chris@16:   bool create_directory(const path& p, system::error_code& ec)
Chris@16:                                        {return detail::create_directory(p, &ec);}
Chris@16:   inline
Chris@16:   void create_directory_symlink(const path& to, const path& from)
Chris@16:                                        {detail::create_directory_symlink(to, from);}
Chris@16:   inline
Chris@16:   void create_directory_symlink(const path& to, const path& from, system::error_code& ec)
Chris@16:                                        {detail::create_directory_symlink(to, from, &ec);}
Chris@16:   inline
Chris@16:   void create_hard_link(const path& to, const path& new_hard_link) {detail::create_hard_link(to, new_hard_link);}
Chris@16: 
Chris@16:   inline
Chris@16:   void create_hard_link(const path& to, const path& new_hard_link, system::error_code& ec)
Chris@16:                                        {detail::create_hard_link(to, new_hard_link, &ec);}
Chris@16:   inline
Chris@16:   void create_symlink(const path& to, const path& new_symlink) {detail::create_symlink(to, new_symlink);}
Chris@16: 
Chris@16:   inline
Chris@16:   void create_symlink(const path& to, const path& new_symlink, system::error_code& ec)
Chris@16:                                        {detail::create_symlink(to, new_symlink, &ec);}
Chris@16:   inline
Chris@16:   path current_path()                  {return detail::current_path();}
Chris@16: 
Chris@16:   inline
Chris@16:   path current_path(system::error_code& ec) {return detail::current_path(&ec);}
Chris@16: 
Chris@16:   inline
Chris@16:   void current_path(const path& p)     {detail::current_path(p);}
Chris@16: 
Chris@16:   inline
Chris@16:   void current_path(const path& p, system::error_code& ec) {detail::current_path(p, &ec);}
Chris@16: 
Chris@16:   inline
Chris@16:   bool equivalent(const path& p1, const path& p2) {return detail::equivalent(p1, p2);}
Chris@16: 
Chris@16:   inline
Chris@16:   bool equivalent(const path& p1, const path& p2, system::error_code& ec)
Chris@16:                                        {return detail::equivalent(p1, p2, &ec);}
Chris@16:   inline
Chris@16:   boost::uintmax_t file_size(const path& p) {return detail::file_size(p);}
Chris@16: 
Chris@16:   inline
Chris@16:   boost::uintmax_t file_size(const path& p, system::error_code& ec)
Chris@16:                                        {return detail::file_size(p, &ec);}
Chris@16:   inline
Chris@16:   boost::uintmax_t hard_link_count(const path& p) {return detail::hard_link_count(p);}
Chris@16: 
Chris@16:   inline
Chris@16:   boost::uintmax_t hard_link_count(const path& p, system::error_code& ec)
Chris@16:                                        {return detail::hard_link_count(p, &ec);}
Chris@16:   inline
Chris@16:   path initial_path()                  {return detail::initial_path();}
Chris@16: 
Chris@16:   inline
Chris@16:   path initial_path(system::error_code& ec) {return detail::initial_path(&ec);}
Chris@16: 
Chris@16:   template <class Path>
Chris@16:   path initial_path() {return initial_path();}
Chris@16:   template <class Path>
Chris@16:   path initial_path(system::error_code& ec) {return detail::initial_path(&ec);}
Chris@16: 
Chris@16:   inline
Chris@16:   std::time_t last_write_time(const path& p) {return detail::last_write_time(p);}
Chris@16: 
Chris@16:   inline
Chris@16:   std::time_t last_write_time(const path& p, system::error_code& ec)
Chris@16:                                        {return detail::last_write_time(p, &ec);}
Chris@16:   inline
Chris@16:   void last_write_time(const path& p, const std::time_t new_time)
Chris@16:                                        {detail::last_write_time(p, new_time);}
Chris@16:   inline
Chris@16:   void last_write_time(const path& p, const std::time_t new_time, system::error_code& ec)
Chris@16:                                        {detail::last_write_time(p, new_time, &ec);}
Chris@16:   inline
Chris@16:   void permissions(const path& p, perms prms)
Chris@16:                                        {detail::permissions(p, prms);}
Chris@16:   inline
Chris@16:   void permissions(const path& p, perms prms, system::error_code& ec)
Chris@16:                                        {detail::permissions(p, prms, &ec);}
Chris@16: 
Chris@16:   inline
Chris@16:   path read_symlink(const path& p)     {return detail::read_symlink(p);}
Chris@16: 
Chris@16:   inline
Chris@16:   path read_symlink(const path& p, system::error_code& ec)
Chris@16:                                        {return detail::read_symlink(p, &ec);}
Chris@16:   inline
Chris@16:     // For standardization, if the committee doesn't like "remove", consider "eliminate"
Chris@16:   bool remove(const path& p)           {return detail::remove(p);}
Chris@16: 
Chris@16:   inline
Chris@16:   bool remove(const path& p, system::error_code& ec) {return detail::remove(p, &ec);}
Chris@16: 
Chris@16:   inline
Chris@16:   boost::uintmax_t remove_all(const path& p) {return detail::remove_all(p);}
Chris@16:     
Chris@16:   inline
Chris@16:   boost::uintmax_t remove_all(const path& p, system::error_code& ec)
Chris@16:                                        {return detail::remove_all(p, &ec);}
Chris@16:   inline
Chris@16:   void rename(const path& old_p, const path& new_p) {detail::rename(old_p, new_p);}
Chris@16: 
Chris@16:   inline
Chris@16:   void rename(const path& old_p, const path& new_p, system::error_code& ec)
Chris@16:                                        {detail::rename(old_p, new_p, &ec);}
Chris@16:   inline  // name suggested by Scott McMurray
Chris@16:   void resize_file(const path& p, uintmax_t size) {detail::resize_file(p, size);}
Chris@16: 
Chris@16:   inline
Chris@16:   void resize_file(const path& p, uintmax_t size, system::error_code& ec)
Chris@16:                                        {detail::resize_file(p, size, &ec);}
Chris@16:   inline
Chris@16:   space_info space(const path& p)      {return detail::space(p);} 
Chris@16: 
Chris@16:   inline
Chris@16:   space_info space(const path& p, system::error_code& ec) {return detail::space(p, &ec);} 
Chris@16: 
Chris@16: # ifndef BOOST_FILESYSTEM_NO_DEPRECATED
Chris@16:   inline bool symbolic_link_exists(const path& p)
Chris@16:                                        { return is_symlink(symlink_status(p)); }
Chris@16: # endif
Chris@16: 
Chris@16:   inline
Chris@16:   path system_complete(const path& p)  {return detail::system_complete(p);}
Chris@16: 
Chris@16:   inline
Chris@16:   path system_complete(const path& p, system::error_code& ec)
Chris@16:                                        {return detail::system_complete(p, &ec);}
Chris@16:   inline
Chris@16:   path temp_directory_path()           {return detail::temp_directory_path();}
Chris@16: 
Chris@16:   inline
Chris@16:   path temp_directory_path(system::error_code& ec) 
Chris@16:                                        {return detail::temp_directory_path(&ec);}
Chris@16:   inline
Chris@16:   path unique_path(const path& p="%%%%-%%%%-%%%%-%%%%")
Chris@16:                                        { return detail::unique_path(p); }
Chris@16:   inline
Chris@16:   path unique_path(const path& p, system::error_code& ec)
Chris@16:                                        { return detail::unique_path(p, &ec); }
Chris@16: 
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: //                                                                                      //
Chris@16: //                                 directory_entry                                      //
Chris@16: //                                                                                      //
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: 
Chris@16: //  GCC has a problem with a member function named path within a namespace or 
Chris@16: //  sub-namespace that also has a class named path. The workaround is to always
Chris@16: //  fully qualify the name path when it refers to the class name.
Chris@16: 
Chris@16: class BOOST_FILESYSTEM_DECL directory_entry
Chris@16: {
Chris@16: public:
Chris@16: 
Chris@16:   // compiler generated copy constructor, copy assignment, and destructor apply
Chris@16: 
Chris@16:   directory_entry() {}
Chris@16:   explicit directory_entry(const boost::filesystem::path& p,
Chris@16:     file_status st = file_status(), file_status symlink_st=file_status())
Chris@16:     : m_path(p), m_status(st), m_symlink_status(symlink_st)
Chris@16:     {}
Chris@16: 
Chris@16:   void assign(const boost::filesystem::path& p,
Chris@16:     file_status st = file_status(), file_status symlink_st = file_status())
Chris@16:     { m_path = p; m_status = st; m_symlink_status = symlink_st; }
Chris@16: 
Chris@16:   void replace_filename(const boost::filesystem::path& p,
Chris@16:     file_status st = file_status(), file_status symlink_st = file_status())
Chris@16:   {
Chris@16:     m_path.remove_filename();
Chris@16:     m_path /= p;
Chris@16:     m_status = st;
Chris@16:     m_symlink_status = symlink_st;
Chris@16:   }
Chris@16: 
Chris@16: # ifndef BOOST_FILESYSTEM_NO_DEPRECATED
Chris@16:   void replace_leaf(const boost::filesystem::path& p,
Chris@16:     file_status st, file_status symlink_st)
Chris@16:       { replace_filename(p, st, symlink_st); }
Chris@16: # endif
Chris@16: 
Chris@16:   const boost::filesystem::path&  path() const               {return m_path;}
Chris@16:   file_status   status() const                               {return m_get_status();}
Chris@16:   file_status   status(system::error_code& ec) const         {return m_get_status(&ec);}
Chris@16:   file_status   symlink_status() const                       {return m_get_symlink_status();}
Chris@16:   file_status   symlink_status(system::error_code& ec) const {return m_get_symlink_status(&ec);}
Chris@16: 
Chris@16:   bool operator==(const directory_entry& rhs) {return m_path == rhs.m_path;} 
Chris@16:   bool operator!=(const directory_entry& rhs) {return m_path != rhs.m_path;} 
Chris@16:   bool operator< (const directory_entry& rhs) {return m_path < rhs.m_path;} 
Chris@16:   bool operator<=(const directory_entry& rhs) {return m_path <= rhs.m_path;} 
Chris@16:   bool operator> (const directory_entry& rhs) {return m_path > rhs.m_path;} 
Chris@16:   bool operator>=(const directory_entry& rhs) {return m_path >= rhs.m_path;} 
Chris@16: 
Chris@16: private:
Chris@16:   boost::filesystem::path   m_path;
Chris@16:   mutable file_status       m_status;           // stat()-like
Chris@16:   mutable file_status       m_symlink_status;   // lstat()-like
Chris@16: 
Chris@16:   file_status m_get_status(system::error_code* ec=0) const;
Chris@16:   file_status m_get_symlink_status(system::error_code* ec=0) const;
Chris@16: }; // directory_entry
Chris@16: 
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: //                                                                                      //
Chris@16: //                            directory_iterator helpers                                //
Chris@16: //                                                                                      //
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: 
Chris@16: class directory_iterator;
Chris@16: 
Chris@16: namespace detail
Chris@16: {
Chris@16:   BOOST_FILESYSTEM_DECL
Chris@16:     system::error_code dir_itr_close(// never throws()
Chris@16:     void *& handle
Chris@16: #   if     defined(BOOST_POSIX_API)
Chris@16:     , void *& buffer
Chris@16: #   endif
Chris@16:   ); 
Chris@16: 
Chris@16:   struct dir_itr_imp
Chris@16:   {
Chris@16:     directory_entry  dir_entry;
Chris@16:     void*            handle;
Chris@16: 
Chris@16: #   ifdef BOOST_POSIX_API
Chris@16:     void*            buffer;  // see dir_itr_increment implementation
Chris@16: #   endif
Chris@16: 
Chris@16:     dir_itr_imp() : handle(0)
Chris@16: #   ifdef BOOST_POSIX_API
Chris@16:       , buffer(0)
Chris@16: #   endif
Chris@16:     {}
Chris@16: 
Chris@16:     ~dir_itr_imp() // never throws
Chris@16:     {
Chris@16:       dir_itr_close(handle
Chris@16: #       if defined(BOOST_POSIX_API)
Chris@16:          , buffer
Chris@16: #       endif
Chris@16:     );
Chris@16:     }
Chris@16:   };
Chris@16: 
Chris@16:   // see path::iterator: comment below
Chris@16:   BOOST_FILESYSTEM_DECL void directory_iterator_construct(directory_iterator& it,
Chris@16:     const path& p, system::error_code* ec);
Chris@16:   BOOST_FILESYSTEM_DECL void directory_iterator_increment(directory_iterator& it,
Chris@16:     system::error_code* ec);
Chris@16: 
Chris@16: }  // namespace detail
Chris@16: 
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: //                                                                                      //
Chris@16: //                                directory_iterator                                    //
Chris@16: //                                                                                      //
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: 
Chris@16:   class directory_iterator
Chris@16:     : public boost::iterator_facade< directory_iterator,
Chris@16:                                      directory_entry,
Chris@16:                                      boost::single_pass_traversal_tag >
Chris@16:   {
Chris@16:   public:
Chris@16: 
Chris@16:     directory_iterator(){}  // creates the "end" iterator
Chris@16: 
Chris@16:     // iterator_facade derived classes don't seem to like implementations in
Chris@16:     // separate translation unit dll's, so forward to detail functions
Chris@16:     explicit directory_iterator(const path& p)
Chris@16:         : m_imp(new detail::dir_itr_imp)
Chris@16:           { detail::directory_iterator_construct(*this, p, 0); }
Chris@16: 
Chris@16:     directory_iterator(const path& p, system::error_code& ec)
Chris@16:         : m_imp(new detail::dir_itr_imp)
Chris@16:           { detail::directory_iterator_construct(*this, p, &ec); }
Chris@16: 
Chris@16:    ~directory_iterator() {} // never throws
Chris@16: 
Chris@16:     directory_iterator& increment(system::error_code& ec)
Chris@16:     { 
Chris@16:       detail::directory_iterator_increment(*this, &ec);
Chris@16:       return *this;
Chris@16:     }
Chris@16: 
Chris@16:   private:
Chris@16:     friend struct detail::dir_itr_imp;
Chris@16:     friend BOOST_FILESYSTEM_DECL void detail::directory_iterator_construct(directory_iterator& it,
Chris@16:       const path& p, system::error_code* ec);
Chris@16:     friend BOOST_FILESYSTEM_DECL void detail::directory_iterator_increment(directory_iterator& it,
Chris@16:       system::error_code* ec);
Chris@16: 
Chris@16:     // shared_ptr provides shallow-copy semantics required for InputIterators.
Chris@16:     // m_imp.get()==0 indicates the end iterator.
Chris@16:     boost::shared_ptr< detail::dir_itr_imp >  m_imp;
Chris@16: 
Chris@16:     friend class boost::iterator_core_access;
Chris@16: 
Chris@16:     boost::iterator_facade<
Chris@16:       directory_iterator,
Chris@16:       directory_entry,
Chris@16:       boost::single_pass_traversal_tag >::reference dereference() const 
Chris@16:     {
Chris@16:       BOOST_ASSERT_MSG(m_imp.get(), "attempt to dereference end iterator");
Chris@16:       return m_imp->dir_entry;
Chris@16:     }
Chris@16: 
Chris@16:     void increment() { detail::directory_iterator_increment(*this, 0); }
Chris@16: 
Chris@16:     bool equal(const directory_iterator& rhs) const
Chris@16:       { return m_imp == rhs.m_imp; }
Chris@101: 
Chris@101:   };  // directory_iterator
Chris@101: 
Chris@101:   //  enable directory_iterator C++11 range-base for statement use  --------------------//
Chris@101: 
Chris@101:   //  begin() and end() are only used by a range-based for statement in the context of
Chris@101:   //  auto - thus the top-level const is stripped - so returning const is harmless and
Chris@101:   //  emphasizes begin() is just a pass through.
Chris@101:   inline
Chris@101:   const directory_iterator& begin(const directory_iterator& iter)  {return iter;}
Chris@101:   inline
Chris@101:   directory_iterator end(const directory_iterator&)  {return directory_iterator();}
Chris@101: 
Chris@101:   //  enable directory_iterator BOOST_FOREACH  -----------------------------------------//
Chris@101: 
Chris@101:   inline
Chris@101:   directory_iterator& range_begin(directory_iterator& iter) {return iter;}
Chris@101:   inline
Chris@101:   directory_iterator range_begin(const directory_iterator& iter) {return iter;}
Chris@101:   inline
Chris@101:   directory_iterator range_end(const directory_iterator&) {return directory_iterator();}
Chris@101:   }  // namespace filesystem
Chris@101: 
Chris@101:   //  namespace boost template specializations
Chris@101:   template<>
Chris@101:   struct range_mutable_iterator<boost::filesystem::directory_iterator>
Chris@101:     { typedef boost::filesystem::directory_iterator type; };
Chris@101:   template<>
Chris@101:   struct range_const_iterator <boost::filesystem::directory_iterator>
Chris@101:     { typedef boost::filesystem::directory_iterator type; };
Chris@101: 
Chris@101: namespace filesystem
Chris@101: {
Chris@16: 
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: //                                                                                      //
Chris@16: //                      recursive_directory_iterator helpers                            //
Chris@16: //                                                                                      //
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: 
Chris@16:   BOOST_SCOPED_ENUM_START(symlink_option)
Chris@16:   {
Chris@16:     none,
Chris@16:     no_recurse = none,         // don't follow directory symlinks (default behavior)
Chris@16:     recurse,                   // follow directory symlinks
Chris@16:     _detail_no_push = recurse << 1  // internal use only
Chris@16:   };
Chris@16:   BOOST_SCOPED_ENUM_END
Chris@16: 
Chris@16:   BOOST_BITMASK(BOOST_SCOPED_ENUM(symlink_option))
Chris@16: 
Chris@16:   namespace detail
Chris@16:   {
Chris@16:     struct recur_dir_itr_imp
Chris@16:     {
Chris@16:       typedef directory_iterator element_type;
Chris@16:       std::stack< element_type, std::vector< element_type > > m_stack;
Chris@16:       int  m_level;
Chris@16:       BOOST_SCOPED_ENUM(symlink_option) m_options;
Chris@16: 
Chris@16:       recur_dir_itr_imp() : m_level(0), m_options(symlink_option::none) {}
Chris@16: 
Chris@16:       void increment(system::error_code* ec);  // ec == 0 means throw on error
Chris@16: 
Chris@101:       bool push_directory(system::error_code& ec) BOOST_NOEXCEPT;
Chris@101: 
Chris@16:       void pop();
Chris@16: 
Chris@16:     };
Chris@16: 
Chris@16:     //  Implementation is inline to avoid dynamic linking difficulties with m_stack:
Chris@16:     //  Microsoft warning C4251, m_stack needs to have dll-interface to be used by
Chris@16:     //  clients of struct 'boost::filesystem::detail::recur_dir_itr_imp'
Chris@16: 
Chris@16:     inline
Chris@101:     bool recur_dir_itr_imp::push_directory(system::error_code& ec) BOOST_NOEXCEPT
Chris@101:     // Returns: true if push occurs, otherwise false. Always returns false on error.
Chris@16:     {
Chris@101:       ec.clear();
Chris@101: 
Chris@101:       //  Discover if the iterator is for a directory that needs to be recursed into,
Chris@101:       //  taking symlinks and options into account.
Chris@101: 
Chris@16:       if ((m_options & symlink_option::_detail_no_push) == symlink_option::_detail_no_push)
Chris@16:         m_options &= ~symlink_option::_detail_no_push;
Chris@16: 
Chris@16:       else
Chris@16:       {
Chris@16:         // Logic for following predicate was contributed by Daniel Aarno to handle cyclic
Chris@16:         // symlinks correctly and efficiently, fixing ticket #5652.
Chris@16:         //   if (((m_options & symlink_option::recurse) == symlink_option::recurse
Chris@16:         //         || !is_symlink(m_stack.top()->symlink_status()))
Chris@16:         //       && is_directory(m_stack.top()->status())) ...
Chris@16:         // The predicate code has since been rewritten to pass error_code arguments,
Chris@16:         // per ticket #5653.
Chris@16: 
Chris@101:         file_status symlink_stat;
Chris@101: 
Chris@101:         if ((m_options & symlink_option::recurse) != symlink_option::recurse)
Chris@16:         {
Chris@101:           symlink_stat = m_stack.top()->symlink_status(ec);
Chris@101:           if (ec)
Chris@101:             return false;
Chris@101:         }
Chris@101: 
Chris@101:         if ((m_options & symlink_option::recurse) == symlink_option::recurse
Chris@101:           || !is_symlink(symlink_stat))
Chris@101:         {
Chris@101:           file_status stat = m_stack.top()->status(ec);
Chris@101:           if (ec || !is_directory(stat))
Chris@101:             return false;
Chris@101: 
Chris@101:           directory_iterator next(m_stack.top()->path(), ec);
Chris@101:           if (!ec && next != directory_iterator())
Chris@16:           {
Chris@101:             m_stack.push(next);
Chris@101:             ++m_level;
Chris@101:             return true;
Chris@16:           }
Chris@16:         }
Chris@16:       }
Chris@101:       return false;
Chris@101:     }
Chris@16: 
Chris@101:     inline
Chris@101:     void recur_dir_itr_imp::increment(system::error_code* ec)
Chris@101:     // ec == 0 means throw on error
Chris@101:     // 
Chris@101:     // Invariant: On return, the top of the iterator stack is the next valid (possibly
Chris@101:     // end) iterator, regardless of whether or not an error is reported, and regardless of
Chris@101:     // whether any error is reported by exception or error code. In other words, progress
Chris@101:     // is always made so a loop on the iterator will always eventually terminate
Chris@101:     // regardless of errors.
Chris@101:     {
Chris@101:       system::error_code ec_push_directory;
Chris@101: 
Chris@101:       //  if various conditions are met, push a directory_iterator into the iterator stack
Chris@101:       if (push_directory(ec_push_directory))
Chris@101:       {
Chris@101:         if (ec)
Chris@101:           ec->clear();
Chris@101:         return;
Chris@101:       }
Chris@101: 
Chris@101:       //  Do the actual increment operation on the top iterator in the iterator
Chris@101:       //  stack, popping the stack if necessary, until either the stack is empty or a
Chris@101:       //  non-end iterator is reached.
Chris@16:       while (!m_stack.empty() && ++m_stack.top() == directory_iterator())
Chris@16:       {
Chris@16:         m_stack.pop();
Chris@16:         --m_level;
Chris@16:       }
Chris@101: 
Chris@101:       // report errors if any
Chris@101:       if (ec_push_directory)
Chris@101:       {
Chris@101:         if (ec)
Chris@101:           *ec = ec_push_directory;
Chris@101:         else
Chris@101:         {
Chris@101:           BOOST_FILESYSTEM_THROW(filesystem_error(
Chris@101:             "filesystem::recursive_directory_iterator directory error",
Chris@101:             ec_push_directory));
Chris@101:         }
Chris@101:       }
Chris@101:       else if (ec)
Chris@101:         ec->clear();
Chris@16:     }
Chris@16: 
Chris@16:     inline
Chris@16:     void recur_dir_itr_imp::pop()
Chris@16:     {
Chris@16:       BOOST_ASSERT_MSG(m_level > 0,
Chris@16:         "pop() on recursive_directory_iterator with level < 1");
Chris@16: 
Chris@16:       do
Chris@16:       {
Chris@16:         m_stack.pop();
Chris@16:         --m_level;
Chris@16:       }
Chris@16:       while (!m_stack.empty() && ++m_stack.top() == directory_iterator());
Chris@16:     }
Chris@16:   } // namespace detail
Chris@16: 
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: //                                                                                      //
Chris@16: //                           recursive_directory_iterator                               //
Chris@16: //                                                                                      //
Chris@16: //--------------------------------------------------------------------------------------//
Chris@16: 
Chris@16:   class recursive_directory_iterator
Chris@16:     : public boost::iterator_facade<
Chris@16:         recursive_directory_iterator,
Chris@16:         directory_entry,
Chris@16:         boost::single_pass_traversal_tag >
Chris@16:   {
Chris@16:   public:
Chris@16: 
Chris@16:     recursive_directory_iterator(){}  // creates the "end" iterator
Chris@16: 
Chris@16:     explicit recursive_directory_iterator(const path& dir_path,
Chris@16:       BOOST_SCOPED_ENUM(symlink_option) opt = symlink_option::none)
Chris@16:       : m_imp(new detail::recur_dir_itr_imp)
Chris@16:     {
Chris@16:       m_imp->m_options = opt;
Chris@16:       m_imp->m_stack.push(directory_iterator(dir_path));
Chris@16:       if (m_imp->m_stack.top() == directory_iterator())
Chris@16:         { m_imp.reset (); }
Chris@16:     }
Chris@16: 
Chris@16:     recursive_directory_iterator(const path& dir_path,
Chris@16:       BOOST_SCOPED_ENUM(symlink_option) opt,
Chris@16:       system::error_code & ec)
Chris@16:     : m_imp(new detail::recur_dir_itr_imp)
Chris@16:     {
Chris@16:       m_imp->m_options = opt;
Chris@16:       m_imp->m_stack.push(directory_iterator(dir_path, ec));
Chris@16:       if (m_imp->m_stack.top() == directory_iterator())
Chris@16:         { m_imp.reset (); }
Chris@16:     }
Chris@16: 
Chris@16:     recursive_directory_iterator(const path& dir_path,
Chris@16:       system::error_code & ec)
Chris@16:     : m_imp(new detail::recur_dir_itr_imp)
Chris@16:     {
Chris@16:       m_imp->m_options = symlink_option::none;
Chris@16:       m_imp->m_stack.push(directory_iterator(dir_path, ec));
Chris@16:       if (m_imp->m_stack.top() == directory_iterator())
Chris@16:         { m_imp.reset (); }
Chris@16:     }
Chris@16: 
Chris@16:     recursive_directory_iterator& increment(system::error_code& ec)
Chris@16:     {
Chris@16:       BOOST_ASSERT_MSG(m_imp.get(),
Chris@16:         "increment() on end recursive_directory_iterator");
Chris@16:       m_imp->increment(&ec);
Chris@16:       if (m_imp->m_stack.empty())
Chris@16:         m_imp.reset(); // done, so make end iterator
Chris@16:       return *this;
Chris@16:     }
Chris@16: 
Chris@16:     int level() const
Chris@16:     { 
Chris@16:       BOOST_ASSERT_MSG(m_imp.get(),
Chris@16:         "level() on end recursive_directory_iterator");
Chris@16:       return m_imp->m_level;
Chris@16:     }
Chris@16: 
Chris@16:     bool no_push_pending() const
Chris@16:     {
Chris@16:       BOOST_ASSERT_MSG(m_imp.get(),
Chris@16:         "is_no_push_requested() on end recursive_directory_iterator");
Chris@16:       return (m_imp->m_options & symlink_option::_detail_no_push)
Chris@16:         == symlink_option::_detail_no_push;
Chris@16:     }
Chris@16: 
Chris@16: #   ifndef BOOST_FILESYSTEM_NO_DEPRECATED
Chris@16:     bool no_push_request() const { return no_push_pending(); }
Chris@16: #   endif
Chris@16: 
Chris@16:     void pop()
Chris@16:     { 
Chris@16:       BOOST_ASSERT_MSG(m_imp.get(),
Chris@16:         "pop() on end recursive_directory_iterator");
Chris@16:       m_imp->pop();
Chris@16:       if (m_imp->m_stack.empty()) m_imp.reset(); // done, so make end iterator
Chris@16:     }
Chris@16: 
Chris@16:     void no_push(bool value=true)
Chris@16:     {
Chris@16:       BOOST_ASSERT_MSG(m_imp.get(),
Chris@16:         "no_push() on end recursive_directory_iterator");
Chris@16:       if (value)
Chris@16:         m_imp->m_options |= symlink_option::_detail_no_push;
Chris@16:       else
Chris@16:         m_imp->m_options &= ~symlink_option::_detail_no_push;
Chris@16:     }
Chris@16: 
Chris@16:     file_status status() const
Chris@16:     {
Chris@16:       BOOST_ASSERT_MSG(m_imp.get(),
Chris@16:         "status() on end recursive_directory_iterator");
Chris@16:       return m_imp->m_stack.top()->status();
Chris@16:     }
Chris@16: 
Chris@16:     file_status symlink_status() const
Chris@16:     {
Chris@16:       BOOST_ASSERT_MSG(m_imp.get(),
Chris@16:         "symlink_status() on end recursive_directory_iterator");
Chris@16:       return m_imp->m_stack.top()->symlink_status();
Chris@16:     }
Chris@16: 
Chris@16:   private:
Chris@16: 
Chris@16:     // shared_ptr provides shallow-copy semantics required for InputIterators.
Chris@16:     // m_imp.get()==0 indicates the end iterator.
Chris@16:     boost::shared_ptr< detail::recur_dir_itr_imp >  m_imp;
Chris@16: 
Chris@16:     friend class boost::iterator_core_access;
Chris@16: 
Chris@16:     boost::iterator_facade< 
Chris@16:       recursive_directory_iterator,
Chris@16:       directory_entry,
Chris@16:       boost::single_pass_traversal_tag >::reference
Chris@16:     dereference() const 
Chris@16:     {
Chris@16:       BOOST_ASSERT_MSG(m_imp.get(),
Chris@16:         "dereference of end recursive_directory_iterator");
Chris@16:       return *m_imp->m_stack.top();
Chris@16:     }
Chris@16: 
Chris@16:     void increment()
Chris@16:     { 
Chris@16:       BOOST_ASSERT_MSG(m_imp.get(),
Chris@16:         "increment of end recursive_directory_iterator");
Chris@16:       m_imp->increment(0);
Chris@16:       if (m_imp->m_stack.empty())
Chris@16:         m_imp.reset(); // done, so make end iterator
Chris@16:     }
Chris@16: 
Chris@16:     bool equal(const recursive_directory_iterator& rhs) const
Chris@16:       { return m_imp == rhs.m_imp; }
Chris@16: 
Chris@101:   };  // recursive directory iterator
Chris@101: 
Chris@101:   //  enable recursive directory iterator C++11 range-base for statement use  ----------//
Chris@101: 
Chris@101:   //  begin() and end() are only used by a range-based for statement in the context of
Chris@101:   //  auto - thus the top-level const is stripped - so returning const is harmless and
Chris@101:   //  emphasizes begin() is just a pass through.
Chris@101:   inline
Chris@101:   const recursive_directory_iterator& begin(const recursive_directory_iterator& iter)
Chris@101:                                                                             {return iter;}
Chris@101:   inline
Chris@101:   recursive_directory_iterator end(const recursive_directory_iterator&)
Chris@101:                                                   {return recursive_directory_iterator();}
Chris@101: 
Chris@101:   //  enable recursive directory iterator BOOST_FOREACH  -------------------------------//
Chris@101: 
Chris@101:   inline
Chris@101:   recursive_directory_iterator& range_begin(recursive_directory_iterator& iter)
Chris@101:                                                                             {return iter;}
Chris@101:   inline
Chris@101:   recursive_directory_iterator range_begin(const recursive_directory_iterator& iter)
Chris@101:                                                                             {return iter;}
Chris@101:   inline
Chris@101:   recursive_directory_iterator range_end(const recursive_directory_iterator&)
Chris@101:                                                   {return recursive_directory_iterator();}
Chris@101:   }  // namespace filesystem
Chris@101: 
Chris@101:   //  namespace boost template specializations
Chris@101:   template<>
Chris@101:   struct range_mutable_iterator<boost::filesystem::recursive_directory_iterator>
Chris@101:                         { typedef boost::filesystem::recursive_directory_iterator type; };
Chris@101:   template<>
Chris@101:   struct range_const_iterator <boost::filesystem::recursive_directory_iterator>
Chris@101:                         { typedef boost::filesystem::recursive_directory_iterator type; };
Chris@101: 
Chris@101: namespace filesystem
Chris@101: {
Chris@16: 
Chris@16: # if !defined(BOOST_FILESYSTEM_NO_DEPRECATED)
Chris@16:   typedef recursive_directory_iterator wrecursive_directory_iterator;
Chris@16: # endif
Chris@16: 
Chris@16: //  test helper  -----------------------------------------------------------------------//
Chris@16: 
Chris@16: //  Not part of the documented interface since false positives are possible;
Chris@16: //  there is no law that says that an OS that has large stat.st_size
Chris@16: //  actually supports large file sizes.
Chris@16: 
Chris@16:   namespace detail
Chris@16:   {
Chris@16:     BOOST_FILESYSTEM_DECL bool possible_large_file_size_support();
Chris@16:   }
Chris@16: 
Chris@16:   } // namespace filesystem
Chris@16: } // namespace boost
Chris@16: 
Chris@16: #include <boost/config/abi_suffix.hpp> // pops abi_prefix.hpp pragmas
Chris@16: #endif // BOOST_FILESYSTEM3_OPERATIONS_HPP