Class representing a tree inventory
use Arch::Inventory qw(:category :type);
my $inv = Arch::Inventory->new; # use cwd
print Arch::Inventory->to_string($inv->get_root_entry), "\n";
print $inv->get_listing;
or (most commonly):
use Arch::Tree;
my $tree = Arch::Tree->new; my $inv = $tree->get_inventory; print $inv->get_listing;
Arch::Inventory generates a tree inventory.
An inventory is a tree structure of elements, each representing a single directory entry of the source tree. Each inventory entry is described by an hash with the following fields:
The classification of the tree element. category can be one of \s-1TREE\s0, \s-1SOURCE\s0, \s-1PRECIOUS\s0, \s-1BACKUP\s0 or \s-1JUNK\s0.
A boolean value indicating whether the element was first classified as \s-1SOURCE\s0 but lacked an inventory id.
The tree element type. type can be one of \s-1FILE\s0, \s-1DIRECTORY\s0 or \s-1SYMLINK\s0.
The complete path to the tree element relative to the inventory base directory.
The elements inventory id. May be \*(C`undef\*(C'.
A hash of the elements direct children, idexed by their last path element. This field exists for elements of type \s-1DIRECTORY\s0 only.
The category and type constants can be conveniently imported using the tags \*(C`:category\*(C' and \*(C`:type\*(C'.
use Arch::Inventory qw(:category :type);
The following methods are available:
new, directory, get_root_entry, get_entry, get_listing, annotate_fs, foreach, dump, to_string. Create an inventory for $dir or the current directory if $dir is not specified.
Returns the inventories base directory as passed to new.
Returns the inventory element for the base directory. The root entry always has the following properties: $root = { category => TREE, # if {arch} exists, SOURCE otherwise untagged => 1, type => DIRECTORY, path => '', id => undef, children => { ... }, } Returns the inventory element for the specified path. The path may either be given as a single string or as a list of path elements. If the element does not exist \*(C`undef\*(C' is returned. Using an empty or no path is equivalent to calling get_root_entry.
Generates a textual inventory listing equivalent to the output of tla inventory -tspbju -B --kind --ids --untagged Note: The output order is not equivalent to tla. Instead of strict \s-1ASCII\s0 order of path names, a directory entry is always directly followed by its child entries. Entries with the same parent entry are \s-1ASCII\s0 ordered.
Add filesystem information to $entry or every inventory entry if none is provided. This adds the fields stat and symlink to the annotated entries which contain the output of lstat and readlink respectively. Execute $coderef for every inventory entry, passing the entry as $_[0].
Generates a dump of the inventory structure using Data::Dumper. Generates an inventory line for the inventory element as produced by tla.
Awaiting for your reports.
Mikhael Goikhman ([email protected]\*(--Perl-GPL/arch-perl\*(--devel).
Enno Cramer ([email protected]/arch-perl\*(--devel).
For more information, see tla, Arch::Util.