IlPathList Class Reference

The purpose of this class is to provide a way to order the search path of files. More...

#include <ilog/pathlist.h>

Public Member Functions
	IlPathList ()
	Initializes a new empty IlPathList object. More...
	IlPathList (const IlString &pathList)
	Initializes a new IlPathList object from a list of paths. More...
void	addInList (const IlPathName &path)
	Adds a path to the end of the list list. More...
void	addInList (const IlString &pathList)
	Adds a path list to the end of the list list. More...
void	addInList (const IlPathList &pathList)
	Adds a path list to the end of the list list. More...
void	addInPostList (const IlPathName &path)
	Adds a path to the end of the list postList. More...
void	addInPostList (const IlString &pathList)
	Adds a path list to the end of the list postList. More...
void	addInPostList (const IlPathList &pathList)
	Adds a path list to the end of the list postList. More...
void	addInPrevList (const IlPathName &path)
	Adds a path to the end of the list prevList. More...
void	addInPrevList (const IlString &pathList)
	Adds a path list to the end of the list prevList. More...
void	addInPrevList (const IlPathList &pathList)
	Adds a path list to the end of the list prevList. More...
IlBoolean	findInPath (const IlPathName &relative, IlPathName &result, IlBoolean verbose=IlFalse) const
	Searches for an existing file in the search path. More...
IlString	getListString () const
	Returns a representation of the list list. More...
IlString	getPostListString () const
	Returns a representation of the list postList. More...
IlString	getPrevListString () const
	Returns a representation of the list prevList. More...
IlString	getString () const
	Returns a representation of the entire search path. More...
void	insertInList (const IlPathName &path)
	Inserts a path at the beginning of the list list. More...
void	insertInList (const IlString &pathList)
	Inserts a path list at the beginning of the list list. More...
void	insertInList (const IlPathList &pathList)
	Inserts a path list at the beginning of the list list. More...
void	insertInPostList (const IlPathName &path)
	Inserts a path at the beginning of the list postList. More...
void	insertInPostList (const IlString &pathList)
	Inserts a path list at the beginning of the list postList. More...
void	insertInPostList (const IlPathList &pathList)
	Inserts a path list at the beginning of the list postList. More...
void	insertInPrevList (const IlPathName &path)
	Inserts a path at the beginning of the list prevList. More...
void	insertInPrevList (const IlString &pathList)
	Inserts a path list at the beginning of the list prevList. More...
void	insertInPrevList (const IlPathList &pathList)
	Inserts a path list at the beginning of the list prevList. More...
void	removeFromList (const IlPathName &path)
	Removes a path from the list list. More...
void	removeFromList (const IlString &pathList)
	Removes a list of paths from the list list. More...
void	removeFromPostList (const IlPathName &path)
	Removes a path from the list postList. More...
void	removeFromPostList (const IlString &pathList)
	Removes a list of paths from the list postList. More...
void	removeFromPrevList (const IlPathName &path)
	Removes a path from the list prevList. More...
void	removeFromPrevList (const IlString &pathList)
	Removes a list of paths from the list prevList. More...
void	setList (const IlPathName &path)
	Replaces the list list with a single path. More...
void	setList (const IlString &pathList)
	Replaces the list list with a path list. More...
void	setList (const IlPathList &pathList)
	Replaces the list list with a path list. More...
void	setPostList (const IlPathName &path)
	Replaces the list postList with a single path. More...
void	setPostList (const IlString &pathList)
	Replaces the list postList with a path list. More...
void	setPostList (const IlPathList &pathList)
	Replaces the list postList with a path list. More...
void	setPrevList (const IlPathName &path)
	Replaces the list prevList with a single path. More...
void	setPrevList (const IlString &pathList)
	Replaces the list prevList with a path list. More...
void	setPrevList (const IlPathList &pathList)
	Replaces the list prevList with a path list. More...
void	unique ()
	Removes the duplicated paths.

Detailed Description

The purpose of this class is to provide a way to order the search path of files.

Library: ilog

