platformstl Namespace Reference


Detailed Description

The platformstl namespace contains all components in the PlatformSTL project.

By default, the platformstl namespace is actually an alias for the namespace stlsoft::platformstl_project, which is where all the PlatformSTL components actually reside. This measure allows all components within the main the STLSoft project (which are defined within the stlsoft namespace) to be visible to all components "within" the platformstl namespace. (Otherwise, there would be a whole lot of onerous qualification throughout the code of all sub-projects.)

Note:
If either/both of the symbols _STLSOFT_NO_NAMESPACES and _PLATFORMSTL_NO_NAMESPACE are defined, all PlatformSTL components will be defined in the global namespace. Conversely, if the _STLSOFT_NO_NAMESPACE symbol (not to be confused with the _STLSOFT_NO_NAMESPACES symbol!) is defined - meaning that all main project components are to be defined in the global namespace, and _PLATFORMSTL_NO_NAMESPACE is not defined, then all PlatformSTL components will be defined within a bona fide platformstl namespace.

This is a vestige of compatibility with compilers with no (or no sensible) namespace support that is maintained for reasons of backwards compatiblity and because it is, in rare circumstances, a useful facility.


Classes

class  module
 Class for manipulating dynamically loaded libraries. More...
class  basic_error_desc
 Class used for composing and decomposing file-system paths. More...
class  basic_current_directory
 A facade for the platform's basic_current_directory functionality. More...
class  current_directory_scope
 A facade for the platform's current_directory_scope functionality. More...
class  basic_cwd_stack
 Acts as a stack for current working directory changes, setting the current working directory with push(), and resetting to its previous value with pop(). More...
class  basic_file_lines
 Maps a text file's contents and presents them as a vector of lines. More...
class  basic_file_path_buffer
 Class used for composing and decomposing file-system paths. More...
class  filesystem_traits
 Traits class for file-system operations. More...
class  memory_mapped_file
 A facade for the platform's memory mapped file API. More...
class  basic_path
 Class used for composing and decomposing file-system paths. More...
class  pipe
 A facade for the platform's pipe functionality. More...
class  readdir_sequence
 STL-like readonly sequence based on directory contents. More...
class  performance_counter
 A performance counter class. More...
class  processtimes_counter
 A performance counter class that measures kernel and user activity. More...
class  process_mutex
 A process mutex class. More...
class  semaphore
 A semaphore class. More...
class  spin_mutex
 A spin mutex class. More...
class  thread_mutex
 A thread mutex class. More...
class  tss_index
 A thread key class. More...
class  environment_map
 Provides an associative STL-collection interface to the current process's system environment. More...
struct  environment_variable_traits
 Abstraction of the platform-dependent environment variable handling. More...
class  system_traits
 Traits class for system operations. More...

Typedefs

typedef basic_error_desc< char > path_a
 Specialisation of the basic_error_desc template for the ANSI character type char.
typedef basic_error_desc< wchar_t > path_w
 Specialisation of the basic_error_desc template for the Unicode character type wchar_t.
typedef basic_error_desc< tchar > path
 Specialisation of the basic_error_desc template for the ANSI character type char on UNIX, and for the TCHAR type on Windows.
typedef basic_cwd_stack< char > cwd_stack_a
typedef basic_cwd_stack< wchar_t > cwd_stack_w
typedef basic_cwd_stack< char > cwd_stack
typedef basic_file_lines< char > file_lines_a
 Specialisation of the basic_file_lines template for the ANSI character type char.
typedef basic_file_lines< wchar_t > file_lines_w
 Specialisation of the basic_file_lines template for the Unicode character type wchar_t.
typedef file_lines_a file_lines
typedef file_lines_w wfile_lines
 Alias for platformstl::file_lines_w;.

Functions

template<typename S>
bool_t create_directory_recurse (S const &dir)
 Creates the given directory, and any intermediate directories that do not exist.
template<typename S>
bool_t remove_directory_recurse (S const &dir)
 Removes the given directory, and all its subdirectories.
template<typename C, typename V1, typename B1, typename V2, typename B2>
ss_typename_type_ret_k
basic_file_lines< C, V1, B1 >
::bool_type 
operator== (basic_file_lines< C, V1, B1 > const &lhs, basic_file_lines< C, V2, B2 > const &rhs)
template<typename C, typename V1, typename B1, typename V2, typename B2>
ss_typename_type_ret_k
basic_file_lines< C, V1, B1 >
::bool_type 
operator!= (basic_file_lines< C, V1, B1 > const &lhs, basic_file_lines< C, V2, B2 > const &rhs)
template<typename S, typename C>
stlsoft::size_t path_squeeze (S const &path, C *buffer, stlsoft::size_t cchBuffer)
stlsoft::bool operator== (platformstl_ns_qual(environment_map)::const_iterator const &lhs, platformstl_ns_qual(environment_map)::const_iterator const &rhs)
stlsoft::bool operator!= (platformstl_ns_qual(environment_map)::const_iterator const &lhs, platformstl_ns_qual(environment_map)::const_iterator const &rhs)


Typedef Documentation

typedef basic_path< tchar, filesystem_traits< tchar > > path

Specialisation of the basic_error_desc template for the ANSI character type char on UNIX, and for the TCHAR type on Windows.

Specialisation of the basic_path template for the ANSI character type char on UNIX, and for the TCHAR type on Windows.

Specialisation of the basic_file_path_buffer template for the ANSI character type char on UNIX, and for the TCHAR type on Windows.

typedef basic_path< char, filesystem_traits< char > > path_a

Specialisation of the basic_error_desc template for the ANSI character type char.

Specialisation of the basic_path template for the ANSI character type char.

Specialisation of the basic_file_path_buffer template for the ANSI character type char.

typedef basic_path< wchar_t, filesystem_traits< wchar_t > > path_w

Specialisation of the basic_error_desc template for the Unicode character type wchar_t.

Specialisation of the basic_path template for the Unicode character type wchar_t.

Specialisation of the basic_file_path_buffer template for the Unicode character type wchar_t.


Generated on Thu Jun 10 08:58:32 2010 for STLSoft by  doxygen 1.5.6