unixstl/unixstl.h File Reference

---

Detailed Description

[C, C++] The root header for the UNIXSTL project.

#include <stlsoft/stlsoft.h>

Go to the source code of this file.

Namespaces
namespace	unixstl
Defines
#define	UNIXSTL_INCL_H_UNIXSTL
#define	_UNIXSTL_VER_MAJOR   1
	The major version number of UNIXSTL.
#define	_UNIXSTL_VER_MINOR   7
	The minor version number of UNIXSTL.
#define	_UNIXSTL_VER_REVISION   3
	The revision version number of UNIXSTL.
#define	_UNIXSTL_VER   _UNIXSTL_VER_1_7_3
	The current composite version number of UNIXSTL.
#define	UNIXSTL_ARCH_IS_UNKNOWN
#define	UNIXSTL_OS_IS_UNKNOWN
#define	UNIXSTL_ASSERT(expr)   STLSOFT_ASSERT(expr)
	Defines a runtime assertion.
#define	UNIXSTL_MESSAGE_ASSERT(msg, expr)   STLSOFT_MESSAGE_ASSERT(msg, expr)
	Defines a runtime assertion, with message.
#define	UNIXSTL_STATIC_ASSERT(expr)   STLSOFT_STATIC_ASSERT(expr)
	Defines a compile-time assertion.
#define	unixstl_ns_qual(x)   ::unixstl::x
	Qualifies with unixstl:: if UNIXSTL is using namespaces or, if not, does not qualify.
#define	unixstl_ns_using(x)   using ::unixstl::x;
	Declares a using directive (with respect to unixstl) if UNIXSTL is using namespaces or, if not, does nothing.
#define	unixstl_ns_qual_std(x)   ::std::x
	Qualifies with std:: if UNIXSTL is being translated in the context of the standard library being within the std namespace or, if not, does not qualify.
#define	unixstl_ns_using_std(x)   using ::std::x;
	Declares a using directive (with respect to std) if UNIXSTL is being translated in the context of the standard library being within the std namespace or, if not, does nothing.
#define	unixstl_destroy_instance(t, _type, p)   STLSOFT_DESTROY_INSTANCE(t, _type, p)
	[DEPRECATED] Destroys the given instance p of the given type (t and _type)
#define	unixstl_gen_opaque(_htype)   STLSOFT_GEN_OPAQUE(_htype)
	[DEPRECATED] Generates an opaque type with the name _htype
Typedefs
typedef char	char_a_t
typedef wchar_t	char_w_t
typedef us_sint8_t	sint8_t
typedef us_uint8_t	uint8_t
typedef us_int16_t	int16_t
typedef us_sint16_t	sint16_t
typedef us_uint16_t	uint16_t
typedef us_int32_t	int32_t
typedef us_sint32_t	sint32_t
typedef us_uint32_t	uint32_t
typedef int	int_t
typedef us_sint_t	sint_t
typedef us_uint_t	uint_t
typedef us_long_t	long_t
typedef bool	bool_t
typedef us_streampos_t	streampos_t
typedef us_streamoff_t	streamoff_t

---

Define Documentation

#define _UNIXSTL_VER   _UNIXSTL_VER_1_7_3

The current composite version number of UNIXSTL.

#define _UNIXSTL_VER_MAJOR   1

The major version number of UNIXSTL.

#define _UNIXSTL_VER_MINOR   7

The minor version number of UNIXSTL.

#define _UNIXSTL_VER_REVISION   3

The revision version number of UNIXSTL.

#define UNIXSTL_ASSERT

(

expr

)

STLSOFT_ASSERT(expr)

Defines a runtime assertion.

Parameters:

expr

Must be non-zero, or an assertion will be fired

Referenced by glob_sequence::glob_sequence(), spin_mutex_base::lock(), semaphore::lock(), process_mutex::process_mutex(), semaphore::semaphore(), memory_mapped_file::swap(), thread_mutex::thread_mutex(), semaphore::try_lock(), spin_mutex_base::unlock(), semaphore::unlock(), unix_exception::what(), memory_mapped_file::~memory_mapped_file(), and spin_mutex_base::~spin_mutex_base().

#define unixstl_destroy_instance	(	t,
		_type,
		p		)	STLSOFT_DESTROY_INSTANCE(t, _type, p)

[DEPRECATED] Destroys the given instance p of the given type (t and _type)

Deprecated:

This is heavily deprecated in favour of STLSOFT_DESTROY_INSTANCE().

#define unixstl_gen_opaque

(

_htype

)

STLSOFT_GEN_OPAQUE(_htype)

[DEPRECATED] Generates an opaque type with the name _htype

Deprecated:

This is heavily deprecated in favour of STLSOFT_GEN_OPAQUE().

#define UNIXSTL_MESSAGE_ASSERT	(	msg,
		expr		)	STLSOFT_MESSAGE_ASSERT(msg, expr)

Defines a runtime assertion, with message.

Parameters:

	expr	Must be non-zero, or an assertion will be fired
	msg	The literal character string message to be included in the assertion

Referenced by spin_mutex_base::lock(), and basic_file_path_buffer< C >::operator[]().

#define unixstl_ns_qual

(

x

)

::unixstl::x

Qualifies with unixstl:: if UNIXSTL is using namespaces or, if not, does not qualify.

#define unixstl_ns_qual_std

(

x

)

::std::x

Qualifies with std:: if UNIXSTL is being translated in the context of the standard library being within the std namespace or, if not, does not qualify.

#define unixstl_ns_using

(

x

)

using ::unixstl::x;

Declares a using directive (with respect to unixstl) if UNIXSTL is using namespaces or, if not, does nothing.

#define unixstl_ns_using_std

(

x

)

using ::std::x;

Declares a using directive (with respect to std) if UNIXSTL is being translated in the context of the standard library being within the std namespace or, if not, does nothing.

#define UNIXSTL_STATIC_ASSERT

(

expr

)

STLSOFT_STATIC_ASSERT(expr)

Defines a compile-time assertion.

Parameters:

expr

Must be non-zero, or compilation will fail