This class has three sub-lists of path names that we will call: prevList, list, and postList.
The search for a relative path name is done according to the order given above: the actual search path is the concatenation of prevList, list, and postList, in this order.
The search is stopped as soon as a file that matches is found.

See Also

IlPathName.

Constructor & Destructor Documentation

IlPathList::IlPathList

(

)

Initializes a new empty IlPathList object.

See Also

IlPathList(const IlString&).

IlPathList::IlPathList

(

const IlString &

pathList

)

Initializes a new IlPathList object from a list of paths.

The string defines a list of path name separated by a : on Unix and a ; on Windows. These path names are stored in list. The lists prevList and postList are empty.

Parameters

pathList

A list of paths to initialize this object.

See Also

IlPathList().

Member Function Documentation

void IlPathList::addInList

(

const IlPathName &

path

)

Adds a path to the end of the list list.

Parameters

path	The path that is added.

See Also

addInPrevList(const IlPathName&), addInList(const IlString&), addInList(const IlPathList&), addInPostList(const IlPathName&), insertInList(const IlPathName&), setList(const IlPathName&), removeFromList(const IlPathName&).

void IlPathList::addInList

(

const IlString &

pathList

)

Adds a path list to the end of the list list.

This string defines a list of path names separated by a : on Unix and a ; on Windows.

Parameters

pathList

The list of paths that are added.

See Also

addInPrevList(const IlString&), addInList(const IlPathName&), addInList(const IlPathList&), addInPostList(const IlString&), insertInList(const IlString&), setList(const IlString&), removeFromList(const IlString&).

void IlPathList::addInList

(

const IlPathList &

pathList

)

Adds a path list to the end of the list list.

Parameters

pathList

The list of paths that are added.

See Also

addInPrevList(const IlPathList&), addInList(const IlPathName&), addInList(const IlString&), addInPostList(const IlPathList&), insertInList(const IlPathList&), setList(const IlPathList&), removeFromList(const IlPathName&).

void IlPathList::addInPostList

(

const IlPathName &

path

)

Adds a path to the end of the list postList.

Parameters

path	The path that is added.

See Also

addInPrevList(const IlPathName&), addInList(const IlPathName&), addInPostList(const IlString&), addInPostList(const IlPathList&), insertInPostList(const IlPathName&), setPostList(const IlPathName&), removeFromPostList(const IlPathName&).

void IlPathList::addInPostList

(

const IlString &

pathList

)

Adds a path list to the end of the list postList.

This string defines a list of path names separated by a : on Unix and a ; on Windows.

Parameters

pathList

The list of paths that are added.

See Also

addInPostList(const IlPathName&), addInPostList(const IlPathList&), insertInPostList(const IlString&), setPostList(const IlString&), removeFromPostList(const IlString&).

void IlPathList::addInPostList

(

const IlPathList &

pathList

)

Adds a path list to the end of the list postList.

Parameters

pathList

The list of paths that are added.

See Also

addInPostList(const IlPathName&), addInPostList(const IlString&), insertInPostList(const IlPathList&), setPostList(const IlPathList&), removeFromPostList(const IlString&).

void IlPathList::addInPrevList

(

const IlPathName &

path

)

Adds a path to the end of the list prevList.

Parameters

path	The path that is added.

See Also

addInPrevList(const IlString&), addInPrevList(const IlPathList&), addInList(const IlPathName&), addInPostList(const IlPathName&), insertInPrevList(const IlPathName&), setPrevList(const IlPathName&), removeFromPrevList(const IlPathName&).

void IlPathList::addInPrevList

(

const IlString &

pathList

)

Adds a path list to the end of the list prevList.

This string defines a list of path names separated by a : on Unix and a ; on Windows.

Parameters

pathList

The list of paths that are added.

See Also

addInPrevList(const IlPathName&), addInPrevList(const IlPathList&), addInList(const IlString&), addInPostList(const IlString&), insertInPrevList(const IlString&), setPrevList(const IlString&), removeFromPrevList(const IlString&).

void IlPathList::addInPrevList

(

const IlPathList &

pathList

)

