Represents a container node in the deck list hierarchy (zones and groupings). More...

#include <inner_deck_list_node.h>

Inheritance diagram for InnerDecklistNode:

Collaboration diagram for InnerDecklistNode:

Public Member Functions
	InnerDecklistNode (QString _name=QString(), InnerDecklistNode *_parent=nullptr, int position=-1)
	Construct a new InnerDecklistNode.
	InnerDecklistNode (InnerDecklistNode other, InnerDecklistNode _parent=nullptr)
	Copy constructor with parent reassignment.
	~InnerDecklistNode () override
	Destructor. Recursively deletes all child nodes.
void	setSortMethod (DeckSortMethod method) override
	Set the sorting method for this node and all children.
QString	getName () const override
void	setName (const QString &_name)
virtual QString	getVisibleName () const
	Get this node’s display-friendly name.
QString	getCardProviderId () const override
QString	getCardSetShortName () const override
QString	getCardCollectorNumber () const override
bool	isDeckHeader () const override
void	clearTree ()
	Delete all children of this node, recursively.
AbstractDecklistNode *	findChild (const QString &_name)
	Find a direct child node by name.
AbstractDecklistNode *	findCardChildByNameProviderIdAndNumber (const QString &_name, const QString &_providerId="", const QString &_cardNumber="")
	Find a child card node by name, provider ID, and collector number.
int	height () const override
	Compute the height of this node.
int	recursiveCount (bool countTotalCards=false) const
	Count cards recursively under this node.
bool	compare (AbstractDecklistNode *other) const override
	Compare this node against another for sorting.
bool	compareNumber (AbstractDecklistNode *other) const
	Compare this node against another for sorting.
bool	compareName (AbstractDecklistNode *other) const
	Compare this node against another for sorting.
QVector< QPair< int, int > >	sort (Qt::SortOrder order=Qt::AscendingOrder)
	Sort this node’s children recursively.
int	readElement (QXmlStreamReader *xml, int limit)
	Deserialize this node and its children from XML.
void	writeElement (QXmlStreamWriter *xml) override
	Serialize this node and its children to XML.
Public Member Functions inherited from AbstractDecklistNode
	AbstractDecklistNode (InnerDecklistNode *_parent=nullptr, int position=-1)
	Construct a new AbstractDecklistNode and insert it into its parent.
virtual	~AbstractDecklistNode ()=default
	Virtual destructor. Child classes must clean up their resources.
InnerDecklistNode *	getParent () const
void	setParent (InnerDecklistNode *newParent)
int	depth () const
	Compute the depth of this node in the tree.

Static Public Member Functions
static QString	visibleNameFromName (const QString &_name)
	Translate an internal name into a user-visible name.
static const QList< QString > &	boardZoneNames ()
	The standard board zone names, in display order.

Private Member Functions
QVector< QPair< int, AbstractDecklistNode * > >	indexedSnapshot () const
	Snapshots the current children as (old index, node) pairs.
QVector< QPair< int, int > >	applySortedOrder (const QVector< QPair< int, AbstractDecklistNode * > > &sorted)
	Replaces this node's children with `sorted` and maps old indexes to new ones.
int	readCardElement (QXmlStreamReader *xml, int remainingBudget)
	Reads a single card element and appends it to this node.

Private Attributes
QString	name
	Internal identifier for this node (zone or group name).

Additional Inherited Members
Protected Attributes inherited from AbstractDecklistNode
InnerDecklistNode *	parent
	Pointer to the parent node, or nullptr if this is the root.
DeckSortMethod	sortMethod
	Current sorting strategy for this node's children.

Detailed Description

Represents a container node in the deck list hierarchy (zones and groupings).

Unlike DecklistCardNode, which holds leaf card data, this class manages collections of child nodes, which may themselves be InnerDecklistNode or DecklistCardNode objects.

Role in the hierarchy:

Root node (invisible): Holds zones.
Zone nodes: "main", "side", "tokens".
Grouping nodes: Created dynamically when grouping by type, color, or mana cost.
Card nodes: Always children of an InnerDecklistNode.

Design notes:

Inherits from AbstractDecklistNode (tree interface) and QList<AbstractDecklistNode*> (storage of children). This allows direct QList-style manipulation of children while still presenting a polymorphic node interface.

Responsibilities:

Store a display name.
Own and manage child nodes (insert, clear, find).
Provide recursive operations such as counting cards or computing height.
Implement sorting logic for reordering children.
Implement XML serialization for persistence.

