Class: TUnixPathNameParser

Declaration: FileSystemInterface.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TPathNameParser

Inherited By:

None.

Purpose:

This class provides an implementation for converting from UNIX-style pathnames to TPathName objects, and vice versa.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TUnixPathNameParser::PathNameToHostSpecific

virtual void PathNameToHostSpecific (const TPathName & anArray, THostSpecificPathName & path) const

Interface Category:

API.

Purpose:

Converts from a TPathName object to a UNIX-style pathname string (for example, /usr/include/sys/mode.h).

Calling Context:

Call this function directly.

Parameters:

const TPathName & anArray -The TPathName to be converted a host-specific syntax.
THostSpecificPathName & path -The object to receive the conversion result.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnixPathNameParser::HostSpecificToPathName

virtual void HostSpecificToPathName (const THostSpecificPathName & path, TPathName & anArray) const

Interface Category:

API.

Purpose:

Converts from a UNIX-style path (for example, /usr/include/sys/mode.h) to a TPathName object.

Calling Context:

Call this function directly.

Parameters:

const THostSpecificPathName & path -The host-specific pathname to be converted to a TPathName.
TPathName & anArray -The TPathName object to receive the conversion result.

Return Value:

None.

Exceptions:

Throws TFileSystemEntityNotAvailable for ill-formed paths (but not for well-formed paths specifying entities that do not exist; that is, the path must be well-formed but need not represent an existing on-disk entity).

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnixPathNameParser::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromwhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnixPathNameParser::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnixPathNameParser::operator=

TUnixPathNameParser & operator =(const TUnixPathNameParser & copyMe)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TUnixPathNameParser & copyMe -The pathname parser to copy from.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnixPathNameParser::~TUnixPathNameParser

virtual ~ TUnixPathNameParser ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUnixPathNameParser::TUnixPathNameParser

TUnixPathNameParser ()
TUnixPathNameParser (const TUnixPathNameParser & copyMe)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Call this function directly.
Called by the stream-in operators.
Called to copy an object.

Parameters:

Takes no parameters.
const TUnixPathNameParser & copyMe -The object to copy from.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.