Adds a path list to the end of the list prevList.

Parameters

pathList

The list of paths that are added.

See Also

addInPrevList(const IlPathName&), addInPrevList(const IlString&), addInList(const IlPathList&), addInPostList(const IlPathList&), insertInPrevList(const IlPathList&), setPrevList(const IlPathList&), removeFromPrevList(const IlString&).

IlBoolean IlPathList::findInPath	(	const IlPathName &	relative,
		IlPathName &	result,
		IlBoolean	verbose = IlFalse
	)		const

Searches for an existing file in the search path.

The search is done by concatenating the path name relative to each path names of prevList, list, and postList (in this order). As soon as a file is found, this function return IlTrue and sets result to the corresponding value. If no file is found, this function returns IlFalse, and result is not modified.

Parameters

relative	A const reference to an IlPathName object.
result	A reference to an IlPathName object.
verbose	An IlBoolean. The default value is IlFalse. If set to IlTrue, messages that indicate what files are found where are sent to std::cout.

IlString IlPathList::getListString

(

)

const

Returns a representation of the list list.

The path names are separated by a : on Unix and a ; on Windows.

Returns

A representation of list.

See Also

getPrevListString(), getString(), getPostListString().

IlString IlPathList::getPostListString

(

)

const

Returns a representation of the list postList.

The path names are separated by a : on Unix and a ; on Windows.

Returns

A representation of postList.

See Also

getString(), getPrevListString(), getListString().

IlString IlPathList::getPrevListString

(

)

const

Returns a representation of the list prevList.

The path names are separated by a : on Unix and a ; on Windows.

Returns

A representation of prevList.

See Also

getString(), getListString(), getPostListString().

IlString IlPathList::getString

(

)

const

Returns a representation of the entire search path.

The string contains all the path names in the order defined by the lists, separated by a : on Unix and a ; on Windows.

Returns

A representation of the entire search path.

See Also

getPrevListString(), getListString(), getPostListString().

void IlPathList::insertInList

(

const IlPathName &

path

)

Inserts a path at the beginning of the list list.

Parameters

path	The path to be inserted.

See Also

addInList(const IlPathName&), insertInPrevList(const IlPathName&), insertInList(const IlString&), insertInList(const IlPathList&), insertInPostList(const IlPathName&), setList(const IlPathName&), removeFromList(const IlPathName&).

void IlPathList::insertInList

(

const IlString &

pathList

)

Inserts a path list at the beginning of the list list.

This string defines a list of path names separated by a : on Unix and a ; on Windows.

Parameters

pathList

The list of paths that are inserted.

See Also

addInList(const IlString&), insertInPrevList(const IlString&), insertInList(const IlPathName&), insertInList(const IlPathList&), insertInPostList(const IlString&), setList(const IlString&), removeFromList(const IlString&).

void IlPathList::insertInList

(

const IlPathList &

pathList

)

Inserts a path list at the beginning of the list list.

Parameters

pathList

The list of paths that are inserted.

See Also

addInList(const IlPathList&), insertInList(const IlPathName&), insertInList(const IlString&), setList(const IlPathList&), removeFromList(const IlString&).

void IlPathList::insertInPostList

(

const IlPathName &

path

)

Inserts a path at the beginning of the list postList.

Parameters

path	The path to be inserted.

See Also

addInPostList(const IlPathName&), insertInPrevList(const IlPathName&), insertInList(const IlPathName&), insertInPostList(const IlString&), insertInPostList(const IlPathList&), setPostList(const IlPathName&), removeFromPostList(const IlPathName&).

void IlPathList::insertInPostList

(

const IlString &

pathList

)

Inserts a path list at the beginning of the list postList.

This string defines a list of path names separated by a : on Unix and a ; on Windows.

Parameters

pathList

The list of paths that are inserted.

See Also

addInPostList(const IlString&), insertInPrevList(const IlString&), insertInList(const IlString&), insertInPostList(const IlPathName&), insertInPostList(const IlPathList&), setPostList(const IlString&), removeFromPostList(const IlString&).

