include/private/svn_editor.h

240  * receiver's callback. This limitation extends to the cancellation
241  * callback, too. (This limitation is due to the scratch_pool shared by
242  * all callbacks, and cleared after each callback; a reentrant call could
251  *    actual callback functions.  svn_editor_create() sets the
252  *    #svn_editor_t's callback baton and scratch pool that the callback
253  *    functions receive, as well as a cancellation callback and baton
282  *    The driver invokes the #svn_editor_t instance's callback functions
298  *    Just before each callback invocation is carried out, the @a cancel_func
302  *    aborts the transmission by invoking the svn_editor_abort() callback.
307  *    receiver finds its callback functions called with the information
308  *    to operate on its tree. Each actual callback function receives those
311  *       svn_editor_create().  It may be freely used by the callback
314  *       each callback returns.  See "Pool Usage".
316  *    If the receiver encounters an error within a callback, it returns an
325  * In order to reduce complexity of callback receivers, the editor callbacks
383  * - If any callback invocation (besides svn_editor_complete()) returns
395  * incomplete until later callback calls are received.
441  * The @a scratch_pool passed to each callback invocation is derived from
443  * cleared directly after each single callback invocation.
444  * To allocate memory with a longer lifetime from within a callback
455  * polled every time the driver invokes a callback, just before the
456  * actual editor callback implementation is invoked.  If this function
458  * as if the callback function had returned it, i.e. as the result from
484 /** These function types define the callback functions a tree delta consumer
504  * @defgroup svn_editor_callbacks Editor callback definitions
644  * this is NOT the same @a scratch_pool that is passed to callback functions.
668 /** Sets the #svn_editor_cb_add_directory_t callback in @a editor
669  * to @a callback.
676                                svn_editor_cb_add_directory_t callback,
679 /** Sets the #svn_editor_cb_add_file_t callback in @a editor
680  * to @a callback.
687                           svn_editor_cb_add_file_t callback,
690 /** Sets the #svn_editor_cb_add_symlink_t callback in @a editor
691  * to @a callback.
698                              svn_editor_cb_add_symlink_t callback,
701 /** Sets the #svn_editor_cb_add_absent_t callback in @a editor
702  * to @a callback.
709                             svn_editor_cb_add_absent_t callback,
712 /** Sets the #svn_editor_cb_alter_directory_t callback in @a editor
713  * to @a callback.
720                                  svn_editor_cb_alter_directory_t callback,
723 /** Sets the #svn_editor_cb_alter_file_t callback in @a editor
724  * to @a callback.
731                             svn_editor_cb_alter_file_t callback,
734 /** Sets the #svn_editor_cb_alter_symlink_t callback in @a editor
735  * to @a callback.
742                                svn_editor_cb_alter_symlink_t callback,
745 /** Sets the #svn_editor_cb_delete_t callback in @a editor
746  * to @a callback.
753                         svn_editor_cb_delete_t callback,
756 /** Sets the #svn_editor_cb_copy_t callback in @a editor
757  * to @a callback.
764                       svn_editor_cb_copy_t callback,
767 /** Sets the #svn_editor_cb_move_t callback in @a editor
768  * to @a callback.
775                       svn_editor_cb_move_t callback,
778 /** Sets the #svn_editor_cb_complete_t callback in @a editor
779  * to @a callback.
786                           svn_editor_cb_complete_t callback,
789 /** Sets the #svn_editor_cb_abort_t callback in @a editor
790  * to @a callback.
797                        svn_editor_cb_abort_t callback,
823 /** Sets all the callback functions in @a editor at once, according to the
824  * callback functions stored in @a many.
844 /** Drive @a editor's #svn_editor_cb_add_directory_t callback.
867 /** Drive @a editor's #svn_editor_cb_add_file_t callback.
899 /** Drive @a editor's #svn_editor_cb_add_symlink_t callback.
917 /** Drive @a editor's #svn_editor_cb_add_absent_t callback.
935 /** Drive @a editor's #svn_editor_cb_alter_directory_t callback.
969 /** Drive @a editor's #svn_editor_cb_alter_file_t callback.
1000 /** Drive @a editor's #svn_editor_cb_alter_symlink_t callback.
1026 /** Drive @a editor's #svn_editor_cb_delete_t callback.
1039 /** Drive @a editor's #svn_editor_cb_copy_t callback.
1061 /** Drive @a editor's #svn_editor_cb_move_t callback.
1086 /** Drive @a editor's #svn_editor_cb_complete_t callback.
1096 /** Drive @a editor's #svn_editor_cb_abort_t callback.