The double_list_links_base Class Reference

A base class for a doubly linked list. More...

Fully Qualified Name

micro_os_plus::utils::double_list_links_base

Included Headers

#include <micro-os-plus/utils/lists.h>

Derived Classes

class	micro_os_plus::utils::double_list_links
	A class for the core of a doubly linked list (pointers to neighbours). More...
class	micro_os_plus::utils::static_double_list_links
	A class for the core of a statically allocated doubly linked list (pointers to neighbours). More...

Protected Member Attributes

double_list_links_base *	next_
	Pointer to the next node. More...
double_list_links_base *	previous_
	Pointer to the previous node. More...

Member Functions

constexpr	double_list_links_base ()
	Construct an uninitialised list node. More...
constexpr	~double_list_links_base ()
	Destruct the node. More...
void	initialize (void)
	Initialise the node links. More...
void	initialize_once (void)
	Initialize the list only at first run. More...
void	link_next (double_list_links_base *node)
	Link the new node as next. More...
void	link_previous (double_list_links_base *node)
	Link the new node as previous. More...
bool	linked (void) const
	Check if the node is linked to a double list. More...
double_list_links_base *	next (void) const
	Get the link to the next node. More...
double_list_links_base *	previous (void) const
	Get the link to the previous node. More...
bool	uninitialized (void) const
	Check if the node is uninitialised. More...
void	unlink (void)
	Remove this node from the list. More...

Description

A pair of uninitialised pointers to the next and previous list elements, plus a set of simple (some inlined) methods to access the pointers.

info

Both the regular and the statically allocated list elements are derived from this class.

Definition at line 111 of file lists.h.

Protected Member Attributes

next_

double_list_links_base* micro_os_plus::utils::double_list_links_base::next_

protected

Pointer to the next node.

Definition at line 231 of file lists.h.

previous_

double_list_links_base* micro_os_plus::utils::double_list_links_base::previous_

protected

Pointer to the previous node.

Definition at line 226 of file lists.h.

Constructors

double_list_links_base()

micro_os_plus::utils::double_list_links_base::double_list_links_base ()

constexpr

Construct an uninitialised list node.

This must be an empty constructor, that does not touch the pointers, but leaves them unchanged.

For statically initialised lists, this means a pair of nullptr pointers.

For regular lists, the constructor of the derived class will handle the initialisations.

warning

Code analysis may trigger:

• Member previous_ was not initialized in constructor
• Member next_ was not initialized in constructor

Definition at line 117 of file lists.h.

Destructor

~double_list_links_base()

micro_os_plus::utils::double_list_links_base::~double_list_links_base ()

constexpr

Destruct the node.

This must be an empty destructor, that does not touch the pointers, but leaves them unchanged.

Definition at line 140 of file lists.h.

Member Functions

initialize()

void micro_os_plus::utils::double_list_links_base::initialize (void)

constexpr

Initialise the node links.

Parameters

None.

Returns

Nothing.

Set both pointers to point to this node.

This is the definition of an unlinked node.

info

After unlinking the node from a list, it must be returned to this state.

Definition at line 160 of file lists.h.

initialize_once()

void micro_os_plus::utils::double_list_links_base::initialize_once (void)

Initialize the list only at first run.

Parameters

None.

Returns

Nothing.

If the statically allocated list is still in the initial uninitialised state (with both pointers nullptr), initialise the list to the empty state, with both pointers pointing to itself.

For non-statically initialised lists, this method is ineffective, since the node is always initialised at construct time.

info

This method must be manually called for statically allocated list before inserting elements, or performing any other operations.

Definition at line 170 of file lists.h.

link_next()

void micro_os_plus::utils::double_list_links_base::link_next (double_list_links_base * node)

Link the new node as next.

Parameters

None.

Returns

Nothing.

Insert the new node between the next pointer and the node pointed by it.

Used by lists to link new nodes to the list head.

Definition at line 180 of file lists.h.

link_previous()

void micro_os_plus::utils::double_list_links_base::link_previous (double_list_links_base * node)

Link the new node as previous.

Parameters

None.

Returns

Nothing.

Insert the new node between the previous pointer and the node pointed by it.

Used by lists to link new nodes to the list tail.

Definition at line 190 of file lists.h.

linked()

bool micro_os_plus::utils::double_list_links_base::linked (void) const

Check if the node is linked to a double list.

Return Values

true	The node is linked with both pointers.
false	The node is not linked.

To be linked, both pointers must point to different nodes than itself (double list requirement).

Definition at line 206 of file lists.h.

next()

double_list_links_base * micro_os_plus::utils::double_list_links_base::next (void) const

constexpr

Get the link to the next node.

Return Values

Pointer

to the next node.

Definition at line 213 of file lists.h.

previous()

double_list_links_base * micro_os_plus::utils::double_list_links_base::previous (void) const

constexpr

Get the link to the previous node.

Return Values

Pointer

to the previous node.

Definition at line 220 of file lists.h.

uninitialized()

bool micro_os_plus::utils::double_list_links_base::uninitialized (void) const

Check if the node is uninitialised.

Parameters

None.

Return Values

true	The links are not initialised.
false	The links are initialised.

An uninitialized node is a node with the pointers set to nullptr.

Only statically allocated nodes in the initial state are uninitialized. Regular nodes are always initialised.

Definition at line 150 of file lists.h.

unlink()

void micro_os_plus::utils::double_list_links_base::unlink (void)

Remove this node from the list.

Returns

Nothing.

Update both neighbours to point to each other, practically removing the node from the list.

The node is returned to the initial state (empty), with both pointers pointing to itself.

Definition at line 198 of file lists.h.

---

Generated via docusaurus-plugin-doxygen by Doxygen 1.13.2