filesystem/src/operations.cpp

//  operations.cpp  ----------------------------------------------------------//

//  Copyright © 2002-2005 Beman Dawes
//  Copyright © 2001 Dietmar Kuehl
//  Use, modification, and distribution is subject to the Boost Software
//  License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy
//  at http://www.boost.org/LICENSE_1_0.txt)

//  See library home page at http://www.boost.org/libs/filesystem

//----------------------------------------------------------------------------// 

// define BOOST_FILESYSTEM_SOURCE so that <boost/filesystem/config.hpp> knows
// the library is being built (possibly exporting rather than importing code)
#define BOOST_FILESYSTEM_SOURCE 

#define __USE_BSD // needed to get struct dirent d_type defines on Linux

#define _FILE_OFFSET_BITS 64 // at worst, these defines may have no effect,
#define __USE_FILE_OFFSET64 // but that is harmless on Windows and on POSIX
      // 64-bit systems or on 32-bit systems which don't have files larger 
      // than can be represented by a traditional POSIX/UNIX off_t type. 
      // OTOH, defining them should kick in 64-bit off_t's (and thus 
      // st_size) on 32-bit systems that provide the Large File
      // Support (LFS) interface, such as Linux, Solaris, and IRIX.
      // The defines are given before any headers are included to
      // ensure that they are available to all included headers.
      // That is required at least on Solaris, and possibly on other
      // systems as well.

// for some compilers (CodeWarrior, for example), windows.h
// is getting included by some other boost header, so do this early:
#define _WIN32_WINNT 0x0500 // Windows 2K or later

#include <boost/filesystem/operations.hpp>
#include <boost/scoped_array.hpp>
#include <boost/throw_exception.hpp>
#include <boost/detail/workaround.hpp>

namespace fs = boost::filesystem;

# if defined(BOOST_WINDOWS_API)
#   include "windows.h"
#   if defined(__BORLANDC__) || defined(__MWERKS__)
#     if defined(__BORLANDC__)
        using std::time_t;
#     endif
#     include "utime.h"
#   else
#     include "sys/utime.h"
#   endif

# else // BOOST_POSIX_API
#   include <sys/types.h>
#   include <sys/statvfs.h>
#   include "dirent.h"
#   include "unistd.h"
#   include "fcntl.h"
#   include "utime.h"
# endif

//  BOOST_FILESYSTEM_STATUS_CACHE enables status_flags cache in
//  dir_itr_increment. The config tests are placed here because some of the
//  macros being tested come from dirent.h.
//
// TODO: "|| defined(__APPLE__)" compiles, but at runtime d_type is alwasy 0. Why?
// TODO: find out what macros enable dirent::d_type on various operating systems.
# if !defined(__CYGWIN__) && !defined(__osf__) \
     && (defined(BOOST_WINDOWS_API) \
        || defined(__USE_BSD) || defined(_DIRENT_HAVE_D_TYPE) \
       )
#   define BOOST_FILESYSTEM_STATUS_CACHE
# endif

#include <sys/stat.h>  // even on Windows some functions use stat()
#include <string>
#include <cstring>
#include <cstdio>      // for remove, rename
#include <cerrno>
#include <cassert>
//#include <iostream>    // for debugging only; comment out when not in use

#ifdef BOOST_NO_STDC_NAMESPACE
namespace std { using ::strcmp; using ::remove; using ::rename; }
#endif

//  helpers  -----------------------------------------------------------------//

namespace
{
  static const fs::directory_iterator end_itr;
  bool is_empty_directory( const std::string & dir_path )
  {
    return fs::directory_iterator(fs::path(dir_path)) == end_itr;
  }

#ifdef BOOST_WINDOWS_API
  
// For Windows, the xxxA form of various function names is used to avoid
// inadvertently getting wide forms of the functions. (The undecorated
// forms are actually macros, so can misfire if the user has various
// other macros defined. There was a bug report of this happening.)

  inline DWORD get_file_attributes( const char * ph )
    { return ::GetFileAttributesA( ph ); }

# ifndef BOOST_FILESYSTEM_NARROW_ONLY

  inline DWORD get_file_attributes( const wchar_t * ph )
    { return ::GetFileAttributesW( ph ); }

  static const fs::wdirectory_iterator wend_itr;
  bool is_empty_directory( const std::wstring & dir_path )
  {
    return fs::wdirectory_iterator(fs::wpath(dir_path)) == wend_itr;
  }

  inline BOOL get_file_attributes_ex( const wchar_t * ph,
    WIN32_FILE_ATTRIBUTE_DATA & fad )
  { return ::GetFileAttributesExW( ph, ::GetFileExInfoStandard, &fad ); }
      
  HANDLE create_file( const wchar_t * ph, DWORD dwDesiredAccess,
    DWORD dwShareMode, LPSECURITY_ATTRIBUTES lpSecurityAttributes,
    DWORD dwCreationDisposition, DWORD dwFlagsAndAttributes,
    HANDLE hTemplateFile )
  {
    return ::CreateFileW( ph, dwDesiredAccess, dwShareMode,
      lpSecurityAttributes, dwCreationDisposition, dwFlagsAndAttributes,
      hTemplateFile );
  }

  inline DWORD get_current_directory( DWORD sz, wchar_t * buf )
    { return ::GetCurrentDirectoryW( sz, buf ); } 

  inline bool get_free_disk_space( const std::wstring & ph,
    PULARGE_INTEGER avail, PULARGE_INTEGER total, PULARGE_INTEGER free )
    { return ::GetDiskFreeSpaceExW( ph.c_str(), avail, total, free ) != 0; }

