sl@0: //  boost/filesystem/convenience.hpp  ----------------------------------------//
sl@0: 
sl@0: //  Copyright Beman Dawes, 2002-2005
sl@0: //  Copyright Vladimir Prus, 2002
sl@0: //  Use, modification, and distribution is subject to the Boost Software
sl@0: //  License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
sl@0: //  http://www.boost.org/LICENSE_1_0.txt)
sl@0: 
sl@0: //  See library home page at http://www.boost.org/libs/filesystem
sl@0: 
sl@0: //----------------------------------------------------------------------------// 
sl@0: 
sl@0: #ifndef BOOST_FILESYSTEM_CONVENIENCE_HPP
sl@0: #define BOOST_FILESYSTEM_CONVENIENCE_HPP
sl@0: 
sl@0: #include <boost/filesystem/operations.hpp>
sl@0: #include <vector>
sl@0: #include <stack>
sl@0: 
sl@0: #include <boost/config/abi_prefix.hpp> // must be the last #include
sl@0: 
sl@0: # ifndef BOOST_FILESYSTEM_NARROW_ONLY
sl@0: #   define BOOST_FS_FUNC(BOOST_FS_TYPE) \
sl@0:       template<class Path> typename boost::enable_if<is_basic_path<Path>, \
sl@0:       BOOST_FS_TYPE>::type
sl@0: #   define BOOST_FS_FUNC_STRING BOOST_FS_FUNC(typename Path::string_type)
sl@0: #   define BOOST_FS_TYPENAME typename
sl@0: # else
sl@0: #   define BOOST_FS_FUNC(BOOST_FS_TYPE) inline BOOST_FS_TYPE 
sl@0:     typedef boost::filesystem::path Path;
sl@0: #   define BOOST_FS_FUNC_STRING std::string
sl@0: #   define BOOST_FS_TYPENAME
sl@0: # endif
sl@0: 
sl@0: namespace boost
sl@0: {
sl@0:   namespace filesystem
sl@0:   {
sl@0: 
sl@0:     BOOST_FS_FUNC(bool) create_directories(const Path& ph)
sl@0:     {
sl@0:          if (ph.empty() || exists(ph))
sl@0:          {
sl@0:            if ( !ph.empty() && !is_directory(ph) )
sl@0:                boost::throw_exception( basic_filesystem_error<Path>(
sl@0:                  "boost::filesystem::create_directories", ph, -1 ) );
sl@0:            return false;
sl@0:          }
sl@0: 
sl@0:          // First create branch, by calling ourself recursively
sl@0:          create_directories(ph.branch_path());
sl@0:          // Now that parent's path exists, create the directory
sl@0:          create_directory(ph);
sl@0:          return true;
sl@0:      }
sl@0: 
sl@0:     BOOST_FS_FUNC_STRING extension(const Path& ph)
sl@0:     {
sl@0:       typedef BOOST_FS_TYPENAME Path::string_type string_type;
sl@0:       string_type leaf = ph.leaf();
sl@0: 
sl@0:       BOOST_FS_TYPENAME string_type::size_type n = leaf.rfind('.');
sl@0:       if (n != string_type::npos)
sl@0:         return leaf.substr(n);
sl@0:       else
sl@0:         return string_type();
sl@0:     }
sl@0: 
sl@0:     BOOST_FS_FUNC_STRING basename(const Path& ph)
sl@0:     {
sl@0:       typedef BOOST_FS_TYPENAME Path::string_type string_type;
sl@0:       string_type leaf = ph.leaf();
sl@0:       BOOST_FS_TYPENAME string_type::size_type n = leaf.rfind('.');
sl@0:       return leaf.substr(0, n);
sl@0:     }
sl@0: 
sl@0:     BOOST_FS_FUNC(Path) change_extension( const Path & ph,
sl@0:       const BOOST_FS_TYPENAME Path::string_type & new_extension )
sl@0:       { return ph.branch_path() / (basename(ph) + new_extension); }
sl@0: 
sl@0: # ifndef BOOST_FILESYSTEM_NARROW_ONLY
sl@0: 
sl@0:     // "do-the-right-thing" overloads  ---------------------------------------//
sl@0: 
sl@0:     inline bool create_directories(const path& ph)
sl@0:       { return create_directories<path>(ph); }
sl@0:     inline bool create_directories(const wpath& ph)
sl@0:       { return create_directories<wpath>(ph); }
sl@0: 
sl@0:     inline std::string extension(const path& ph)
sl@0:       { return extension<path>(ph); }
sl@0:     inline std::wstring extension(const wpath& ph)
sl@0:       { return extension<wpath>(ph); }
sl@0: 
sl@0:     inline std::string basename(const path& ph)
sl@0:       { return basename<path>( ph ); }
sl@0:     inline std::wstring basename(const wpath& ph)
sl@0:       { return basename<wpath>( ph ); }
sl@0: 
sl@0:     inline path change_extension( const path & ph, const std::string& new_ex )
sl@0:       { return change_extension<path>( ph, new_ex ); }
sl@0:     inline wpath change_extension( const wpath & ph, const std::wstring& new_ex )
sl@0:       { return change_extension<wpath>( ph, new_ex ); }
sl@0: 
sl@0: # endif
sl@0: 
sl@0: 
sl@0:     //  basic_recursive_directory_iterator helpers  --------------------------//
sl@0: 
sl@0:     namespace detail
sl@0:     {
sl@0:       template< class Path >
sl@0:       struct recur_dir_itr_imp
sl@0:       {
sl@0:         typedef basic_directory_iterator< Path > element_type;
sl@0:         std::stack< element_type, std::vector< element_type > > m_stack;
sl@0:         int  m_level;
sl@0:         bool m_no_push;
sl@0:         bool m_no_throw;
sl@0: 
sl@0:         recur_dir_itr_imp() : m_level(0), m_no_push(false), m_no_throw(false) {}
sl@0:       };
sl@0: 
sl@0:     } // namespace detail
sl@0: 
sl@0:     //  basic_recursive_directory_iterator  ----------------------------------//
sl@0: 
sl@0:     template< class Path >
sl@0:     class basic_recursive_directory_iterator
sl@0:       : public boost::iterator_facade<
sl@0:           basic_recursive_directory_iterator<Path>,
sl@0:           basic_directory_entry<Path>,
sl@0:           boost::single_pass_traversal_tag >
sl@0:     {
sl@0:     public:
sl@0:       typedef Path path_type;
sl@0: 
sl@0:       basic_recursive_directory_iterator(){}  // creates the "end" iterator
sl@0: 
sl@0:       explicit basic_recursive_directory_iterator( const Path & dir_path );
sl@0:       basic_recursive_directory_iterator( const Path & dir_path, system_error_type & ec );
sl@0: 
sl@0:       int level() const { return m_imp->m_level; }
sl@0: 
sl@0:       void pop();
sl@0:       void no_push()
sl@0:       {
sl@0:         BOOST_ASSERT( m_imp.get() && "attempt to no_push() on end iterator" );
sl@0:         m_imp->m_no_push = true;
sl@0:       }
sl@0: 
sl@0:       file_status status() const
sl@0:       {
sl@0:         BOOST_ASSERT( m_imp.get()
sl@0:           && "attempt to call status() on end recursive_iterator" );
sl@0:         return m_imp->m_stack.top()->status();
sl@0:       }
sl@0: 
sl@0:       file_status symlink_status() const
sl@0:       {
sl@0:         BOOST_ASSERT( m_imp.get()
sl@0:           && "attempt to call symlink_status() on end recursive_iterator" );
sl@0:         return m_imp->m_stack.top()->symlink_status();
sl@0:       }
sl@0: 
sl@0:     private:
sl@0: 
sl@0:       // shared_ptr provides shallow-copy semantics required for InputIterators.
sl@0:       // m_imp.get()==0 indicates the end iterator.
sl@0:       boost::shared_ptr< detail::recur_dir_itr_imp< Path > >  m_imp;
sl@0: 
sl@0:       friend class boost::iterator_core_access;
sl@0: 
sl@0:       typename boost::iterator_facade< 
sl@0:         basic_recursive_directory_iterator<Path>,
sl@0:         basic_directory_entry<Path>,
sl@0:         boost::single_pass_traversal_tag >::reference
sl@0:       dereference() const 
sl@0:       {
sl@0:         BOOST_ASSERT( m_imp.get() && "attempt to dereference end iterator" );
sl@0:         return *m_imp->m_stack.top();
sl@0:       }
sl@0: 
sl@0:       void increment();
sl@0: 
sl@0:       bool equal( const basic_recursive_directory_iterator & rhs ) const
sl@0:         { return m_imp == rhs.m_imp; }
sl@0:     };
sl@0: 
sl@0:     typedef basic_recursive_directory_iterator<path> recursive_directory_iterator;
sl@0: # ifndef BOOST_FILESYSTEM_NARROW_ONLY
sl@0:     typedef basic_recursive_directory_iterator<wpath> wrecursive_directory_iterator;
sl@0: # endif
sl@0: 
sl@0:     //  basic_recursive_directory_iterator implementation  -------------------//
sl@0: 
sl@0:     //  constructors
sl@0:     template<class Path>
sl@0:     basic_recursive_directory_iterator<Path>::
sl@0:       basic_recursive_directory_iterator( const Path & dir_path )
sl@0:       : m_imp( new detail::recur_dir_itr_imp<Path> )
sl@0:     {
sl@0:       m_imp->m_stack.push( basic_directory_iterator<Path>( dir_path ) );
sl@0:     }
sl@0: 
sl@0:     template<class Path>
sl@0:     basic_recursive_directory_iterator<Path>::
sl@0:       basic_recursive_directory_iterator( const Path & dir_path, system_error_type & ec )
sl@0:       : m_imp( new detail::recur_dir_itr_imp<Path> )
sl@0:     {
sl@0:       m_imp->m_stack.push( basic_directory_iterator<Path>( dir_path, std::nothrow ) );
sl@0:       m_imp->m_no_throw = true;
sl@0:     }
sl@0: 
sl@0:     //  increment
sl@0:     template<class Path>
sl@0:     void basic_recursive_directory_iterator<Path>::increment()
sl@0:     {
sl@0:       BOOST_ASSERT( m_imp.get() && "increment on end iterator" );
sl@0:       
sl@0:       static const basic_directory_iterator<Path> end_itr;
sl@0: 
sl@0:       if ( m_imp->m_no_push ) m_imp->m_no_push = false;
sl@0:       else if ( is_directory( m_imp->m_stack.top()->status() ) )
sl@0:       {
sl@0:         system_error_type ec;
sl@0:         m_imp->m_stack.push(
sl@0:           m_imp->m_no_throw
sl@0:             ? basic_directory_iterator<Path>( *m_imp->m_stack.top(), ec )
sl@0:             : basic_directory_iterator<Path>( *m_imp->m_stack.top() )
sl@0:           );
sl@0:         if ( m_imp->m_stack.top() != end_itr )
sl@0:         {
sl@0:           ++m_imp->m_level;
sl@0:           return;
sl@0:         }
sl@0:         m_imp->m_stack.pop();
sl@0:       }
sl@0: 
sl@0:       while ( !m_imp->m_stack.empty()
sl@0:         && ++m_imp->m_stack.top() == end_itr )
sl@0:       {
sl@0:         m_imp->m_stack.pop();
sl@0:         --m_imp->m_level;
sl@0:       }
sl@0: 
sl@0:       if ( m_imp->m_stack.empty() ) m_imp.reset(); // done, so make end iterator
sl@0:     }
sl@0: 
sl@0:     //  pop
sl@0:     template<class Path>
sl@0:     void basic_recursive_directory_iterator<Path>::pop()
sl@0:     {
sl@0:       BOOST_ASSERT( m_imp.get() && "pop on end iterator" );
sl@0:       BOOST_ASSERT( m_imp->m_level > 0 && "pop with level < 1" );
sl@0: 
sl@0:       m_imp->m_stack.pop();
sl@0:       --m_imp->m_level;
sl@0:     }
sl@0: 
sl@0:     //  what() basic_filesystem_error_decoder  -------------------------------//
sl@0: 
sl@0:     namespace detail
sl@0:     {
sl@0: 
sl@0: #   if BOOST_WORKAROUND(__BORLANDC__,BOOST_TESTED_AT(0x581))
sl@0:       using boost::filesystem::system_message;
sl@0: #   endif
sl@0: 
sl@0:       inline void decode_system_message( system_error_type ec, std::string & target )
sl@0:       {
sl@0:         system_message( ec, target );
sl@0:       }
sl@0: 
sl@0: #   if defined(BOOST_WINDOWS_API) && !defined(BOOST_FILESYSTEM_NARROW_ONLY)
sl@0:       inline void decode_system_message( system_error_type ec, std::wstring & target )
sl@0:       {
sl@0:         system_message( ec, target );
sl@0:       }
sl@0: #   endif
sl@0: 
sl@0:       template<class String>
sl@0:       void decode_system_message( system_error_type ec, String & target )
sl@0:       {
sl@0:         std::string temp;
sl@0:         system_message( ec, temp );
sl@0:         for ( const char * p = temp.c_str(); *p != 0; ++p )
sl@0:           { target += static_cast<typename String::value_type>( *p ); }
sl@0:       }
sl@0:     }
sl@0: 
sl@0:     template<class Path>
sl@0:     typename Path::string_type what( const basic_filesystem_error<Path> & ex )
sl@0:     {
sl@0:       typename Path::string_type s;
sl@0:       for ( const char * p = ex.what(); *p != 0; ++p )
sl@0:         { s += static_cast<typename Path::string_type::value_type>( *p ); }
sl@0: 
sl@0:       if ( !ex.path1().empty() )
sl@0:       {
sl@0:         s += static_cast<typename Path::string_type::value_type>( ':' );
sl@0:         s += static_cast<typename Path::string_type::value_type>( ' ' );
sl@0:         s += static_cast<typename Path::string_type::value_type>( '\"' );
sl@0:         s += ex.path1().file_string();
sl@0:         s += static_cast<typename Path::string_type::value_type>( '\"' );
sl@0:       }
sl@0:       if ( !ex.path2().empty() )
sl@0:       {
sl@0:         s += static_cast<typename Path::string_type::value_type>( ',' );
sl@0:         s += static_cast<typename Path::string_type::value_type>( ' ' );
sl@0:         s += static_cast<typename Path::string_type::value_type>( '\"' );
sl@0:         s += ex.path2().file_string();
sl@0:         s += static_cast<typename Path::string_type::value_type>( '\"' );
sl@0:       }
sl@0:       if ( ex.system_error() )
sl@0:       {
sl@0:         s += static_cast<typename Path::string_type::value_type>( ' ' );
sl@0: 
sl@0:         detail::decode_system_message( ex.system_error(), s );
sl@0:       }
sl@0:       return s;
sl@0:     }
sl@0: 
sl@0:   } // namespace filesystem
sl@0: } // namespace boost
sl@0: 
sl@0: #undef BOOST_FS_FUNC_STRING
sl@0: #undef BOOST_FS_FUNC
sl@0: 
sl@0: #include <boost/config/abi_suffix.hpp> // pops abi_prefix.hpp pragmas
sl@0: #endif // BOOST_FILESYSTEM_CONVENIENCE_HPP