|
ALib C++ Framework
|
by |  |
|
Loading...
Searching...
No Matches
|
ALib C++ Framework
|
by | |
|
This class builds on ALib type StringTree. The contained elements (tree nodes) are of typeFInfo and represent entries in filesystems. Usually the tree is filled using the function ScanFiles.
Public base class StringTree provides all interfaces necessary to create and delete entries, iterate and recursively walk the file tree. Please consult its documentation for further information.
The base classes' method Cursor Root() is overloaded by this class and returns an instance of class File instead of an instance of class alib{containers;StringTree::Cursor}. This class can be turned into a cursor using AsCursor and then used to navigate through the tree. Then, the cursor can be cast back (or assigned) to a File instance.
The class fulfills weak monotonic allocation requirements, which is achieved by recycling not only the nodes (what base type StringTree does by default) but also any extended node information. This is implemented with the StringTree handler-type FTreeNodeHandler on the one hand, and on the other hand, with the implementation of the method AllocateExtendedInfo, which has to be exclusively used to attach information structs on FInfo elements.
Furthermore, class File (the nodes of the tree) provides method AttachCustomData, which likewise uses the internal pool-allocator.
In summary, this allows an indefinite sequence of file-scan and result filtering (deletions) with using more memory than the highest resulting fill state in such sequence requires.
Inner Type Index: | |
| struct | ListenerRecord |
| Record used to manage registered listeners. More... | |
Public Static Method Index: | |
| static void | FixSums (Cursor directory) |
Public Field Index: | |
| PoolAllocator | Pool |
Protected Type Index: | |
| using | base = StringTree<MonoAllocator, FInfo, detail::FTreeNodeHandler> |
| Type alias of this classes' base class. | |
| Protected Type Index: inherited from alib::containers::detail::StringTreeBase< TAllocator, T, TNodeHandler, TRecycling > | |
| using | CharacterType = typename TNodeHandler::CharacterType |
| using | ConstCursorBase = TCursorBase<true> |
| The constant version of type TCursorBase. | |
| using | CursorBase = TCursorBase<false> |
| The mutable version of type TCursorBase. | |
| using | NameStorageType = typename TNodeHandler::NameStringType |
| using | NameType = const strings::TString<CharacterType> |
| The string-type of node names and paths if provided externally for comparison. | |
| using | NodeList = lang::BidiListHook<NodeBase> |
| Alias shortcut for a bidirectional list of Node elements. | |
| using | SharedRecyclerType = typename decltype(nodeTable)::SharedRecyclerType |
| using | SubstringType = typename strings::TSubstring<CharacterType> |
Protected Field Index: | |
| ListMA< ListenerRecord > | listeners |
| The list of registered listeners. | |
| NumberFormat | numberFormat |
| OwnerAndGroupResolver | ogResolver |
| Protected Field Index: inherited from alib::containers::detail::StringTreeBase< TAllocator, T, TNodeHandler, TRecycling > | |
| int | dbgRootDataSet =0 |
| HashTable< TAllocator, typename NodeKey::ValueDescriptor, typename NodeKey::Hash, typename NodeKey::EqualTo, lang::Caching::Enabled, TRecycling > | nodeTable |
| RootNodeSpacer | root |
| The root node. | |
| CharacterType | separator |
Protected Method Index: | |
| void | notifyListeners (FTreeListener::Event event, const File &file, const system::PathString &filePath) |
| void | registerListener (FTreeListener *listener, lang::ContainerOp insertOrRemove, FTreeListener::Event event, const File *file, const StringTree::Cursor *subTree, const system::PathString &fileName, const system::PathString &pathPrefix, const system::PathString &pathSubstring) |
| Protected Method Index: inherited from alib::containers::StringTree< TAllocator, T, TNodeHandler, TRecycling > | |
| Cursor | createCursor (baseNode &node) |
| Protected Method Index: inherited from alib::containers::detail::StringTreeBase< TAllocator, T, TNodeHandler, TRecycling > | |
| StringTreeBase (TAllocator &allocator, CharacterType pathSeparator) | |
| template<typename TSharedRecycler = SharedRecyclerType> | |
| StringTreeBase (TAllocator &allocator, TSharedRecycler &pRecycler, CharacterType pathSeparator) | |
| template<typename TSharedRecycler = SharedRecyclerType> | |
| StringTreeBase (TSharedRecycler &pRecycler, CharacterType pathSeparator) | |
| bool | checkChildName (const NameType &name) const |
| TAllocator & | GetAllocator () noexcept |
Additional Inherited Members | |
| Public Type Index: inherited from alib::containers::StringTree< TAllocator, T, TNodeHandler, TRecycling > | |
| using | AllocatorType |
| Type definition publishing template parameter TAllocator. | |
| using | CharacterType |
| using | ConstCursor |
| The constant version of type TCursor<TConst>. | |
| using | Cursor |
| The mutable version of type TCursor<TConst>. | |
| using | HandlerType |
| Type definition publishing template parameter TNodeHandler. | |
| using | NameType |
| using | SharedRecyclerType |
| using | SubstringType |
|
protected |
|
protected |
|
protected |
Formatting information used with format methods of associated File instances.
|
protected |
A caching owner and group resolver. Used with format methods of associated File instances.
| PoolAllocator alib::files::FTree::Pool |
An object pool used for recycling all sorts of allocated objects as well as the hashtable entries. It is chained to the allocator provided with construction.
The pool may be used in accordance with the general rules imposed by camp ALib Monomem. If so, in multithreaded environments, this object has to be locked (in addition to all other custom locks when interfacing this type), when using this pool from custom code.
| alib::files::FTree::FTree | ( | MonoAllocator & | allocator | ) |
|
inline |
Allocates (or recycles) an appropriate information object fitting to the type of this entry. This method must only be applied to entries of types
| 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. |
|
inline |
Deletes all custom data objects attached to any File in this tree.
Note that this method is only applicable if all custom data objects set in any node of this tree share the same type TCustom. With debug-compilations this is asserted.
| TCustom | The object type to optionally store in tree nodes. |
|
static |
|
inline |
Retrieves formatting flags which are used with method AString & Format(Substring, AString&, lang::CurrentData, NumberFormat*) const.
|
inline |
Retrieves formatting flags which are used with method AString & Format(Substring, AString&, lang::CurrentData, NumberFormat*) const.
|
inline |
Retrieves formatting flags which are used with method AString & Format(Substring, AString&, lang::CurrentData, NumberFormat*) const.
|
inline |
|
inline |
Inserts or removes a listener to a specific file.
| insertOrRemove | Denotes whether the listener should be inserted or removed. (Only enum elements ContainerOp::Insert or ContainerOp::Remove must be passed.) |
| listener | The listener to register. |
| event | The event to listen to. |
| file | The file to listen to. |
|
inline |
Inserts or removes a listener for all files that share the given fileName.
| insertOrRemove | Denotes whether the listener should be inserted or removed. (Only enum elements ContainerOp::Insert or ContainerOp::Remove must be passed.) |
| listener | The listener to register. |
| event | The event to listen to. |
| fileName | The name of one or more files to listen to. |
|
inline |
Inserts or removes a listener for all files below the subtree specified by the given cursor.
| insertOrRemove | Denotes whether the listener should be inserted or removed. (Only enum elements ContainerOp::Insert or ContainerOp::Remove must be passed.) |
| listener | The listener to register. |
| event | The event to listen to. |
| cursor | The parent node in the tree of files to monitor. |
|
inline |
Inserts or removes a listener for all files below the subtree specified by the given startPath.
| insertOrRemove | Denotes whether the listener should be inserted or removed. (Only enum elements ContainerOp::Insert or ContainerOp::Remove must be passed.) |
| listener | The listener to register. |
| event | The event to listen to. |
| pathPrefix | The path prefix of the subtree of files to monitor. Note that a missing leading separator character will be added. |
|
inline |
Inserts or removes a listener for all files whose path (excluding the file name) contains the given pathSubstring.
| insertOrRemove | Denotes whether the listener should be inserted or removed. (Only enum elements ContainerOp::Insert or ContainerOp::Remove must be passed.) |
| listener | The listener to register. |
| event | The event to listen to. |
| pathSubstring | The substring to match in the path (including the file name) of the files to monitor. |
| int alib::files::FTree::MonitorStop | ( | FTreeListener * | listener | ) |
Removes all registrations of the given listener.
| listener | The listener to remove. |
|
inline |
Notifies registered listeners on events.
| event | The event that occurred. |
| file | The file. |
| filePath | The full path of the file. Might be nulled if not available to the caller. In this case it is internally created. Defaults to NULL_STRING. |
|
protected |
|
protected |
Implements the various overloaded listener registration methods.
| listener | The listener to register or dispose. |
| insertOrRemove | Denotes registration or disposal of a listener. |
| event | The event to listen to. |
| file | If given, the exported value of the file to listen to. |
| subTree | If given, the exported value of the subtree of files to listen to. |
| fileName | If given, the file's name to listen to. |
| pathPrefix | If given, the start string of the file path to monitor. |
| pathSubstring | If given, the substring to match in the path (including the file name) of the files to monitor. |
|
inline |
Sort of 'overloads' method Cursor Root() , which otherwise is accessible via operator-> inherited by parent class TSharedMonoVal. In contrast to the inherited method, this version returns an instance of type File.