Directory tree. More...

#include <dirtree.hpp>

Public Member Functions
	dirtree_t (dirspec_t *ds)
	dirtree_t (dirtree_impl_t *di)
	~dirtree_t ()
bool	is_orderable () const
	Is dirtree orderable?
dterr_t	chdir (const char *path)
	Change current directory.
qstring	getcwd () const
	Get current directory.
qstring	get_abspath (const dirtree_cursor_t &cursor, uint32 name_flags=DTN_FULL_NAME) const
	Get absolute path pointed by the cursor.
qstring	get_abspath (const char *relpath) const
	Construct an absolute path from the specified relative path.
direntry_t	resolve_cursor (const dirtree_cursor_t &cursor) const
	Resolve cursor.
dirtree_cursor_t	make_cursor (const char *path) const
	Make cursor from path.
direntry_t	resolve_path (const char *path) const
	Resolve path.
bool	isdir (const char *path) const
	Is a directory?
bool	isfile (const char *path) const
	Is a file?
qstring	get_entry_name (const direntry_t &de, uint32 name_flags=DTN_FULL_NAME) const
	Get entry name.
bool	is_dir_ordered (diridx_t diridx) const
	Is dir ordered?
dterr_t	set_natural_order (diridx_t diridx, bool enable) const
	Enable/disable natural inode order in a directory.
ssize_t	get_dir_size (diridx_t diridx) const
	Get dir size.
qstring	get_entry_attrs (const direntry_t &de) const
	Get entry attributes.
bool	findfirst (dirtree_iterator_t ff, const char pattern) const
	Start iterating over files in a directory.
bool	findnext (dirtree_iterator_t *ff) const
	Continue iterating over files in a directory.
dterr_t	mkdir (const char *path)
	Create a directory.
dterr_t	rmdir (const char *path)
	Remove a directory.
dterr_t	link (const char *path)
	Add a file item into a directory.
dterr_t	unlink (const char *path)
	Remove a file item from a directory.
dterr_t	link (inode_t inode)
	Add an inode into the current directory.
dterr_t	unlink (inode_t inode)
	Remove an inode from the current directory.
dterr_t	rename (const char from, const char to)
	Rename a directory entry.
dterr_t	fold_common_prefix (const char *path=nullptr, char sep=DIRTREE_FOLDED_SEP)
	Collapse single child folders into a single folder item The default separator (DIRTREE_FOLDED_SEP, ASCII 0x1D) is rendered as '/' by the UI but is not split by the path parser, so folded folders behave like a single item for rmdir/cd/rename/etc.
dterr_t	bulk_move (const dirtree_cursor_vec_t &items, const char dstdir, ssize_t dst_rank=-1, dirtree_cursor_vec_t moved_items=nullptr, dirtree_bulk_results_t *errs=nullptr)
	Move many items to a directory.
dterr_t	bulk_remove (const dirtree_cursor_vec_t &items, dirtree_bulk_results_t *errs=nullptr)
	Delete many items.
ssize_t	get_rank (diridx_t diridx, const direntry_t &de) const
	Get ordering rank of an item.
dterr_t	change_rank (const char *path, ssize_t rank_delta)
	Change ordering rank of an item.
dirtree_cursor_t	get_parent_cursor (const dirtree_cursor_t &cursor) const
	Get parent cursor.
bool	load ()
	Load the tree structure from the netnode.
bool	save () const
	Save the tree structure to the netnode.
const char *	get_id () const
	netnode name
void	set_id (const char *nm)
void	notify_dirtree (bool added, inode_t inode)
	Notify dirtree about a change of an inode.
ssize_t	traverse (dirtree_visitor_t &v) const
	Traverse dirtree, and be notified at each entry If the the visitor returns anything other than 0, iteration will stop, and that value returned.
dirtree_cursor_t	find_entry (const direntry_t &de) const
	Find the cursor corresponding to an entry of a directory.

Static Public Member Functions
static const char *	errstr (dterr_t err)
	Get textual representation of the error code.
