From 33487a8aeb5fa21365880dc41bbf7e2fc838e012 Mon Sep 17 00:00:00 2001 From: Beman Dawes Date: Mon, 13 Oct 2008 14:30:47 +0000 Subject: [PATCH] Filesystem: add macros and deprecated names sections to docs [SVN r49316] --- doc/index.htm | 211 +++++++++++++++++++++++++++++- doc/reference.html | 6 +- include/boost/filesystem/path.hpp | 8 +- 3 files changed, 218 insertions(+), 7 deletions(-) diff --git a/doc/index.htm b/doc/index.htm index 1e41605..4c9846e 100644 --- a/doc/index.htm +++ b/doc/index.htm @@ -44,6 +44,8 @@ Using the Reference Documentation
Example programs
Implementation
+ Macros
+ Deprecated names and features
Using only narrow character paths
Building the object-library
    Notes for Cygwin users
@@ -309,6 +311,211 @@ either the POSIX or Windows API.

The library is in regular use on Apple OS X, HP-UX, IBM AIX, Linux, Microsoft Windows, SGI IRIX, and Sun Solaris operating systems using a variety of compilers.

+

Macros

+

Users may defined the following macros if desired. Sensible defaults are +provided, so users can ignore these macros unless they have special needs.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Macro NameDefaultEffect if defined
BOOST_WINDOWS_APIDefined if Windows is detected by Boost.System's automatic configuration + code, otherwise not defined.Implementation uses the Microsoft Windows native + application program interface (API).
BOOST_POSIX_APIDefined if Windows is not detected by Boost.System's automatic configuration + code.Implementation uses the POSIX native + application program interface (API).
BOOST_FILESYSTEM_DYN_LINKDefined if BOOST_ALL_DYN_LINK is defined, + otherwise not defined.Boost.System library is dynamically linked. If not defined, + static linking is assumed.
BOOST_FILESYSTEM_NO_LIBDefined if BOOST_ALL_NO_LIB is defined, + otherwise not defined.Boost.System library does not use the Boost auto-link + facility.
BOOST_FILESYSTEM_NARROW_ONLYNot defined.Removes features that require wchar_t support.
BOOST_FILESYSTEM_NO_DEPRECATEDNot defined.Deprecated features are excluded.
+

Deprecated names and features

+

As the library evolves over time, names sometimes +change or features are removed. To ease transition, Boost.Filesystem deprecates +the old names and features, but continues to provide them unless macro +BOOST_FILESYSTEM_NO_DEPRECATED is defined.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Component +

Old name, now deprecated

 +

New name

basic_pathleaf()filename()
basic_pathbranch_path()parent_path()
basic_pathhas_leaf()has_filename()
basic_pathhas_branch_path()has_parent_path()
+ basic_path +

remove_leaf()

 +

remove_filename()

+ basic_path + basic_path( const string_type & str,
+  name_check )		 + feature removed
+ basic_path + basic_path( const string_type::value_type * s,
+  name_check )		 + feature removed
+ basic_path + native_file_string() + file_string()
+ basic_path + native_directory_string() + directory_string()
+ basic_path + default_name_check_writable() + feature removed
+ basic_path + default_name_check( name_check ) + feature removed
+ basic_path + default_name_check() + feature removed
+ basic_path + canonize() + feature removed
+ basic_path + normalize() + feature removed
+ operations.hpp + is_regular( file_status f ) + is_regular_file( file_status f )
+ operations.hpp + symbolic_link_exists( const path & ph ) + feature removed
+ basic_directory_status + filename() + feature removed, use path().filename() instead
+ basic_directory_status + leaf() + feature removed, use path().filename() instead
+ basic_directory_status + string() + feature removed, use path().string() instead

Restricting library to narrow character paths

Compilers or standard libraries which do not support wide characters (wchar_t) or wide character strings (std::wstring) are detected automatically, and cause @@ -553,7 +760,7 @@ performance issues.

Revised -18 March, 2008

+13 October, 2008

© Copyright Beman Dawes, 2002-2005

Use, modification, and distribution are subject to the Boost Software @@ -562,4 +769,4 @@ www.boost.org/LICENSE_1_0.txt

- + \ No newline at end of file diff --git a/doc/reference.html b/doc/reference.html index e33192c..05ce462 100644 --- a/doc/reference.html +++ b/doc/reference.html @@ -129,6 +129,10 @@ +

Some functions have been renamed or deprecated since earlier releases of +the library. See Deprecated names and +features.

+

Introduction

Some library behavior is specified by reference to ISO/IEC 9945:2003, POSIX. How such behavior is actually implemented is unspecified.

@@ -3072,7 +3076,7 @@ final document.

Distributed under the Boost Software License, Version 1.0. See www.boost.org/LICENSE_1_0.txt

Revised -06 July 2008

+13 October 2008

diff --git a/include/boost/filesystem/path.hpp b/include/boost/filesystem/path.hpp index c5762a5..302a02f 100644 --- a/include/boost/filesystem/path.hpp +++ b/include/boost/filesystem/path.hpp @@ -227,10 +227,10 @@ namespace boost string_type extension() const; # ifndef BOOST_FILESYSTEM_NO_DEPRECATED - string_type leaf() const { return filename(); } - basic_path branch_path() const { return parent_path(); } - bool has_leaf() const { return !m_path.empty(); } - bool has_branch_path() const { return !parent_path().empty(); } + string_type leaf() const { return filename(); } + basic_path branch_path() const { return parent_path(); } + bool has_leaf() const { return !m_path.empty(); } + bool has_branch_path() const { return !parent_path().empty(); } # endif bool empty() const { return m_path.empty(); } // name consistent with std containers