mir Namespace Reference

Namespaces
	client
	Convenient C++ wrappers around the Mir toolkit API.
	detail
	events
	frontend
	geometry
	Basic geometry types. Types for dimensions, displacements, etc. and the operations that they support.
	graphics
	scene
	shell

Classes
class	AbnormalExit
class	AnonymousShmFile
class	FatalErrorStrategy
class	Fd
struct	IntOwnedFd
class	IntWrapper
class	optional_value
class	ShmFile

Typedefs
typedef std::unique_ptr< MirEvent, void(*)(MirEvent *)>	EventUPtr

Functions
void	fatal_error_except (char const *reason,...)
	Throws an exception that will typically kill the Mir server and propagate from mir::run_mir. More...
void	fatal_error_abort (char const *reason,...)
	An alternative to fatal_error_except() that kills the program and dump core as cleanly as possible. More...
template<typename Tag , typename ValueType >
std::ostream &	operator<< (std::ostream &out, IntWrapper< Tag, ValueType > const &value)
template<typename Tag , typename ValueType >
constexpr bool	operator== (IntWrapper< Tag, ValueType > const &lhs, IntWrapper< Tag, ValueType > const &rhs)
template<typename Tag , typename ValueType >
constexpr bool	operator!= (IntWrapper< Tag, ValueType > const &lhs, IntWrapper< Tag, ValueType > const &rhs)
template<typename Tag , typename ValueType >
constexpr bool	operator<= (IntWrapper< Tag, ValueType > const &lhs, IntWrapper< Tag, ValueType > const &rhs)
template<typename Tag , typename ValueType >
constexpr bool	operator>= (IntWrapper< Tag, ValueType > const &lhs, IntWrapper< Tag, ValueType > const &rhs)
template<typename Tag , typename ValueType >
constexpr bool	operator< (IntWrapper< Tag, ValueType > const &lhs, IntWrapper< Tag, ValueType > const &rhs)
template<typename T >
bool	operator== (optional_value< T > const &lhs, optional_value< T > const &rhs)
template<typename T >
bool	operator!= (optional_value< T > const &lhs, optional_value< T > const &rhs)
template<typename T >
bool	operator== (optional_value< T > const &lhs, T const &rhs)
template<typename T >
bool	operator!= (optional_value< T > const &lhs, T const &rhs)
template<typename T >
bool	operator== (T const &lhs, optional_value< T > const &rhs)
template<typename T >
bool	operator!= (T const &lhs, optional_value< T > const &rhs)
std::ostream &	operator<< (std::ostream &out, MirInputEventModifier modifier)
std::ostream &	operator<< (std::ostream &out, MirKeyboardAction action)
std::ostream &	operator<< (std::ostream &out, MirTouchAction action)
std::ostream &	operator<< (std::ostream &out, MirTouchTooltype tool)
std::ostream &	operator<< (std::ostream &out, MirPointerAction action)
std::ostream &	operator<< (std::ostream &out, MirPromptSessionState state)
std::ostream &	operator<< (std::ostream &out, MirOrientation orientation)
std::ostream &	operator<< (std::ostream &out, MirSurfaceAttrib attribute) MIR_FOR_REMOVAL_IN_VERSION_1("use << with MirWindowAttrib instead")
std::ostream &	operator<< (std::ostream &out, MirWindowAttrib attribute)
std::ostream &	operator<< (std::ostream &out, MirSurfaceFocusState state) MIR_FOR_REMOVAL_IN_VERSION_1("use << with MirWindowFocusState instead")
std::ostream &	operator<< (std::ostream &out, MirWindowFocusState state)
std::ostream &	operator<< (std::ostream &out, MirSurfaceVisibility state) MIR_FOR_REMOVAL_IN_VERSION_1("use << with MirWindowVisibility instead")
std::ostream &	operator<< (std::ostream &out, MirWindowVisibility state)
std::ostream &	operator<< (std::ostream &out, MirSurfaceType type) MIR_FOR_REMOVAL_IN_VERSION_1("use << with MirWindowType instead")
std::ostream &	operator<< (std::ostream &out, MirWindowType type)
std::ostream &	operator<< (std::ostream &out, MirSurfaceState state) MIR_FOR_REMOVAL_IN_VERSION_1("use << with MirWindowState instead")
std::ostream &	operator<< (std::ostream &out, MirWindowState state)
std::ostream &	operator<< (std::ostream &out, MirPromptSessionEvent const &event)
std::ostream &	operator<< (std::ostream &out, MirResizeEvent const &event)
std::ostream &	operator<< (std::ostream &out, MirOrientationEvent const &event)
std::ostream &	operator<< (std::ostream &out, MirInputEvent const &event)
std::ostream &	operator<< (std::ostream &out, MirCloseWindowEvent const &event)
std::ostream &	operator<< (std::ostream &out, MirKeymapEvent const &event)
std::ostream &	operator<< (std::ostream &out, MirWindowEvent const &event)
std::ostream &	operator<< (std::ostream &out, MirInputDeviceStateEvent const &event)
std::ostream &	operator<< (std::ostream &out, MirWindowPlacementEvent const &event)
std::ostream &	operator<< (std::ostream &out, MirWindowOutputEvent const &event)
std::ostream &	operator<< (std::ostream &out, MirEvent const &event)