static bool	isdir (const direntry_t &de)
static bool	isfile (const direntry_t &de)

Friends
struct	dirtree_internal_t

Detailed Description

Directory tree.

This class organizes a virtual directory tree over items that are represented by dirspec_t.

Constructor & Destructor Documentation

◆ dirtree_t() [1/2]

dirtree_t::dirtree_t ( dirspec_t * ds )

inline

◆ dirtree_t() [2/2]

dirtree_t::dirtree_t ( dirtree_impl_t * di )

inline

◆ ~dirtree_t()

dirtree_t::~dirtree_t ( )

inline

Member Function Documentation

◆ errstr()

const char * dirtree_t::errstr ( dterr_t err )

inlinestatic

Get textual representation of the error code.

◆ is_orderable()

bool dirtree_t::is_orderable ( ) const

inline

Is dirtree orderable?

Returns: true if the dirtree is orderable

◆ chdir()

dterr_t dirtree_t::chdir ( const char * path )

inline

Change current directory.

Parameters

path	new current directory

Returns: dterr_t error code

◆ getcwd()

qstring dirtree_t::getcwd ( ) const

inline

Get current directory.

Returns: the current working directory

◆ get_abspath() [1/2]

qstring dirtree_t::get_abspath	(	const dirtree_cursor_t &	cursor,
		uint32	name_flags = DTN_FULL_NAME ) const

inline

Get absolute path pointed by the cursor.

Parameters

cursor
name_flags	how exactly the name should be retrieved. combination of bits for get_...name() methods bits

Returns: path; empty string if error

Note: see also resolve_cursor()

◆ get_abspath() [2/2]

qstring dirtree_t::get_abspath ( const char * relpath ) const

inline

Construct an absolute path from the specified relative path.

This function verifies the directory part of the specified path. The last component of the specified path is not verified.

Parameters

relpath relative path

Returns: path. empty path means wrong directory part of RELPATH

◆ resolve_cursor()

direntry_t dirtree_t::resolve_cursor ( const dirtree_cursor_t & cursor ) const

inline

Resolve cursor.

Parameters

cursor to analyze

Returns: directory entry; if the cursor is bad, the resolved entry will be invalid.

Note: see also get_abspath()

◆ make_cursor()

dirtree_cursor_t dirtree_t::make_cursor ( const char * path ) const

inline

Make cursor from path.

Parameters

path	to analyze

Returns: directory cursor; if the path is bad, the resolved cursor will be invalid.

Note: see also get_abspath()

◆ resolve_path()

direntry_t dirtree_t::resolve_path ( const char * path ) const

inline

Resolve path.

Parameters

path	to analyze

Returns: directory entry

◆ isdir() [1/2]

bool dirtree_t::isdir ( const direntry_t & de )

inlinestatic

◆ isfile() [1/2]

bool dirtree_t::isfile ( const direntry_t & de )

inlinestatic

◆ isdir() [2/2]

bool dirtree_t::isdir ( const char * path ) const

inline

Is a directory?

Parameters

path	to analyze

Returns: true if the specified path is a directory

◆ isfile() [2/2]

bool dirtree_t::isfile ( const char * path ) const

inline

Is a file?

Parameters

path	to analyze

Returns: true if the specified path is a file

◆ get_entry_name()

qstring dirtree_t::get_entry_name	(	const direntry_t &	de,
		uint32	name_flags = DTN_FULL_NAME ) const

inline

Get entry name.

Parameters

de	directory entry
name_flags	how exactly the name should be retrieved. combination of bits for get_...name() methods bits

Returns: name

◆ is_dir_ordered()

bool dirtree_t::is_dir_ordered ( diridx_t diridx ) const

inline

Is dir ordered?

Returns: true if the dirtree has natural ordering

◆ set_natural_order()

dterr_t dirtree_t::set_natural_order	(	diridx_t	diridx,
		bool	enable ) const

inline

Enable/disable natural inode order in a directory.

Parameters

