2 * lock.h: routines for diffing local files and directories.
4 * ====================================================================
5 * Licensed to the Apache Software Foundation (ASF) under one
6 * or more contributor license agreements. See the NOTICE file
7 * distributed with this work for additional information
8 * regarding copyright ownership. The ASF licenses this file
9 * to you under the Apache License, Version 2.0 (the
10 * "License"); you may not use this file except in compliance
11 * with the License. You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing,
16 * software distributed under the License is distributed on an
17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18 * KIND, either express or implied. See the License for the
19 * specific language governing permissions and limitations
21 * ====================================================================
24 #ifndef SVN_LIBSVN_WC_DIFF_H
25 #define SVN_LIBSVN_WC_DIFF_H
27 #include <apr_pools.h>
30 #include "svn_types.h"
31 #include "svn_error.h"
35 #include "private/svn_diff_tree.h"
39 #endif /* __cplusplus */
41 /* A function to diff locally added and locally copied files.
43 Reports the file LOCAL_ABSPATH as ADDED file with relpath RELPATH to
44 PROCESSOR with as parent baton PROCESSOR_PARENT_BATON.
46 The node is expected to have status svn_wc__db_status_normal, or
47 svn_wc__db_status_added. When DIFF_PRISTINE is TRUE, report the pristine
48 version of LOCAL_ABSPATH as ADDED. In this case an
49 svn_wc__db_status_deleted may shadow an added or deleted node.
52 svn_wc__diff_local_only_file(svn_wc__db_t *db,
53 const char *local_abspath,
55 const svn_diff_tree_processor_t *processor,
56 void *processor_parent_baton,
57 svn_boolean_t diff_pristine,
58 svn_cancel_func_t cancel_func,
60 apr_pool_t *scratch_pool);
62 /* A function to diff locally added and locally copied directories.
64 Reports the directory LOCAL_ABSPATH and everything below it (limited by
65 DEPTH) as added with relpath RELPATH to PROCESSOR with as parent baton
66 PROCESSOR_PARENT_BATON.
68 The node is expected to have status svn_wc__db_status_normal, or
69 svn_wc__db_status_added. When DIFF_PRISTINE is TRUE, report the pristine
70 version of LOCAL_ABSPATH as ADDED. In this case an
71 svn_wc__db_status_deleted may shadow an added or deleted node.
74 svn_wc__diff_local_only_dir(svn_wc__db_t *db,
75 const char *local_abspath,
78 const svn_diff_tree_processor_t *processor,
79 void *processor_parent_baton,
80 svn_boolean_t diff_pristine,
81 svn_cancel_func_t cancel_func,
83 apr_pool_t *scratch_pool);
85 /* Reports the BASE-file LOCAL_ABSPATH as deleted to PROCESSOR with relpath
86 RELPATH, revision REVISION and parent baton PROCESSOR_PARENT_BATON.
88 If REVISION is invalid, the revision as stored in BASE is used.
90 The node is expected to have status svn_wc__db_status_normal in BASE. */
92 svn_wc__diff_base_only_file(svn_wc__db_t *db,
93 const char *local_abspath,
95 svn_revnum_t revision,
96 const svn_diff_tree_processor_t *processor,
97 void *processor_parent_baton,
98 apr_pool_t *scratch_pool);
100 /* Reports the BASE-directory LOCAL_ABSPATH and everything below it (limited
101 by DEPTH) as deleted to PROCESSOR with relpath RELPATH and parent baton
102 PROCESSOR_PARENT_BATON.
104 If REVISION is invalid, the revision as stored in BASE is used.
106 The node is expected to have status svn_wc__db_status_normal in BASE. */
108 svn_wc__diff_base_only_dir(svn_wc__db_t *db,
109 const char *local_abspath,
111 svn_revnum_t revision,
113 const svn_diff_tree_processor_t *processor,
114 void *processor_parent_baton,
115 svn_cancel_func_t cancel_func,
117 apr_pool_t *scratch_pool);
119 /* Diff the file PATH against the text base of its BASE layer. At this
120 * stage we are dealing with a file that does exist in the working copy.
123 svn_wc__diff_base_working_diff(svn_wc__db_t *db,
124 const char *local_abspath,
126 svn_revnum_t revision,
127 const svn_diff_tree_processor_t *processor,
128 void *processor_dir_baton,
129 svn_boolean_t diff_pristine,
130 svn_cancel_func_t cancel_func,
132 apr_pool_t *scratch_pool);
134 /* Return a tree processor filter that filters by changelist membership.
136 * This filter only passes on the changes for a file if the file's path
137 * (in the WC) is assigned to one of the changelists in @a changelist_hash.
138 * It also passes on the opening and closing of each directory that contains
139 * such a change, and possibly also of other directories, but not addition
140 * or deletion or changes to a directory.
142 * If @a changelist_hash is null then no filtering is performed and the
143 * returned diff processor is driven exactly like the input @a processor.
145 * @a wc_ctx is the WC context and @a root_local_abspath is the WC path of
146 * the root of the diff (for which relpath = "" in the diff processor).
148 * Allocate the returned diff processor in @a result_pool, or if no
149 * filtering is required then the input pointer @a processor itself may be
152 const svn_diff_tree_processor_t *
153 svn_wc__changelist_filter_tree_processor_create(
154 const svn_diff_tree_processor_t *processor,
155 svn_wc_context_t *wc_ctx,
156 const char *root_local_abspath,
157 apr_hash_t *changelist_hash,
158 apr_pool_t *result_pool);
163 #endif /* __cplusplus */
165 #endif /* SVN_LIBSVN_WC_DIFF_H */