.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Arch::Inventory 3pm"
.TH Arch::Inventory 3pm "2022-06-08" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Arch::Inventory \- class representing a tree inventory
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Arch::Inventory qw(:category :type);
\&
\&    my $inv = Arch::Inventory\->new;  # use cwd
\&    print Arch::Inventory\->to_string($inv\->get_root_entry), "\en";
\&    print $inv\->get_listing;
.Ve
.PP
or (most commonly):
.PP
.Vb 1
\&    use Arch::Tree;
\&
\&    my $tree = Arch::Tree\->new;
\&    my $inv = $tree\->get_inventory;
\&    print $inv\->get_listing;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Arch::Inventory generates a tree inventory.
.PP
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:
.IP "\fBcategory\fR" 4
.IX Item "category"
The classification of the tree element. \fBcategory\fR can be one of
\&\fB\s-1TREE\s0\fR, \fB\s-1SOURCE\s0\fR, \fB\s-1PRECIOUS\s0\fR, \fB\s-1BACKUP\s0\fR or \fB\s-1JUNK\s0\fR.
.IP "\fBuntagged\fR" 4
.IX Item "untagged"
A boolean value indicating whether the element was first classified as
\&\fB\s-1SOURCE\s0\fR but lacked an inventory id.
.IP "\fBtype\fR" 4
.IX Item "type"
The tree element type. \fBtype\fR can be one of \fB\s-1FILE\s0\fR, \fB\s-1DIRECTORY\s0\fR or
\&\fB\s-1SYMLINK\s0\fR.
.IP "\fBpath\fR" 4
.IX Item "path"
The complete path to the tree element relative to the inventory base
directory.
.IP "\fBid\fR" 4
.IX Item "id"
The elements inventory id. May be \f(CW\*(C`undef\*(C'\fR.
.IP "\fBchildren\fR" 4
.IX Item "children"
A hash of the elements direct children, idexed by their last path element.
.Sp
This field exists for elements of type \fB\s-1DIRECTORY\s0\fR only.
.PP
The \fBcategory\fR and \fBtype\fR constants can be conveniently imported using
the tags \f(CW\*(C`:category\*(C'\fR and \f(CW\*(C`:type\*(C'\fR.
.PP
.Vb 1
\&    use Arch::Inventory qw(:category :type);
.Ve
.SH "METHODS"
.IX Header "METHODS"
The following methods are available:
.PP
\&\fBnew\fR,
\&\fBdirectory\fR,
\&\fBget_root_entry\fR,
\&\fBget_entry\fR,
\&\fBget_listing\fR,
\&\fBannotate_fs\fR,
\&\fBforeach\fR,
\&\fBdump\fR,
\&\fBto_string\fR.
.IP "\fBnew\fR [\fI\f(CI$dir\fI\fR]" 4
.IX Item "new [$dir]"
Create an inventory for \fI\f(CI$dir\fI\fR or the current directory if \fI\f(CI$dir\fI\fR is
not specified.
.IP "\fBdirectory\fR" 4
.IX Item "directory"
Returns the inventories base directory as passed to \fBnew\fR.
.IP "\fBget_root_entry\fR" 4
.IX Item "get_root_entry"
Returns the inventory element for the base directory.
.Sp
The root entry always has the following properties:
.Sp
.Vb 8
\&    $root = {
\&        category => TREE,       # if {arch} exists, SOURCE otherwise
\&        untagged => 1,
\&        type     => DIRECTORY,
\&        path     => \*(Aq\*(Aq,
\&        id       => undef,
\&        children => { ... },
\&    }
.Ve
.IP "\fBget_entry\fR \fI\f(CI$path\fI\fR" 4
.IX Item "get_entry $path"
.PD 0
.IP "\fBget_entry\fR \fI\f(CI@path_elements\fI\fR" 4
.IX Item "get_entry @path_elements"
.PD
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.
.Sp
If the element does not exist \f(CW\*(C`undef\*(C'\fR is returned.
.Sp
Using an empty or no path is equivalent to calling \fBget_root_entry\fR.
.IP "\fBget_listing\fR" 4
.IX Item "get_listing"
Generates a textual inventory listing equivalent to the output of
.Sp
.Vb 1
\&    tla inventory \-tspbju \-B \-\-kind \-\-ids \-\-untagged
.Ve
.Sp
\&\fBNote:\fR 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.
.IP "\fBannotate_fs\fR" 4
.IX Item "annotate_fs"
.PD 0
.IP "\fBannotate_fs\fR \fI\f(CI$entry\fI\fR" 4
.IX Item "annotate_fs $entry"
.PD
Add filesystem information to \fI\f(CI$entry\fI\fR or every inventory entry if
none is provided. This adds the fields \fBstat\fR and \fBsymlink\fR to the
annotated entries which contain the output of \fBlstat\fR and \fBreadlink\fR
respectively.
.IP "\fBforeach\fR \fI\f(CI$coderef\fI\fR" 4
.IX Item "foreach $coderef"
Execute \fI\f(CI$coderef\fI\fR for every inventory entry, passing the entry as \f(CW$_\fR[0].
.IP "\fBdump\fR" 4
.IX Item "dump"
Generates a dump of the inventory structure using Data::Dumper.
.IP "\fBto_string\fR \fI\f(CI$inventory_element\fI\fR" 4
.IX Item "to_string $inventory_element"
Generates an inventory line for the inventory element as produced by tla.
.SH "BUGS"
.IX Header "BUGS"
Awaiting for your reports.
.SH "AUTHORS"
.IX Header "AUTHORS"
Mikhael Goikhman (migo@homemail.com\*(--Perl\-GPL/arch\-perl\*(--devel).
.PP
Enno Cramer (uebergeek@web.de\-\-2003/arch\-perl\*(--devel).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
For more information, see tla, Arch::Util.