Collaboration diagram for Internal documentation. Not intended or useful for the user.:

Typedefs
using	bactria::ranges::plugin::create_event_t = std::add_pointer_t< void (std::uint32_t, char const , std::uint32_t) noexcept >
	Signature for plugin function bactria_ranges_create_event(). More...

using	bactria::ranges::plugin::destroy_event_t = std::add_pointer_t< void(void *) noexcept >
	Signature for plugin function bactria_ranges_destroy_event(). More...

using	bactria::ranges::plugin::fire_event_t = std::add_pointer_t< void(void , char const , char const , std::uint32_t, char const ) noexcept >
	Signature for plugin function bactria_ranges_fire_event(). More...

using	bactria::ranges::plugin::create_range_t = std::add_pointer_t< void (char const , std::uint32_t, char const *, std::uint32_t) noexcept >
	Signature for plugin function bactria_ranges_create_range(). More...

using	bactria::ranges::plugin::destroy_range_t = std::add_pointer_t< void(void *) noexcept >
	Signature for plugin function bactria_ranges_destroy_range(). More...

using	bactria::ranges::plugin::start_range_t = std::add_pointer_t< void(void *) noexcept >
	Signature for plugin function bactria_ranges_start_range(). More...

using	bactria::ranges::plugin::stop_range_t = std::add_pointer_t< void(void *) noexcept >
	Signature for plugin function bactria_ranges_stop_range(). More...

Functions
auto	bactria::ranges::plugin::activated () -> bool
	Checks for an active ranges plugin. More...

auto	bactria::ranges::plugin::load () -> plugin_handle_t
	Initializes the ranges plugin. More...

auto	bactria::ranges::plugin::create_event (std::uint32_t color, char const *cat_name, std::uint32_t cat_id) noexcept
	Creates a plugin-specific event handle. More...

auto	bactria::ranges::plugin::destroy_event (void *event_handle) noexcept
	Destroys a plugin-specific event handle. More...

auto	bactria::ranges::plugin::fire_event (void event_handle, char const event_name, char const source, std::uint32_t lineno, char const caller) noexcept
	Plugin-specific event firing. More...

auto	bactria::ranges::plugin::create_range (char const name, std::uint32_t color, char const cat_name, std::uint32_t cat_id) noexcept
	Creates a plugin-specific range handle. More...

auto	bactria::ranges::plugin::destroy_range (void *range_handle) noexcept
	Destroys a plugin-specific range handle. More...

auto	bactria::ranges::plugin::start_range (void *range_handle) noexcept
	Plugin-specific range starting. More...

auto	bactria::ranges::plugin::stop_range (void *range_handle) noexcept
	Plugin-specific range stopping. More...

Variables
auto	bactria::ranges::plugin::create_event_ptr = create_event_t{nullptr}
	Pointer to plugin function bactria_ranges_create_event(). More...

auto	bactria::ranges::plugin::destroy_event_ptr = destroy_event_t{nullptr}
	Pointer to plugin function bactria_ranges_destroy_event(). More...

auto	bactria::ranges::plugin::fire_event_ptr = fire_event_t{nullptr}
	Pointer to plugin function bactria_ranges_fire_event(). More...

auto	bactria::ranges::plugin::create_range_ptr = create_range_t{nullptr}
	Pointer to plugin function bactria_ranges_create_range(). More...

auto	bactria::ranges::plugin::destroy_range_ptr = destroy_range_t{nullptr}
	Pointer to plugin function bactria_ranges_destroy_range(). More...

auto	bactria::ranges::plugin::start_range_ptr = start_range_t{nullptr}
	Pointer to plugin function bactria_ranges_start_range(). More...

auto	bactria::ranges::plugin::stop_range_ptr = stop_range_t{nullptr}
	Pointer to plugin function bactria_ranges_stop_range(). More...

Detailed Description

Typedef Documentation

◆ create_event_t

using bactria::ranges::plugin::create_event_t = typedef std::add_pointer_t<void*(std::uint32_t, char const*, std::uint32_t) noexcept>

Signature for plugin function bactria_ranges_create_event().

Used internally by bactria during plugin initialization. Should never be used by the user.

◆ create_range_t

using bactria::ranges::plugin::create_range_t = typedef std::add_pointer_t<void*(char const*, std::uint32_t, char const*, std::uint32_t) noexcept>

Signature for plugin function bactria_ranges_create_range().

Used internally by bactria during plugin initialization. Should never be used by the user.

◆ destroy_event_t

using bactria::ranges::plugin::destroy_event_t = typedef std::add_pointer_t<void(void*) noexcept>

Signature for plugin function bactria_ranges_destroy_event().

Used internally by bactria during plugin initialization. Should never be used by the user.

◆ destroy_range_t

using bactria::ranges::plugin::destroy_range_t = typedef std::add_pointer_t<void(void*) noexcept>

Signature for plugin function bactria_ranges_destroy_range().

Used internally by bactria during plugin initialization. Should never be used by the user.

◆ fire_event_t

using bactria::ranges::plugin::fire_event_t = typedef std::add_pointer_t<void(void*, char const*, char const*, std::uint32_t, char const*) noexcept>

Signature for plugin function bactria_ranges_fire_event().

Used internally by bactria during plugin initialization. Should never be used by the user.

◆ start_range_t

using bactria::ranges::plugin::start_range_t = typedef std::add_pointer_t<void(void*) noexcept>