Ownership:

Owns all child nodes stored in the QList. The destructor recursively deletes children.

Constructor & Destructor Documentation

◆ InnerDecklistNode() [1/2]

InnerDecklistNode::InnerDecklistNode	(	QString	_name = QString(),
		InnerDecklistNode *	_parent = nullptr,
		int	position = -1 )

inlineexplicit

Construct a new InnerDecklistNode.

Parameters

_name	Internal name (e.g., "main", "side", "tokens", or group label).
_parent	Parent node (may be nullptr for the root).
position	Optional index for insertion into parent. -1 = append.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InnerDecklistNode() [2/2]

InnerDecklistNode::InnerDecklistNode	(	InnerDecklistNode *	other,
		InnerDecklistNode *	_parent = nullptr )

explicit

Copy constructor with parent reassignment.

Parameters

other	Node to copy from (deep copy of children).
_parent	Parent node for the copy.

Here is the call graph for this function:

◆ ~InnerDecklistNode()

InnerDecklistNode::~InnerDecklistNode ( )

override

Destructor. Recursively deletes all child nodes.

Here is the call graph for this function:

Member Function Documentation

◆ applySortedOrder()

QVector< QPair< int, int > > InnerDecklistNode::applySortedOrder ( const QVector< QPair< int, AbstractDecklistNode * > > & sorted )

private

Replaces this node's children with sorted and maps old indexes to new ones.

Returns: A list of (old index, new index) pairs for each reordered child.

Here is the caller graph for this function:

◆ boardZoneNames()

const QList< QString > & InnerDecklistNode::boardZoneNames ( )

static

The standard board zone names, in display order.

Returns: main, side and maybeboard.

Here is the caller graph for this function:

◆ clearTree()

void InnerDecklistNode::clearTree ( )

Delete all children of this node, recursively.

Here is the caller graph for this function:

◆ compare()

bool InnerDecklistNode::compare ( AbstractDecklistNode * other ) const

overridevirtual

Compare this node against another for sorting.

Uses current sortMethod to determine the comparison.

Parameters

other Node to compare.

Returns: true if this node should sort before other.

Implements AbstractDecklistNode.

Here is the call graph for this function:

◆ compareName()

bool InnerDecklistNode::compareName ( AbstractDecklistNode * other ) const

Compare this node against another for sorting.

Uses current sortMethod to determine the comparison.

Parameters

other Node to compare.

Returns: true if this node should sort before other.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ compareNumber()

bool InnerDecklistNode::compareNumber ( AbstractDecklistNode * other ) const

Compare this node against another for sorting.

Uses current sortMethod to determine the comparison.

Parameters

other Node to compare.

Returns: true if this node should sort before other.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findCardChildByNameProviderIdAndNumber()

AbstractDecklistNode * InnerDecklistNode::findCardChildByNameProviderIdAndNumber	(	const QString &	_name,
		const QString &	_providerId = "",
		const QString &	_cardNumber = "" )

Find a child card node by name, provider ID, and collector number.

Searches immediate children only.

Parameters

_name	Card name to match.
_providerId	Optional provider ID to match.
_cardNumber	Optional collector number to match.

Returns: Pointer to child node if found, nullptr otherwise.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findChild()

AbstractDecklistNode * InnerDecklistNode::findChild ( const QString & _name )

Find a direct child node by name.

Parameters

_name Name to match.

Returns: Pointer to child node, or nullptr if not found.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCardCollectorNumber()

QString InnerDecklistNode::getCardCollectorNumber ( ) const

inlinenodiscardoverridevirtual

Returns: Always empty for container nodes.

Implements AbstractDecklistNode.

◆ getCardProviderId()

QString InnerDecklistNode::getCardProviderId ( ) const

inlinenodiscardoverridevirtual

Returns: Always empty for container nodes.

Implements AbstractDecklistNode.

◆ getCardSetShortName()

QString InnerDecklistNode::getCardSetShortName ( ) const

inlinenodiscardoverridevirtual

Returns: Always empty for container nodes.

Implements AbstractDecklistNode.

◆ getName()

QString InnerDecklistNode::getName ( ) const

inlinenodiscardoverridevirtual

Returns: The internal name of this node.

Implements AbstractDecklistNode.

Here is the caller graph for this function:

◆ getVisibleName()

QString InnerDecklistNode::getVisibleName ( ) const

nodiscardvirtual

