boost::filesystem::path Class Reference

#include <path.hpp>

Classes
class	iterator

Public Types
typedef char	value_type
typedef std::basic_string < value_type >	string_type
typedef std::codecvt< wchar_t, char, std::mbstate_t >	codecvt_type
typedef iterator	const_iterator

Public Member Functions
	path ()
	path (const path &p)
template<class Source >
	path (Source const &source, typename boost::enable_if< path_traits::is_pathable< typename boost::decay< Source >::type > >::type *=0)
	path (const value_type *s)
	path (value_type *s)
	path (const string_type &s)
	path (string_type &s)
template<class Source >
	path (Source const &source, const codecvt_type &cvt)
template<class InputIterator >
	path (InputIterator begin, InputIterator end)
template<class InputIterator >
	path (InputIterator begin, InputIterator end, const codecvt_type &cvt)
path &	operator= (const path &p)
template<class Source >
boost::enable_if < path_traits::is_pathable < typename boost::decay < Source >::type >, path & > ::type	operator= (Source const &source)
path &	operator= (const value_type *ptr)
path &	operator= (value_type *ptr)
path &	operator= (const string_type &s)
path &	operator= (string_type &s)
path &	assign (const value_type *ptr, const codecvt_type &)
template<class Source >
path &	assign (Source const &source, const codecvt_type &cvt)
template<class InputIterator >
path &	assign (InputIterator begin, InputIterator end)
template<class InputIterator >
path &	assign (InputIterator begin, InputIterator end, const codecvt_type &cvt)
template<class Source >
boost::enable_if < path_traits::is_pathable < typename boost::decay < Source >::type >, path & > ::type	operator+= (Source const &source)
path &	operator+= (const path &p)
path &	operator+= (const value_type *ptr)
path &	operator+= (value_type *ptr)
path &	operator+= (const string_type &s)
path &	operator+= (string_type &s)
path &	operator+= (value_type c)
template<class CharT >
boost::enable_if< is_integral < CharT >, path & >::type	operator+= (CharT c)
template<class Source >
path &	concat (Source const &source)
template<class Source >
path &	concat (Source const &source, const codecvt_type &cvt)
template<class InputIterator >
path &	concat (InputIterator begin, InputIterator end)
template<class InputIterator >
path &	concat (InputIterator begin, InputIterator end, const codecvt_type &cvt)
path &	operator/= (const path &p)
template<class Source >
boost::enable_if < path_traits::is_pathable < typename boost::decay < Source >::type >, path & > ::type	operator/= (Source const &source)
path &	operator/= (const value_type *ptr)
path &	operator/= (value_type *ptr)
path &	operator/= (const string_type &s)
path &	operator/= (string_type &s)
path &	append (const value_type *ptr)
path &	append (const value_type *ptr, const codecvt_type &)
template<class Source >
path &	append (Source const &source)
template<class Source >
path &	append (Source const &source, const codecvt_type &cvt)
template<class InputIterator >
path &	append (InputIterator begin, InputIterator end)
template<class InputIterator >
path &	append (InputIterator begin, InputIterator end, const codecvt_type &cvt)
void	clear ()
path &	make_preferred ()
path &	remove_filename ()
path &	replace_extension (const path &new_extension=path())
void	swap (path &rhs)
const string_type &	native () const
const value_type *	c_str () const
template<class String >
String	string () const
template<class String >
String	string (const codecvt_type &cvt) const
const std::string &	string () const
const std::string &	string (const codecvt_type &) const
const std::wstring	wstring () const
const std::wstring	wstring (const codecvt_type &cvt) const
template<class String >
String	generic_string () const
template<class String >
String	generic_string (const codecvt_type &cvt) const
const std::string &	generic_string () const
const std::string &	generic_string (const codecvt_type &) const
const std::wstring	generic_wstring () const
const std::wstring	generic_wstring (const codecvt_type &cvt) const
int	compare (const path &p) const BOOST_NOEXCEPT
int	compare (const std::string &s) const
int	compare (const value_type *s) const
path	root_path () const
path	root_name () const
path	root_directory () const
path	relative_path () const
path	parent_path () const
path	filename () const
path	stem () const
path	extension () const
bool	empty () const
bool	has_root_path () const
bool	has_root_name () const
bool	has_root_directory () const
bool	has_relative_path () const
bool	has_parent_path () const
bool	has_filename () const
bool	has_stem () const
bool	has_extension () const
bool	is_absolute () const
bool	is_relative () const
iterator	begin () const
iterator	end () const
path &	normalize ()
path &	remove_leaf ()
path	leaf () const
path	branch_path () const
bool	has_leaf () const
bool	has_branch_path () const
bool	is_complete () const