Variables
void(*	fatal_error )(char const *reason,...)
	fatal_error() is strictly for "this should never happen" situations that you cannot recover from. More...

Typedef Documentation

EventUPtr

typedef std::unique_ptr<MirEvent, void(*)(MirEvent*)> mir::EventUPtr

Function Documentation

fatal_error_abort()

void mir::fatal_error_abort	(	char const *	reason,
			...
	)

An alternative to fatal_error_except() that kills the program and dump core as cleanly as possible.

Parameters

[in]

reason

A printf-style format string.

fatal_error_except()

void mir::fatal_error_except	(	char const *	reason,
			...
	)

Throws an exception that will typically kill the Mir server and propagate from mir::run_mir.

Parameters

[in]

reason

A printf-style format string.

operator!=() [1/4]

template<typename Tag , typename ValueType >

constexpr bool mir::operator!= ( IntWrapper< Tag, ValueType > const &  lhs, IntWrapper< Tag, ValueType > const &  rhs  )

inline

operator!=() [2/4]

template<typename T >

bool mir::operator!= ( optional_value< T > const &  lhs, optional_value< T > const &  rhs  )

inline

operator!=() [3/4]

template<typename T >

bool mir::operator!= ( optional_value< T > const &  lhs, T const &  rhs  )

inline

operator!=() [4/4]

template<typename T >

bool mir::operator!= ( T const &  lhs, optional_value< T > const &  rhs  )

inline

operator<()

template<typename Tag , typename ValueType >

constexpr bool mir::operator< ( IntWrapper< Tag, ValueType > const &  lhs, IntWrapper< Tag, ValueType > const &  rhs  )

inline

operator<<() [1/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirInputEventModifier	modifier
	)

operator<<() [2/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirKeyboardAction	action
	)

operator<<() [3/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirTouchAction	action
	)

operator<<() [4/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirTouchTooltype	tool
	)

operator<<() [5/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirPointerAction	action
	)

operator<<() [6/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirPromptSessionState	state
	)

operator<<() [7/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirOrientation	orientation
	)

operator<<() [8/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirSurfaceAttrib	attribute
	)

operator<<() [9/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirWindowAttrib	attribute
	)

operator<<() [10/29]

template<typename Tag , typename ValueType >

std::ostream& mir::operator<<	(	std::ostream &	out,
		IntWrapper< Tag, ValueType > const &	value
	)

operator<<() [11/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirSurfaceFocusState	state
	)

operator<<() [12/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirWindowFocusState	state
	)

operator<<() [13/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirSurfaceVisibility	state
	)

operator<<() [14/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirWindowVisibility	state
	)

operator<<() [15/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirSurfaceType	type
	)

operator<<() [16/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirWindowType	type
	)

operator<<() [17/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirSurfaceState	state
	)

operator<<() [18/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirWindowState	state
	)

operator<<() [19/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirPromptSessionEvent const &	event
	)

operator<<() [20/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirResizeEvent const &	event
	)

operator<<() [21/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirOrientationEvent const &	event
	)

operator<<() [22/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirInputEvent const &	event
	)

operator<<() [23/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirCloseWindowEvent const &	event
	)

operator<<() [24/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirKeymapEvent const &	event
	)

operator<<() [25/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirWindowEvent const &	event
	)

operator<<() [26/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirInputDeviceStateEvent const &	event
	)

operator<<() [27/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirWindowPlacementEvent const &	event
	)

operator<<() [28/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirWindowOutputEvent const &	event
	)

operator<<() [29/29]

std::ostream& mir::operator<<	(	std::ostream &	out,
		MirEvent const &	event
	)

operator<=()

template<typename Tag , typename ValueType >

constexpr bool mir::operator<= ( IntWrapper< Tag, ValueType > const &  lhs, IntWrapper< Tag, ValueType > const &  rhs  )

inline

operator==() [1/4]

template<typename Tag , typename ValueType >

constexpr bool mir::operator== ( IntWrapper< Tag, ValueType > const &  lhs, IntWrapper< Tag, ValueType > const &  rhs  )

inline

operator==() [2/4]

template<typename T >

bool mir::operator== ( optional_value< T > const &  lhs, optional_value< T > const &  rhs  )

inline

operator==() [3/4]

template<typename T >

bool mir::operator== ( optional_value< T > const &  lhs, T const &  rhs  )

inline

operator==() [4/4]

template<typename T >

bool mir::operator== ( T const &  lhs, optional_value< T > const &  rhs  )

inline

operator>=()

template<typename Tag , typename ValueType >

constexpr bool mir::operator>= ( IntWrapper< Tag, ValueType > const &  lhs, IntWrapper< Tag, ValueType > const &  rhs  )

inline

Variable Documentation

fatal_error

void(* mir::fatal_error) (char const *reason,...)

fatal_error() is strictly for "this should never happen" situations that you cannot recover from.

By default it points at fatal_error_except(). Note the reason parameter is a simple char* so its value is clearly visible in stack trace output.

Parameters

[in]

reason

A printf-style format string.