  inline std::size_t get_full_path_name(
    const std::wstring & ph, std::size_t len, wchar_t * buf, wchar_t ** p )
  {
    return static_cast<std::size_t>(
      ::GetFullPathNameW( ph.c_str(),
        static_cast<DWORD>(len), buf, p ));
  } 

  inline bool remove_directory( const std::wstring & ph )
    { return ::RemoveDirectoryW( ph.c_str() ) != 0; }

  inline bool delete_file( const std::wstring & ph )
    { return ::DeleteFileW( ph.c_str() ) != 0; }

  inline bool create_directory( const std::wstring & dir )
    {  return ::CreateDirectoryW( dir.c_str(), 0 ) != 0; }

  inline bool create_hard_link( const std::wstring & to_ph,
    const std::wstring & from_ph )
    {  return ::CreateHardLinkW( from_ph.c_str(), to_ph.c_str(), 0 ) != 0; }

# endif // ifndef BOOST_FILESYSTEM_NARROW_ONLY

  template< class String >
  fs::status_flags status_template( const String & ph,
    boost::filesystem::system_error_type * ec )
  {
    DWORD attr( get_file_attributes( ph.c_str() ) );
    if ( attr == 0xFFFFFFFF )
    {
      UINT err = ::GetLastError();
      if ( ec != 0 ) *ec = err;
      return ((err == ERROR_FILE_NOT_FOUND)
        || (err == ERROR_PATH_NOT_FOUND)
        || (err == ERROR_BAD_NETPATH ))
        ? fs::not_found_flag : fs::error_flag;
    }
    return (attr & FILE_ATTRIBUTE_DIRECTORY) != 0
      ? fs::directory_flag : fs::file_flag;
  }

  BOOL get_file_attributes_ex( const char * ph,
    WIN32_FILE_ATTRIBUTE_DATA & fad )
  { return ::GetFileAttributesExA( ph, ::GetFileExInfoStandard, &fad ); }

  template< class String >
  boost::filesystem::detail::query_pair
  is_empty_template( const String & ph )
  {
    WIN32_FILE_ATTRIBUTE_DATA fad;
    if ( get_file_attributes_ex( ph.c_str(), fad ) == 0 )
      return std::make_pair( ::GetLastError(), false );    
    return std::make_pair( 0,
      ( fad.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY )
        ? is_empty_directory( ph )
        :( !fad.nFileSizeHigh && !fad.nFileSizeLow ) );
  }

  HANDLE create_file( const char * ph, DWORD dwDesiredAccess,
    DWORD dwShareMode, LPSECURITY_ATTRIBUTES lpSecurityAttributes,
    DWORD dwCreationDisposition, DWORD dwFlagsAndAttributes,
    HANDLE hTemplateFile )
  {
    return ::CreateFileA( ph, dwDesiredAccess, dwShareMode,
      lpSecurityAttributes, dwCreationDisposition, dwFlagsAndAttributes,
      hTemplateFile );
  }

  // Thanks to Jeremy Maitin-Shepard for much help and for permission to
  // base the equivalent() implementation on portions of his 
  // file-equivalence-win32.cpp experimental code.
  struct handle_wrapper
  {
    HANDLE handle;
    handle_wrapper( HANDLE h )
      : handle(h) {}
    ~handle_wrapper()
    {
      if ( handle != INVALID_HANDLE_VALUE )
        ::CloseHandle(handle);
    }
  };

  template< class String >
  boost::filesystem::detail::query_pair
  equivalent_template( const String & ph1, const String & ph2 )
  {
    // Note well: Physical location on external media is part of the
    // equivalence criteria. If there are no open handles, physical location
    // can change due to defragmentation or other relocations. Thus handles
    // must be held open until location information for both paths has
    // been retrieved.
    handle_wrapper p1(
      create_file(
          ph1.c_str(),
          0,
          FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
          0,
          OPEN_EXISTING,
          FILE_FLAG_BACKUP_SEMANTICS,
          0 ) );
    int error1(0); // save error code in case we have to throw
    if ( p1.handle == INVALID_HANDLE_VALUE )
      error1 = ::GetLastError();
    handle_wrapper p2(
      create_file(
          ph2.c_str(),
          0,
          FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
          0,
          OPEN_EXISTING,
          FILE_FLAG_BACKUP_SEMANTICS,
          0 ) );
    if ( p1.handle == INVALID_HANDLE_VALUE
      || p2.handle == INVALID_HANDLE_VALUE )
    {
      if ( p1.handle != INVALID_HANDLE_VALUE
        || p2.handle != INVALID_HANDLE_VALUE )
        { return std::make_pair( 0, false ); }
      assert( p1.handle == INVALID_HANDLE_VALUE
        && p2.handle == INVALID_HANDLE_VALUE );
        { return std::make_pair( error1, false ); }
    }
    // at this point, both handles are known to be valid
    BY_HANDLE_FILE_INFORMATION info1, info2;
    if ( !::GetFileInformationByHandle( p1.handle, &info1 ) )
      { return std::make_pair( ::GetLastError(), false ); }
    if ( !::GetFileInformationByHandle( p2.handle, &info2 ) )
      { return std::make_pair( ::GetLastError(), false ); }
    // In theory, volume serial numbers are sufficient to distinguish between
    // devices, but in practice VSN's are sometimes duplicated, so last write
    // time and file size are also checked.
      return std::make_pair( 0,
        info1.dwVolumeSerialNumber == info2.dwVolumeSerialNumber
        && info1.nFileIndexHigh == info2.nFileIndexHigh
        && info1.nFileIndexLow == info2.nFileIndexLow
        && info1.nFileSizeHigh == info2.nFileSizeHigh
        && info1.nFileSizeLow == info2.nFileSizeLow
        && info1.ftLastWriteTime.dwLowDateTime
          == info2.ftLastWriteTime.dwLowDateTime
        && info1.ftLastWriteTime.dwHighDateTime
          == info2.ftLastWriteTime.dwHighDateTime );
  }