diridx	directory index
enable	action to do TRUE - enable ordering: re-order existing entries so that all subdirs are at the beginning of the list, file entries are sorted and placed after the subdirs FALSE - disable ordering, no changes to existing entries

Returns: dterr_t error code

◆ get_dir_size()

ssize_t dirtree_t::get_dir_size ( diridx_t diridx ) const

inline

Get dir size.

Parameters

diridx directory index

Returns: number of entries under this directory; if error, return -1

◆ get_entry_attrs()

qstring dirtree_t::get_entry_attrs ( const direntry_t & de ) const

inline

Get entry attributes.

Parameters

de	directory entry

Returns: name

◆ findfirst()

bool dirtree_t::findfirst	(	dirtree_iterator_t *	ff,
		const char *	pattern ) const

inline

Start iterating over files in a directory.

Parameters

ff	directory iterator. it will be initialized by the function
pattern	pattern to search for

Returns: success

◆ findnext()

bool dirtree_t::findnext ( dirtree_iterator_t * ff ) const

inline

Continue iterating over files in a directory.

Parameters

ff	directory iterator

Returns: success

◆ mkdir()

dterr_t dirtree_t::mkdir ( const char * path )

inline

Create a directory.

Parameters

path	directory to create

Returns: dterr_t error code

◆ rmdir()

dterr_t dirtree_t::rmdir ( const char * path )

inline

Remove a directory.

Parameters

path	directory to delete

Returns: dterr_t error code

◆ link() [1/2]

dterr_t dirtree_t::link ( const char * path )

inline

Add a file item into a directory.

Parameters

path	path to item to add to a directory

Returns: dterr_t error code

◆ unlink() [1/2]

dterr_t dirtree_t::unlink ( const char * path )

inline

Remove a file item from a directory.

Parameters

path	path to item remove from a directory

Returns: dterr_t error code

◆ link() [2/2]

dterr_t dirtree_t::link ( inode_t inode )

inline

Add an inode into the current directory.

Parameters

inode

Returns: dterr_t error code

◆ unlink() [2/2]

dterr_t dirtree_t::unlink ( inode_t inode )

inline

Remove an inode from the current directory.

Parameters

inode

Returns: dterr_t error code

◆ rename()

dterr_t dirtree_t::rename	(	const char *	from,
		const char *	to )

inline

Rename a directory entry.

Parameters

from	source path
to	destination path

Returns: dterr_t error code

Note: This function can also rename the item

◆ fold_common_prefix()

dterr_t dirtree_t::fold_common_prefix	(	const char *	path = nullptr,
		char	sep = DIRTREE_FOLDED_SEP )

inline

Collapse single child folders into a single folder item The default separator (DIRTREE_FOLDED_SEP, ASCII 0x1D) is rendered as '/' by the UI but is not split by the path parser, so folded folders behave like a single item for rmdir/cd/rename/etc.

Parameters

path	starting directory; nullptr or "/" means root
sep	character used to join names

Returns: dterr_t error code

◆ bulk_move()

dterr_t dirtree_t::bulk_move	(	const dirtree_cursor_vec_t &	items,
		const char *	dstdir,
		ssize_t	dst_rank = -1,
		dirtree_cursor_vec_t *	moved_items = nullptr,
		dirtree_bulk_results_t *	errs = nullptr )

inline

Move many items to a directory.

Parameters

items	items to move
dstdir	destination directory. will be created if does not exist.
dst_rank	rank inside the destination directory, where the items should be moved to. example: 0 means to insert to the very beginning of the directory. -1 means to append files to the end of the directory and insert directories after the first existing directory. if the rank is different from -1 and the destination directory has natural ordering and some moved items are files, then the natural ordering will be disabled.
moved_items	buffer for cursors of the successfully moved items
errs	buffer for errors. only errors are reported here, in any order

Returns: dterr_t error code

Note: the return code refers to the destination directory. for the errors related to the source items, see errs

◆ bulk_remove()

dterr_t dirtree_t::bulk_remove	(	const dirtree_cursor_vec_t &	items,
		dirtree_bulk_results_t *	errs = nullptr )

inline