Static Public Member Functions
static std::locale	imbue (const std::locale &loc)
static const codecvt_type &	codecvt ()

Public Attributes
BOOST_STATIC_CONSTEXPR value_type	preferred_separator = '/'

Friends
class	iterator
bool	operator< (const path &lhs, const path &rhs)

Member Typedef Documentation

typedef std::codecvt<wchar_t, char, std::mbstate_t> boost::filesystem::path::codecvt_type

typedef iterator boost::filesystem::path::const_iterator

typedef std::basic_string<value_type> boost::filesystem::path::string_type

typedef char boost::filesystem::path::value_type

Constructor & Destructor Documentation

boost::filesystem::path::path ( )

inline

boost::filesystem::path::path ( const path &  p )

inline

template<class Source >

boost::filesystem::path::path ( Source const &  source, typename boost::enable_if< path_traits::is_pathable< typename boost::decay< Source >::type > >::type *  = 0  )

inline

References boost::filesystem::path_traits::dispatch().

boost::filesystem::path::path ( const value_type *  s )

inline

boost::filesystem::path::path ( value_type *  s )

inline

boost::filesystem::path::path ( const string_type &  s )

inline

boost::filesystem::path::path ( string_type &  s )

inline

template<class Source >

boost::filesystem::path::path ( Source const &  source, const codecvt_type &  cvt  )

inline

References boost::filesystem::path_traits::dispatch().

template<class InputIterator >

boost::filesystem::path::path ( InputIterator  begin, InputIterator  end  )

inline

References boost::filesystem::path_traits::convert(), and boost::asio::s.

template<class InputIterator >

boost::filesystem::path::path ( InputIterator  begin, InputIterator  end, const codecvt_type &  cvt  )

inline

References boost::filesystem::path_traits::convert(), and boost::asio::s.

Member Function Documentation

path& boost::filesystem::path::append ( const value_type *  ptr )

inline

References boost::proto::exprns_::operator/=().

path& boost::filesystem::path::append ( const value_type *  ptr, const codecvt_type &    )

inline

References boost::proto::exprns_::operator/=().

template<class Source >

path & boost::filesystem::path::append

(

Source const &

source

)

References boost::filesystem::path_traits::dispatch(), and boost::filesystem::path_traits::empty().

template<class Source >

path & boost::filesystem::path::append	(	Source const &	source,
		const codecvt_type &	cvt
	)

References boost::filesystem::path_traits::dispatch(), and boost::filesystem::path_traits::empty().

template<class InputIterator >

path & boost::filesystem::path::append	(	InputIterator	begin,
		InputIterator	end
	)

References boost::filesystem::path_traits::convert(), and boost::asio::s.

template<class InputIterator >

path & boost::filesystem::path::append	(	InputIterator	begin,
		InputIterator	end,
		const codecvt_type &	cvt
	)

References boost::filesystem::path_traits::convert(), and boost::asio::s.

path& boost::filesystem::path::assign ( const value_type *  ptr, const codecvt_type &    )

inline

References boost::python::ptr().

template<class Source >

path& boost::filesystem::path::assign ( Source const &  source, const codecvt_type &  cvt  )

inline

References clear(), and boost::filesystem::path_traits::dispatch().

template<class InputIterator >

path& boost::filesystem::path::assign ( InputIterator  begin, InputIterator  end  )

inline

References clear(), boost::filesystem::path_traits::convert(), and boost::asio::s.

template<class InputIterator >

path& boost::filesystem::path::assign ( InputIterator  begin, InputIterator  end, const codecvt_type &  cvt  )

inline

References clear(), boost::filesystem::path_traits::convert(), and boost::asio::s.

iterator boost::filesystem::path::begin

(

)

const

Referenced by boost::wave::util::as_relative_to().

path boost::filesystem::path::branch_path ( ) const

inline