void IlPathList::insertInPostList

(

const IlPathList &

pathList

)

Inserts a path list at the beginning of the list postList.

Parameters

pathList

The list of paths that are inserted.

See Also

addInPostList(const IlPathName&), insertInPrevList(const IlPathList&), insertInList(const IlPathList&), insertInPostList(const IlPathName&), insertInPostList(const IlString&), setPostList(const IlPathList&), removeFromPostList(const IlString&).

void IlPathList::insertInPrevList

(

const IlPathName &

path

)

Inserts a path at the beginning of the list prevList.

Parameters

path	The path to be inserted.

See Also

addInPrevList(const IlPathName&), insertInPrevList(const IlString&), insertInPrevList(const IlPathList&), insertInList(const IlPathName&), insertInPostList(const IlPathName&), setPrevList(const IlPathName&), removeFromPrevList(const IlPathName&).

void IlPathList::insertInPrevList

(

const IlString &

pathList

)

Inserts a path list at the beginning of the list prevList.

This string defines a list of path names separated by a : on Unix and a ; on Windows.

Parameters

pathList

The list of paths that are inserted.

See Also

addInPrevList(const IlString&), insertInPrevList(const IlPathName&), insertInPrevList(const IlPathList&), insertInList(const IlString&), insertInPostList(const IlString&), setPrevList(const IlString&), removeFromPrevList(const IlString&).

void IlPathList::insertInPrevList

(

const IlPathList &

pathList

)

Inserts a path list at the beginning of the list prevList.

Parameters

pathList

The list of paths that are inserted.

See Also

addInPrevList(const IlPathList&), insertInPrevList(const IlPathName&), insertInPrevList(const IlString&), insertInList(const IlPathList&), insertInPostList(const IlPathList&), setPrevList(const IlPathList&), removeFromPrevList(const IlString&).

void IlPathList::removeFromList

(

const IlPathName &

path

)

Removes a path from the list list.

Parameters

path	The path to be removed.

See Also

addInList(const IlPathName&), insertInList(const IlPathName&), setList(const IlPathName&), removeFromPrevList(const IlPathName&), removeFromList(const IlString&), removeFromPostList(const IlPathName&).

void IlPathList::removeFromList

(

const IlString &

pathList

)

Removes a list of paths from the list list.

This string defines a list of path names separated by a : on Unix and a ; on Windows.

Parameters

pathList

The list of paths to be removed.

See Also

addInList(const IlString&), insertInList(const IlString&), setPrevList(const IlString&), setList(const IlString&), removeFromPrevList(const IlString&), removeFromList(const IlPathName&), removeFromPostList(const IlString&).

void IlPathList::removeFromPostList

(

const IlPathName &

path

)

Removes a path from the list postList.

Parameters

path	The path to be removed.

See Also

addInPostList(const IlPathName&), insertInPostList(const IlPathName&), setPostList(const IlPathName&), removeFromPrevList(const IlPathName&), removeFromList(const IlPathName&), removeFromPostList(const IlString&).

void IlPathList::removeFromPostList

(

const IlString &

pathList

)

Removes a list of paths from the list postList.

This string defines a list of path names separated by a : on Unix and a ; on Windows.

Parameters

pathList

The list of paths to be removed.

See Also

addInPostList(const IlString&), insertInPostList(const IlString&), setPostList(const IlString&), removeFromPrevList(const IlString&), removeFromList(const IlString&), removeFromPostList(const IlPathName&).

void IlPathList::removeFromPrevList

(

const IlPathName &

path

)

Removes a path from the list prevList.

Parameters

path	The path to be removed.

See Also

addInPrevList(const IlPathName&), insertInPrevList(const IlPathName&), setPrevList(const IlPathName&), removeFromPrevList(const IlString&), removeFromList(const IlString&), removeFromPostList(const IlString&).

void IlPathList::removeFromPrevList

(

const IlString &

pathList

)

Removes a list of paths from the list prevList.

This string defines a list of path names separated by a : on Unix and a ; on Windows.

