path Class Reference

#include <path.hpp>

Inheritance diagram for path:

Collaboration diagram for path:

Public Types
typedef vmime::word	component
typedef std::vector< component >	list

Public Member Functions
	path ()
	path (const component &c)
	path (const path &p)
	path (const string &s)
path	operator/ (const path &p) const
path	operator/ (const component &c) const
path &	operator/= (const path &p)
path &	operator/= (const component &c)
path	getParent () const
path &	operator= (const path &p)
path &	operator= (const component &c)
bool	operator== (const path &p) const
bool	operator!= (const path &p) const
void	appendComponent (const component &c)
const component &	getComponentAt (const size_t pos) const
component &	getComponentAt (const size_t pos)
bool	isEmpty () const
bool	isRoot () const
const component	getLastComponent () const
component &	getLastComponent ()
size_t	getSize () const
const component &	operator[] (const size_t x) const
component &	operator[] (const size_t x)
bool	isDirectParentOf (const path &p) const
bool	isParentOf (const path &p) const
void	renameParent (const path &oldPath, const path &newPath)
const string	toString (const string &sep, const charset &cset) const

Static Public Member Functions
static path	fromString (const string &str, const string &sep, const charset &cset)

Additional Inherited Members
Protected Member Functions inherited from object
	object ()
	object (const object &)
object &	operator= (const object &)
virtual	~object ()

Detailed Description

Abstract representation of a path (filesystem, mailbox, etc).

Member Typedef Documentation

component

typedef vmime::word component

list

typedef std::vector<component> list

Constructor & Destructor Documentation

path() [1/4]

path

(

)

Referenced by maildirFolder::copyMessages(), maildirFolder::expunge(), and maildirFolder::setMessageFlags().

path() [2/4]

path

(

const component &

c

)

References vmime::dynamicCast().

path() [3/4]

path

(

const path &

p

)

References vmime::dynamicCast().

path() [4/4]

path ( const string &  s )

explicit

References vmime::dynamicCast().

Member Function Documentation

appendComponent()

void appendComponent

(

const component &

c

)

Append a component to the path.

Parameters

c	component to add

References vmime::dynamicCast().

Referenced by path::fromString().

fromString()

path fromString ( const string &  str, const string &  sep, const charset &  cset  )

static

Construct a new path from a string.

Parameters

str	string representation of the path
sep	separator string (eg: "/")
cset	charset in which the path is encoded (use the value returned by vmime::charset::getLocalCharset() to use the default charset of your system)

Returns

a new path corresponding to the specified string

References path::appendComponent(), vmime::dynamicCast(), and vmime::end().

getComponentAt() [1/2]

path::component & getComponentAt

(

const size_t

pos

)

Return the component at the specified position.

Parameters

pos

position

Returns

component at position 'pos'

References vmime::dynamicCast().

getComponentAt() [2/2]

const path::component & getComponentAt

(

const size_t

pos

)

const

Return the component at the specified position.

Parameters

pos

position

Returns

component at position 'pos'

References vmime::dynamicCast().

getLastComponent() [1/2]

path::component & getLastComponent

(

)

Return the last component of this path (non-const version).

Returns

last component

getLastComponent() [2/2]

const path::component getLastComponent

(

)

const

Return the last component of this path (const version).

Returns

last component

Referenced by courierMaildirFormat::isSubfolderDirectory(), kmailMaildirFormat::isSubfolderDirectory(), kmailMaildirFormat::listFoldersImpl(), IMAPFolder::rename(), and maildirFolder::rename().

getParent()

path getParent

(

)

const

References vmime::dynamicCast(), and path::isEmpty().

getSize()

size_t getSize

(

)

const

Return the number of components in this path.

Returns

number of components

Referenced by path::isDirectParentOf(), path::isParentOf(), and path::renameParent().

isDirectParentOf()

bool isDirectParentOf

(

const path &

p

)

const

Test whether this path is a direct parent of another one.

Parameters

p	other path

Returns

true if the specified path is a child of this path, false otherwise

References vmime::dynamicCast(), and path::getSize().

isEmpty()

bool isEmpty

(

)

const

Test whether this path is empty (root).

Returns

true if the path is empty (no components = root)

Referenced by path::getParent(), IMAPFolder::rename(), maildirFolder::rename(), and path::renameParent().

isParentOf()

bool isParentOf

(

const path &

p

)

const

Test whether this path is a parent of another one.

Parameters

p	other path

Returns

true if the specified path is a child (direct or indirect) of this path, false otherwise

References vmime::dynamicCast(), and path::getSize().

Referenced by IMAPFolder::rename(), and maildirFolder::rename().

isRoot()

bool isRoot

(

)

const

Test whether this path is the root (alias for isEmpty()).

Returns

true if the path is the root

operator!=()

bool operator!=

(

const path &

p

)

const

References vmime::dynamicCast().

operator/() [1/2]

path operator/

(

const component &

c

)

const

References vmime::dynamicCast().

operator/() [2/2]

path operator/

(

const path &

p

)

const

References vmime::dynamicCast().

operator/=() [1/2]

path & operator/=

(

const component &

c

)

References vmime::dynamicCast().

operator/=() [2/2]

path & operator/=

(

const path &

p

)

References vmime::dynamicCast().

operator=() [1/2]

path & operator=

(

const component &

c

)

References vmime::dynamicCast().

operator=() [2/2]

path & operator=

(

const path &

p

)

References vmime::dynamicCast().

operator==()

bool operator==

(

const path &

p

)

const

References vmime::dynamicCast().

operator[]() [1/2]

path::component & operator[]

(

const size_t

x

)

Return the specified component of the path (non-const version).

Parameters

x	index of the component

Returns

component at the specified index

References vmime::dynamicCast().

operator[]() [2/2]

const path::component & operator[]

(

const size_t

x

)

const

Return the specified component of the path (const version).

Parameters

x	index of the component

Returns

component at the specified index

References vmime::dynamicCast().

renameParent()

void renameParent	(	const path &	oldPath,
		const path &	newPath
	)

Rename a parent component in the path.

Example: path("a/b/c/d").renameParent("a/b", "x/y/z") will return path("x/y/z/c/d").

Parameters

oldPath	old parent path
newPath	new parent path

References vmime::dynamicCast(), path::getSize(), and path::isEmpty().

Referenced by courierMaildirFormat::renameFolder().

toString()

const string toString	(	const string &	sep,
		const charset &	cset
	)		const

Returns a string representation of this path.

Parameters

sep	separator string (eg: "/")
cset	charset in which to encode the components (use the value returned by vmime::charset::getLocalCharset() to use the default charset of your system)

Returns

a string representing this path

References vmime::dynamicCast().

---

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

• utility/path.hpp
• utility/path.cpp