Referenced by boost::wave::util::branch_path().

const value_type* boost::filesystem::path::c_str ( ) const

inline

Referenced by boost::filesystem::hash_value().

void boost::filesystem::path::clear ( )

inline

Referenced by assign(), and boost::wave::util::include_paths::set_current_directory().

static const codecvt_type& boost::filesystem::path::codecvt ( )

static

Referenced by boost::filesystem::path_traits::convert().

int boost::filesystem::path::compare

(

const path &

p

)

const

Referenced by boost::filesystem::operator!=(), boost::filesystem::operator<(), and boost::filesystem::operator==().

int boost::filesystem::path::compare ( const std::string &  s ) const

inline

References compare().

Referenced by compare().

int boost::filesystem::path::compare ( const value_type *  s ) const

inline

References compare().

Referenced by compare().

template<class Source >

path& boost::filesystem::path::concat ( Source const &  source )

inline

References boost::filesystem::path_traits::dispatch().

template<class Source >

path& boost::filesystem::path::concat ( Source const &  source, const codecvt_type &  cvt  )

inline

References boost::filesystem::path_traits::dispatch().

template<class InputIterator >

path& boost::filesystem::path::concat ( InputIterator  begin, InputIterator  end  )

inline

References boost::filesystem::path_traits::convert(), and boost::asio::s.

template<class InputIterator >

path& boost::filesystem::path::concat ( InputIterator  begin, InputIterator  end, const codecvt_type &  cvt  )

inline

References boost::filesystem::path_traits::convert(), and boost::asio::s.

bool boost::filesystem::path::empty ( ) const

inline

iterator boost::filesystem::path::end

(

)

const

Referenced by boost::wave::util::as_relative_to().

path boost::filesystem::path::extension

(

)

const

Referenced by boost::filesystem::extension().

path boost::filesystem::path::filename

(

)

const

template<class String >

String boost::filesystem::path::generic_string

(

)

const

Referenced by boost::filesystem::path::generic_string< std::string >().

template<class String >

String boost::filesystem::path::generic_string

(

const codecvt_type &

cvt

)

const

const std::string& boost::filesystem::path::generic_string ( ) const

inline

const std::string& boost::filesystem::path::generic_string ( const codecvt_type &  ) const

inline

const std::wstring boost::filesystem::path::generic_wstring ( ) const

inline

Referenced by boost::filesystem::path::generic_string< std::wstring >().

const std::wstring boost::filesystem::path::generic_wstring ( const codecvt_type &  cvt ) const

inline

bool boost::filesystem::path::has_branch_path ( ) const

inline

bool boost::filesystem::path::has_extension ( ) const

inline

References boost::filesystem::extension().

bool boost::filesystem::path::has_filename ( ) const

inline

bool boost::filesystem::path::has_leaf ( ) const

inline

bool boost::filesystem::path::has_parent_path ( ) const

inline

bool boost::filesystem::path::has_relative_path ( ) const

inline

bool boost::filesystem::path::has_root_directory ( ) const

inline

bool boost::filesystem::path::has_root_name ( ) const

inline

bool boost::filesystem::path::has_root_path ( ) const

inline

Referenced by boost::wave::util::as_relative_to().

bool boost::filesystem::path::has_stem ( ) const

inline

static std::locale boost::filesystem::path::imbue ( const std::locale &  loc )

static

bool boost::filesystem::path::is_absolute ( ) const

inline

bool boost::filesystem::path::is_complete ( ) const

inline

bool boost::filesystem::path::is_relative ( ) const

inline

path boost::filesystem::path::leaf ( ) const

inline

Referenced by boost::wave::util::leaf().

path& boost::filesystem::path::make_preferred

(

)

const string_type& boost::filesystem::path::native ( ) const

inline

Referenced by boost::filesystem::hash_value().

path& boost::filesystem::path::normalize ( )

inline

Referenced by boost::wave::util::normalize().

template<class Source >

boost::enable_if<path_traits::is_pathable< typename boost::decay<Source>::type>, path&>::type boost::filesystem::path::operator+= ( Source const &  source )

inline

path& boost::filesystem::path::operator+= ( const path &  p )

inline

path& boost::filesystem::path::operator+= ( const value_type *  ptr )

inline

References boost::python::ptr().

