FTreeNodeHandler Struct Reference

Description:

Specialized TNodeHandler for class FTree which recycles extended information objects of type FInfo::EIDirectory, FInfo::EISymLinkFile, and FInfo::EISymLinkDir with node deletion.

In respect to the node name allocation, this type behaves like default handler StringTreeNamesDynamic. In debug compilations, statistics variables DBG_STATS_STRINGTREE_NAMES and DBG_STATS_STRINGTREE_NAME_OVERFLOWS are increased, just like the original does.

Definition at line 51 of file ftree.hpp.

#include <ftree.hpp>

Public Type Index:
using	CharacterType = lang::system::PathCharType
using	NameStringType = lang::system::PathString

Public Static Method Index:
static ALIB_API void	AllocateExtendedInfo (StringTree< MonoAllocator, FInfo, detail::FTreeNodeHandler >::Cursor &node, const lang::system::PathString &symLinkDest, const lang::system::PathString &symLinkRealPath)
static void	FreeNode (TTree &tree, TTree::Node &node)
static void	InitializeNode (TTree &tree, TTree::Node &node)

Type Definition Details:

CharacterType

using CharacterType = lang::system::PathCharType

The character type that the StringTree uses for child name and path strings. This is taken from the C++ standard library.

Definition at line 55 of file ftree.hpp.

NameStringType

using NameStringType = lang::system::PathString

The string-type of a node's name. This is a simple static string, allocated with the pool allocator.

Definition at line 59 of file ftree.hpp.

Method Details:

AllocateExtendedInfo()

void AllocateExtendedInfo ( StringTree< MonoAllocator, FInfo, detail::FTreeNodeHandler >::Cursor & node, const lang::system::PathString & symLinkDest, const lang::system::PathString & symLinkRealPath )

static

Implements FTree::AllocateExtendedInfo.

Parameters

node	The node add extended information to.
symLinkDest	In case of symbolic link types, the symbolic link target.
symLinkRealPath	In case of symbolic link types, the symbolic link target as real path.

Definition at line 29 of file ftree.cpp.

Here is the call graph for this function:

FreeNode()

static void FreeNode ( TTree & tree, TTree::Node & node )

inlinestatic

This implementation frees any dynamically allocated memory of the node's name and in addition recycles any extended information object attached to the FInfo object.

Parameters

tree	The instance of struct detail::StringTreeBase that invokes this method. Any member may be accessed, including nodeTable which contains the MonoAllocator that the tree uses for the allocation of nodes.
node	The node that is to be removed. Allows access to the key and custom value data. While the parent and sibling nodes are likewise accessible, it is strictly forbidden to modify those.

InitializeNode()

static void InitializeNode ( TTree & tree, TTree::Node & node )

inlinestatic

Copies the node's name to the local string.

Parameters

tree	The instance of struct detail::StringTreeBase that invokes this method. Any member may be accessed, including nodeTable which contains the MonoAllocator that the tree uses for the allocation of nodes.
node	The node that was just created. Allows access to the key and custom value data. While the parent and sibling nodes are likewise accessible, it is strictly forbidden to modify those.

---

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

• ftree.hpp
• ftree.cpp