alib::files::detail::FTreeNodeHandler Struct Reference

Description:

Specialized TNodeHandler for class FTree which recycles extended information objects of type EIDirectory, EISymLinkFile, and 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 36 of file ftree.inl.

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

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

Type Definition Details:

CharacterType

using alib::files::detail::FTreeNodeHandler::CharacterType = 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 40 of file ftree.inl.

NameStringType

using alib::files::detail::FTreeNodeHandler::NameStringType = system::PathString

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

Definition at line 44 of file ftree.inl.

Method Details:

AllocateExtendedInfo()

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

static

Implements void AllocateExtendedInfo(Cursor&, const system::PathString&, const system::PathString&) .

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 63 of file ftree.cpp.

FreeNode()

void alib::files::detail::FTreeNodeHandler::FreeNode ( TTree::Node & node, TTree & tree )

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

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.
tree	The instance of struct template <typename TAllocator, typename T, typename TNodeHandler, Recycling TRecycling> 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.

InitializeNode()

void alib::files::detail::FTreeNodeHandler::InitializeNode ( TTree::Node & node, TTree & tree )

inlinestatic

Copies the node's name to the local string.

Parameters

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.
tree	The instance of struct template <typename TAllocator, typename T, typename TNodeHandler, Recycling TRecycling> 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.

---

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

• ftree.inl
• ftree.cpp