  template< class String >
  boost::filesystem::detail::uintmax_pair
  file_size_template( const String & ph )
  {
    WIN32_FILE_ATTRIBUTE_DATA fad;
    // by now, intmax_t is 64-bits on all Windows compilers
    if ( get_file_attributes_ex( ph.c_str(), fad ) == 0 )
      return std::make_pair( ::GetLastError(), 0 );    
    if ( (fad.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) !=0 )
      return std::make_pair( ERROR_FILE_NOT_FOUND, 0 );
    return std::make_pair( 0,
      (static_cast<boost::uintmax_t>(fad.nFileSizeHigh)
        << (sizeof(fad.nFileSizeLow)*8))
      + fad.nFileSizeLow );
  }

  inline bool get_free_disk_space( const std::string & ph,
    PULARGE_INTEGER avail, PULARGE_INTEGER total, PULARGE_INTEGER free )
    { return ::GetDiskFreeSpaceExA( ph.c_str(), avail, total, free ) != 0; }

  template< class String >
  boost::filesystem::detail::space_pair
  space_template( String & ph )
  {
    ULARGE_INTEGER avail, total, free;
    boost::filesystem::detail::space_pair result;
    if ( get_free_disk_space( ph, &avail, &total, &free ) )
    {
      result.first = 0;
      result.second.capacity
        = (static_cast<boost::uintmax_t>(total.HighPart) << 32)
          + total.LowPart;
      result.second.free
        = (static_cast<boost::uintmax_t>(free.HighPart) << 32)
          + free.LowPart;
      result.second.available
        = (static_cast<boost::uintmax_t>(avail.HighPart) << 32)
          + avail.LowPart;
    }
    else
    {
      result.first = ::GetLastError();
      result.second.capacity = result.second.free
        = result.second.available = 0;
    }
    return result;
  }

  inline DWORD get_current_directory( DWORD sz, char * buf )
    { return ::GetCurrentDirectoryA( sz, buf ); } 

  template< class String >
  boost::filesystem::system_error_type
  get_current_path_template( String & ph )
  {
    DWORD sz;
    if ( (sz = get_current_directory( 0,
      static_cast<typename String::value_type*>(0) )) == 0 )
      { sz = 1; }
    typedef typename String::value_type value_type;
    boost::scoped_array<value_type> buf( new value_type[sz] );
    if ( get_current_directory( sz, buf.get() ) == 0 )
      return ::GetLastError();
    ph = buf.get();
    return 0;
  }

  inline std::size_t get_full_path_name(
    const std::string & ph, std::size_t len, char * buf, char ** p )
  {
    return static_cast<std::size_t>(
      ::GetFullPathNameA( ph.c_str(),
        static_cast<DWORD>(len), buf, p ));
  } 

  const std::size_t buf_size( 128 );

  template<class String>
  boost::filesystem::system_error_type
  get_full_path_name_template( const String & ph, String & target )
  {
    typename String::value_type buf[buf_size];
    typename String::value_type * pfn;
    std::size_t len = get_full_path_name( ph,
      sizeof(buf) , buf, &pfn );
    if ( len == 0 ) return ::GetLastError();
    if ( len > buf_size )
    {
      typedef typename String::value_type value_type;
      boost::scoped_array<value_type> big_buf( new value_type[len] );
      if ( (len=get_full_path_name( ph, len , big_buf.get(), &pfn ))
        == 0 ) return ::GetLastError();
      big_buf[len] = '\0';
      target = big_buf.get();
      return 0;
    }
    buf[len] = '\0';
    target = buf;
    return 0;
  }

  template<class String>
  boost::filesystem::system_error_type
  get_file_write_time( const String & ph, FILETIME & last_write_time )
  {
    handle_wrapper hw(
      create_file( ph.c_str(), 0,
        FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
        OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, 0 ) );
    if ( hw.handle == INVALID_HANDLE_VALUE )
      return ::GetLastError();
    return ::GetFileTime( hw.handle, 0, 0, &last_write_time ) != 0
      ? 0 : ::GetLastError();
  }

  template<class String>
  boost::filesystem::system_error_type
  set_file_write_time( const String & ph, const FILETIME & last_write_time )
  {
    handle_wrapper hw(
      create_file( ph.c_str(), FILE_WRITE_ATTRIBUTES,
        FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
        OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, 0 ) );
    if ( hw.handle == INVALID_HANDLE_VALUE )
      return ::GetLastError();
    return ::SetFileTime( hw.handle, 0, 0, &last_write_time ) != 0
      ? 0 : ::GetLastError();
  }

  // these constants come from inspecting some Microsoft sample code
  std::time_t to_time_t( const FILETIME & ft )
  {
    __int64 t = (static_cast<__int64>( ft.dwHighDateTime ) << 32)
      + ft.dwLowDateTime;
# if !defined( BOOST_MSVC ) || BOOST_MSVC > 1300 // > VC++ 7.0
    t -= 116444736000000000LL;
# else
    t -= 116444736000000000;
# endif
    t /= 10000000;
    return static_cast<std::time_t>( t );
  }