Delete many items.

Parameters

items	items to delete
errs	buffer for errors. only errors are reported here, in any order Directories are deleted recursively, even if they are not empty.

◆ get_rank()

ssize_t dirtree_t::get_rank	(	diridx_t	diridx,
		const direntry_t &	de ) const

inline

Get ordering rank of an item.

Parameters

diridx	index of the parent directory
de	directory entry

Returns: number in a range of [0..n) where n is the number of entries in the parent directory. -1 if error

◆ change_rank()

dterr_t dirtree_t::change_rank	(	const char *	path,
		ssize_t	rank_delta )

inline

Change ordering rank of an item.

Parameters

path	path to the item
rank_delta	the amount of the change. positive numbers mean to move down in the list; negative numbers mean to move up.

Returns: dterr_t error code

Note: this function may disable natural ordering of the parent folder

See also: set_natural_order()

◆ get_parent_cursor()

dirtree_cursor_t dirtree_t::get_parent_cursor ( const dirtree_cursor_t & cursor ) const

inline

Get parent cursor.

Parameters

cursor a valid ditree cursor

Returns: cursor's parent

◆ load()

bool dirtree_t::load ( )

inline

Load the tree structure from the netnode.

If dirspec_t::id is empty, the operation will be considered a success. In addition, calling load() more than once will not do anything, and will be considered a success.

Returns: success

See also: dirspec_t::id.

◆ save()

bool dirtree_t::save ( ) const

inline

Save the tree structure to the netnode.

Returns: success

See also: dirspec_t::id.

◆ get_id()

const char * dirtree_t::get_id ( ) const

inline

netnode name

◆ set_id()

void dirtree_t::set_id ( const char * nm )

inline

◆ notify_dirtree()

void dirtree_t::notify_dirtree	(	bool	added,
		inode_t	inode )

inline

Notify dirtree about a change of an inode.

Parameters

added	are we adding or deleting an inode?
inode	inode in question

◆ traverse()

ssize_t dirtree_t::traverse ( dirtree_visitor_t & v ) const

inline

Traverse dirtree, and be notified at each entry If the the visitor returns anything other than 0, iteration will stop, and that value returned.

The tree is traversed using a depth-first algorithm. It is forbidden to modify the dirtree_t during traversal; doing so will result in undefined behavior.

Parameters

v	the callback

Returns: 0, or whatever the visitor returned

◆ find_entry()

dirtree_cursor_t dirtree_t::find_entry ( const direntry_t & de ) const

inline

Find the cursor corresponding to an entry of a directory.

Parameters

de	directory entry

Returns: cursor corresponding to the directory entry

◆ dirtree_internal_t

friend struct dirtree_internal_t

friend

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

/Users/geoffrey/ida-sdk/src/include/dirtree.hpp

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ dirtree_t() [1/2]

◆ dirtree_t() [2/2]

◆ ~dirtree_t()

Member Function Documentation

◆ errstr()

◆ is_orderable()

◆ chdir()

◆ getcwd()

◆ get_abspath() [1/2]

◆ get_abspath() [2/2]

◆ resolve_cursor()

◆ make_cursor()

◆ resolve_path()

◆ isdir() [1/2]

◆ isfile() [1/2]

◆ isdir() [2/2]

◆ isfile() [2/2]

◆ get_entry_name()

◆ is_dir_ordered()

◆ set_natural_order()

◆ get_dir_size()

◆ get_entry_attrs()

◆ findfirst()

◆ findnext()

◆ mkdir()

◆ rmdir()

◆ link() [1/2]

◆ unlink() [1/2]

◆ link() [2/2]

◆ unlink() [2/2]

◆ rename()

◆ fold_common_prefix()

◆ bulk_move()

◆ bulk_remove()

◆ get_rank()

◆ change_rank()

◆ get_parent_cursor()

◆ load()

◆ save()

◆ get_id()

◆ set_id()

◆ notify_dirtree()

◆ traverse()

◆ find_entry()

Friends And Related Symbol Documentation

◆ dirtree_internal_t