svn::simple::edit(3) [suse man page]

SVN::Simple::Edit(3)					User Contributed Perl Documentation				      SVN::Simple::Edit(3)

NAME

       SVN::Simple::Edit - A simple interface for driving svn delta editors

SYNOPSIS

	my $edit = SVN::Simple::Edit->new
	   (_editor => [SVN::Repos::get_commit_editor($repos, "file://$repospath",
					     '/', 'root', 'FOO', &committed)],
	   );

	$edit->open_root($fs->youngest_rev);
	$edit->add_directory ('trunk');
	$edit->add_file ('trunk/filea');
	$edit->modify_file ("trunk/fileb", "content", $checksum);
	$edit->delete_entry ("trunk/filec");
	$edit->close_edit ();
	...
	$edit->copy_directory ('branches/a, trunk, 0);

DESCRIPTION

       SVN::Simple::Edit wraps the subversion delta editor with a perl friendly interface and then you could easily drive it for describing
       changes to a tree. A common usage is to wrap the commit editor, so you could make commits to a subversion repository easily.

       This also means you can not supply the $edit object as an delta_editor to other API, and that's why this module is named ::Edit instead of
       ::Editor.

       See SVN::Simple::Editor for simple interface implementing a delta editor.

PARAMETERS

   for constructor
       _editor
	   The editor that will receive delta editor calls.

       missing_handler
	   Called when parent directory are not opened yet, could be:

	   &SVN::Simple::Edit::build_missing
	       Always build parents if you don't open them explicitly.

	   &SVN::Simple::Edit::open_missing
	       Always open the parents if you don't create them explicitly.

	   SVN::Simple::Edit::check_missing ([$root])
	       Check if the path exists on $root. Open it if so, otherwise create it.

       root
	   The default root to use by SVN::Simple::Edit::check_missing.

       base_path
	   The base path the edit object is created to send delta editor calls.

       noclose
	   Do not close files or directories. This might make non-sorted operations on directories/files work.

METHODS

       Note: Don't expect all editors will work with operations not sorted in DFS order.

       open_root ($base_rev)
       add_directory ($path)
       open_directory ($path)
       copy_directory ($path, $from, $fromrev)
       add_file ($path)
       open_file ($path)
       copy_file ($path, $from, $fromrev)
       delete_entry ($path)
       change_dir_prop ($path, $propname, $propvalue)
       change_file_prop ($path, $propname, $propvalue)
       close_edit ()

AUTHORS

       Chia-liang Kao <clkao@clkao.org>

COPYRIGHT

       Copyright 2003-2004 by Chia-liang Kao <clkao@clkao.org>.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

       See <http://www.perl.com/perl/misc/Artistic.html>

perl v5.12.1							    2005-02-23						      SVN::Simple::Edit(3)

native::Delta(3)					User Contributed Perl Documentation					  native::Delta(3)

NAME

       SVN::Delta - Subversion delta functions

SYNOPSIS

	   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",
						 '/', 'root', 'FOO', &committed));

	   my $rootbaton = $editor->open_root(0);

	   my $fbaton = $editor->add_file ('filea', $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

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 "_editor", which could either be an editor in C (such as
       the one you get from get_commit_editor), or another SVN::Delta::Editor object.

SVN
::Delta::Editor
       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.

       Implementing Editors

       If you want to implement an editor, subclass SVN::Delta::Editor and implement the editors callbacks. see the METHODS section below.

       CONSTRUCTOR - new (...)

       new ($editor, $editor_baton)
	   Link to the native editor

       You can also pass a hash array to new:

       _debug
	   Turn on debug.

       _editor
	   An arrayref of the editor/baton pair or another SVN::Delta::Editor object to link with.

       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.

       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.

BUGS

       Functions returning editor/baton pair should really be typemapped to a SVN::Delta::Editor object.

AUTHORS

       Chia-liang Kao <clkao@clkao.org>

COPYRIGHT

       Copyright (c) 2003 CollabNet.  All rights reserved.

       This software is licensed as described in the file COPYING, which you should have received as part of this distribution.  The terms are
       also available at http://subversion.tigris.org/license-1.html.  If newer versions of this license are posted there, you may use a newer
       version instead, at your option.

       This software consists of voluntary contributions made by many individuals.  For exact contribution history, see the revision history and
       logs, available at http://subversion.tigris.org/.

perl v5.10.0							    2005-10-24							  native::Delta(3)