  void to_FILETIME( std::time_t t, FILETIME & ft )
  {
    __int64 temp = t;
    temp *= 10000000;
# if !defined( BOOST_MSVC ) || BOOST_MSVC > 1300 // > VC++ 7.0
    temp += 116444736000000000LL;
# else
    temp += 116444736000000000;
# endif
    ft.dwLowDateTime = static_cast<DWORD>( temp );
    ft.dwHighDateTime = static_cast<DWORD>( temp >> 32 );
  }

  template<class String>
  boost::filesystem::detail::time_pair
  last_write_time_template( const String & ph )
  {
    FILETIME lwt;
    boost::filesystem::system_error_type result
      = get_file_write_time( ph, lwt );
    return std::make_pair( result, to_time_t( lwt ) );
  }

  template<class String>
  boost::filesystem::system_error_type
  last_write_time_template( const String & ph, const std::time_t new_time )
  {
    FILETIME lwt;
    to_FILETIME( new_time, lwt );
    return set_file_write_time( ph, lwt );
  }

  bool remove_directory( const std::string & ph )
    { return ::RemoveDirectoryA( ph.c_str() ) != 0; }
  
  bool delete_file( const std::string & ph )
    { return ::DeleteFileA( ph.c_str() ) != 0; }
  
  template<class String>
  boost::filesystem::system_error_type
  remove_template( const String & ph )
  {
    fs::system_error_type ec;
    fs::status_flags sf( fs::detail::status_api( ph, &ec ) );
    if ( sf == fs::error_flag ) return ec;
    if ( (sf & fs::directory_flag) != 0 )
    {
      if ( !remove_directory( ph ) )
        return ::GetLastError();
    }
    else
    {
      if ( !delete_file( ph ) ) return ::GetLastError();
    }
    return 0;
  }

  inline bool create_directory( const std::string & dir )
    {  return ::CreateDirectoryA( dir.c_str(), 0 ) != 0; }
         
  template<class String>
  boost::filesystem::detail::query_pair
  create_directory_template( const String & dir_ph )
  {
    boost::filesystem::system_error_type error(0);
    if ( create_directory( dir_ph ) ) return std::make_pair( error, true );
    error = ::GetLastError();
    // an error here may simply mean the postcondition is already met
    if ( error == ERROR_ALREADY_EXISTS
      && (fs::detail::status_api( dir_ph ) & fs::directory_flag) != 0 )
      return std::make_pair( 0, false );
    return std::make_pair( error, false );
  }

  inline bool create_hard_link( const std::string & to_ph,
    const std::string & from_ph )
    {  return ::CreateHardLinkA( from_ph.c_str(), to_ph.c_str(), 0 ) != 0; }
         
  template<class String>
  boost::filesystem::system_error_type
  create_hard_link_template( const String & to_ph,
    const String & from_ph )
  {
    return create_hard_link( to_ph.c_str(), from_ph.c_str() )
      ? 0 : ::GetLastError();
  }

#endif
} // unnamed namespace

namespace boost
{
  namespace filesystem
  {
    BOOST_FILESYSTEM_DECL symlink_t symlink; 

    namespace detail
    {

//  free functions  ----------------------------------------------------------//

      BOOST_FILESYSTEM_DECL bool possible_large_file_size_support()
      {
#   ifdef BOOST_POSIX_API
        struct stat lcl_stat;
        return sizeof( lcl_stat.st_size ) > 4;
#   else
        return true;
#   endif
      }

#   ifdef BOOST_WINDOWS_API

      BOOST_FILESYSTEM_DECL fs::status_flags
      status_api( const std::string & ph,
        boost::filesystem::system_error_type * ec )
        { return status_template( ph, ec ); }

#     ifndef BOOST_FILESYSTEM_NARROW_ONLY

      BOOST_FILESYSTEM_DECL fs::status_flags
      status_api( const std::wstring & ph,
        boost::filesystem::system_error_type * ec )
        { return status_template( ph, ec ); }

      BOOST_FILESYSTEM_DECL bool symbolic_link_exists_api( const std::wstring & )
        { return false; }

      BOOST_FILESYSTEM_DECL
      fs::detail::query_pair is_empty_api( const std::wstring & ph )
        { return is_empty_template( ph ); }

      BOOST_FILESYSTEM_DECL
      fs::detail::query_pair
      equivalent_api( const std::wstring & ph1, const std::wstring & ph2 )
        { return equivalent_template( ph1, ph2 ); }

      BOOST_FILESYSTEM_DECL
      fs::detail::uintmax_pair file_size_api( const std::wstring & ph )
        { return file_size_template( ph ); }

      BOOST_FILESYSTEM_DECL
      fs::detail::space_pair space_api( const std::wstring & ph )
        { return space_template( ph ); }

      BOOST_FILESYSTEM_DECL
      boost::filesystem::system_error_type 
      get_current_path_api( std::wstring & ph )
        { return get_current_path_template( ph ); }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
        get_full_path_name_api( const std::wstring & ph, std::wstring & target )
         { return get_full_path_name_template( ph, target ); }

      BOOST_FILESYSTEM_DECL time_pair
        last_write_time_api( const std::wstring & ph )
          { return last_write_time_template( ph ); }
 
      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
        last_write_time_api( const std::wstring & ph, std::time_t new_value )
          { return last_write_time_template( ph, new_value ); }

      BOOST_FILESYSTEM_DECL fs::detail::query_pair
      create_directory_api( const std::wstring & ph )
        { return create_directory_template( ph ); }

      BOOST_FILESYSTEM_DECL fs::system_error_type
      create_hard_link_api( const std::wstring & to_ph,
        const std::wstring & from_ph )
        { return create_hard_link_template( to_ph, from_ph ); }