Get this node’s display-friendly name.

Returns: Human-readable name (zone/group name).

Here is the call graph for this function:

Here is the caller graph for this function:

◆ height()

int InnerDecklistNode::height ( ) const

nodiscardoverridevirtual

Compute the height of this node.

Returns: Maximum depth of descendants + 1.

Implements AbstractDecklistNode.

Here is the call graph for this function:

◆ indexedSnapshot()

QVector< QPair< int, AbstractDecklistNode * > > InnerDecklistNode::indexedSnapshot ( ) const

private

Snapshots the current children as (old index, node) pairs.

Here is the caller graph for this function:

◆ isDeckHeader()

bool InnerDecklistNode::isDeckHeader ( ) const

inlinenodiscardoverridevirtual

Returns: Always true; InnerDecklistNode represents deck structure.

Implements AbstractDecklistNode.

◆ readCardElement()

int InnerDecklistNode::readCardElement	(	QXmlStreamReader *	xml,
		int	remainingBudget )

private

Reads a single card element and appends it to this node.

The card's quantity is capped at remainingBudget so a malicious or oversized deck file cannot push the total card count past the deck size limit.

Returns: The amount of cards actually added.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readElement()

int InnerDecklistNode::readElement	(	QXmlStreamReader *	xml,
		int	limit )

Deserialize this node and its children from XML.

Parameters

xml	Reader positioned at this element.
limit	The maximum amount of cards to read

Returns: the amount of cards found

Here is the call graph for this function:

Here is the caller graph for this function:

◆ recursiveCount()

int InnerDecklistNode::recursiveCount ( bool countTotalCards = false ) const

nodiscard

Count cards recursively under this node.

Parameters

countTotalCards If true, sums up quantities of cards. If false, counts unique card nodes.

Returns: Total count.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setName()

void InnerDecklistNode::setName ( const QString & _name )

inline

Parameters

_name Set the internal name of this node.

◆ setSortMethod()

void InnerDecklistNode::setSortMethod ( DeckSortMethod method )

overridevirtual

Set the sorting method for this node and all children.

Parameters

method Sort method to apply recursively.

Reimplemented from AbstractDecklistNode.

Here is the caller graph for this function:

◆ sort()

QVector< QPair< int, int > > InnerDecklistNode::sort ( Qt::SortOrder order = Qt::AscendingOrder )

Sort this node’s children recursively.

Parameters

order Ascending or descending.

Returns: A QVector of (oldIndex, newIndex) pairs indicating how children were reordered.

Here is the call graph for this function:

◆ visibleNameFromName()

QString InnerDecklistNode::visibleNameFromName ( const QString & _name )

static

Translate an internal name into a user-visible name.

For example, the internal string "main" is presented as "Mainboard" in the UI.

Parameters

_name Internal identifier.

Returns: Display-friendly string.

Here is the caller graph for this function:

◆ writeElement()

void InnerDecklistNode::writeElement ( QXmlStreamWriter * xml )

overridevirtual

Serialize this node and its children to XML.

Parameters

xml	Writer to append elements to.

Implements AbstractDecklistNode.

Here is the caller graph for this function:

Member Data Documentation

◆ name

QString InnerDecklistNode::name

private

Internal identifier for this node (zone or group name).

The documentation for this class was generated from the following files:

libcockatrice_deck_list/libcockatrice/deck_list/tree/inner_deck_list_node.h
libcockatrice_deck_list/libcockatrice/deck_list/tree/inner_deck_list_node.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Role in the hierarchy:

Design notes:

Responsibilities:

Ownership:

Constructor & Destructor Documentation

◆ InnerDecklistNode() [1/2]

◆ InnerDecklistNode() [2/2]

◆ ~InnerDecklistNode()

Member Function Documentation

◆ applySortedOrder()

◆ boardZoneNames()

◆ clearTree()

◆ compare()

◆ compareName()

◆ compareNumber()

◆ findCardChildByNameProviderIdAndNumber()

◆ findChild()

◆ getCardCollectorNumber()

◆ getCardProviderId()

◆ getCardSetShortName()

◆ getName()

◆ getVisibleName()

◆ height()

◆ indexedSnapshot()

◆ isDeckHeader()

◆ readCardElement()

◆ readElement()

◆ recursiveCount()

◆ setName()

◆ setSortMethod()

◆ sort()

◆ visibleNameFromName()

◆ writeElement()

Member Data Documentation

◆ name