.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "native::Delta 3perl"
.TH native::Delta 3perl 2024-04-07 "perl v5.38.2" "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
SVN::Delta \- Subversion delta functions
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&    require SVN::Core;
\&    require SVN::Repos;
\&    require SVN::Delta;
\&
\&    # driving an editor
\&    my $editor = SVN::Delta::Editor\->
\&        new(SVN::Repos::get_commit_editor($repos, "file://$repospath",
\&                                          \*(Aq/\*(Aq, \*(Aqroot\*(Aq, \*(AqFOO\*(Aq, \e&committed));
\&
\&    my $rootbaton = $editor\->open_root(0);
\&
\&    my $fbaton = $editor\->add_file(\*(Aqfilea\*(Aq, $rootbaton,
\&                                   undef, \-1);
\&
\&    my $ret = $editor\->apply_textdelta($fbaton, undef);
\&    SVN::TxDelta::send_string("FILEA CONTENT", @$ret);
\&
\&    # implement an editor in perl
\&    SVN::Repos::dir_delta($root1, $path, undef,
\&                          $root2, $path,
\&                          SVN::Delta::Editor\->new(_debug=>1),
\&                          1, 1, 0, 1
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
SVN::Delta wraps delta related function in subversion. The most
important one is SVN::Delta::Editor, the interface for describing tree
deltas. by default SVN::Delta::Editor relays method calls to its
internal member \f(CW\*(C`_editor\*(C'\fR, which could either be an editor in C (such
as the one you get from get_commit_editor), or another
SVN::Delta::Editor object.
.SH SVN::Delta::Editor
.IX Header "SVN::Delta::Editor"
.SS "Driving Editors"
.IX Subsection "Driving Editors"
If you want to drive a native editor (such as commit_editor obtained
by SVN::Repos::get_commit_editor), create a SVN::Delta::Editor object
with the native editor/baton pair. The object will then be ready to
use and its method calls will be relayed to the native editor.
.SS "Implementing Editors"
.IX Subsection "Implementing Editors"
If you want to implement an editor, subclass SVN::Delta::Editor and
implement the editors callbacks. see the METHODS section below.
.SS "CONSTRUCTOR \- new(...)"
.IX Subsection "CONSTRUCTOR - new(...)"
.ie n .IP "new($editor, $editor_baton)" 4
.el .IP "new($editor, \f(CW$editor_baton\fR)" 4
.IX Item "new($editor, $editor_baton)"
Link to the native editor
.PP
You can also pass a hash array to new:
.IP _debug 4
.IX Item "_debug"
Turn on debug.
.IP _editor 4
.IX Item "_editor"
An arrayref of the editor/baton pair or another SVN::Delta::Editor
object to link with.
.SS METHODS
.IX Subsection "METHODS"
Please consult the svn_delta.h section in the Subversion API. Member
functions of svn_delta_editor_t could be called as methods of
SVN::Delta::Editor objects, with the edit_baton omitted. The pool is
also optional.
.PP
If you are subclassing, the methods take exactly the same arguments as
the member functions (note that void ** are returned data though as
throughout the perl bindings), with the edit_baton omitted.
.SH BUGS
.IX Header "BUGS"
Functions returning editor/baton pair should really be typemapped to a
SVN::Delta::Editor object.
.SH AUTHORS
.IX Header "AUTHORS"
Chia-liang Kao <clkao@clkao.org>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
.Vb 7
\&    Licensed to the Apache Software Foundation (ASF) under one
\&    or more contributor license agreements.  See the NOTICE file
\&    distributed with this work for additional information
\&    regarding copyright ownership.  The ASF licenses this file
\&    to you under the Apache License, Version 2.0 (the
\&    "License"); you may not use this file except in compliance
\&    with the License.  You may obtain a copy of the License at
\&
\&      http://www.apache.org/licenses/LICENSE\-2.0
\&
\&    Unless required by applicable law or agreed to in writing,
\&    software distributed under the License is distributed on an
\&    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
\&    KIND, either express or implied.  See the License for the
\&    specific language governing permissions and limitations
\&    under the License.
.Ve