      BOOST_FILESYSTEM_DECL fs::system_error_type
      create_symlink_api( const std::wstring & to_ph,
        const std::wstring & from_ph )
        { return ERROR_NOT_SUPPORTED; }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      remove_api( const std::wstring & ph ) { return remove_template( ph ); }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      rename_api( const std::wstring & from, const std::wstring & to )
      {
        return ::MoveFileW( from.c_str(), to.c_str() )
          ? 0 : ::GetLastError();
      }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      copy_file_api( const std::wstring & from, const std::wstring & to )
      {
        return ::CopyFileW( from.c_str(), to.c_str(), /*fail_if_exists=*/true )
          ? 0 : ::GetLastError();
      }

      BOOST_FILESYSTEM_DECL bool create_file_api( const std::wstring & ph,
        std::ios_base::openmode mode ) // true if succeeds
      {
        DWORD access(
          ((mode & std::ios_base::in) == 0 ? 0 : GENERIC_READ)
          | ((mode & std::ios_base::out) == 0 ? 0 : GENERIC_WRITE) );

        DWORD disposition(0); // see 27.8.1.3 Table 92
        if ( (mode&~std::ios_base::binary)
          == (std::ios_base::out|std::ios_base::app) )
          disposition = OPEN_ALWAYS;
        else if ( (mode&~(std::ios_base::binary|std::ios_base::out))
          == std::ios_base::in ) disposition = OPEN_EXISTING;
        else if ( ((mode&~(std::ios_base::binary|std::ios_base::trunc))
          == std::ios_base::out )
          || ((mode&~std::ios_base::binary)
          == (std::ios_base::in|std::ios_base::out|std::ios_base::trunc)) )
          disposition = CREATE_ALWAYS;
        else assert( 0 && "invalid mode argument" );

        HANDLE handle ( ::CreateFileW( ph.c_str(), access,
          FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
          disposition, (mode &std::ios_base::out) != 0
          ? FILE_ATTRIBUTE_ARCHIVE : FILE_ATTRIBUTE_NORMAL, 0 ) );
        if ( handle == INVALID_HANDLE_VALUE ) return false;
        ::CloseHandle( handle );
        return true;
      }

