dump_editor.h

   1 /**
   2  * @copyright
   3  * ====================================================================
   4  *    Licensed to the Apache Software Foundation (ASF) under one
   5  *    or more contributor license agreements.  See the NOTICE file
   6  *    distributed with this work for additional information
   7  *    regarding copyright ownership.  The ASF licenses this file
   8  *    to you under the Apache License, Version 2.0 (the
   9  *    "License"); you may not use this file except in compliance
  10  *    with the License.  You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  *    Unless required by applicable law or agreed to in writing,
  15  *    software distributed under the License is distributed on an
  16  *    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  17  *    KIND, either express or implied.  See the License for the
  18  *    specific language governing permissions and limitations
  19  *    under the License.
  20  * ====================================================================
  21  * @endcopyright
  22  *
  23  * @file dump_editor.h
  24  * @brief The svn_delta_editor_t editor used by svnrdump to dump
  25  * revisions.
  26  */
  27
  28 #ifndef DUMP_EDITOR_H_
  29 #define DUMP_EDITOR_H_
  30
  31 /**
  32  * A directory baton used by all directory-related callback functions
  33  * in the dump editor.
  34  */
  35 struct dir_baton
  36 {
  37   struct dump_edit_baton *eb;
  38   struct dir_baton *parent_dir_baton;
  39
  40   /* is this directory a new addition to this revision? */
  41   svn_boolean_t added;
  42
  43   /* has this directory been written to the output stream? */
  44   svn_boolean_t written_out;
  45
  46   /* the absolute path to this directory */
  47   const char *abspath;
  48
  49   /* Copyfrom info for the node, if any */
  50   const char *copyfrom_path;
  51   svn_revnum_t copyfrom_rev;
  52
  53   /* Hash of paths that need to be deleted, though some -might- be
  54      replaced.  Maps const char * paths to this dir_baton. Note that
  55      they're full paths, because that's what the editor driver gives
  56      us, although they're all really within this directory. */
  57   apr_hash_t *deleted_entries;
  58 };
  59
  60 /**
  61  * A handler baton to be used in window_handler().
  62  */
  63 struct handler_baton
  64 {
  65   svn_txdelta_window_handler_t apply_handler;
  66   void *apply_baton;
  67 };
  68
  69 /**
  70  * Get a dump editor @a editor along with a @a edit_baton allocated in
  71  * @a pool.  The editor will write output to @a stream.  Use @a
  72  * cancel_func and @a cancel_baton to check for user cancellation of
  73  * the operation (for timely-but-safe termination).
  74  */
  75 svn_error_t *
  76 get_dump_editor(const svn_delta_editor_t **editor,
  77                 void **edit_baton,
  78                 svn_stream_t *stream,
  79                 svn_cancel_func_t cancel_func,
  80                 void *cancel_baton,
  81                 apr_pool_t *pool);
  82
  83 /**
  84  * Normalize the line ending style of the values of properties in @a
  85  * rev_props using @a pool for memory allocation.
  86  */
  87 svn_error_t *
  88 normalize_props(apr_hash_t *props,
  89                 apr_pool_t *pool);
  90
  91 #endif