Parameters

pathList

The list of paths to be removed.

See Also

addInPrevList(const IlString&), insertInPrevList(const IlString&), setPrevList(const IlString&), removeFromPrevList(const IlPathName&), removeFromList(const IlString&), removeFromPostList(const IlString&).

void IlPathList::setList

(

const IlPathName &

path

)

Replaces the list list with a single path.

Parameters

path	The path that replaces the list path list.

See Also

addInList(const IlPathName&), insertInList(const IlPathName&), setPrevList(const IlPathName&), setList(const IlString&), setList(const IlPathList&), setPostList(const IlPathName&), removeFromList(const IlString&).

void IlPathList::setList

(

const IlString &

pathList

)

Replaces the list list with a path list.

This string defines a list of path names separated by a : on Unix and a ; on Windows.

Parameters

pathList

The list of paths that replaces the list path list.

See Also

addInList(const IlString&), insertInList(const IlString&), setPrevList(const IlString&), setList(const IlPathName&), setList(const IlPathList&), setPostList(const IlString&), removeFromList(const IlString&).

void IlPathList::setList

(

const IlPathList &

pathList

)

Replaces the list list with a path list.

Parameters

pathList

The list of paths that replaces the list path list.

See Also

addInList(const IlPathList&), insertInList(const IlPathList&), setPrevList(const IlPathList&), setList(const IlPathName&), setList(const IlString&), setPostList(const IlPathList&), removeFromList(const IlString&).

void IlPathList::setPostList

(

const IlPathName &

path

)

Replaces the list postList with a single path.

Parameters

path	The path that replaces the postList path list.

See Also

addInPostList(const IlPathName&), setPrevList(const IlPathName&), setList(const IlPathName&), setPostList(const IlString&), setPostList(const IlPathList&), removeFromPostList(const IlPathName&).

void IlPathList::setPostList

(

const IlString &

pathList

)

Replaces the list postList with a path list.

This string defines a list of path names separated by a : on Unix and a ; on Windows.

Parameters

pathList

The list of paths that replaces the postList path list.

See Also

addInPostList(const IlString&), insertInPostList(const IlString&), setPrevList(const IlString&), setList(const IlString&), setPostList(const IlPathName&), setPostList(const IlPathList&), removeFromPostList(const IlString&).

void IlPathList::setPostList

(

const IlPathList &

pathList

)

Replaces the list postList with a path list.

Parameters

pathList

The list of paths that replaces the postList path list.

See Also

addInPostList(const IlPathList&), insertInPostList(const IlPathList&), setPrevList(const IlPathList&), setList(const IlPathList&), setPostList(const IlPathName&), setPostList(const IlString&), removeFromPostList(const IlString&).

void IlPathList::setPrevList

(

const IlPathName &

path

)

Replaces the list prevList with a single path.

Parameters

path	The path that replaces the prevList path list.

See Also

addInPrevList(const IlPathName&), insertInPrevList(const IlPathName&), setPrevList(const IlString&), setPrevList(const IlPathList&), setList(const IlPathName&), setPostList(const IlPathName&), removeFromPrevList(const IlPathName&).

void IlPathList::setPrevList

(

const IlString &

pathList

)

Replaces the list prevList with a path list.

This string defines a list of path names separated by a : on Unix and a ; on Windows.

Parameters

pathList

The list of paths that replaces the prevList path list.

See Also

addInPrevList(const IlString&), insertInPrevList(const IlString&), setPrevList(const IlPathName&), setPrevList(const IlPathList&), setList(const IlString&), setPostList(const IlString&), removeFromPrevList(const IlString&).

void IlPathList::setPrevList

(

const IlPathList &

pathList

)

Replaces the list prevList with a path list.

Parameters

pathList

The list of paths that replaces the prevList path list.

See Also

addInPrevList(const IlPathList&), insertInPrevList(const IlPathList&), setPrevList(const IlPathName&), setPrevList(const IlString&), setList(const IlPathList&), setPostList(const IlPathList&), removeFromPrevList(const IlString&).