      BOOST_FILESYSTEM_DECL std::string narrow_path_api(
        const std::wstring & ph ) // return is empty if fails
      {
        std::string narrow_short_form;
        std::wstring short_form;
        for ( DWORD buf_sz( static_cast<DWORD>( ph.size()+1 ));; )
        {
          boost::scoped_array<wchar_t> buf( new wchar_t[buf_sz] );
          DWORD sz( ::GetShortPathNameW( ph.c_str(), buf.get(), buf_sz ) );
          if ( sz == 0 ) return narrow_short_form;
          if ( sz <= buf_sz )
          {
            short_form += buf.get();
            break;
          }
          buf_sz = sz + 1;
        }
        for ( std::wstring::iterator it( short_form.begin() );
          it != short_form.end(); ++it )
        {
          // my expectation is that Unicode characters in long names will be
          // converted to 8-bit characters in the short 8.3 form names; this
          // expectation is based on observation rather than Windows API
          // documentation.
          assert( (*it & 0xFF) == *it || "program logic error; see program comments" );
          if ( (*it & 0xFF) != *it )
            boost::throw_exception( "program logic error" );
          narrow_short_form += static_cast<char>( *it );
        }
        return narrow_short_form;
      }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      dir_itr_first( void *& handle, const std::wstring & dir,
        std::wstring & target, status_flags & sf, status_flags & symlink_sf )
      {
        // use a form of search Sebastian Martel reports will work with Win98
        std::wstring dirpath( dir );
        dirpath += (dirpath.empty()
          || dirpath[dirpath.size()-1] != L'\\') ? L"\\*" : L"*";

        WIN32_FIND_DATAW data;
        if ( (handle = ::FindFirstFileW( dirpath.c_str(), &data ))
          == INVALID_HANDLE_VALUE )
        { 
          handle = 0;
          return ::GetLastError() == ERROR_FILE_NOT_FOUND
            ? 0 : ::GetLastError();
        }
        target = data.cFileName;
        symlink_sf = sf = ((data.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
          == FILE_ATTRIBUTE_DIRECTORY)
          ? fs::directory_flag
          : fs::file_flag;
        return 0;
      }  

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      dir_itr_increment( void *& handle, std::wstring & target,
        status_flags & sf, status_flags & symlink_sf )
      {
        WIN32_FIND_DATAW data;
        if ( ::FindNextFileW( handle, &data ) == 0 ) // fails
        {
          int error = ::GetLastError();
          dir_itr_close( handle );
          return error == ERROR_NO_MORE_FILES ? 0 : error;
        }
        target = data.cFileName;
        symlink_sf = sf = ((data.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
          == FILE_ATTRIBUTE_DIRECTORY)
          ? fs::directory_flag
          : fs::file_flag;
        return 0;
      }

#     endif // ifndef BOOST_FILESYSTEM_NARROW_ONLY

      // suggested by Walter Landry
      BOOST_FILESYSTEM_DECL bool symbolic_link_exists_api( const std::string & )
        { return false; }

      BOOST_FILESYSTEM_DECL
      fs::detail::query_pair is_empty_api( const std::string & ph )
        { return is_empty_template( ph ); }

      BOOST_FILESYSTEM_DECL
      fs::detail::query_pair
      equivalent_api( const std::string & ph1, const std::string & ph2 )
        { return equivalent_template( ph1, ph2 ); }

      BOOST_FILESYSTEM_DECL
      fs::detail::uintmax_pair file_size_api( const std::string & ph )
        { return file_size_template( ph ); }

      BOOST_FILESYSTEM_DECL
      fs::detail::space_pair space_api( const std::string & ph )
        { return space_template( ph ); }

      BOOST_FILESYSTEM_DECL
      boost::filesystem::system_error_type 
      get_current_path_api( std::string & ph )
        { return get_current_path_template( ph ); }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
        get_full_path_name_api( const std::string & ph, std::string & target )
         { return get_full_path_name_template( ph, target ); }

      BOOST_FILESYSTEM_DECL time_pair
        last_write_time_api( const std::string & ph )
          { return last_write_time_template( ph ); }
 
      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
        last_write_time_api( const std::string & ph, std::time_t new_value )
          { return last_write_time_template( ph, new_value ); }

      BOOST_FILESYSTEM_DECL fs::detail::query_pair
      create_directory_api( const std::string & ph )
        { return create_directory_template( ph ); }

      BOOST_FILESYSTEM_DECL fs::system_error_type
      create_hard_link_api( const std::string & to_ph,
        const std::string & from_ph )
        { return create_hard_link_template( to_ph, from_ph ); }

      BOOST_FILESYSTEM_DECL fs::system_error_type
      create_symlink_api( const std::string & to_ph,
        const std::string & from_ph )
        { return ERROR_NOT_SUPPORTED; }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      remove_api( const std::string & ph ) { return remove_template( ph ); }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      rename_api( const std::string & from, const std::string & to )
      {
        return ::MoveFileA( from.c_str(), to.c_str() )
          ? 0 : ::GetLastError();
      }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      copy_file_api( const std::string & from, const std::string & to )
      {
        return ::CopyFileA( from.c_str(), to.c_str(), /*fail_if_exists=*/true )
          ? 0 : ::GetLastError();
      }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      dir_itr_first( void *& handle, const std::string & dir,
        std::string & target, status_flags & sf, status_flags & symlink_sf )
      // Note: an empty root directory has no "." or ".." entries, so this
      // causes a ERROR_FILE_NOT_FOUND error which we do not considered an
      // error. It is treated as eof instead.
      {
        // use a form of search Sebastian Martel reports will work with Win98
        std::string dirpath( dir );
        dirpath += (dirpath.empty()
          || (dirpath[dirpath.size()-1] != '\\'
            && dirpath[dirpath.size()-1] != ':')) ? "\\*" : "*";

        WIN32_FIND_DATAA data;
        if ( (handle = ::FindFirstFileA( dirpath.c_str(), &data ))
          == INVALID_HANDLE_VALUE )
        { 
          handle = 0;
          return ::GetLastError() == ERROR_FILE_NOT_FOUND
            ? 0 : ::GetLastError();
        }
        target = data.cFileName;
        symlink_sf = sf = ((data.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
          == FILE_ATTRIBUTE_DIRECTORY)
          ? fs::directory_flag
          : fs::file_flag;
        return 0;
      }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      dir_itr_close( void *& handle )
      {
        if ( handle != 0 )
        {
          bool ok = ::FindClose( handle ) != 0;
          handle = 0;
          return ok ? 0 : ::GetLastError();
        }
        return 0;
      }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      dir_itr_increment( void *& handle, std::string & target,
        status_flags & sf, status_flags & symlink_sf )
      {
        WIN32_FIND_DATAA data;
        if ( ::FindNextFileA( handle, &data ) == 0 ) // fails
        {
          int error = ::GetLastError();
          dir_itr_close( handle );
          return error == ERROR_NO_MORE_FILES ? 0 : error;
        }
        target = data.cFileName;
        symlink_sf = sf = ((data.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
          == FILE_ATTRIBUTE_DIRECTORY)
          ? fs::directory_flag
          : fs::file_flag;
        return 0;
      }

#   else // BOOST_POSIX_API

      BOOST_FILESYSTEM_DECL boost::filesystem::status_flags
      status_api( const std::string & ph,
                  boost::filesystem::system_error_type * ec )
      {
        struct stat path_stat;
        if ( ::stat( ph.c_str(), &path_stat ) != 0 )
        {
          if ( ec != 0 ) *ec = errno;
          return ( (errno == ENOENT) || (errno == ENOTDIR) )
            ? fs::not_found_flag : fs::error_flag;
        }
        fs::status_flags result(0);
        if ( S_ISDIR( path_stat.st_mode ) ) result |= fs::directory_flag;
        if ( S_ISREG( path_stat.st_mode ) ) result |= fs::file_flag;
        if ( result == 0 ) result = fs::other_flag;
        return result;
      }

      BOOST_FILESYSTEM_DECL boost::filesystem::status_flags
      symlink_status_api( const std::string & ph,
                          boost::filesystem::system_error_type * ec )
      {
        struct stat path_stat;
        if ( ::lstat( ph.c_str(), &path_stat ) != 0 )
        {
          if ( ec != 0 ) *ec = errno;
          return ( (errno == ENOENT) || (errno == ENOTDIR) )
            ? fs::not_found_flag : fs::error_flag;
        }
        fs::status_flags result(0);
        if ( S_ISLNK( path_stat.st_mode ) ) result |= fs::symlink_flag;
        if ( S_ISDIR( path_stat.st_mode ) ) result |= fs::directory_flag;
        if ( S_ISREG( path_stat.st_mode ) ) result |= fs::file_flag;
        if ( result == 0 ) result = fs::other_flag;
        return result;
      }

      // suggested by Walter Landry
      BOOST_FILESYSTEM_DECL bool
      symbolic_link_exists_api( const std::string & ph )
      {
        struct stat path_stat;
        return ::lstat( ph.c_str(), &path_stat ) == 0
          && S_ISLNK( path_stat.st_mode );
      }

      BOOST_FILESYSTEM_DECL query_pair
      is_empty_api( const std::string & ph )
      {
        struct stat path_stat;
        if ( (::stat( ph.c_str(), &path_stat )) != 0 )
          return std::make_pair( errno, false );        
        return std::make_pair( 0, S_ISDIR( path_stat.st_mode )
          ? is_empty_directory( ph )
          : path_stat.st_size == 0 );
      }

      BOOST_FILESYSTEM_DECL query_pair
      equivalent_api( const std::string & ph1, const std::string & ph2 )
      {
        struct stat s2;
        int e2( ::stat( ph2.c_str(), &s2 ) );
        struct stat s1;
        int e1( ::stat( ph1.c_str(), &s1 ) );
        if ( e1 != 0 || e2 != 0 )
          return std::make_pair( e1 != 0 && e2 != 0 ? errno : 0, false );
        // at this point, both stats are known to be valid
        return std::make_pair( 0,
            s1.st_dev == s2.st_dev
            && s1.st_ino == s2.st_ino
            // According to the POSIX stat specs, "The st_ino and st_dev fields
            // taken together uniquely identify the file within the system."
            // Just to be sure, size and mod time are also checked.
            && s1.st_size == s2.st_size
            && s1.st_mtime == s2.st_mtime );
      }
 
      BOOST_FILESYSTEM_DECL uintmax_pair
      file_size_api( const std::string & ph )
      {
        struct stat path_stat;
        if ( ::stat( ph.c_str(), &path_stat ) != 0 )
          return std::make_pair( errno, 0 );
        if ( !S_ISREG( path_stat.st_mode ) )
          return std::make_pair( EPERM, 0 ); 
        return std::make_pair( 0,
          static_cast<boost::uintmax_t>(path_stat.st_size) );
      }

      BOOST_FILESYSTEM_DECL space_pair
      space_api( const std::string & ph )
      {
        struct statvfs vfs;
        space_pair result;
        if ( ::statvfs( ph.c_str(), &vfs ) != 0 )
        {
          result.first = errno;
          result.second.capacity = result.second.free
            = result.second.available = 0;
        }
        else
        {
          result.first = 0;
          result.second.capacity 
            = static_cast<boost::uintmax_t>(vfs.f_blocks) * vfs.f_frsize;
          result.second.free 
            = static_cast<boost::uintmax_t>(vfs.f_bfree) * vfs.f_frsize;
          result.second.available
            = static_cast<boost::uintmax_t>(vfs.f_bavail) * vfs.f_frsize;
        }
        return result;
      }

      BOOST_FILESYSTEM_DECL time_pair 
      last_write_time_api( const std::string & ph )
      {
        struct stat path_stat;
        if ( ::stat( ph.c_str(), &path_stat ) != 0 )
          return std::make_pair( errno, 0 );
        return std::make_pair( 0, path_stat.st_mtime );
      }

      BOOST_FILESYSTEM_DECL fs::system_error_type
      last_write_time_api( const std::string & ph, std::time_t new_value )
      {
        struct stat path_stat;
        if ( ::stat( ph.c_str(), &path_stat ) != 0 ) return errno;
        ::utimbuf buf;
        buf.actime = path_stat.st_atime; // utime() updates access time too:-(
        buf.modtime = new_value;
        return ::utime( ph.c_str(), &buf ) != 0 ? errno : 0;
      }

      BOOST_FILESYSTEM_DECL fs::system_error_type 
      get_current_path_api( std::string & ph )
      {
        for ( long path_max = 32;; path_max *=2 ) // loop 'til buffer large enough
        {
          boost::scoped_array<char>
            buf( new char[static_cast<std::size_t>(path_max)] );
          if ( ::getcwd( buf.get(), static_cast<std::size_t>(path_max) ) == 0 )
          {
            if ( errno != ERANGE
          // bug in some versions of the Metrowerks C lib on the Mac: wrong errno set 
#         if defined(__MSL__) && (defined(macintosh) || defined(__APPLE__) || defined(__APPLE_CC__))
              && errno != 0
#         endif
              ) return errno;
          }
          else
          {
            ph = buf.get();
            break;
          }
        }
        return 0;
      }

      BOOST_FILESYSTEM_DECL fs::detail::query_pair
      create_directory_api( const std::string & ph )
      {
        if ( ::mkdir( ph.c_str(), S_IRWXU|S_IRWXG|S_IRWXO ) == 0 )
          { return std::make_pair( 0, true ); }
        if ( errno != EEXIST 
          || (status_api( ph ) & fs::directory_flag) == 0 )
          { return std::make_pair( errno, false ); }
        return std::make_pair( 0, false );
      }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      create_hard_link_api( const std::string & to_ph,
          const std::string & from_ph )
      {
        return ::link( to_ph.c_str(), from_ph.c_str() ) == 0
          ? 0 : errno;
      }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      create_symlink_api( const std::string & to_ph,
          const std::string & from_ph )
      {
        return ::symlink( to_ph.c_str(), from_ph.c_str() ) == 0
          ? 0 : errno;
      }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      remove_api( const std::string & ph )
      {
#     if defined(__QNXNTO__) || (defined(__MSL__) && (defined(macintosh) || defined(__APPLE__) || defined(__APPLE_CC__)))
        // Some Metrowerks C library versions fail on directories because of a
        // known Metrowerks coding error in ::remove. Workaround is to call
        // rmdir() or unlink() as indicated.
        // Same bug also reported for QNX, with the same fix.
        if ( (is_directory( ph )
          ? ::rmdir( ph.string().c_str() )
          : ::unlink( ph.string().c_str() )) != 0 )
#     else
        // note that the POSIX behavior for symbolic links is what we want;
        // the link rather than what it points to is deleted
        if ( std::remove( ph.c_str() ) != 0 )
#     endif
        {
          int error = errno;
          // POSIX says "If the directory is not an empty directory, rmdir()
          // shall fail and set errno to EEXIST or ENOTEMPTY."
          // Linux uses ENOTEMPTY, Solaris uses EEXIST.
          if ( error == EEXIST ) error = ENOTEMPTY;
          return error;
        }
        return 0;
      }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      rename_api( const std::string & from, const std::string & to )
      {
        // POSIX is too permissive so must check
        if ( status_api( to ) != fs::not_found_flag ) 
          return EEXIST;
        return std::rename( from.c_str(), to.c_str() ) != 0 
          ? errno : 0;
      }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      copy_file_api( const std::string & from_file_ph,
        const std::string & to_file_ph )
      {
        const std::size_t buf_sz = 32768;
        boost::scoped_array<char> buf( new char [buf_sz] );
        int infile=0, outfile=0;  // init quiets compiler warning
        struct stat from_stat;

        if ( ::stat( from_file_ph.c_str(), &from_stat ) != 0
          || (infile = ::open( from_file_ph.c_str(),
                              O_RDONLY )) < 0
          || (outfile = ::open( to_file_ph.c_str(),
                                O_WRONLY | O_CREAT | O_EXCL,
                                from_stat.st_mode )) < 0 )
        {
          if ( infile >= 0 ) ::close( infile );
          return errno;
        }

        ssize_t sz, sz_read=1, sz_write;
        while ( sz_read > 0
          && (sz_read = ::read( infile, buf.get(), buf_sz )) > 0 )
        {
          // Allow for partial writes - see Advanced Unix Programming (2nd Ed.),
          // Marc Rochkind, Addison-Wesley, 2004, page 94
          sz_write = 0;
          do
          {
            if ( (sz = ::write( outfile, buf.get(), sz_read - sz_write )) < 0 )
            { 
              sz_read = sz; // cause read loop termination
              break;        //  and error to be thrown after closes
            }
            sz_write += sz;
          } while ( sz_write < sz_read );
        }

        if ( ::close( infile) < 0 ) sz_read = -1;
        if ( ::close( outfile) < 0 ) sz_read = -1;

        return sz_read < 0 ? errno : 0;
      }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      dir_itr_first( void *& handle, const std::string & dir,
        std::string & target, status_flags &, status_flags & )
      {
        static const std::string dummy_first_name( "." );
        if ( (handle = ::opendir( dir.c_str() )) == 0 ) return errno;
        target = dummy_first_name;
        return 0;
      }  

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      dir_itr_close( void *& handle )
      {
        if ( handle == 0 ) return 0;
        DIR * h( static_cast<DIR*>(handle) );
        handle = 0;
        return ::closedir( h ) == 0 ? 0 : errno;
      }

      // warning: the only dirent member updated is d_name
      inline int readdir_r_simulator( DIR * dirp, struct dirent * entry,
        struct dirent ** result ) // *result set to 0 on end of directory
        {
    #     if !defined(__CYGWIN__) \
          && defined(_POSIX_THREAD_SAFE_FUNCTIONS) \
          && defined(_SC_THREAD_SAFE_FUNCTIONS) \
          && (_POSIX_THREAD_SAFE_FUNCTIONS+0 >= 0) \
          && (!defined(__HP_aCC) || (defined(__HP_aCC) && defined(_REENTRANT)))
          if ( ::sysconf( _SC_THREAD_SAFE_FUNCTIONS ) >= 0 )
            { return ::readdir_r( dirp, entry, result ); }
    #     endif

          struct dirent * p;
          errno = 0;
          *result = 0;
          if ( (p = ::readdir( dirp )) == 0 )
            return errno;
          // POSIX specs require entry->d_name be large enough:
          std::strcpy( entry->d_name, p->d_name );
          *result = entry;
          return 0;
        }

      BOOST_FILESYSTEM_DECL boost::filesystem::system_error_type
      dir_itr_increment( void *& handle, std::string & target,
        status_flags & sf, status_flags & symlink_sf )
      {
        struct dirent entry, * result;
        int return_code;
        if ( (return_code = readdir_r_simulator( static_cast<DIR*>(handle),
          &entry, &result )) != 0 ) return errno;
        if ( result == 0 ) return dir_itr_close( handle );
        target = entry.d_name;
#     ifdef BOOST_FILESYSTEM_STATUS_CACHE
//        std::cout << "entry.d_type is " << (int)entry.d_type << std::endl;
//        std::cout << "DT_DIR is " << (int)DT_DIR << std::endl;
        if ( entry.d_type == DT_DIR ) sf = symlink_sf = fs::directory_flag;
        else if ( entry.d_type == DT_REG ) sf = symlink_sf = fs::file_flag;
        else if ( entry.d_type == DT_LNK )
          { sf = 0; symlink_sf = fs::symlink_flag; }
        else sf = symlink_sf = fs::other_flag;
#     else
        sf = symlink_sf = 0;
#     endif
        return 0;
      }

#   endif
    } // namespace detail
  } // namespace filesystem
} // namespace boost