path& boost::filesystem::path::operator+= ( value_type *  ptr )

inline

References boost::python::ptr().

path& boost::filesystem::path::operator+= ( const string_type &  s )

inline

References boost::asio::s.

path& boost::filesystem::path::operator+= ( string_type &  s )

inline

References boost::asio::s.

path& boost::filesystem::path::operator+= ( value_type  c )

inline

References boost::multiprecision::backends::c.

template<class CharT >

boost::enable_if<is_integral<CharT>, path&>::type boost::filesystem::path::operator+= ( CharT  c )

inline

References boost::multiprecision::backends::c.

path& boost::filesystem::path::operator/=

(

const path &

p

)

template<class Source >

boost::enable_if<path_traits::is_pathable< typename boost::decay<Source>::type>, path&>::type boost::filesystem::path::operator/= ( Source const &  source )

inline

References boost::spirit::type_of::append.

path& boost::filesystem::path::operator/=

(

const value_type *

ptr

)

path& boost::filesystem::path::operator/= ( value_type *  ptr )

inline

References boost::proto::exprns_::operator/=().

path& boost::filesystem::path::operator/= ( const string_type &  s )

inline

References operator/=().

Referenced by operator/=().

path& boost::filesystem::path::operator/= ( string_type &  s )

inline

References operator/=().

Referenced by operator/=().

path& boost::filesystem::path::operator= ( const path &  p )

inline

template<class Source >

boost::enable_if<path_traits::is_pathable< typename boost::decay<Source>::type>, path&>::type boost::filesystem::path::operator= ( Source const &  source )

inline

References boost::filesystem::path_traits::dispatch().

path& boost::filesystem::path::operator= ( const value_type *  ptr )

inline

References boost::python::ptr().

path& boost::filesystem::path::operator= ( value_type *  ptr )

inline

References boost::python::ptr().

path& boost::filesystem::path::operator= ( const string_type &  s )

inline

References boost::asio::s.

path& boost::filesystem::path::operator= ( string_type &  s )

inline

References boost::asio::s.

path boost::filesystem::path::parent_path

(

)

const

path boost::filesystem::path::relative_path

(

)

const

Referenced by boost::wave::util::as_relative_to().

path& boost::filesystem::path::remove_filename

(

)

path& boost::filesystem::path::remove_leaf ( )

inline

path& boost::filesystem::path::replace_extension

(

const path &

new_extension = path()

)

Referenced by boost::filesystem::change_extension().

path boost::filesystem::path::root_directory

(

)

const

path boost::filesystem::path::root_name

(

)

const

path boost::filesystem::path::root_path

(

)

const

Referenced by boost::wave::util::as_relative_to().

path boost::filesystem::path::stem

(

)

const

Referenced by boost::filesystem::basename().

template<class String >

String boost::filesystem::path::string

(

)

const

Referenced by boost::filesystem::basename(), boost::wave::context< IteratorT, LexIteratorT, InputPolicyT, HooksT, DerivedT >::begin(), boost::wave::util::create_directories(), boost::filesystem::extension(), boost::wave::util::include_paths::find_include_file(), boost::wave::context< IteratorT, LexIteratorT, InputPolicyT, HooksT, DerivedT >::init_context(), boost::wave::util::leaf(), and boost::wave::util::native_file_string().

template<class String >

String boost::filesystem::path::string

(

const codecvt_type &

cvt

)

const

const std::string& boost::filesystem::path::string ( ) const

inline

const std::string& boost::filesystem::path::string ( const codecvt_type &  ) const

inline

void boost::filesystem::path::swap ( path &  rhs )

inline

Referenced by boost::filesystem::swap().

const std::wstring boost::filesystem::path::wstring ( ) const

inline

References boost::filesystem::path_traits::convert().

const std::wstring boost::filesystem::path::wstring ( const codecvt_type &  cvt ) const

inline

References boost::filesystem::path_traits::convert().

Friends And Related Function Documentation

friend class iterator

friend

bool operator< ( const path &  lhs, const path &  rhs  )

friend

Member Data Documentation

BOOST_STATIC_CONSTEXPR value_type boost::filesystem::path::preferred_separator = '/'

---

The documentation for this class was generated from the following file:

• boost_1_57_0/boost/filesystem/path.hpp