Signature for plugin function bactria_ranges_start_range().

Used internally by bactria during plugin initialization. Should never be used by the user.

◆ stop_range_t

using bactria::ranges::plugin::stop_range_t = typedef std::add_pointer_t<void(void*) noexcept>

Signature for plugin function bactria_ranges_stop_range().

Used internally by bactria during plugin initialization. Should never be used by the user.

Function Documentation

◆ activated()

auto bactria::ranges::plugin::activated ( ) -> bool

inline

Checks for an active ranges plugin.

This function checks for an activate ranges plugin. It should never be called by the user directly.

Returns: true If BACTRIA_DEACTIVATE is NOT defined and BACTRIA_RANGES_PLUGIN is defined.; false If either BACTRIA_DEACTIVATE is defined or BACTRIA_RANGES_PLUGIN is NOT defined.

◆ create_event()

auto bactria::ranges::plugin::create_event	(	std::uint32_t	color,
		char const *	cat_name,
		std::uint32_t	cat_id
	)

inlinenoexcept

Creates a plugin-specific event handle.

Used internally by the Event class. Users should not call this directly.

See also: Event::Event()

◆ create_range()

auto bactria::ranges::plugin::create_range	(	char const *	name,
		std::uint32_t	color,
		char const *	cat_name,
		std::uint32_t	cat_id
	)

inlinenoexcept

Creates a plugin-specific range handle.

Used internally by the Range class. Users should not call this directly.

See also: Range::Range()

◆ destroy_event()

auto bactria::ranges::plugin::destroy_event ( void * event_handle )

inlinenoexcept

Destroys a plugin-specific event handle.

Used internally by the Event class. Users should not call this directly.

See also: Event::~Event()

◆ destroy_range()

auto bactria::ranges::plugin::destroy_range ( void * range_handle )

inlinenoexcept

Destroys a plugin-specific range handle.

Used internally by the Range class. Users should not call this directly.

See also: Range::~Range()

◆ fire_event()

auto bactria::ranges::plugin::fire_event	(	void *	event_handle,
		char const *	event_name,
		char const *	source,
		std::uint32_t	lineno,
		char const *	caller
	)

inlinenoexcept

Plugin-specific event firing.

Used internally by the Event class. Users should not call this directly.

See also: Event::fire()

◆ load()

auto bactria::ranges::plugin::load ( ) -> plugin_handle_t

inline

Initializes the ranges plugin.

Used internally by bactria during plugin initialization. Should never be used by the user.

Returns: A platform-specific plugin handle.

Exceptions

std::runtime_error On failure during plugin initialization.

◆ start_range()

auto bactria::ranges::plugin::start_range ( void * range_handle )

inlinenoexcept

Plugin-specific range starting.

Used internally by the Range class. Users should not call this directly.

See also: Range::start()

◆ stop_range()

auto bactria::ranges::plugin::stop_range ( void * range_handle )

inlinenoexcept

Plugin-specific range stopping.

Used internally by the Range class. Users should not call this directly.

See also: Range::stop()

Variable Documentation

◆ create_event_ptr

auto bactria::ranges::plugin::create_event_ptr = create_event_t{nullptr}

Pointer to plugin function bactria_ranges_create_event().

Used internally by bactria during plugin initialization. Should never be used by the user.

◆ create_range_ptr

auto bactria::ranges::plugin::create_range_ptr = create_range_t{nullptr}

Pointer to plugin function bactria_ranges_create_range().

Used internally by bactria during plugin initialization. Should never be used by the user.

◆ destroy_event_ptr

auto bactria::ranges::plugin::destroy_event_ptr = destroy_event_t{nullptr}

Pointer to plugin function bactria_ranges_destroy_event().

Used internally by bactria during plugin initialization. Should never be used by the user.

◆ destroy_range_ptr

auto bactria::ranges::plugin::destroy_range_ptr = destroy_range_t{nullptr}

Pointer to plugin function bactria_ranges_destroy_range().

Used internally by bactria during plugin initialization. Should never be used by the user.

◆ fire_event_ptr

auto bactria::ranges::plugin::fire_event_ptr = fire_event_t{nullptr}

Pointer to plugin function bactria_ranges_fire_event().

Used internally by bactria during plugin initialization. Should never be used by the user.

◆ start_range_ptr

auto bactria::ranges::plugin::start_range_ptr = start_range_t{nullptr}

Pointer to plugin function bactria_ranges_start_range().

Used internally by bactria during plugin initialization. Should never be used by the user.Internal documentation. Not intended or useful for the user.

◆ stop_range_ptr

auto bactria::ranges::plugin::stop_range_ptr = stop_range_t{nullptr}

Pointer to plugin function bactria_ranges_stop_range().

Used internally by bactria during plugin initialization. Should never be used by the user.

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ create_event_t

◆ create_range_t

◆ destroy_event_t

◆ destroy_range_t

◆ fire_event_t

◆ start_range_t

◆ stop_range_t

Function Documentation

◆ activated()

◆ create_event()

◆ create_range()

◆ destroy_event()

◆ destroy_range()

◆ fire_event()

◆ load()

◆ start_range()

◆ stop_range()

Variable Documentation

◆ create_event_ptr

◆ create_range_ptr

◆ destroy_event_ptr

◆ destroy_range_ptr

◆ fire_event_ptr

◆ start_range_ptr

◆ stop_range_ptr