.\" 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::Changes 3pm"
.TH Arch::Changes 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::Changes \- class representing a list of changes
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Arch::Changes qw(:type);
\&
\&    use Arch::Tree;
\&    my $changes = $tree\->get_changes;
\&    print $changes\->get_listing;
\&
\&    use Arch::Log;
\&    my $changed = $log\->get_changes\->is_changed(\*(Aqto\*(Aq, "COPYING");
\&    die "License was compromised" if $changed && $changed\->{&MODIFY};
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Arch::Changes contains a list of elements, each representing a single
tree change. Each change element is described by a hash with the
following fields:
.IP "\fBtype\fR" 4
.IX Item "type"
The type of the change. Can be one of \fB\s-1ADD\s0\fR, \fB\s-1DELETE\s0\fR, \fB\s-1MODIFY\s0\fR,
\&\fB\s-1META_MODIFY\s0\fR or \fB\s-1RENAME\s0\fR.
.IP "\fBis_dir\fR" 4
.IX Item "is_dir"
A boolean value indicating whether the affected tree element is a
directory.
.IP "\fBarguments\fR" 4
.IX Item "arguments"
A list of arguments. The first element is always relative path of the
affected tree element. For changes of type \fB\s-1RENAME\s0\fR the first
argument is the old path and the second argument the new path name.
.PP
The type constants can be conveniently imported using the tag \f(CW\*(C`:type\*(C'\fR.
.PP
.Vb 1
\&    use Arch::Changes qw(:type);
.Ve
.SH "METHODS"
.IX Header "METHODS"
The following methods are available:
.PP
\&\fBnew\fR,
\&\fBadd\fR,
\&\fBcount\fR,
\&\fBget\fR,
\&\fBget_listing\fR,
\&\fBis_changed\fR,
\&\fBdump\fR,
\&\fBtype_string\fR,
\&\fBto_string\fR.
.IP "\fBnew\fR" 4
.IX Item "new"
Creates a new, initially empty, changes list.
.Sp
Typically it is called indirectly from method \fBget_changes\fR in
Arch::Changeset, Arch::Tree or Arch::Log class.
.IP "\fBadd\fR \fItype\fR \fIis_dir\fR \fIarguments...\fR" 4
.IX Item "add type is_dir arguments..."
Adds a new change element to the list of changes.
.Sp
Typically it is called indirectly from method \fBget_changes\fR in
Arch::Changeset, Arch::Tree or Arch::Log class.
.IP "\fBcount\fR" 4
.IX Item "count"
Returns the number of change elements.
.IP "\fBget\fR \fInum\fR" 4
.IX Item "get num"
Returns the \fInum\fR\-th change element or all if \fInum\fR is undefined.
.IP "\fBget_listing\fR" 4
.IX Item "get_listing"
Generates a textual changes listing as produced by \f(CW\*(C`tla changes\*(C'\fR.
.IP "\fBis_changed\fR \fIto\fR \fIfilepath\fR [\fIis_dir\fR]" 4
.IX Item "is_changed to filepath [is_dir]"
Verify whether the given \fIfilepath\fR is modified by the changes. The \fIto\fR
parameter may get boolean values \*(L"0\*(R", \*(L"1\*(R", \*(L"from\*(R" or \*(L"to\*(R", it only affects
\&\fB\s-1RENAME\s0\fR changes, and in some sense \fB\s-1ADD\s0\fR and \fB\s-1DELETE\s0\fR changes. If \fIto\fR
is set, then the given \fIfilepath\fR is taken as the destination of \fB\s-1RENAME\s0\fR
or \fB\s-1ADD\s0\fR, otherwise as the source of \fB\s-1RENAME\s0\fR or \fB\s-1DELETE\s0\fR. The \fB\s-1MODIFY\s0\fR
and \fB\s-1META_MODIFY\s0\fR changes are not affected, since the destination and the
source is the same file/dir.
.Sp
If \fIfilepath\fR is not modified by any changes, return undef.
.Sp
Otherwise, return hash with possible keys \fB\s-1ADD\s0\fR, \fB\s-1DELETE\s0\fR, \fB\s-1MODIFY\s0\fR,
\&\fB\s-1META_MODIFY\s0\fR and \fB\s-1RENAME\s0\fR. The hash values are 1 in all cases except for
\&\fB\s-1RENAME\s0\fR, then the value is the file name on the opposite side (i.e.,
the source of \fB\s-1RENAME\s0\fR if \fIto\fR is true, and the destination if false).
.Sp
Note, the valid return values for arch are: undef, hashref with one key
(\fB\s-1ADD\s0\fR or \fB\s-1DELETE\s0\fR) or hashref with combination of one-to-three
keys (\fB\s-1MODIFY\s0\fR, \fB\s-1META_MODIFY\s0\fR and \fB\s-1RENAME\s0\fR).
.IP "\fBdump\fR" 4
.IX Item "dump"
Generates a dump of the changes list using Data::Dumper.
.IP "\fBtype_string\fR \fIchange\fR" 4
.IX Item "type_string change"
Returns the change type string as produced by \f(CW\*(C`tla changes\*(C'\fR.
.IP "\fBto_string\fR \fIchange\fR" 4
.IX Item "to_string change"
Generates a changes line for \fIchange\fR as produced by \f(CW\*(C`tla changes\*(C'\fR.
.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::Changeset, Arch::Tree,
Arch::Log.