Subversion
Loading...
Searching...
No Matches
svn_wc.h
Go to the documentation of this file.
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 svn_wc.h
24 * @brief Subversion's working copy library
25 *
26 * Requires:
27 * - A working copy
28 *
29 * Provides:
30 * - Ability to manipulate working copy's versioned data.
31 * - Ability to manipulate working copy's administrative files.
32 *
33 * Used By:
34 * - Clients.
35 *
36 * Notes:
37 * The 'path' parameters to most of the older functions can be
38 * absolute or relative (relative to current working
39 * directory). If there are any cases where they are
40 * relative to the path associated with the
41 * 'svn_wc_adm_access_t *adm_access' baton passed along with the
42 * path, those cases should be explicitly documented, and if they
43 * are not, please fix it. All new functions introduced since
44 * Subversion 1.7 require absolute paths, unless explicitly
45 * documented otherwise.
46 *
47 * Starting with Subversion 1.7, several arguments are re-ordered
48 * to be more consistent through the api. The common ordering used
49 * is:
50 *
51 * Firsts:
52 * - Output arguments
53 * Then:
54 * - Working copy context
55 * - Local abspath
56 * Followed by:
57 * - Function specific arguments
58 * - Specific callbacks with their batons
59 * Finally:
60 * - Generic callbacks (with baton) from directly functional to
61 * just observing:
62 * - svn_wc_conflict_resolver_func2_t
63 * - svn_wc_external_update_t
64 * - svn_cancel_func_t
65 * - svn_wc_notify_func2_t
66 * - Result pool
67 * - Scratch pool.
68 */
69
70#ifndef SVN_WC_H
71#define SVN_WC_H
72
73#include <apr.h>
74#include <apr_pools.h>
75#include <apr_tables.h>
76#include <apr_hash.h>
77#include <apr_time.h>
78#include <apr_file_io.h>
79
80#include "svn_types.h"
81#include "svn_string.h"
82#include "svn_checksum.h"
83#include "svn_io.h"
84#include "svn_delta.h" /* for svn_stream_t */
85#include "svn_opt.h"
86#include "svn_ra.h" /* for svn_ra_reporter_t type */
87
88#ifdef __cplusplus
89extern "C" {
90#endif /* __cplusplus */
91
92␌
93/**
94 * Get libsvn_wc version information.
95 *
96 * @since New in 1.1.
97 */
98const svn_version_t *
100
101
102/**
103 * @defgroup svn_wc Working copy management
104 * @{
105 */
106
107
108/** Flags for use with svn_wc_translated_file2() and svn_wc_translated_stream().
109 *
110 * @defgroup translate_flags Translation flags
111 * @{
112 */
113
114 /** Translate from Normal Form.
115 *
116 * The working copy text bases and repository files are stored
117 * in normal form. Some files' contents - or ever representation -
118 * differs between the working copy and the normal form. This flag
119 * specifies to take the latter form as input and transform it
120 * to the former.
121 *
122 * Either this flag or #SVN_WC_TRANSLATE_TO_NF should be specified,
123 * but not both.
124 */
125#define SVN_WC_TRANSLATE_FROM_NF 0x00000000
126
127 /** Translate to Normal Form.
128 *
129 * Either this flag or #SVN_WC_TRANSLATE_FROM_NF should be specified,
130 * but not both.
131 */
132#define SVN_WC_TRANSLATE_TO_NF 0x00000001
133
134 /** Force repair of eol styles, making sure the output file consistently
135 * contains the one eol style as specified by the svn:eol-style
136 * property and the required translation direction.
137 *
138 */
139#define SVN_WC_TRANSLATE_FORCE_EOL_REPAIR 0x00000002
140
141 /** Don't register a pool cleanup to delete the output file */
142#define SVN_WC_TRANSLATE_NO_OUTPUT_CLEANUP 0x00000004
143
144 /** Guarantee a new file is created on successful return.
145 * The default shortcuts translation by returning the path
146 * of the untranslated file when no translation is required.
147 */
148#define SVN_WC_TRANSLATE_FORCE_COPY 0x00000008
149
150 /** Use a non-wc-local tmp directory for creating output files,
151 * instead of in the working copy admin tmp area which is the default.
152 *
153 * @since New in 1.4.
154 */
155#define SVN_WC_TRANSLATE_USE_GLOBAL_TMP 0x00000010
156
157/** @} */
158
159
160/**
161 * @defgroup svn_wc_context Working copy context
162 * @{
163 */
164
165/** The context for all working copy interactions.
166 *
167 * This is the client-facing datastructure API consumers are required
168 * to create and use when interacting with a working copy. Multiple
169 * contexts can be created for the same working copy simultaneously, within
170 * the same process or different processes. Context mutexing will be handled
171 * internally by the working copy library.
172 *
173 * @note: #svn_wc_context_t should be passed by non-const pointer in all
174 * APIs, even for read-only operations, as it contains mutable data (caching,
175 * etc.).
176 *
177 * @since New in 1.7.
178 */
180
181/** Create a context for the working copy, and return it in @a *wc_ctx. This
182 * context is not associated with a particular working copy, but as operations
183 * are performed, will load the appropriate working copy information.
184 *
185 * @a config should hold the various configuration options that may apply to
186 * this context. It should live at least as long as @a result_pool. It may
187 * be @c NULL.
188 *
189 * The context will be allocated in @a result_pool, and will use @a
190 * result_pool for any internal allocations requiring the same longevity as
191 * the context. The context will be automatically destroyed, and its
192 * resources released, when @a result_pool is cleared, or it may be manually
193 * destroyed by invoking svn_wc_context_destroy().
194 *
195 * Use @a scratch_pool for temporary allocations. It may be cleared
196 * immediately upon returning from this function.
197 *
198 * @since New in 1.7.
199 */
202 const svn_config_t *config,
203 apr_pool_t *result_pool,
204 apr_pool_t *scratch_pool);
205
206
207/** Destroy the working copy context described by @a wc_ctx, releasing any
208 * acquired resources.
209 *
210 * @since New in 1.7.
211 */
214
215
216/** @} */
217
218
219/**
220 * Locking/Opening/Closing using adm access batons.
221 *
222 * @defgroup svn_wc_adm_access Adm access batons (deprecated)
223 * @{
224 */
225
226/** Baton for access to a working copy administrative area.
227 *
228 * Access batons can be grouped into sets, by passing an existing open
229 * baton when opening a new baton. Given one baton in a set, other batons
230 * may be retrieved. This allows an entire hierarchy to be locked, and
231 * then the set of batons can be passed around by passing a single baton.
232 *
233 * @deprecated Provided for backward compatibility with the 1.6 API.
234 * New code should use a #svn_wc_context_t object to access the working
235 * copy.
236 */
238
239
240/**
241 * Return, in @a *adm_access, a pointer to a new access baton for the working
242 * copy administrative area associated with the directory @a path. If
243 * @a write_lock is TRUE the baton will include a write lock, otherwise the
244 * baton can only be used for read access. If @a path refers to a directory
245 * that is already write locked then the error #SVN_ERR_WC_LOCKED will be
246 * returned. The error #SVN_ERR_WC_NOT_DIRECTORY will be returned if
247 * @a path is not a versioned directory.
248 *
249 * If @a associated is an open access baton then @a adm_access will be added
250 * to the set containing @a associated. @a associated can be @c NULL, in
251 * which case @a adm_access is the start of a new set.
252 *
253 * @a levels_to_lock specifies how far to lock. Zero means just the specified
254 * directory. Any negative value means to lock the entire working copy
255 * directory hierarchy under @a path. A positive value indicates the number of
256 * levels of directories to lock -- 1 means just immediate subdirectories, 2
257 * means immediate subdirectories and their subdirectories, etc. All the
258 * access batons will become part of the set containing @a adm_access. This
259 * is an all-or-nothing option, if it is not possible to lock all the
260 * requested directories then an error will be returned and @a adm_access will
261 * be invalid, with the exception that subdirectories of @a path that are
262 * missing from the physical filesystem will not be locked and will not cause
263 * an error. The error #SVN_ERR_WC_LOCKED will be returned if a
264 * subdirectory of @a path is already write locked.
265 *
266 * If @a cancel_func is non-NULL, call it with @a cancel_baton to determine
267 * if the client has canceled the operation.
268 *
269 * @a pool will be used to allocate memory for the baton and any subsequently
270 * cached items. If @a adm_access has not been closed when the pool is
271 * cleared, it will be closed automatically at that point, and removed from
272 * its set. A baton closed in this way will not remove physical locks from
273 * the working copy if cleanup is required.
274 *
275 * The first baton in a set, with @a associated passed as @c NULL, must have
276 * the longest lifetime of all the batons in the set. This implies it must be
277 * the root of the hierarchy.
278 *
279 * @since New in 1.2.
280 * @deprecated Provided for backward compatibility with the 1.6 API.
281 * Callers should use a #svn_wc_context_t object to access the working
282 * copy.
283 */
287 svn_wc_adm_access_t *associated,
288 const char *path,
289 svn_boolean_t write_lock,
290 int levels_to_lock,
291 svn_cancel_func_t cancel_func,
292 void *cancel_baton,
293 apr_pool_t *pool);
294
295/**
296 * Similar to svn_wc_adm_open3(), but without cancellation support.
297 *
298 * @deprecated Provided for backward compatibility with the 1.1 API.
299 */
303 svn_wc_adm_access_t *associated,
304 const char *path,
305 svn_boolean_t write_lock,
306 int levels_to_lock,
307 apr_pool_t *pool);
308
309/**
310 * Similar to svn_wc_adm_open2(), but with @a tree_lock instead of
311 * @a levels_to_lock. @a levels_to_lock is set to -1 if @a tree_lock
312 * is @c TRUE, else 0.
313 *
314 * @deprecated Provided for backward compatibility with the 1.0 API.
315 */
319 svn_wc_adm_access_t *associated,
320 const char *path,
321 svn_boolean_t write_lock,
322 svn_boolean_t tree_lock,
323 apr_pool_t *pool);
324
325/**
326 * Checks the working copy to determine the node type of @a path. If
327 * @a path is a versioned directory then the behaviour is like that of
328 * svn_wc_adm_open3(), otherwise, if @a path is a file or does not
329 * exist, then the behaviour is like that of svn_wc_adm_open3() with
330 * @a path replaced by the parent directory of @a path. If @a path is
331 * an unversioned directory, the behaviour is also like that of
332 * svn_wc_adm_open3() on the parent, except that if the open fails,
333 * then the returned #SVN_ERR_WC_NOT_DIRECTORY error refers to @a path,
334 * not to @a path's parent.
335 *
336 * @since New in 1.2.
337 * @deprecated Provided for backward compatibility with the 1.6 API.
338 * Callers should use a #svn_wc_context_t object to access the working
339 * copy.
340 */
344 svn_wc_adm_access_t *associated,
345 const char *path,
346 svn_boolean_t write_lock,
347 int levels_to_lock,
348 svn_cancel_func_t cancel_func,
349 void *cancel_baton,
350 apr_pool_t *pool);
351
352/**
353 * Similar to svn_wc_adm_probe_open3() without the cancel
354 * functionality.
355 *
356 * @deprecated Provided for backward compatibility with the 1.1 API.
357 */
361 svn_wc_adm_access_t *associated,
362 const char *path,
363 svn_boolean_t write_lock,
364 int levels_to_lock,
365 apr_pool_t *pool);
366
367/**
368 * Similar to svn_wc_adm_probe_open2(), but with @a tree_lock instead of
369 * @a levels_to_lock. @a levels_to_lock is set to -1 if @a tree_lock
370 * is @c TRUE, else 0.
371 *
372 * @deprecated Provided for backward compatibility with the 1.0 API.
373 */
377 svn_wc_adm_access_t *associated,
378 const char *path,
379 svn_boolean_t write_lock,
380 svn_boolean_t tree_lock,
381 apr_pool_t *pool);
382
383/**
384 * Open access batons for @a path and return in @a *anchor_access and
385 * @a *target the anchor and target required to drive an editor. Return
386 * in @a *target_access the access baton for the target, which may be the
387 * same as @a *anchor_access (in which case @a *target is the empty
388 * string, never NULL). All the access batons will be in the
389 * @a *anchor_access set.
390 *
391 * @a levels_to_lock determines the levels_to_lock used when opening
392 * @a path if @a path is a versioned directory, @a levels_to_lock is
393 * ignored otherwise. If @a write_lock is @c TRUE the access batons
394 * will hold write locks.
395 *
396 * If @a cancel_func is non-NULL, call it with @a cancel_baton to determine
397 * if the client has canceled the operation.
398 *
399 * This function is essentially a combination of svn_wc_adm_open3() and
400 * svn_wc_get_actual_target(), with the emphasis on reducing physical IO.
401 *
402 * @since New in 1.2.
403 * @deprecated Provided for backward compatibility with the 1.6 API.
404 * Callers should use a #svn_wc_context_t object to access the working
405 * copy.
406 */
410 svn_wc_adm_access_t **target_access,
411 const char **target,
412 const char *path,
413 svn_boolean_t write_lock,
414 int levels_to_lock,
415 svn_cancel_func_t cancel_func,
416 void *cancel_baton,
417 apr_pool_t *pool);
418
419/** Return, in @a *adm_access, a pointer to an existing access baton associated
420 * with @a path. @a path must be a directory that is locked as part of the
421 * set containing the @a associated access baton.
422 *
423 * If the requested access baton is marked as missing in, or is simply
424 * absent from, @a associated, return #SVN_ERR_WC_NOT_LOCKED.
425 *
426 * @a pool is used only for local processing, it is not used for the batons.
427 *
428 * @deprecated Provided for backward compatibility with the 1.6 API.
429 */
433 svn_wc_adm_access_t *associated,
434 const char *path,
435 apr_pool_t *pool);
436
437/** Check the working copy to determine the node type of @a path. If
438 * @a path is a versioned directory then the behaviour is like that of
439 * svn_wc_adm_retrieve(), otherwise, if @a path is a file, an unversioned
440 * directory, or does not exist, then the behaviour is like that of
441 * svn_wc_adm_retrieve() with @a path replaced by the parent directory of
442 * @a path.
443 *
444 * @deprecated Provided for backward compatibility with the 1.6 API.
445 */
449 svn_wc_adm_access_t *associated,
450 const char *path,
451 apr_pool_t *pool);
452
453/**
454 * Try various ways to obtain an access baton for @a path.
455 *
456 * First, try to obtain @a *adm_access via svn_wc_adm_probe_retrieve(),
457 * but if this fails because @a associated can't give a baton for
458 * @a path or @a path's parent, then try svn_wc_adm_probe_open3(),
459 * this time passing @a write_lock and @a levels_to_lock. If there is
460 * still no access because @a path is not a versioned directory, then
461 * just set @a *adm_access to NULL and return success. But if it is
462 * because @a path is locked, then return the error #SVN_ERR_WC_LOCKED,
463 * and the effect on @a *adm_access is undefined. (Or if the attempt
464 * fails for any other reason, return the corresponding error, and the
465 * effect on @a *adm_access is also undefined.)
466 *
467 * If svn_wc_adm_probe_open3() succeeds, then add @a *adm_access to
468 * @a associated.
469 *
470 * If @a cancel_func is non-NULL, call it with @a cancel_baton to determine
471 * if the client has canceled the operation.
472 *
473 * Use @a pool only for local processing, not to allocate @a *adm_access.
474 *
475 * @since New in 1.2.
476 * @deprecated Provided for backward compatibility with the 1.6 API.
477 */
481 svn_wc_adm_access_t *associated,
482 const char *path,
483 svn_boolean_t write_lock,
484 int levels_to_lock,
485 svn_cancel_func_t cancel_func,
486 void *cancel_baton,
487 apr_pool_t *pool);
488
489/**
490 * Similar to svn_wc_adm_probe_try3() without the cancel
491 * functionality.
492 *
493 * @deprecated Provided for backward compatibility with the 1.1 API.
494 */
498 svn_wc_adm_access_t *associated,
499 const char *path,
500 svn_boolean_t write_lock,
501 int levels_to_lock,
502 apr_pool_t *pool);
503
504/**
505 * Similar to svn_wc_adm_probe_try2(), but with @a tree_lock instead of
506 * @a levels_to_lock. @a levels_to_lock is set to -1 if @a tree_lock
507 * is @c TRUE, else 0.
508 *
509 * @deprecated Provided for backward compatibility with the 1.0 API.
510 */
514 svn_wc_adm_access_t *associated,
515 const char *path,
516 svn_boolean_t write_lock,
517 svn_boolean_t tree_lock,
518 apr_pool_t *pool);
519
520
521/** Give up the access baton @a adm_access, and its lock if any. This will
522 * recursively close any batons in the same set that are direct
523 * subdirectories of @a adm_access. Any physical locks will be removed from
524 * the working copy. Lock removal is unconditional, there is no check to
525 * determine if cleanup is required.
526 *
527 * Any temporary allocations are performed using @a scratch_pool.
528 *
529 * @since New in 1.6
530 * @deprecated Provided for backward compatibility with the 1.6 API.
531 */
535 apr_pool_t *scratch_pool);
536
537/**
538 * Similar to svn_wc_adm_close2(), but with the internal pool of @a adm_access
539 * used for temporary allocations.
540 *
541 * @deprecated Provided for backward compatibility with the 1.5 API.
542 */
546
547/** Return the path used to open the access baton @a adm_access.
548 *
549 * @deprecated Provided for backward compatibility with the 1.6 API.
550 */
552const char *
554
555/** Return the pool used by access baton @a adm_access.
556 *
557 * @deprecated Provided for backward compatibility with the 1.6 API.
558 */
560apr_pool_t *
562
563/** Return @c TRUE is the access baton @a adm_access has a write lock,
564 * @c FALSE otherwise. Compared to svn_wc_locked() this is a cheap, fast
565 * function that doesn't access the filesystem.
566 *
567 * @deprecated Provided for backward compatibility with the 1.6 API.
568 * New code should use svn_wc_locked2() instead.
569 */
573
574/** @} */
575
576
577/** Gets up to two booleans indicating whether a path is locked for
578 * writing.
579 *
580 * @a locked_here is set to TRUE when a write lock on @a local_abspath
581 * exists in @a wc_ctx. @a locked is set to TRUE when there is a
582 * write_lock on @a local_abspath
583 *
584 * @a locked_here and/or @a locked can be NULL when you are not
585 * interested in a specific value
586 *
587 * @since New in 1.7.
588 */
591 svn_boolean_t *locked,
592 svn_wc_context_t *wc_ctx,
593 const char *local_abspath,
594 apr_pool_t *scratch_pool);
595
596/** Set @a *locked to non-zero if @a path is locked, else set it to zero.
597 *
598 * New code should use svn_wc_locked2() instead.
599 *
600 * @deprecated Provided for backward compatibility with the 1.6 API.
601 */
605 const char *path,
606 apr_pool_t *pool);
607
608
609/**
610 * @defgroup svn_wc_adm_dir_name Name of Subversion's admin dir
611 * @{
612 */
613
614/** The default name of the administrative subdirectory.
615 *
616 * Ideally, this would be completely private to wc internals (in fact,
617 * it used to be that adm_subdir() in adm_files.c was the only function
618 * who knew the adm subdir's name). However, import wants to protect
619 * against importing administrative subdirs, so now the name is a
620 * matter of public record.
621 *
622 * @deprecated Provided for backward compatibility with the 1.2 API.
623 */
624#define SVN_WC_ADM_DIR_NAME ".svn"
625
626
627/**
628 * Return @c TRUE if @a name is the name of the WC administrative
629 * directory. Use @a pool for any temporary allocations. Only works
630 * with base directory names, not paths or URIs.
631 *
632 * For compatibility, the default name (.svn) will always be treated
633 * as an admin dir name, even if the working copy is actually using an
634 * alternative name.
635 *
636 * @since New in 1.3.
637 */
639svn_wc_is_adm_dir(const char *name, apr_pool_t *pool);
640
641
642/**
643 * Return the name of the administrative directory.
644 * Use @a pool for any temporary allocations.
645 *
646 * The returned pointer will refer to either a statically allocated
647 * string, or to a string allocated in @a pool.
648 *
649 * @since New in 1.3.
650 */
651const char *
652svn_wc_get_adm_dir(apr_pool_t *pool);
653
654
655/**
656 * Use @a name for the administrative directory in the working copy.
657 * Use @a pool for any temporary allocations.
658 *
659 * The list of valid names is limited. Currently only ".svn" (the
660 * default) and "_svn" are allowed.
661 *
662 * @note This function changes global (per-process) state and must be
663 * called in a single-threaded context during the initialization of a
664 * Subversion client.
665 *
666 * @since New in 1.3.
667 */
669svn_wc_set_adm_dir(const char *name,
670 apr_pool_t *pool);
671
672/** @} */
673
674
675/**
676 * @defgroup svn_wc_externals Externals
677 * @{
678 */
679
680/** Callback for external definitions updates
681 *
682 * @a local_abspath is the path on which the external definition was found.
683 * @a old_val and @a new_val are the before and after values of the
684 * SVN_PROP_EXTERNALS property. @a depth is the ambient depth of the
685 * working copy directory at @a local_abspath.
686 *
687 * @since New in 1.7. */
688typedef svn_error_t *(*svn_wc_external_update_t)(void *baton,
689 const char *local_abspath,
690 const svn_string_t *old_val,
691 const svn_string_t *new_val,
692 svn_depth_t depth,
693 apr_pool_t *scratch_pool);
694
695/** Traversal information is information gathered by a working copy
696 * crawl or update. For example, the before and after values of the
697 * svn:externals property are important after an update, and since
698 * we're traversing the working tree anyway (a complete traversal
699 * during the initial crawl, and a traversal of changed paths during
700 * the checkout/update/switch), it makes sense to gather the
701 * property's values then instead of making a second pass.
702 *
703 * New code should use the svn_wc_external_update_t callback instead.
704 *
705 * @deprecated Provided for backward compatibility with the 1.6 API.
706 */
708
709
710/** Return a new, empty traversal info object, allocated in @a pool.
711 *
712 * New code should use the svn_wc_external_update_t callback instead.
713 *
714 * @deprecated Provided for backward compatibility with the 1.6 API.
715 */
719
720/** Set @a *externals_old and @a *externals_new to hash tables representing
721 * changes to values of the svn:externals property on directories
722 * traversed by @a traversal_info.
723 *
724 * @a traversal_info is obtained from svn_wc_init_traversal_info(), but is
725 * only useful after it has been passed through another function, such
726 * as svn_wc_crawl_revisions(), svn_wc_get_update_editor(),
727 * svn_wc_get_switch_editor(), etc.
728 *
729 * Each hash maps <tt>const char *</tt> directory names onto
730 * <tt>const char *</tt> values of the externals property for that directory.
731 * The dir names are full paths -- that is, anchor plus target, not target
732 * alone. The values are not parsed, they are simply copied raw, and are
733 * never NULL: directories that acquired or lost the property are
734 * simply omitted from the appropriate table. Directories whose value
735 * of the property did not change show the same value in each hash.
736 *
737 * The hashes, keys, and values have the same lifetime as @a traversal_info.
738 *
739 * New code should use the svn_wc_external_update_t callback instead.
740 *
741 * @deprecated Provided for backward compatibility with the 1.6 API.
742 */
744void
745svn_wc_edited_externals(apr_hash_t **externals_old,
746 apr_hash_t **externals_new,
747 svn_wc_traversal_info_t *traversal_info);
748
749
750/** Set @a *depths to a hash table mapping <tt>const char *</tt>
751 * directory names (directories traversed by @a traversal_info) to
752 * <tt>const char *</tt> values (the depths of those directories, as
753 * converted by svn_depth_to_word()).
754 *
755 * @a traversal_info is obtained from svn_wc_init_traversal_info(), but is
756 * only useful after it has been passed through another function, such
757 * as svn_wc_crawl_revisions(), svn_wc_get_update_editor(),
758 * svn_wc_get_switch_editor(), etc.
759 *
760 * The dir names are full paths -- that is, anchor plus target, not target
761 * alone. The values are not allocated, they are static constant strings.
762 * Although the values are never NULL, not all directories traversed
763 * are necessarily listed. For example, directories which did not
764 * have an svn:externals property set or modified are not included.
765 *
766 * The hashes and keys have the same lifetime as @a traversal_info.
767 *
768 * New code should use the svn_wc_external_update_t callback instead.
769 *
770 * @since New in 1.5.
771 * @deprecated Provided for backward compatibility with the 1.6 API.
772 */
774void
775svn_wc_traversed_depths(apr_hash_t **depths,
776 svn_wc_traversal_info_t *traversal_info);
777
778
779/** One external item. This usually represents one line from an
780 * svn:externals description but with the path and URL
781 * canonicalized.
782 *
783 * In order to avoid backwards compatibility problems clients should use
784 * svn_wc_external_item2_create() to allocate and initialize this structure
785 * instead of doing so themselves.
786 *
787 * @since New in 1.5.
788 */
790{
791 /** The name of the subdirectory into which this external should be
792 checked out. This is relative to the parent directory that
793 holds this external item. (Note that these structs are often
794 stored in hash tables with the target dirs as keys, so this
795 field will often be redundant.) */
796 const char *target_dir;
797
798 /** Where to check out from. This is possibly a relative external URL, as
799 * allowed in externals definitions, but without the peg revision. */
800 const char *url;
801
802 /** What revision to check out. The only valid kinds for this are
803 svn_opt_revision_number, svn_opt_revision_date, and
804 svn_opt_revision_head. */
806
807 /** The peg revision to use when checking out. The only valid kinds are
808 svn_opt_revision_number, svn_opt_revision_date, and
809 svn_opt_revision_head. */
811
813
814/**
815 * Initialize an external item.
816 * Set @a *item to an external item object, allocated in @a pool.
817 *
818 * In order to avoid backwards compatibility problems, this function
819 * is used to initialize and allocate the #svn_wc_external_item2_t
820 * structure rather than doing so explicitly, as the size of this
821 * structure may change in the future.
822 *
823 * The current implementation never returns error, but callers should
824 * still check for error, for compatibility with future versions.
825 *
826 * @since New in 1.8.
827 */
830 apr_pool_t *pool);
831
832/** Same as svn_wc_external_item2_create() except the pointer to the new
833 * empty item is 'const' which is stupid since the next thing you need to do
834 * is fill in its fields.
835 *
836 * @deprecated Provided for backward compatibility with the 1.7 API.
837 * @since New in 1.5.
838 */
842 apr_pool_t *pool);
843
844/**
845 * Return a duplicate of @a item, allocated in @a pool. No part of the new
846 * item will be shared with @a item.
847 *
848 * @since New in 1.5.
849 */
852 apr_pool_t *pool);
853
854/**
855 * One external item. Similar to svn_wc_external_item2_t, except
856 * @a revision is interpreted as both the operational revision and the
857 * peg revision.
858 *
859 * @deprecated Provided for backward compatibility with the 1.4 API.
860 */
862{
863 /** Same as #svn_wc_external_item2_t.target_dir */
864 const char *target_dir;
865
866 /** Same as #svn_wc_external_item2_t.url */
867 const char *url;
868
869 /** Same as #svn_wc_external_item2_t.revision */
871
873
874/**
875 * Return a duplicate of @a item, allocated in @a pool. No part of the new
876 * item will be shared with @a item.
877 *
878 * @since New in 1.3.
879 *
880 * @deprecated Provided for backward compatibility with the 1.4 API.
881 */
885 apr_pool_t *pool);
886
887/**
888 * If @a externals_p is non-NULL, set @a *externals_p to an array of
889 * #svn_wc_external_item2_t * objects based on @a desc.
890 *
891 * If the format of @a desc is invalid, don't touch @a *externals_p and
892 * return #SVN_ERR_CLIENT_INVALID_EXTERNALS_DESCRIPTION. Thus, if
893 * you just want to check the validity of an externals description,
894 * and don't care about the parsed result, pass NULL for @a externals_p.
895 *
896 * The format of @a desc is the same as for values of the directory
897 * property #SVN_PROP_EXTERNALS. Look there for more details.
898 *
899 * If @a canonicalize_url is @c TRUE, canonicalize the @a url member
900 * of those objects. If the @a url member refers to an absolute URL,
901 * it will be canonicalized as URL consistent with the way URLs are
902 * canonicalized throughout the Subversion API. If, however, the
903 * @a url member makes use of the recognized (SVN-specific) relative
904 * URL syntax for svn:externals, "canonicalization" is an ill-defined
905 * concept which may even result in munging the relative URL syntax
906 * beyond recognition. You've been warned.
907 *
908 * Allocate the table, keys, and values in @a pool.
909 *
910 * @a defining_directory is the path or URL of the directory on which
911 * the svn:externals property corresponding to @a desc is set.
912 * @a defining_directory is only used when constructing error strings.
913 *
914 * @since New in 1.5.
915 */
917svn_wc_parse_externals_description3(apr_array_header_t **externals_p,
918 const char *defining_directory,
919 const char *desc,
920 svn_boolean_t canonicalize_url,
921 apr_pool_t *pool);
922
923/**
924 * Similar to svn_wc_parse_externals_description3() with @a
925 * canonicalize_url set to @c TRUE, but returns an array of
926 * #svn_wc_external_item_t * objects instead of
927 * #svn_wc_external_item2_t * objects
928 *
929 * @since New in 1.1.
930 *
931 * @deprecated Provided for backward compatibility with the 1.4 API.
932 */
935svn_wc_parse_externals_description2(apr_array_header_t **externals_p,
936 const char *parent_directory,
937 const char *desc,
938 apr_pool_t *pool);
939
940/**
941 * Similar to svn_wc_parse_externals_description2(), but returns the
942 * parsed externals in a hash instead of an array. This function
943 * should not be used, as storing the externals in a hash causes their
944 * order of evaluation to be not easily identifiable.
945 *
946 * @deprecated Provided for backward compatibility with the 1.0 API.
947 */
950svn_wc_parse_externals_description(apr_hash_t **externals_p,
951 const char *parent_directory,
952 const char *desc,
953 apr_pool_t *pool);
954
955/** @} */
956␌
957
958/**
959 * @defgroup svn_wc_notifications Notification callback handling
960 * @{
961 *
962 * In many cases, the WC library will scan a working copy and make
963 * changes. The caller usually wants to know when each of these changes
964 * has been made, so that it can display some kind of notification to
965 * the user.
966 *
967 * These notifications have a standard callback function type, which
968 * takes the path of the file that was affected, and a caller-
969 * supplied baton.
970 *
971 * @note The callback is a 'void' return -- this is a simple
972 * reporting mechanism, rather than an opportunity for the caller to
973 * alter the operation of the WC library.
974 *
975 * @note Some of the actions are used across several
976 * different Subversion commands. For example, the update actions are
977 * also used for checkouts, switches, and merges.
978 */
979
980/** The type of action occurring. */
982{
983 /** Adding a path to revision control. */
985
986 /** Copying a versioned path. */
988
989 /** Deleting a versioned path. */
991
992 /** Restoring a missing path from the pristine text-base. */
994
995 /** Reverting a modified path. */
997
998 /** A revert operation has failed. */
1000
1001 /** All conflicts on a path were marked as resolved.
1002 * @note As of 1.10, separate notifications are sent for individually
1003 * resolved text, property, and tree conflicts. This notification is used
1004 * only if all conflicts on a path were marked resolved at once. */
1006
1007 /** Skipping a path. */
1009
1010 /** Got a delete in an update. */
1012
1013 /** Got an add in an update. */
1015
1016 /** Got any other action in an update. */
1018
1019 /** The last notification in an update (including updates of externals). */
1021
1022 /** Updating an external module. */
1024
1025 /** The last notification in a status (including status on externals). */
1027
1028 /** Running status on an external module. */
1030
1031 /** Committing a modification. */
1033
1034 /** Committing an addition. */
1036
1037 /** Committing a deletion. */
1039
1040 /** Committing a replacement. */
1042
1043 /** Transmitting post-fix text-delta data for a file. */
1045
1046 /** Processed a single revision's blame. */
1048
1049 /** Locking a path. @since New in 1.2. */
1051
1052 /** Unlocking a path. @since New in 1.2. */
1054
1055 /** Failed to lock a path. @since New in 1.2. */
1057
1058 /** Failed to unlock a path. @since New in 1.2. */
1060
1061 /** Tried adding a path that already exists. @since New in 1.5. */
1063
1064 /** Changelist name set. @since New in 1.5. */
1066
1067 /** Changelist name cleared. @since New in 1.5. */
1069
1070 /** Warn user that a path has moved from one changelist to another.
1071 @since New in 1.5.
1072 @deprecated As of 1.7, separate clear and set notifications are sent. */
1074
1075 /** A merge operation (to path) has begun. See #svn_wc_notify_t.merge_range.
1076 @since New in 1.5. */
1078
1079 /** A merge operation (to path) from a foreign repository has begun.
1080 See #svn_wc_notify_t.merge_range. @since New in 1.5. */
1082
1083 /** Replace notification. @since New in 1.5. */
1085
1086 /** Property added. @since New in 1.6. */
1088
1089 /** Property updated. @since New in 1.6. */
1091
1092 /** Property deleted. @since New in 1.6. */
1094
1095 /** Nonexistent property deleted. @since New in 1.6. */
1097
1098 /** Revprop set. @since New in 1.6. */
1100
1101 /** Revprop deleted. @since New in 1.6. */
1103
1104 /** The last notification in a merge. @since New in 1.6. */
1106
1107 /** The path is a tree-conflict victim of the intended action (*not*
1108 * a persistent tree-conflict from an earlier operation, but *this*
1109 * operation caused the tree-conflict). @since New in 1.6. */
1111
1112 /** The path is a subdirectory referenced in an externals definition
1113 * which is unable to be operated on. @since New in 1.6. */
1115
1116 /** Starting an update operation. @since New in 1.7. */
1118
1119 /** An update tried to add a file or directory at a path where
1120 * a separate working copy was found. @since New in 1.7. */
1122
1123 /** An explicit update tried to update a file or directory that
1124 * doesn't live in the repository and can't be brought in.
1125 * @since New in 1.7. */
1127
1128 /** An update tried to update a file or directory to which access could
1129 * not be obtained. @since New in 1.7. */
1131
1132 /** An update operation removed an external working copy.
1133 * @since New in 1.7. */
1135
1136 /** A node below an existing node was added during update.
1137 * @since New in 1.7. */
1139
1140 /** A node below an existing node was updated during update.
1141 * @since New in 1.7. */
1143
1144 /** A node below an existing node was deleted during update.
1145 * @since New in 1.7. */
1147
1148 /** The mergeinfo on path was updated. @since New in 1.7. */
1150
1151 /** A working copy directory was upgraded to the latest format.
1152 * @since New in 1.7. */
1154
1155 /** Mergeinfo describing a merge was recorded.
1156 * @since New in 1.7. */
1158
1159 /** Mergeinfo was removed due to elision.
1160 * @since New in 1.7. */
1162
1163 /** A file in the working copy was patched.
1164 * @since New in 1.7. */
1166
1167 /** A hunk from a patch was applied.
1168 * @since New in 1.7. */
1170
1171 /** A hunk from a patch was rejected.
1172 * @since New in 1.7. */
1174
1175 /** A hunk from a patch was found to already be applied.
1176 * @since New in 1.7. */
1178
1179 /** Committing a non-overwriting copy (path is the target of the
1180 * copy, not the source).
1181 * @since New in 1.7. */
1183
1184 /** Committing an overwriting (replace) copy (path is the target of
1185 * the copy, not the source).
1186 * @since New in 1.7. */
1188
1189 /** The server has instructed the client to follow a URL
1190 * redirection.
1191 * @since New in 1.7. */
1193
1194 /** The operation was attempted on a path which doesn't exist.
1195 * @since New in 1.7. */
1197
1198 /** Removing a path by excluding it.
1199 * @since New in 1.7. */
1201
1202 /** Operation failed because the node remains in conflict
1203 * @since New in 1.7. */
1205
1206 /** Operation failed because an added node is missing
1207 * @since New in 1.7. */
1209
1210 /** Operation failed because a node is out of date
1211 * @since New in 1.7. */
1213
1214 /** Operation failed because an added parent is not selected
1215 * @since New in 1.7. */
1217
1218 /** Operation failed because a node is locked by another user and/or
1219 * working copy. @since New in 1.7. */
1221
1222 /** Operation failed because the operation was forbidden by the server.
1223 * @since New in 1.7. */
1225
1226 /** The operation skipped the path because it was conflicted.
1227 * @since New in 1.7. */
1229
1230 /** Just the lock on a file was removed during update.
1231 * @since New in 1.8. */
1233
1234 /** Operation failed because a node is obstructed.
1235 * @since New in 1.8. */
1237
1238 /** Conflict resolver is starting.
1239 * This can be used by clients to detect when to display conflict summary
1240 * information, for example.
1241 * @since New in 1.8. */
1243
1244 /** Conflict resolver is done.
1245 * This can be used by clients to detect when to display conflict summary
1246 * information, for example.
1247 * @since New in 1.8. */
1249
1250 /** The current operation left local changes of something that was deleted
1251 * The changes are available on (and below) the notified path
1252 * @since New in 1.8. */
1254
1255 /** A copy from a foreign repository has started
1256 * @since New in 1.8. */
1258
1259 /** A move in the working copy has been broken, i.e. degraded into a
1260 * copy + delete. The notified path is the move source (the deleted path).
1261 * ### TODO: Provide path to move destination as well?
1262 * @since New in 1.8. */
1264
1265 /** Running cleanup on an external module.
1266 * @since New in 1.9. */
1268
1269 /** The operation failed because the operation (E.g. commit) is only valid
1270 * if the operation includes this path.
1271 * @since New in 1.9. */
1273
1274 /** Running info on an external module.
1275 * @since New in 1.9. */
1277
1278 /** Finalizing commit.
1279 * @since New in 1.9. */
1281
1282 /** All text conflicts in a file were marked as resolved.
1283 * @since New in 1.10. */
1285
1286 /** A property conflict on a path was marked as resolved.
1287 * The name of the property is specified in #svn_wc_notify_t.prop_name.
1288 * @since New in 1.10. */
1290
1291 /** A tree conflict on a path was marked as resolved.
1292 * @since New in 1.10. */
1294
1295 /** Starting to search the repository for details about a tree conflict.
1296 * @since New in 1.10. */
1298
1299 /** Progressing in search of repository for details about a tree conflict.
1300 * The revision being searched is specified in #svn_wc_notify_t.revision.
1301 * @since New in 1.10. */
1303
1304 /** Done searching the repository for details about a conflict.
1305 * @since New in 1.10. */
1307
1308 /** Hydrating (fetching text-bases): starting a batch of fetching
1309 * within the WC subtree at @c svn_wc_notify_t.path. (Zero or more files
1310 * may be fetched, each preceded by @c svn_wc_notify_hydrating_file.)
1311 * @since New in 1.15. */
1313
1314 /** Hydrating (fetching text-bases): about to fetch a file
1315 * from @c svn_wc_notify_t.url at @c svn_wc_notify_t.revision.
1316 * @since New in 1.15. */
1318
1319 /** Hydrating (fetching text-bases): finished a batch of fetching
1320 * within the WC subtree at @c svn_wc_notify_t.path.
1321 * @since New in 1.15. */
1323
1324 /** A warning, specified in #svn_wc_notify_t.err.
1325 * @since New in 1.15. */
1327
1329
1330
1331/** The type of notification that is occurring. */
1333{
1334 svn_wc_notify_state_inapplicable = 0,
1335
1336 /** Notifier doesn't know or isn't saying. */
1338
1339 /** The state did not change. */
1341
1342 /** The item wasn't present. */
1344
1345 /** An unversioned item obstructed work. */
1347
1348 /** Pristine state was modified. */
1350
1351 /** Modified state had mods merged in. */
1353
1354 /** Modified state got conflicting mods. */
1356
1357 /** The source to copy the file from is missing. */
1359
1361
1362/**
1363 * What happened to a lock during an operation.
1364 *
1365 * @since New in 1.2.
1366 */
1368{
1369 svn_wc_notify_lock_state_inapplicable = 0,
1370
1371 svn_wc_notify_lock_state_unknown,
1372
1373 /** The lock wasn't changed. */
1375
1376 /** The item was locked. */
1378
1379 /** The item was unlocked. */
1381
1383
1384/**
1385 * Structure used in the #svn_wc_notify_func2_t function.
1386 *
1387 * @c kind, @c content_state, @c prop_state and @c lock_state are from
1388 * after @c action, not before.
1389 *
1390 * @note If @c action is #svn_wc_notify_update_completed, then @c path has
1391 * already been installed, so it is legitimate for an implementation of
1392 * #svn_wc_notify_func2_t to examine @c path in the working copy.
1393 *
1394 * @note The purpose of the @c kind, @c mime_type, @c content_state, and
1395 * @c prop_state fields is to provide "for free" information that an
1396 * implementation is likely to want, and which it would otherwise be
1397 * forced to deduce via expensive operations such as reading entries
1398 * and properties. However, if the caller does not have this
1399 * information, it will simply pass the corresponding `*_unknown'
1400 * values, and it is up to the implementation how to handle that
1401 * (i.e., whether to attempt deduction, or just to punt and
1402 * give a less informative notification).
1403 *
1404 * @note Callers of notification functions should use svn_wc_create_notify()
1405 * or svn_wc_create_notify_url() to create structures of this type to allow
1406 * for extensibility.
1407 *
1408 * @since New in 1.2.
1409 */
1410typedef struct svn_wc_notify_t {
1411
1412 /** Path, either absolute or relative to the current working directory
1413 * (i.e., not relative to an anchor). @c path is "." or another valid path
1414 * value for compatibility reasons when the real target is a url that
1415 * is available in @c url. */
1416 const char *path;
1417
1418 /** Action that describes what happened to #svn_wc_notify_t.path. */
1420
1421 /** Node kind of @c path. */
1423
1424 /** If non-NULL, indicates the mime-type of @c path.
1425 * It is always @c NULL for directories. */
1426 const char *mime_type;
1427
1428 /** Points to the lock structure received from the repository when
1429 * @c action is #svn_wc_notify_locked. For other actions, it is
1430 * @c NULL. */
1432
1433 /** Points to an error describing the reason for the failure when @c
1434 * action is one of the following: #svn_wc_notify_failed_lock,
1435 * #svn_wc_notify_failed_unlock, #svn_wc_notify_failed_external.
1436 * Is @c NULL otherwise. */
1438
1439 /** The type of notification that is occurring about node content. */
1441
1442 /** The type of notification that is occurring about node properties. */
1444
1445 /** Reflects the addition or removal of a lock token in the working copy. */
1447
1448 /** When @c action is #svn_wc_notify_update_completed, target revision
1449 * of the update, or #SVN_INVALID_REVNUM if not available; when @c
1450 * action is #svn_wc_notify_blame_revision, processed revision; Since
1451 * Subversion 1.7 when action is #svn_wc_notify_update_update or
1452 * #svn_wc_notify_update_add, the target revision.
1453 * In all other cases, it is #SVN_INVALID_REVNUM.
1454 */
1456
1457 /** If @c action pertains to a changelist, this is the changelist name.
1458 * In all other cases, it is @c NULL. @since New in 1.5 */
1459 const char *changelist_name;
1460
1461 /** When @c action is #svn_wc_notify_merge_begin or
1462 * #svn_wc_notify_foreign_merge_begin or
1463 * #svn_wc_notify_merge_record_info_begin, and both the
1464 * left and right sides of the merge are from the same URL. In all
1465 * other cases, it is @c NULL. @since New in 1.5 */
1467
1468 /** Similar to @c path, but if non-NULL the notification is about a url.
1469 * @since New in 1.6 */
1470 const char *url;
1471
1472 /** If non-NULL, specifies an absolute path prefix that can be subtracted
1473 * from the start of the absolute path in @c path or @c url. Its purpose
1474 * is to allow notification to remove a common prefix from all the paths
1475 * displayed for an operation. @since New in 1.6 */
1476 const char *path_prefix;
1477
1478 /** If @c action relates to properties, specifies the name of the property.
1479 * @since New in 1.6 */
1480 const char *prop_name;
1481
1482 /** If @c action is #svn_wc_notify_blame_revision, contains a list of
1483 * revision properties for the specified revision
1484 * @since New in 1.6 */
1485 apr_hash_t *rev_props;
1486
1487 /** If @c action is #svn_wc_notify_update_update or
1488 * #svn_wc_notify_update_add, contains the revision before the update.
1489 * In all other cases, it is #SVN_INVALID_REVNUM.
1490 * @since New in 1.7 */
1492
1493 /** These fields are used by svn patch to identify the
1494 * hunk the notification is for. They are line-based
1495 * offsets and lengths parsed from the unidiff hunk header.
1496 * @since New in 1.7. */
1497 /* @{ */
1499 svn_linenum_t hunk_original_length;
1500 svn_linenum_t hunk_modified_start;
1501 svn_linenum_t hunk_modified_length;
1502 /* @} */
1503
1504 /** The line at which a hunk was matched (and applied).
1505 * @since New in 1.7. */
1507
1508 /** The fuzz factor the hunk was applied with.
1509 * @since New in 1.7 */
1511
1512 /* NOTE: Add new fields at the end to preserve binary compatibility.
1513 Also, if you add fields here, you have to update svn_wc_create_notify
1514 and svn_wc_dup_notify. */
1515} svn_wc_notify_t;
1516
1517/**
1518 * Allocate an #svn_wc_notify_t structure in @a pool, initialize and return
1519 * it.
1520 *
1521 * Set the @c path field of the created struct to @a path, and @c action to
1522 * @a action. Set all other fields to their @c _unknown, @c NULL or
1523 * invalid value, respectively. Make only a shallow copy of the pointer
1524 * @a path.
1525 *
1526 * @since New in 1.2.
1527 */
1528svn_wc_notify_t *
1531 apr_pool_t *pool);
1532
1533/**
1534 * Allocate an #svn_wc_notify_t structure in @a pool, initialize and return
1535 * it.
1536 *
1537 * Set the @c url field of the created struct to @a url, @c path to "." and @c
1538 * action to @a action. Set all other fields to their @c _unknown, @c NULL or
1539 * invalid value, respectively. Make only a shallow copy of the pointer
1540 * @a url.
1541 *
1542 * @since New in 1.6.
1543 */
1544svn_wc_notify_t *
1547 apr_pool_t *pool);
1548
1549/**
1550 * Return a deep copy of @a notify, allocated in @a pool.
1551 *
1552 * @since New in 1.2.
1553 */
1554svn_wc_notify_t *
1555svn_wc_dup_notify(const svn_wc_notify_t *notify,
1556 apr_pool_t *pool);
1557
1558/**
1559 * Notify the world that @a notify->action has happened to @a notify->path.
1560 *
1561 * Recommendation: callers of #svn_wc_notify_func2_t should avoid
1562 * invoking it multiple times on the same path within a given
1563 * operation, and implementations should not bother checking for such
1564 * duplicate calls. For example, in an update, the caller should not
1565 * invoke the notify func on receiving a prop change and then again
1566 * on receiving a text change. Instead, wait until all changes have
1567 * been received, and then invoke the notify func once (from within
1568 * an #svn_delta_editor_t's close_file(), for example), passing
1569 * the appropriate @a notify->content_state and @a notify->prop_state flags.
1570 *
1571 * @since New in 1.2.
1572 */
1573typedef void (*svn_wc_notify_func2_t)(void *baton,
1574 const svn_wc_notify_t *notify,
1575 apr_pool_t *pool);
1576
1577/**
1578 * Similar to #svn_wc_notify_func2_t, but takes the information as arguments
1579 * instead of struct fields.
1580 *
1581 * @deprecated Provided for backward compatibility with the 1.1 API.
1582 */
1583typedef void (*svn_wc_notify_func_t)(void *baton,
1584 const char *path,
1587 const char *mime_type,
1591
1592/** @} */
1593
1594␌
1595/**
1596 * Interactive conflict handling
1597 *
1598 * @defgroup svn_wc_conflict Conflict callback functionality
1599 * @{
1600 *
1601 * This API gives a Subversion client application the opportunity to
1602 * define a callback that allows the user to resolve conflicts
1603 * interactively during updates and merges.
1604 *
1605 * If a conflict is discovered, libsvn_wc invokes the callback with an
1606 * #svn_wc_conflict_description_t. This structure describes the
1607 * path in conflict, whether it's a text or property conflict, and may
1608 * also present up to three files that can be used to resolve the
1609 * conflict (perhaps by launching an editor or 3rd-party merging
1610 * tool). The structure also provides a possible fourth file (@c
1611 * merged_file) which, if not NULL, represents libsvn_wc's attempt to
1612 * contextually merge the first three files. (Note that libsvn_wc
1613 * will not attempt to merge a file that it believes is binary, and it
1614 * will only attempt to merge property values it believes to be a
1615 * series of multi-line text.)
1616 *
1617 * When the callback is finished interacting with the user, it
1618 * responds by returning a #svn_wc_conflict_result_t. This
1619 * structure indicates whether the user wants to postpone the conflict
1620 * for later (allowing libsvn_wc to mark the path "conflicted" as
1621 * usual), or whether the user wants libsvn_wc to use one of the four
1622 * files as the "final" state for resolving the conflict immediately.
1623 *
1624 * Note that the callback is at liberty (and encouraged) to merge the
1625 * three files itself. If it does so, it signals this to libsvn_wc by
1626 * returning a choice of #svn_wc_conflict_choose_merged. To return
1627 * the 'final' merged file to libsvn_wc, the callback has the option of
1628 * either:
1629 *
1630 * - editing the original @c merged_file in-place
1631 *
1632 * or, if libsvn_wc never supplied a merged_file in the
1633 * description structure (i.e. passed NULL for that field),
1634 *
1635 * - return the merged file in the #svn_wc_conflict_result_t.
1636 *
1637 */
1638
1639/** The type of action being attempted on an object.
1640 *
1641 * @since New in 1.5.
1642 */
1644{
1645 svn_wc_conflict_action_edit, /**< attempting to change text or props */
1646 svn_wc_conflict_action_add, /**< attempting to add object */
1647 svn_wc_conflict_action_delete, /**< attempting to delete object */
1648 svn_wc_conflict_action_replace /**< attempting to replace object,
1649 @since New in 1.7 */
1651
1652
1653/** The pre-existing condition which is causing a state of conflict.
1654 *
1655 * @since New in 1.5.
1656 */
1658{
1659 /** Local edits are already present */
1661 /** Another object is in the way */
1663 /** Object is already schedule-delete */
1665 /** Object is unknown or missing */
1667 /** Object is unversioned */
1669 /** Object is already added or schedule-add. @since New in 1.6. */
1671 /** Object is already replaced. @since New in 1.7. */
1673 /** Object is moved away. @since New in 1.8. */
1675 /** Object is moved here. @since New in 1.8. */
1677
1679
1680
1681/** The type of conflict being described by an
1682 * #svn_wc_conflict_description2_t (see below).
1683 *
1684 * @since New in 1.5.
1685 */
1687{
1688 /** textual conflict (on a file) */
1690 /** property conflict (on a file or dir) */
1692 /** tree conflict (on a dir) @since New in 1.6. */
1695
1696
1697/** The user operation that exposed a conflict.
1698 *
1699 * @since New in 1.6.
1700 */
1702{
1703 svn_wc_operation_none = 0,
1704 svn_wc_operation_update,
1705 svn_wc_operation_switch,
1706 svn_wc_operation_merge
1707
1709
1710
1711/** Info about one of the conflicting versions of a node. Each field may
1712 * have its respective null/invalid/unknown value if the corresponding
1713 * information is not relevant or not available.
1714 *
1715 * @todo Consider making some or all of the info mandatory, to reduce
1716 * complexity.
1717 *
1718 * @note Fields may be added to the end of this structure in future
1719 * versions. Therefore, to preserve binary compatibility, users
1720 * should not directly allocate structures of this type.
1721 *
1722 * @see svn_wc_conflict_version_create()
1723 * @see svn_wc_conflict_version_dup()
1724 *
1725 * @since New in 1.6.
1726*/
1728{
1729 /** @name Where to find this node version in a repository */
1730 /**@{*/
1731
1732 /** URL of repository root */
1733 const char *repos_url;
1734
1735 /** revision at which to look up path_in_repos */
1737
1738 /** path within repos; must not start with '/' */
1739 /* ### should have been called repos_relpath, but we can't change this. */
1740 const char *path_in_repos;
1741 /** @} */
1742
1743 /** The node kind. Can be any kind, including 'none' or 'unknown'. */
1745
1746 /** UUID of the repository (or NULL if unknown.)
1747 * @since New in 1.8. */
1748 const char *repos_uuid;
1749
1750 /* @todo Add metadata about a local copy of the node, if and when
1751 * we store one. */
1752
1753 /* Remember to update svn_wc_conflict_version_create() and
1754 * svn_wc_conflict_version_dup() in case you add fields to this struct. */
1756
1757/**
1758 * Allocate an #svn_wc_conflict_version_t structure in @a pool,
1759 * initialize to contain a conflict origin, and return it.
1760 *
1761 * Set the @c repos_url field of the created struct to @a repos_root_url,
1762 * the @c path_in_repos field to @a repos_relpath, the @c peg_rev field to
1763 * @a revision and the @c node_kind to @a kind. Make only shallow
1764 * copies of the pointer arguments.
1765 *
1766 * @a repos_root_url, @a repos_relpath and @a revision must be valid,
1767 * non-null values. @a repos_uuid should be a valid UUID, but can be
1768 * NULL if unknown. @a kind can be any kind, even 'none' or 'unknown'.
1769 *
1770 * @since New in 1.8.
1771 */
1773svn_wc_conflict_version_create2(const char *repos_root_url,
1774 const char *repos_uuid,
1775 const char *repos_relpath,
1778 apr_pool_t *result_pool);
1779
1780/** Similar to svn_wc_conflict_version_create2(), but doesn't set all
1781 * required values.
1782 *
1783 * @since New in 1.6.
1784 * @deprecated Provided for backward compatibility with the 1.7 API.
1785 */
1789 const char *path_in_repos,
1790 svn_revnum_t peg_rev,
1791 svn_node_kind_t node_kind,
1792 apr_pool_t *pool);
1793
1794/** Return a duplicate of @a version, allocated in @a pool.
1795 * No part of the new version will be shared with @a version.
1796 *
1797 * @since New in 1.6.
1798 */
1801 apr_pool_t *pool);
1802
1803
1804/** A struct that describes a conflict that has occurred in the
1805 * working copy.
1806 *
1807 * The conflict described by this structure is one of:
1808 * - a conflict on the content of the file node @a local_abspath
1809 * - a conflict on the property @a property_name of @a local_abspath
1810 * - a tree conflict, of which @a local_abspath is the victim
1811 * Be aware that the victim of a tree conflict can be a non-existent node.
1812 * The three kinds of conflict are distinguished by @a kind.
1813 *
1814 * @note Fields may be added to the end of this structure in future
1815 * versions. Therefore, to preserve binary compatibility, users
1816 * should not directly allocate structures of this type but should use
1817 * svn_wc_conflict_description_create_text2() or
1818 * svn_wc_conflict_description_create_prop2() or
1819 * svn_wc_conflict_description_create_tree2() instead.
1820 *
1821 * @since New in 1.7.
1822 */
1824{
1825 /** The path that is in conflict (for a tree conflict, it is the victim) */
1826 const char *local_abspath;
1827
1828 /** The node type of the local node involved in this conflict.
1829 * For a tree conflict, this is the node kind of the tree conflict victim.
1830 * For the left/right node kinds of the incoming conflicting change see
1831 * src_left_version->node_kind and src_right_version->node_kind. */
1833
1834 /** What sort of conflict are we describing? */
1836
1837 /** The name of the property whose conflict is being described.
1838 * (Only if @a kind is 'property'; else undefined.) */
1839 const char *property_name;
1840
1841 /** Whether svn thinks ('my' version of) @c path is a 'binary' file.
1842 * (Only if @c kind is 'text', else undefined.) */
1844
1845 /** The svn:mime-type property of ('my' version of) @c path, if available,
1846 * else NULL.
1847 * (Only if @c kind is 'text', else undefined.) */
1848 const char *mime_type;
1849
1850 /** The incoming action being attempted on the conflicted node or property.
1851 * When @c kind is 'text', this action must be 'edit', but generally it can
1852 * be any kind of possible change. */
1854
1855 /** The local change or state of the target node or property, relative
1856 * to its merge-left source, that conflicts with the incoming action.
1857 * When @c kind is 'text', this must be 'edited', but generally it can
1858 * be any kind of possible change.
1859 * Note that 'local' does not always refer to a working copy. A change
1860 * can be local to the target branch of a merge operation, for example,
1861 * and is not necessarily visible in a working copy of the target branch
1862 * at any given revision. */
1864
1865 /** If this is text-conflict and involves the merging of two files
1866 * descended from a common ancestor, here are the paths of up to
1867 * four fulltext files that can be used to interactively resolve the
1868 * conflict.
1869 *
1870 * @a base_abspath, @a their_abspath and @a my_abspath are absolute
1871 * paths.
1872 *
1873 * ### Is @a merged_file relative to some directory, or absolute?
1874 *
1875 * All four files will be in repository-normal form -- LF
1876 * line endings and contracted keywords. (If any of these files are
1877 * not available, they default to NULL.)
1878 *
1879 * On the other hand, if this is a property-conflict, then these
1880 * paths represent temporary files that contain the three different
1881 * property-values in conflict. The fourth path (@c merged_file)
1882 * may or may not be NULL; if set, it represents libsvn_wc's
1883 * attempt to merge the property values together. (Remember that
1884 * property values are technically binary values, and thus can't
1885 * always be merged.)
1886 */
1887 const char *base_abspath; /* common ancestor of the two files being merged */
1888
1889 /** their version of the file */
1890 /* ### BH: For properties this field contains the reference to
1891 the property rejection (.prej) file */
1892 const char *their_abspath;
1893
1894 /** my locally-edited version of the file */
1895 const char *my_abspath;
1896
1897 /** merged version; may contain conflict markers
1898 * ### For property conflicts, this contains 'their_abspath'. */
1899 const char *merged_file;
1900
1901 /** The operation that exposed the conflict.
1902 * Used only for tree conflicts.
1903 */
1905
1906 /** Info on the "merge-left source" or "older" version of incoming change. */
1908
1909 /** Info on the "merge-right source" or "their" version of incoming change. */
1911
1912 /** For property conflicts, the absolute path to the .prej file.
1913 * @since New in 1.9. */
1915
1916 /** For property conflicts, the local base value of the property, i.e. the
1917 * value of the property as of the BASE revision of the working copy.
1918 * For conflicts created during update/switch this contains the
1919 * post-update/switch property value. The pre-update/switch value can
1920 * be found in prop_value_incoming_old.
1921 * Only set if available, so might be @c NULL.
1922 * @since New in 1.9. */
1924
1925 /** For property conflicts, the local working value of the property,
1926 * i.e. the value of the property in the working copy, possibly with
1927 * local modiciations.
1928 * Only set if available, so might be @c NULL.
1929 * @since New in 1.9. */
1931
1932 /** For property conflicts, the incoming old value of the property,
1933 * i.e. the value the property had at @c src_left_version.
1934 * Only set if available, so might be @c NULL.
1935 * @since New in 1.9 */
1937
1938 /** For property conflicts, the incoming new value of the property,
1939 * i.e. the value the property had at @c src_right_version.
1940 * Only set if available, so might be @c NULL.
1941 * @since New in 1.9 */
1943
1944/* NOTE: Add new fields at the end to preserve binary compatibility.
1945 Also, if you add fields here, you have to update
1946 svn_wc_conflict_description2_dup and perhaps
1947 svn_wc_conflict_description_create_text2,
1948 svn_wc_conflict_description_create_prop2, and
1949 svn_wc_conflict_description_create_tree2. */
1951
1952
1953/** Similar to #svn_wc_conflict_description2_t, but with relative paths and
1954 * adm_access batons. Passed to #svn_wc_conflict_resolver_func_t.
1955 *
1956 * @since New in 1.5.
1957 * @deprecated Provided for backward compatibility with the 1.6 API.
1958 */
1960{
1961 /** The path that is in conflict (for a tree conflict, it is the victim) */
1962 const char *path;
1963
1964 /** The local node type of the path being operated on (for a tree conflict,
1965 * this specifies the local node kind, which may be (and typically is)
1966 * different than the left and right kind) */
1968
1969 /** What sort of conflict are we describing? */
1971
1972 /** The name of the property whose conflict is being described.
1973 * (Only if @a kind is 'property'; else undefined.) */
1974 const char *property_name;
1975
1976 /** Whether svn thinks ('my' version of) @c path is a 'binary' file.
1977 * (Only if @c kind is 'text', else undefined.) */
1979
1980 /** The svn:mime-type property of ('my' version of) @c path, if available,
1981 * else NULL.
1982 * (Only if @c kind is 'text', else undefined.) */
1983 const char *mime_type;
1984
1985 /** If not NULL, an open working copy access baton to either the
1986 * path itself (if @c path is a directory), or to the parent
1987 * directory (if @c path is a file.)
1988 * For a tree conflict, this will always be an access baton
1989 * to the parent directory of the path, even if the path is
1990 * a directory. */
1992
1993 /** The action being attempted on the conflicted node or property.
1994 * (When @c kind is 'text', this action must be 'edit'.) */
1996
1997 /** The state of the target node or property, relative to its merge-left
1998 * source, that is the reason for the conflict.
1999 * (When @c kind is 'text', this reason must be 'edited'.) */
2001
2002 /** If this is text-conflict and involves the merging of two files
2003 * descended from a common ancestor, here are the paths of up to
2004 * four fulltext files that can be used to interactively resolve the
2005 * conflict. All four files will be in repository-normal form -- LF
2006 * line endings and contracted keywords. (If any of these files are
2007 * not available, they default to NULL.)
2008 *
2009 * On the other hand, if this is a property-conflict, then these
2010 * paths represent temporary files that contain the three different
2011 * property-values in conflict. The fourth path (@c merged_file)
2012 * may or may not be NULL; if set, it represents libsvn_wc's
2013 * attempt to merge the property values together. (Remember that
2014 * property values are technically binary values, and thus can't
2015 * always be merged.)
2016 */
2017 const char *base_file; /* common ancestor of the two files being merged */
2018
2019 /** their version of the file */
2020 const char *their_file;
2021
2022 /** my locally-edited version of the file */
2023 const char *my_file;
2024
2025 /** merged version; may contain conflict markers */
2026 const char *merged_file;
2027
2028 /** The operation that exposed the conflict.
2029 * Used only for tree conflicts.
2030 *
2031 * @since New in 1.6.
2032 */
2034
2035 /** Info on the "merge-left source" or "older" version of incoming change.
2036 * @since New in 1.6. */
2038
2039 /** Info on the "merge-right source" or "their" version of incoming change.
2040 * @since New in 1.6. */
2042
2044
2045/**
2046 * Allocate an #svn_wc_conflict_description2_t structure in @a result_pool,
2047 * initialize to represent a text conflict, and return it.
2048 *
2049 * Set the @c local_abspath field of the created struct to @a local_abspath
2050 * (which must be an absolute path), the @c kind field to
2051 * #svn_wc_conflict_kind_text, the @c node_kind to #svn_node_file,
2052 * the @c action to #svn_wc_conflict_action_edit, and the @c reason to
2053 * #svn_wc_conflict_reason_edited.
2054 *
2055 * @note It is the caller's responsibility to set the other required fields
2056 * (such as the four file names and @c mime_type and @c is_binary).
2057 *
2058 * @since New in 1.7.
2059 */
2062 apr_pool_t *result_pool);
2063
2064
2065/** Similar to svn_wc_conflict_description_create_text2(), but returns
2066 * a #svn_wc_conflict_description_t *.
2067 *
2068 * @since New in 1.6.
2069 * @deprecated Provided for backward compatibility with the 1.6 API.
2070 */
2074 svn_wc_adm_access_t *adm_access,
2075 apr_pool_t *pool);
2076
2077/**
2078 * Allocate an #svn_wc_conflict_description2_t structure in @a result_pool,
2079 * initialize to represent a property conflict, and return it.
2080 *
2081 * Set the @c local_abspath field of the created struct to @a local_abspath
2082 * (which must be an absolute path), the @c kind field
2083 * to #svn_wc_conflict_kind_property, the @c node_kind to @a node_kind, and
2084 * the @c property_name to @a property_name.
2085 *
2086 * @note: It is the caller's responsibility to set the other required fields
2087 * (such as the four file names and @c action and @c reason).
2088 *
2089 * @since New in 1.7.
2090 */
2093 svn_node_kind_t node_kind,
2094 const char *property_name,
2095 apr_pool_t *result_pool);
2096
2097/** Similar to svn_wc_conflict_descriptor_create_prop(), but returns
2098 * a #svn_wc_conflict_description_t *.
2099 *
2100 * @since New in 1.6.
2101 * @deprecated Provided for backward compatibility with the 1.6 API.
2102 */
2106 svn_wc_adm_access_t *adm_access,
2107 svn_node_kind_t node_kind,
2108 const char *property_name,
2109 apr_pool_t *pool);
2110
2111/**
2112 * Allocate an #svn_wc_conflict_description2_t structure in @a pool,
2113 * initialize to represent a tree conflict, and return it.
2114 *
2115 * Set the @c local_abspath field of the created struct to @a local_abspath
2116 * (which must be an absolute path), the @c kind field to
2117 * #svn_wc_conflict_kind_tree, the @c node_kind to @a node_kind,
2118 * the @c operation to @a operation, the @c src_left_version field to
2119 * @a src_left_version, and the @c src_right_version field to
2120 * @a src_right_version.
2121 *
2122 * @note: It is the caller's responsibility to set the other required fields
2123 * (such as the four file names and @c action and @c reason).
2124 *
2125 * @since New in 1.7.
2126 */
2129 const char *local_abspath,
2130 svn_node_kind_t node_kind,
2131 svn_wc_operation_t operation,
2132 const svn_wc_conflict_version_t *src_left_version,
2133 const svn_wc_conflict_version_t *src_right_version,
2134 apr_pool_t *result_pool);
2135
2136
2137/** Similar to svn_wc_conflict_description_create_tree(), but returns
2138 * a #svn_wc_conflict_description_t *.
2139 *
2140 * @since New in 1.6.
2141 * @deprecated Provided for backward compatibility with the 1.6 API.
2142 */
2146 const char *path,
2147 svn_wc_adm_access_t *adm_access,
2148 svn_node_kind_t node_kind,
2149 svn_wc_operation_t operation,
2150 /* non-const */ svn_wc_conflict_version_t *src_left_version,
2151 /* non-const */ svn_wc_conflict_version_t *src_right_version,
2152 apr_pool_t *pool);
2153
2154
2155/** Return a duplicate of @a conflict, allocated in @a result_pool.
2156 * A deep copy of all members will be made.
2157 *
2158 * @since New in 1.9.
2159 */
2162 const svn_wc_conflict_description2_t *conflict,
2163 apr_pool_t *result_pool);
2164
2165
2166/** Like svn_wc_conflict_description2_dup(), but is improperly named
2167 * as a private function when it is intended to be a public API.
2168 *
2169 * @since New in 1.7.
2170 * @deprecated Provided for backward compatibility with the 1.8 API.
2171 */
2175 const svn_wc_conflict_description2_t *conflict,
2176 apr_pool_t *result_pool);
2177
2178
2179/** The way in which the conflict callback chooses a course of action.
2180 *
2181 * @since New in 1.5.
2182 */
2184{
2185 /** Undefined; for private use only.
2186 This value must never be returned in svn_wc_conflict_result_t,
2187 but a separate value, unequal to all other pre-defined values may
2188 be useful in conflict resolver implementations to signal that no
2189 choice is made yet.
2190 * @since New in 1.9
2191 */
2193
2194 /** Don't resolve the conflict now. Let libsvn_wc mark the path
2195 'conflicted', so user can run 'svn resolved' later. */
2197
2198 /** If there were files to choose from, select one as a way of
2199 resolving the conflict here and now. libsvn_wc will then do the
2200 work of "installing" the chosen file.
2201 */
2202 svn_wc_conflict_choose_base, /**< original version */
2203 svn_wc_conflict_choose_theirs_full, /**< incoming version */
2205 svn_wc_conflict_choose_theirs_conflict, /**< incoming (for conflicted hunks) */
2206 svn_wc_conflict_choose_mine_conflict, /**< own (for conflicted hunks) */
2207 svn_wc_conflict_choose_merged, /**< merged version */
2208
2209 /** @since New in 1.8. */
2211
2213
2214
2215/** The final result returned by #svn_wc_conflict_resolver_func_t.
2216 *
2217 * @note Fields may be added to the end of this structure in future
2218 * versions. Therefore, to preserve binary compatibility, users
2219 * should not directly allocate structures of this type. Instead,
2220 * construct this structure using svn_wc_create_conflict_result()
2221 * below.
2222 *
2223 * @since New in 1.5.
2224 */
2226{
2227 /** A choice to either delay the conflict resolution or select a
2228 particular file to resolve the conflict. */
2230
2231 /** If not NULL, this is a path to a file which contains the client's
2232 (or more likely, the user's) merging of the three values in
2233 conflict. libsvn_wc accepts this file if (and only if) @c choice
2234 is set to #svn_wc_conflict_choose_merged.*/
2235 const char *merged_file;
2236
2237 /** If true, save a backup copy of merged_file (or the original
2238 merged_file from the conflict description, if merged_file is
2239 NULL) in the user's working copy. */
2241
2242 /** If not NULL, this is the new merged property, used when choosing
2243 * #svn_wc_conflict_choose_merged. This value is preferred over using
2244 * merged_file.
2245 *
2246 * @since New in 1.9.
2247 */
2249
2251
2252
2253/**
2254 * Allocate an #svn_wc_conflict_result_t structure in @a pool,
2255 * initialize and return it.
2256 *
2257 * Set the @c choice field of the structure to @a choice, @c merged_file
2258 * to @a merged_file, and @c save_merged to false. Make only a shallow
2259 * copy of the pointer argument @a merged_file. @a merged_file may be
2260 * NULL if setting merged_file is not needed.
2261 *
2262 * @since New in 1.5.
2263 */
2266 const char *merged_file,
2267 apr_pool_t *pool);
2268
2269
2270/** A callback used in merge, update and switch for resolving conflicts
2271 * during the application of a tree delta to a working copy.
2272 *
2273 * @a description describes the exact nature of the conflict, and
2274 * provides information to help resolve it. @a baton is a closure
2275 * object; it should be provided by the implementation, and passed by
2276 * the caller. When finished, the callback signals its resolution by
2277 * returning a structure in @a *result, which should be allocated in
2278 * @a result_pool. (See #svn_wc_conflict_result_t.) @a scratch_pool
2279 * should be used for any temporary allocations.
2280 *
2281 * The values #svn_wc_conflict_choose_mine_conflict and
2282 * #svn_wc_conflict_choose_theirs_conflict are not legal for conflicts
2283 * in binary files or binary properties.
2284 *
2285 * Implementations of this callback are free to present the conflict
2286 * using any user interface. This may include simple contextual
2287 * conflicts in a file's text or properties, or more complex
2288 * 'tree'-based conflicts related to obstructed additions, deletions,
2289 * and edits. The callback implementation is free to decide which
2290 * sorts of conflicts to handle; it's also free to decide which types
2291 * of conflicts are automatically resolvable and which require user
2292 * interaction.
2293 *
2294 * @since New in 1.7.
2295 */
2296typedef svn_error_t *(*svn_wc_conflict_resolver_func2_t)(
2297 svn_wc_conflict_result_t **result,
2298 const svn_wc_conflict_description2_t *description,
2299 void *baton,
2300 apr_pool_t *result_pool,
2301 apr_pool_t *scratch_pool);
2302
2303
2304/** Similar to #svn_wc_conflict_resolver_func2_t, but using
2305 * #svn_wc_conflict_description_t instead of
2306 * #svn_wc_conflict_description2_t
2307 *
2308 * @since New in 1.5.
2309 * @deprecated Provided for backward compatibility with the 1.6 API.
2310 */
2311typedef svn_error_t *(*svn_wc_conflict_resolver_func_t)(
2312 svn_wc_conflict_result_t **result,
2313 const svn_wc_conflict_description_t *description,
2314 void *baton,
2315 apr_pool_t *pool);
2316
2317/** @} */
2318
2319
2320␌
2321/**
2322 * A callback vtable invoked by our diff-editors, as they receive diffs
2323 * from the server. 'svn diff' and 'svn merge' implement their own versions
2324 * of this vtable.
2325 *
2326 * Common parameters:
2327 *
2328 * If @a state is non-NULL, set @a *state to the state of the item
2329 * after the operation has been performed. (In practice, this is only
2330 * useful with merge, not diff; diff callbacks will probably set
2331 * @a *state to #svn_wc_notify_state_unknown, since they do not change
2332 * the state and therefore do not bother to know the state after the
2333 * operation.) By default, @a state refers to the item's content
2334 * state. Functions concerned with property state have separate
2335 * @a contentstate and @a propstate arguments.
2336 *
2337 * If @a tree_conflicted is non-NULL, set @a *tree_conflicted to true if
2338 * this operation caused a tree conflict, else to false. (Like with @a
2339 * state, this is only useful with merge, not diff; diff callbacks
2340 * should set this to false.)
2341 *
2342 * @since New in 1.7.
2343 */
2345{
2346 /**
2347 * This function is called before @a file_changed to allow callbacks to
2348 * skip the most expensive processing of retrieving the file data.
2349 *
2350 */
2351 svn_error_t *(*file_opened)(svn_boolean_t *tree_conflicted,
2352 svn_boolean_t *skip,
2353 const char *path,
2354 svn_revnum_t rev,
2355 void *diff_baton,
2356 apr_pool_t *scratch_pool);
2357
2358 /**
2359 * A file @a path has changed. If @a tmpfile2 is non-NULL, the
2360 * contents have changed and those changes can be seen by comparing
2361 * @a tmpfile1 and @a tmpfile2, which represent @a rev1 and @a rev2 of
2362 * the file, respectively.
2363 *
2364 * If known, the @c svn:mime-type value of each file is passed into
2365 * @a mimetype1 and @a mimetype2; either or both of the values can
2366 * be NULL. The implementor can use this information to decide if
2367 * (or how) to generate differences.
2368 *
2369 * @a propchanges is an array of (#svn_prop_t) structures. If it contains
2370 * any elements, the original list of properties is provided in
2371 * @a originalprops, which is a hash of #svn_string_t values, keyed on the
2372 * property name.
2373 *
2374 */
2375 svn_error_t *(*file_changed)(svn_wc_notify_state_t *contentstate,
2376 svn_wc_notify_state_t *propstate,
2377 svn_boolean_t *tree_conflicted,
2378 const char *path,
2379 const char *tmpfile1,
2380 const char *tmpfile2,
2381 svn_revnum_t rev1,
2382 svn_revnum_t rev2,
2383 const char *mimetype1,
2384 const char *mimetype2,
2385 const apr_array_header_t *propchanges,
2386 apr_hash_t *originalprops,
2387 void *diff_baton,
2388 apr_pool_t *scratch_pool);
2389
2390 /**
2391 * A file @a path was added. The contents can be seen by comparing
2392 * @a tmpfile1 and @a tmpfile2, which represent @a rev1 and @a rev2
2393 * of the file, respectively. (If either file is empty, the rev
2394 * will be 0.)
2395 *
2396 * If known, the @c svn:mime-type value of each file is passed into
2397 * @a mimetype1 and @a mimetype2; either or both of the values can
2398 * be NULL. The implementor can use this information to decide if
2399 * (or how) to generate differences.
2400 *
2401 * @a propchanges is an array of (#svn_prop_t) structures. If it contains
2402 * any elements, the original list of properties is provided in
2403 * @a originalprops, which is a hash of #svn_string_t values, keyed on the
2404 * property name.
2405 * If @a copyfrom_path is non-@c NULL, this add has history (i.e., is a
2406 * copy), and the origin of the copy may be recorded as
2407 * @a copyfrom_path under @a copyfrom_revision.
2408 */
2409 svn_error_t *(*file_added)(svn_wc_notify_state_t *contentstate,
2410 svn_wc_notify_state_t *propstate,
2411 svn_boolean_t *tree_conflicted,
2412 const char *path,
2413 const char *tmpfile1,
2414 const char *tmpfile2,
2415 svn_revnum_t rev1,
2416 svn_revnum_t rev2,
2417 const char *mimetype1,
2418 const char *mimetype2,
2419 const char *copyfrom_path,
2420 svn_revnum_t copyfrom_revision,
2421 const apr_array_header_t *propchanges,
2422 apr_hash_t *originalprops,
2423 void *diff_baton,
2424 apr_pool_t *scratch_pool);
2425
2426 /**
2427 * A file @a path was deleted. The [loss of] contents can be seen by
2428 * comparing @a tmpfile1 and @a tmpfile2. @a originalprops provides
2429 * the properties of the file.
2430 * ### Some existing callers include WC "entry props" in @a originalprops.
2431 *
2432 * If known, the @c svn:mime-type value of each file is passed into
2433 * @a mimetype1 and @a mimetype2; either or both of the values can
2434 * be NULL. The implementor can use this information to decide if
2435 * (or how) to generate differences.
2436 */
2437 svn_error_t *(*file_deleted)(svn_wc_notify_state_t *state,
2438 svn_boolean_t *tree_conflicted,
2439 const char *path,
2440 const char *tmpfile1,
2441 const char *tmpfile2,
2442 const char *mimetype1,
2443 const char *mimetype2,
2444 apr_hash_t *originalprops,
2445 void *diff_baton,
2446 apr_pool_t *scratch_pool);
2447
2448 /**
2449 * A directory @a path was deleted.
2450 */
2451 svn_error_t *(*dir_deleted)(svn_wc_notify_state_t *state,
2452 svn_boolean_t *tree_conflicted,
2453 const char *path,
2454 void *diff_baton,
2455 apr_pool_t *scratch_pool);
2456 /**
2457 * A directory @a path has been opened. @a rev is the revision that the
2458 * directory came from.
2459 *
2460 * This function is called for any existing directory @a path before any
2461 * of the callbacks are called for a child of @a path.
2462 *
2463 * If the callback returns @c TRUE in @a *skip_children, children
2464 * of this directory will be skipped.
2465 */
2466 svn_error_t *(*dir_opened)(svn_boolean_t *tree_conflicted,
2467 svn_boolean_t *skip,
2468 svn_boolean_t *skip_children,
2469 const char *path,
2470 svn_revnum_t rev,
2471 void *diff_baton,
2472 apr_pool_t *scratch_pool);
2473
2474 /**
2475 * A directory @a path was added. @a rev is the revision that the
2476 * directory came from.
2477 *
2478 * This function is called for any new directory @a path before any
2479 * of the callbacks are called for a child of @a path.
2480 *
2481 * If @a copyfrom_path is non-@c NULL, this add has history (i.e., is a
2482 * copy), and the origin of the copy may be recorded as
2483 * @a copyfrom_path under @a copyfrom_revision.
2484 */
2486 svn_boolean_t *tree_conflicted,
2487 svn_boolean_t *skip,
2488 svn_boolean_t *skip_children,
2489 const char *path,
2490 svn_revnum_t rev,
2491 const char *copyfrom_path,
2492 svn_revnum_t copyfrom_revision,
2493 void *diff_baton,
2494 apr_pool_t *scratch_pool);
2495
2496 /**
2497 * A list of property changes (@a propchanges) was applied to the
2498 * directory @a path.
2499 *
2500 * The array is a list of (#svn_prop_t) structures.
2501 *
2502 * @a dir_was_added is set to #TRUE if the directory was added, and
2503 * to #FALSE if the directory pre-existed.
2504 */
2505 svn_error_t *(*dir_props_changed)(svn_wc_notify_state_t *propstate,
2506 svn_boolean_t *tree_conflicted,
2507 const char *path,
2508 svn_boolean_t dir_was_added,
2509 const apr_array_header_t *propchanges,
2510 apr_hash_t *original_props,
2511 void *diff_baton,
2512 apr_pool_t *scratch_pool);
2513
2514 /**
2515 * A directory @a path which has been opened with @a dir_opened or @a
2516 * dir_added has been closed.
2517 *
2518 * @a dir_was_added is set to #TRUE if the directory was added, and
2519 * to #FALSE if the directory pre-existed.
2520 */
2521 svn_error_t *(*dir_closed)(svn_wc_notify_state_t *contentstate,
2522 svn_wc_notify_state_t *propstate,
2523 svn_boolean_t *tree_conflicted,
2524 const char *path,
2525 svn_boolean_t dir_was_added,
2526 void *diff_baton,
2527 apr_pool_t *scratch_pool);
2528
2530
2531
2532/**
2533 * Similar to #svn_wc_diff_callbacks4_t, but without @a copyfrom_path and
2534 * @a copyfrom_revision arguments to @c file_added and @c dir_added functions.
2535 *
2536 * @since New in 1.6.
2537 * @deprecated Provided for backward compatibility with the 1.6 API.
2538 */
2540{
2541 /** The same as #svn_wc_diff_callbacks4_t.file_changed. */
2542 svn_error_t *(*file_changed)(svn_wc_adm_access_t *adm_access,
2543 svn_wc_notify_state_t *contentstate,
2544 svn_wc_notify_state_t *propstate,
2545 svn_boolean_t *tree_conflicted,
2546 const char *path,
2547 const char *tmpfile1,
2548 const char *tmpfile2,
2549 svn_revnum_t rev1,
2550 svn_revnum_t rev2,
2551 const char *mimetype1,
2552 const char *mimetype2,
2553 const apr_array_header_t *propchanges,
2554 apr_hash_t *originalprops,
2555 void *diff_baton);
2556
2557 /** Similar to #svn_wc_diff_callbacks4_t.file_added but without
2558 * @a copyfrom_path and @a copyfrom_revision arguments. */
2559 svn_error_t *(*file_added)(svn_wc_adm_access_t *adm_access,
2560 svn_wc_notify_state_t *contentstate,
2561 svn_wc_notify_state_t *propstate,
2562 svn_boolean_t *tree_conflicted,
2563 const char *path,
2564 const char *tmpfile1,
2565 const char *tmpfile2,
2566 svn_revnum_t rev1,
2567 svn_revnum_t rev2,
2568 const char *mimetype1,
2569 const char *mimetype2,
2570 const apr_array_header_t *propchanges,
2571 apr_hash_t *originalprops,
2572 void *diff_baton);
2573
2574 /** The same as #svn_wc_diff_callbacks4_t.file_deleted. */
2575 svn_error_t *(*file_deleted)(svn_wc_adm_access_t *adm_access,
2576 svn_wc_notify_state_t *state,
2577 svn_boolean_t *tree_conflicted,
2578 const char *path,
2579 const char *tmpfile1,
2580 const char *tmpfile2,
2581 const char *mimetype1,
2582 const char *mimetype2,
2583 apr_hash_t *originalprops,
2584 void *diff_baton);
2585
2586 /** Similar to #svn_wc_diff_callbacks4_t.dir_added but without
2587 * @a copyfrom_path and @a copyfrom_revision arguments. */
2588 svn_error_t *(*dir_added)(svn_wc_adm_access_t *adm_access,
2589 svn_wc_notify_state_t *state,
2590 svn_boolean_t *tree_conflicted,
2591 const char *path,
2592 svn_revnum_t rev,
2593 void *diff_baton);
2594
2595 /** The same as #svn_wc_diff_callbacks4_t.dir_deleted. */
2596 svn_error_t *(*dir_deleted)(svn_wc_adm_access_t *adm_access,
2597 svn_wc_notify_state_t *state,
2598 svn_boolean_t *tree_conflicted,
2599 const char *path,
2600 void *diff_baton);
2601
2602 /** The same as #svn_wc_diff_callbacks4_t.dir_props_changed. */
2603 svn_error_t *(*dir_props_changed)(svn_wc_adm_access_t *adm_access,
2604 svn_wc_notify_state_t *propstate,
2605 svn_boolean_t *tree_conflicted,
2606 const char *path,
2607 const apr_array_header_t *propchanges,
2608 apr_hash_t *original_props,
2609 void *diff_baton);
2610
2611 /** The same as #svn_wc_diff_callbacks4_t.dir_opened. */
2612 svn_error_t *(*dir_opened)(svn_wc_adm_access_t *adm_access,
2613 svn_boolean_t *tree_conflicted,
2614 const char *path,
2615 svn_revnum_t rev,
2616 void *diff_baton);
2617
2618 /** The same as #svn_wc_diff_callbacks4_t.dir_closed. */
2619 svn_error_t *(*dir_closed)(svn_wc_adm_access_t *adm_access,
2620 svn_wc_notify_state_t *contentstate,
2621 svn_wc_notify_state_t *propstate,
2622 svn_boolean_t *tree_conflicted,
2623 const char *path,
2624 void *diff_baton);
2625
2627
2628/**
2629 * Similar to #svn_wc_diff_callbacks3_t, but without the @c dir_opened
2630 * and @c dir_closed functions, and without the @a tree_conflicted argument
2631 * to the functions.
2632 *
2633 * @deprecated Provided for backward compatibility with the 1.2 API.
2634 */
2636{
2637 /** The same as @c file_changed in #svn_wc_diff_callbacks3_t. */
2638 svn_error_t *(*file_changed)(svn_wc_adm_access_t *adm_access,
2639 svn_wc_notify_state_t *contentstate,
2640 svn_wc_notify_state_t *propstate,
2641 const char *path,
2642 const char *tmpfile1,
2643 const char *tmpfile2,
2644 svn_revnum_t rev1,
2645 svn_revnum_t rev2,
2646 const char *mimetype1,
2647 const char *mimetype2,
2648 const apr_array_header_t *propchanges,
2649 apr_hash_t *originalprops,
2650 void *diff_baton);
2651
2652 /** The same as @c file_added in #svn_wc_diff_callbacks3_t. */
2653 svn_error_t *(*file_added)(svn_wc_adm_access_t *adm_access,
2654 svn_wc_notify_state_t *contentstate,
2655 svn_wc_notify_state_t *propstate,
2656 const char *path,
2657 const char *tmpfile1,
2658 const char *tmpfile2,
2659 svn_revnum_t rev1,
2660 svn_revnum_t rev2,
2661 const char *mimetype1,
2662 const char *mimetype2,
2663 const apr_array_header_t *propchanges,
2664 apr_hash_t *originalprops,
2665 void *diff_baton);
2666
2667 /** The same as @c file_deleted in #svn_wc_diff_callbacks3_t. */
2668 svn_error_t *(*file_deleted)(svn_wc_adm_access_t *adm_access,
2669 svn_wc_notify_state_t *state,
2670 const char *path,
2671 const char *tmpfile1,
2672 const char *tmpfile2,
2673 const char *mimetype1,
2674 const char *mimetype2,
2675 apr_hash_t *originalprops,
2676 void *diff_baton);
2677
2678 /** The same as @c dir_added in #svn_wc_diff_callbacks3_t. */
2679 svn_error_t *(*dir_added)(svn_wc_adm_access_t *adm_access,
2680 svn_wc_notify_state_t *state,
2681 const char *path,
2682 svn_revnum_t rev,
2683 void *diff_baton);
2684
2685 /** The same as @c dir_deleted in #svn_wc_diff_callbacks3_t. */
2686 svn_error_t *(*dir_deleted)(svn_wc_adm_access_t *adm_access,
2687 svn_wc_notify_state_t *state,
2688 const char *path,
2689 void *diff_baton);
2690
2691 /** The same as @c dir_props_changed in #svn_wc_diff_callbacks3_t. */
2692 svn_error_t *(*dir_props_changed)(svn_wc_adm_access_t *adm_access,
2693 svn_wc_notify_state_t *state,
2694 const char *path,
2695 const apr_array_header_t *propchanges,
2696 apr_hash_t *original_props,
2697 void *diff_baton);
2698
2700
2701/**
2702 * Similar to #svn_wc_diff_callbacks2_t, but with file additions/content
2703 * changes and property changes split into different functions.
2704 *
2705 * @deprecated Provided for backward compatibility with the 1.1 API.
2706 */
2708{
2709 /** Similar to @c file_changed in #svn_wc_diff_callbacks2_t, but without
2710 * property change information. @a tmpfile2 is never NULL. @a state applies
2711 * to the file contents. */
2712 svn_error_t *(*file_changed)(svn_wc_adm_access_t *adm_access,
2713 svn_wc_notify_state_t *state,
2714 const char *path,
2715 const char *tmpfile1,
2716 const char *tmpfile2,
2717 svn_revnum_t rev1,
2718 svn_revnum_t rev2,
2719 const char *mimetype1,
2720 const char *mimetype2,
2721 void *diff_baton);
2722
2723 /** Similar to @c file_added in #svn_wc_diff_callbacks2_t, but without
2724 * property change information. @a *state applies to the file contents. */
2725 svn_error_t *(*file_added)(svn_wc_adm_access_t *adm_access,
2726 svn_wc_notify_state_t *state,
2727 const char *path,
2728 const char *tmpfile1,
2729 const char *tmpfile2,
2730 svn_revnum_t rev1,
2731 svn_revnum_t rev2,
2732 const char *mimetype1,
2733 const char *mimetype2,
2734 void *diff_baton);
2735
2736 /** Similar to @c file_deleted in #svn_wc_diff_callbacks2_t, but without
2737 * the properties. */
2738 svn_error_t *(*file_deleted)(svn_wc_adm_access_t *adm_access,
2739 svn_wc_notify_state_t *state,
2740 const char *path,
2741 const char *tmpfile1,
2742 const char *tmpfile2,
2743 const char *mimetype1,
2744 const char *mimetype2,
2745 void *diff_baton);
2746
2747 /** The same as @c dir_added in #svn_wc_diff_callbacks2_t. */
2748 svn_error_t *(*dir_added)(svn_wc_adm_access_t *adm_access,
2749 svn_wc_notify_state_t *state,
2750 const char *path,
2751 svn_revnum_t rev,
2752 void *diff_baton);
2753
2754 /** The same as @c dir_deleted in #svn_wc_diff_callbacks2_t. */
2755 svn_error_t *(*dir_deleted)(svn_wc_adm_access_t *adm_access,
2756 svn_wc_notify_state_t *state,
2757 const char *path,
2758 void *diff_baton);
2759
2760 /** Similar to @c dir_props_changed in #svn_wc_diff_callbacks2_t, but this
2761 * function is called for files as well as directories. */
2762 svn_error_t *(*props_changed)(svn_wc_adm_access_t *adm_access,
2763 svn_wc_notify_state_t *state,
2764 const char *path,
2765 const apr_array_header_t *propchanges,
2766 apr_hash_t *original_props,
2767 void *diff_baton);
2768
2770
2771␌
2772/* Asking questions about a working copy. */
2773
2774/** Set @a *wc_format to @a local_abspath's working copy format version
2775 * number if @a local_abspath is a valid working copy directory, else set it
2776 * to 0.
2777 *
2778 * Return error @c APR_ENOENT if @a local_abspath does not exist at all.
2779 *
2780 * @since New in 1.7.
2781 */
2783svn_wc_check_wc2(int *wc_format,
2784 svn_wc_context_t *wc_ctx,
2785 const char *local_abspath,
2786 apr_pool_t *scratch_pool);
2787
2788/**
2789 * Similar to svn_wc_check_wc2(), but with a relative path and no supplied
2790 * working copy context.
2791 *
2792 * @deprecated Provided for backward compatibility with the 1.6 API.
2793 */
2797 int *wc_format,
2798 apr_pool_t *pool);
2799
2800
2801/** Set @a *has_binary_prop to @c TRUE iff @a path has been marked
2802 * with a property indicating that it is non-text (in other words, binary).
2803 * @a adm_access is an access baton set that contains @a path.
2804 *
2805 * @deprecated Provided for backward compatibility with the 1.6 API. As a
2806 * replacement for this functionality, @see svn_mime_type_is_binary and
2807 * #SVN_PROP_MIME_TYPE.
2808 */
2812 const char *path,
2813 svn_wc_adm_access_t *adm_access,
2814 apr_pool_t *pool);
2815
2816␌
2817/* Detecting modification. */
2818
2819/** Set @a *modified_p to non-zero if @a local_abspath's text is modified
2820 * with regard to the base revision, else set @a *modified_p to zero.
2821 * @a local_abspath is the absolute path to the file.
2822 *
2823 * This function uses some heuristics to avoid byte-by-byte comparisons
2824 * against the base text (eg. file size and its modification time).
2825 *
2826 * If @a local_abspath does not exist, consider it unmodified. If it exists
2827 * but is not under revision control (not even scheduled for
2828 * addition), return the error #SVN_ERR_ENTRY_NOT_FOUND.
2829 *
2830 * @a unused is ignored.
2831 *
2832 * @since New in 1.7.
2833 */
2836 svn_wc_context_t *wc_ctx,
2837 const char *local_abspath,
2838 svn_boolean_t unused,
2839 apr_pool_t *scratch_pool);
2840
2841/** Similar to svn_wc_text_modified_p2(), but with a relative path and
2842 * adm_access baton?
2843 *
2844 * @deprecated Provided for backward compatibility with the 1.6 API.
2845 */
2849 const char *filename,
2850 svn_boolean_t force_comparison,
2851 svn_wc_adm_access_t *adm_access,
2852 apr_pool_t *pool);
2853
2854/** Set @a *modified_p to non-zero if @a path's properties are modified
2855 * with regard to the base revision, else set @a modified_p to zero.
2856 * @a adm_access must be an access baton for @a path.
2857 *
2858 * @since New in 1.7.
2859 */
2862 svn_wc_context_t *wc_ctx,
2863 const char *local_abspath,
2864 apr_pool_t *scratch_pool);
2865
2866/** Similar to svn_wc_props_modified_p2(), but with a relative path and
2867 * adm_access baton.
2868 *
2869 * @deprecated Provided for backward compatibility with the 1.6 API.
2870 */
2874 const char *path,
2875 svn_wc_adm_access_t *adm_access,
2876 apr_pool_t *pool);
2877
2878
2879/**
2880␌* @defgroup svn_wc_entries Entries and status (deprecated)
2881 * @{
2882 */
2883
2884/** The schedule states an entry can be in.
2885 * @deprecated Provided for backward compatibility with the 1.6 API. */
2887{
2888 /** Nothing special here */
2890
2891 /** Slated for addition */
2893
2894 /** Slated for deletion */
2896
2897 /** Slated for replacement (delete + add) */
2899
2901
2902
2903/**
2904 * Values for the working_size field in svn_wc_entry_t
2905 * when it isn't set to the actual size value of the unchanged
2906 * working file.
2907 *
2908 * The value of the working size is unknown (hasn't been
2909 * calculated and stored in the past for whatever reason).
2910 *
2911 * @since New in 1.5
2912 * @deprecated Provided for backward compatibility with the 1.6 API.
2913 */
2914#define SVN_WC_ENTRY_WORKING_SIZE_UNKNOWN (-1)
2915
2916/** A working copy entry -- that is, revision control information about
2917 * one versioned entity.
2918 *
2919 * @deprecated Provided for backward compatibility with the 1.6 API.
2920 */
2921/* SVN_DEPRECATED */
2922typedef struct svn_wc_entry_t
2923{
2924 /* IMPORTANT: If you extend this structure, add new fields to the end. */
2925
2926 /* General Attributes */
2927
2928 /** entry's name */
2929 const char *name;
2930
2931 /** base revision */
2933
2934 /** url in repository */
2935 const char *url;
2936
2937 /** canonical repository URL or NULL if not known */
2938 const char *repos;
2939
2940 /** repository uuid */
2941 const char *uuid;
2942
2943 /** node kind (file, dir, ...) */
2945
2946 /* State information */
2947
2948 /** scheduling (add, delete, replace ...) */
2950
2951 /** in a copied state (possibly because the entry is a child of a
2952 * path that is #svn_wc_schedule_add or #svn_wc_schedule_replace,
2953 * when the entry itself is #svn_wc_schedule_normal).
2954 * COPIED is true for nodes under a directory that was copied, but
2955 * COPYFROM_URL is null there. They are both set for the root
2956 * destination of the copy.
2957 */
2959
2960 /** The directory containing this entry had a versioned child of this
2961 * name, but this entry represents a different revision or a switched
2962 * path at which no item exists in the repository. This typically
2963 * arises from committing or updating to a deletion of this entry
2964 * without committing or updating the parent directory.
2965 *
2966 * The schedule can be 'normal' or 'add'. */
2968
2969 /** absent -- we know an entry of this name exists, but that's all
2970 (usually this happens because of authz restrictions) */
2972
2973 /** for THIS_DIR entry, implies whole entries file is incomplete */
2975
2976 /** copyfrom location */
2977 const char *copyfrom_url;
2978
2979 /** copyfrom revision */
2981
2982 /** old version of conflicted file. A file basename, relative to the
2983 * user's directory that the THIS_DIR entry refers to. */
2984 const char *conflict_old;
2985
2986 /** new version of conflicted file. A file basename, relative to the
2987 * user's directory that the THIS_DIR entry refers to. */
2988 const char *conflict_new;
2989
2990 /** working version of conflicted file. A file basename, relative to the
2991 * user's directory that the THIS_DIR entry refers to. */
2992 const char *conflict_wrk;
2993
2994 /** property reject file. A file basename, relative to the user's
2995 * directory that the THIS_DIR entry refers to. */
2996 const char *prejfile;
2997
2998 /** last up-to-date time for text contents (0 means no information available)
2999 */
3000 apr_time_t text_time;
3001
3002 /** last up-to-date time for properties (0 means no information available)
3003 *
3004 * @deprecated This value will always be 0 in version 1.4 and later.
3005 */
3006 apr_time_t prop_time;
3007
3008 /** Hex MD5 checksum for the untranslated text base file,
3009 * can be @c NULL for backwards compatibility.
3010 */
3011 const char *checksum;
3012
3013 /* "Entry props" */
3014
3015 /** last revision this was changed */
3017
3018 /** last date this was changed */
3019 apr_time_t cmt_date;
3020
3021 /** last commit author of this item */
3022 const char *cmt_author;
3023
3024 /** lock token or NULL if path not locked in this WC
3025 * @since New in 1.2.
3026 */
3027 const char *lock_token;
3028
3029 /** lock owner, or NULL if not locked in this WC
3030 * @since New in 1.2.
3031 */
3032 const char *lock_owner;
3033
3034 /** lock comment or NULL if not locked in this WC or no comment
3035 * @since New in 1.2.
3036 */
3037 const char *lock_comment;
3038
3039 /** Lock creation date or 0 if not locked in this WC
3040 * @since New in 1.2.
3041 */
3043
3044 /** Whether this entry has any working properties.
3045 * False if this information is not stored in the entry.
3046 *
3047 * @since New in 1.4. */
3049
3050 /** Whether this entry has property modifications.
3051 *
3052 * @note For working copies in older formats, this flag is not valid.
3053 *
3054 * @see svn_wc_props_modified_p().
3055 *
3056 * @since New in 1.4. */
3058
3059 /** A space-separated list of all properties whose presence/absence is cached
3060 * in this entry.
3061 *
3062 * @see @c present_props.
3063 *
3064 * @since New in 1.4.
3065 * @deprecated This value will always be "" in version 1.7 and later. */
3066 const char *cachable_props;
3067
3068 /** Cached property existence for this entry.
3069 * This is a space-separated list of property names. If a name exists in
3070 * @c cachable_props but not in this list, this entry does not have that
3071 * property. If a name exists in both lists, the property is present on this
3072 * entry.
3073 *
3074 * @since New in 1.4.
3075 * @deprecated This value will always be "" in version 1.7 and later. */
3076 const char *present_props;
3077
3078 /** which changelist this item is part of, or NULL if not part of any.
3079 * @since New in 1.5.
3080 */
3081 const char *changelist;
3082
3083 /** Size of the file after being translated into local
3084 * representation, or #SVN_WC_ENTRY_WORKING_SIZE_UNKNOWN if
3085 * unknown.
3086 *
3087 * @since New in 1.5.
3088 */
3089 apr_off_t working_size;
3090
3091 /** Whether a local copy of this entry should be kept in the working copy
3092 * after a deletion has been committed, Only valid for the this-dir entry
3093 * when it is scheduled for deletion.
3094 *
3095 * @since New in 1.5. */
3097
3098 /** The depth of this entry.
3099 *
3100 * ### It's a bit annoying that we only use this on this_dir
3101 * ### entries, yet it will exist (with value svn_depth_infinity) on
3102 * ### all entries. Maybe some future extensibility would make this
3103 * ### field meaningful on entries besides this_dir.
3104 *
3105 * @since New in 1.5. */
3107
3108 /** Serialized data for all of the tree conflicts detected in this_dir.
3109 *
3110 * @since New in 1.6. */
3112
3113 /** The entry is a intra-repository file external and this is the
3114 * repository root relative path to the file specified in the
3115 * externals definition, otherwise NULL if the entry is not a file
3116 * external.
3117 *
3118 * @since New in 1.6. */
3120
3121 /** The entry is a intra-repository file external and this is the
3122 * peg revision number specified in the externals definition. This
3123 * field is only valid when the file_external_path field is
3124 * non-NULL. The only permissible values are
3125 * svn_opt_revision_unspecified if the entry is not an external,
3126 * svn_opt_revision_head if the external revision is unspecified or
3127 * specified with -r HEAD or svn_opt_revision_number for a specific
3128 * revision number.
3129 *
3130 * @since New in 1.6. */
3132
3133 /** The entry is an intra-repository file external and this is the
3134 * operative revision number specified in the externals definition.
3135 * This field is only valid when the file_external_path field is
3136 * non-NULL. The only permissible values are
3137 * svn_opt_revision_unspecified if the entry is not an external,
3138 * svn_opt_revision_head if the external revision is unspecified or
3139 * specified with -r HEAD or svn_opt_revision_number for a specific
3140 * revision number.
3141 *
3142 * @since New in 1.6. */
3144
3145 /* IMPORTANT: If you extend this structure, check the following functions in
3146 * subversion/libsvn_wc/entries.c, to see if you need to extend them as well.
3147 *
3148 * svn_wc__atts_to_entry()
3149 * svn_wc_entry_dup()
3150 * alloc_entry()
3151 * read_entry()
3152 * write_entry()
3153 * fold_entry()
3154 */
3156
3157
3158/** How an entries file's owner dir is named in the entries file.
3159 * @deprecated Provided for backward compatibility with the 1.6 API. */
3160#define SVN_WC_ENTRY_THIS_DIR ""
3161
3162
3163/** Set @a *entry to an entry for @a path, allocated in the access baton pool.
3164 * If @a show_hidden is TRUE, return the entry even if it's in 'excluded',
3165 * 'deleted' or 'absent' state. Excluded entries are those with their depth
3166 * set to #svn_depth_exclude. If @a path is not under revision control, or
3167 * if entry is hidden, not scheduled for re-addition, and @a show_hidden is @c
3168 * FALSE, then set @a *entry to @c NULL.
3169 *
3170 * @a *entry should not be modified, since doing so modifies the entries
3171 * cache in @a adm_access without changing the entries file on disk.
3172 *
3173 * If @a path is not a directory then @a adm_access must be an access baton
3174 * for the parent directory of @a path. To avoid needing to know whether
3175 * @a path is a directory or not, if @a path is a directory @a adm_access
3176 * can still be an access baton for the parent of @a path so long as the
3177 * access baton for @a path itself is in the same access baton set.
3178 *
3179 * @a path can be relative or absolute but must share the same base used
3180 * to open @a adm_access.
3181 *
3182 * Note that it is possible for @a path to be absent from disk but still
3183 * under revision control; and conversely, it is possible for @a path to
3184 * be present, but not under revision control.
3185 *
3186 * Use @a pool only for local processing.
3187 *
3188 * @deprecated Provided for backward compatibility with the 1.6 API.
3189 */
3193 const char *path,
3194 svn_wc_adm_access_t *adm_access,
3195 svn_boolean_t show_hidden,
3196 apr_pool_t *pool);
3197
3198
3199/** Parse the `entries' file for @a adm_access and return a hash @a entries,
3200 * whose keys are (<tt>const char *</tt>) entry names and values are
3201 * (<tt>svn_wc_entry_t *</tt>). The hash @a entries, and its keys and
3202 * values, are allocated from the pool used to open the @a adm_access
3203 * baton (that's how the entries caching works). @a pool is used for
3204 * transient allocations.
3205 *
3206 * Entries that are in a 'excluded', 'deleted' or 'absent' state (and not
3207 * scheduled for re-addition) are not returned in the hash, unless
3208 * @a show_hidden is TRUE. Excluded entries are those with their depth set to
3209 * #svn_depth_exclude.
3210 *
3211 * @par Important:
3212 * The @a entries hash is the entries cache in @a adm_access
3213 * and so usually the hash itself, the keys and the values should be treated
3214 * as read-only. If any of these are modified then it is the caller's
3215 * responsibility to ensure that the entries file on disk is updated. Treat
3216 * the hash values as type (<tt>const svn_wc_entry_t *</tt>) if you wish to
3217 * avoid accidental modification. Modifying the schedule member is a
3218 * particularly bad idea, as the entries writing process relies on having
3219 * access to the original schedule. Use a duplicate entry to modify the
3220 * schedule.
3221 *
3222 * @par Important:
3223 * Only the entry structures representing files and
3224 * #SVN_WC_ENTRY_THIS_DIR contain complete information. The entry
3225 * structures representing subdirs have only the `kind' and `state'
3226 * fields filled in. If you want info on a subdir, you must use this
3227 * routine to open its @a path and read the #SVN_WC_ENTRY_THIS_DIR
3228 * structure, or call svn_wc_entry() on its @a path.
3229 *
3230 * @deprecated Provided for backward compatibility with the 1.6 API.
3231 */
3234svn_wc_entries_read(apr_hash_t **entries,
3235 svn_wc_adm_access_t *adm_access,
3236 svn_boolean_t show_hidden,
3237 apr_pool_t *pool);
3238
3239
3240/** Return a duplicate of @a entry, allocated in @a pool. No part of the new
3241 * entry will be shared with @a entry.
3242 *
3243 * @deprecated Provided for backward compatibility with the 1.6 API.
3244 */
3248 apr_pool_t *pool);
3249
3250/** @} */
3251
3252
3253/**
3254 * This struct contains information about a working copy node.
3255 *
3256 * @note Fields may be added to the end of this structure in future
3257 * versions. Therefore, users shouldn't allocate structures of this
3258 * type, to preserve binary compatibility.
3259 *
3260 * @since New in 1.7.
3261 */
3262typedef struct svn_wc_info_t
3263{
3264 /** The schedule of this item
3265 * ### Do we still need schedule? */
3267
3268 /** If copied, the URL from which the copy was made, else @c NULL. */
3269 const char *copyfrom_url;
3270
3271 /** If copied, the revision from which the copy was made,
3272 * else #SVN_INVALID_REVNUM. */
3274
3275 /** The checksum of the node, if it is a file. */
3277
3278 /** A changelist the item is in, @c NULL if this node is not in a
3279 * changelist. */
3280 const char *changelist;
3281
3282 /** The depth of the item, see #svn_depth_t */
3284
3285 /**
3286 * The size of the file after being translated into its local
3287 * representation, or #SVN_INVALID_FILESIZE if unknown.
3288 * Not applicable for directories.
3289 */
3291
3292 /**
3293 * The time at which the file had the recorded size recorded_size and was
3294 * considered unmodified. */
3295 apr_time_t recorded_time;
3296
3297 /** Array of const svn_wc_conflict_description2_t * which contains info
3298 * on any conflict of which this node is a victim. Otherwise NULL. */
3299 const apr_array_header_t *conflicts;
3300
3301 /** The local absolute path of the working copy root. */
3302 const char *wcroot_abspath;
3303
3304 /** The path the node was moved from, if it was moved here. Else NULL.
3305 * @since New in 1.8. */
3307
3308 /** The path the node was moved to, if it was moved away. Else NULL.
3309 * @since New in 1.8. */
3310 const char *moved_to_abspath;
3311
3312 /**
3313 * The format of the working copy.
3314 * @since New in 1.15.
3315 */
3317
3318 /**
3319 * Whether pristine content is stored locally or is being fetched on-demand.
3320 * @since New in 1.15.
3321 */
3324
3325/**
3326 * Return a duplicate of @a info, allocated in @a pool. No part of the new
3327 * structure will be shared with @a info.
3328 *
3329 * @since New in 1.7.
3330 */
3333 apr_pool_t *pool);
3334
3335
3336/** Given @a local_abspath in a dir under version control, decide if it is
3337 * in a state of conflict; return the answers in @a *text_conflicted_p, @a
3338 * *prop_conflicted_p, and @a *tree_conflicted_p. If one or two of the
3339 * answers are uninteresting, simply pass @c NULL pointers for those.
3340 *
3341 * If @a local_abspath is unversioned or does not exist, return
3342 * #SVN_ERR_WC_PATH_NOT_FOUND.
3343 *
3344 * If the @a local_abspath has corresponding text conflict files (with suffix
3345 * .mine, .theirs, etc.) that cannot be found, assume that the text conflict
3346 * has been resolved by the user and return @c FALSE in @a
3347 * *text_conflicted_p.
3348 *
3349 * Similarly, if a property conflicts file (.prej suffix) is said to exist,
3350 * but it cannot be found, assume that the property conflicts have been
3351 * resolved by the user and return @c FALSE in @a *prop_conflicted_p.
3352 *
3353 * @a *tree_conflicted_p can't be auto-resolved in this fashion. An
3354 * explicit `resolved' is needed.
3355 *
3356 * @since New in 1.7.
3357 */
3359svn_wc_conflicted_p3(svn_boolean_t *text_conflicted_p,
3360 svn_boolean_t *prop_conflicted_p,
3361 svn_boolean_t *tree_conflicted_p,
3362 svn_wc_context_t *wc_ctx,
3363 const char *local_abspath,
3364 apr_pool_t *scratch_pool);
3365
3366/** Similar to svn_wc_conflicted_p3(), but with a path/adm_access parameter
3367 * pair in place of a wc_ctx/local_abspath pair.
3368 *
3369 * @since New in 1.6.
3370 * @deprecated Provided for backward compatibility with the 1.6 API.
3371 */
3375 svn_boolean_t *prop_conflicted_p,
3376 svn_boolean_t *tree_conflicted_p,
3377 const char *path,
3378 svn_wc_adm_access_t *adm_access,
3379 apr_pool_t *pool);
3380
3381/** Given a @a dir_path under version control, decide if one of its entries
3382 * (@a entry) is in a state of conflict; return the answers in @a
3383 * text_conflicted_p and @a prop_conflicted_p. These pointers must not be
3384 * null.
3385 *
3386 * If the @a entry mentions that text conflict files (with suffix .mine,
3387 * .theirs, etc.) exist, but they cannot be found, assume the text conflict
3388 * has been resolved by the user and return FALSE in @a *text_conflicted_p.
3389 *
3390 * Similarly, if the @a entry mentions that a property conflicts file (.prej
3391 * suffix) exists, but it cannot be found, assume the property conflicts
3392 * have been resolved by the user and return FALSE in @a *prop_conflicted_p.
3393 *
3394 * The @a entry is not updated.
3395 *
3396 * @deprecated Provided for backward compatibility with the 1.5 API.
3397 */
3401 svn_boolean_t *prop_conflicted_p,
3402 const char *dir_path,
3403 const svn_wc_entry_t *entry,
3404 apr_pool_t *pool);
3405
3406
3407/** Set @a *url and @a *rev to the ancestor URL and revision for @a path,
3408 * allocating in @a pool. @a adm_access must be an access baton for @a path.
3409 *
3410 * If @a url or @a rev is NULL, then ignore it (just don't return the
3411 * corresponding information).
3412 *
3413 * @deprecated Provided for backward compatibility with the 1.6 API.
3414 */
3418 svn_revnum_t *rev,
3419 const char *path,
3420 svn_wc_adm_access_t *adm_access,
3421 apr_pool_t *pool);
3422
3423
3424/** A callback vtable invoked by the generic entry-walker function.
3425 * @since New in 1.5.
3426 */
3428{
3429 /** An @a entry was found at @a path. */
3430 svn_error_t *(*found_entry)(const char *path,
3431 const svn_wc_entry_t *entry,
3432 void *walk_baton,
3433 apr_pool_t *pool);
3434
3435 /** Handle the error @a err encountered while processing @a path.
3436 * Wrap or squelch @a err as desired, and return an #svn_error_t
3437 * *, or #SVN_NO_ERROR.
3438 */
3439 svn_error_t *(*handle_error)(const char *path,
3441 void *walk_baton,
3442 apr_pool_t *pool);
3443
3445
3446/** @deprecated Provided for backward compatibility with the 1.4 API. */
3448{
3449 /** An @a entry was found at @a path. */
3450 svn_error_t *(*found_entry)(const char *path,
3451 const svn_wc_entry_t *entry,
3452 void *walk_baton,
3453 apr_pool_t *pool);
3454
3456
3457/**
3458 * A generic entry-walker.
3459 *
3460 * Do a potentially recursive depth-first entry-walk beginning on
3461 * @a path, which can be a file or dir. Call callbacks in
3462 * @a walk_callbacks, passing @a walk_baton to each. Use @a pool for
3463 * looping, recursion, and to allocate all entries returned.
3464 * @a adm_access must be an access baton for @a path. The pool
3465 * passed to @a walk_callbacks is a temporary subpool of @a pool.
3466 *
3467 * If @a depth is #svn_depth_empty, invoke the callbacks on @a path
3468 * and return without recursing further. If #svn_depth_files, do
3469 * the same and invoke the callbacks on file children (if any) of
3470 * @a path, then return. If #svn_depth_immediates, do the preceding
3471 * but also invoke callbacks on immediate subdirectories, then return.
3472 * If #svn_depth_infinity, recurse fully starting from @a path.
3473 *
3474 * If @a cancel_func is non-NULL, call it with @a cancel_baton to determine
3475 * if the client has canceled the operation.
3476 *
3477 * Like our other entries interfaces, entries that are in a 'excluded',
3478 * 'deleted' or 'absent' state (and not scheduled for re-addition) are not
3479 * discovered, unless @a show_hidden is TRUE. Excluded entries are those with
3480 * their depth set to #svn_depth_exclude.
3481 *
3482 * When a new directory is entered, #SVN_WC_ENTRY_THIS_DIR will always
3483 * be returned first.
3484 *
3485 * @note Callers should be aware that each directory will be
3486 * returned *twice*: first as an entry within its parent, and
3487 * subsequently as the '.' entry within itself. The two calls can be
3488 * distinguished by looking for #SVN_WC_ENTRY_THIS_DIR in the 'name'
3489 * field of the entry.
3490 *
3491 * @since New in 1.5.
3492 * @deprecated Provided for backward compatibility with the 1.6 API.
3493 */
3497 svn_wc_adm_access_t *adm_access,
3498 const svn_wc_entry_callbacks2_t *walk_callbacks,
3499 void *walk_baton,
3500 svn_depth_t depth,
3501 svn_boolean_t show_hidden,
3502 svn_cancel_func_t cancel_func,
3503 void *cancel_baton,
3504 apr_pool_t *pool);
3505
3506/**
3507 * Similar to svn_wc_walk_entries3(), but without cancellation support
3508 * or error handling from @a walk_callbacks, and with @a depth always
3509 * set to #svn_depth_infinity.
3510 *
3511 * @since New in 1.2.
3512 * @deprecated Provided for backward compatibility with the 1.4 API.
3513 */
3517 svn_wc_adm_access_t *adm_access,
3518 const svn_wc_entry_callbacks_t *walk_callbacks,
3519 void *walk_baton,
3520 svn_boolean_t show_hidden,
3521 svn_cancel_func_t cancel_func,
3522 void *cancel_baton,
3523 apr_pool_t *pool);
3524
3525/**
3526 * Similar to svn_wc_walk_entries2(), but without cancellation support.
3527 *
3528 * @deprecated Provided for backward compatibility with the 1.1 API.
3529 */
3533 svn_wc_adm_access_t *adm_access,
3534 const svn_wc_entry_callbacks_t *walk_callbacks,
3535 void *walk_baton,
3536 svn_boolean_t show_hidden,
3537 apr_pool_t *pool);
3538
3539
3540/** Mark missing @a path as 'deleted' in its @a parent's list of
3541 * entries. @a path should be a directory that is both deleted (via
3542 * svn_wc_delete4) and removed (via a system call). This function
3543 * should only be called during post-commit processing following a
3544 * successful commit editor drive.
3545 *
3546 * Return #SVN_ERR_WC_PATH_FOUND if @a path isn't actually missing.
3547 *
3548 * @deprecated Provided for backward compatibility with the 1.6 API.
3549 */
3553 svn_wc_adm_access_t *parent,
3554 apr_pool_t *pool);
3555
3556
3557/**
3558 * Ensure that an administrative area exists for @a local_abspath, so
3559 * that @a local_abspath is a working copy subdir based on @a url at @a
3560 * revision, with depth @a depth, and with repository UUID @a repos_uuid
3561 * and repository root URL @a repos_root_url.
3562 *
3563 * @a depth must be a definite depth, it cannot be #svn_depth_unknown.
3564 * @a repos_uuid and @a repos_root_url MUST NOT be @c NULL, and
3565 * @a repos_root_url must be a prefix of @a url.
3566 *
3567 * If the administrative area does not exist, then create it and
3568 * initialize it to an unlocked state. The format of the new
3569 * administrative area will be the library's default format
3570 * (#SVN_WC__DEFAULT_VERSION).
3571 *
3572 * If the administrative area already exists then the given @a url
3573 * must match the URL in the administrative area and the given
3574 * @a revision must match the BASE of the working copy dir unless
3575 * the admin directory is scheduled for deletion or the
3576 * #SVN_ERR_WC_OBSTRUCTED_UPDATE error will be returned.
3577 *
3578 * Do not ensure existence of @a local_abspath itself; if @a local_abspath
3579 * does not exist, return error.
3580 *
3581 * Use @a scratch_pool for temporary allocations.
3582 *
3583 * @since New in 1.7.
3584 * @deprecated Provided for backwards compatibility with the 1.14 API.
3585 */
3589 const char *local_abspath,
3590 const char *url,
3591 const char *repos_root_url,
3592 const char *repos_uuid,
3594 svn_depth_t depth,
3595 apr_pool_t *scratch_pool);
3596
3597/**
3598 * Similar to svn_wc_ensure_adm4(), but without the wc context parameter.
3599 *
3600 * @note the @a uuid and @a repos parameters were documented as allowing
3601 * @c NULL to be passed. Beginning with 1.7, this will return an error,
3602 * contrary to prior documented behavior: see 'notes/api-errata/1.7/wc005.txt'.
3603 *
3604 * @since New in 1.5.
3605 * @deprecated Provided for backwards compatibility with the 1.6 API.
3606 */
3610 const char *uuid,
3611 const char *url,
3612 const char *repos,
3614 svn_depth_t depth,
3615 apr_pool_t *pool);
3616
3617
3618/**
3619 * Similar to svn_wc_ensure_adm3(), but with @a depth set to
3620 * #svn_depth_infinity.
3621 *
3622 * See the note on svn_wc_ensure_adm3() regarding the @a repos and @a uuid
3623 * parameters.
3624 *
3625 * @since New in 1.3.
3626 * @deprecated Provided for backwards compatibility with the 1.4 API.
3627 */
3631 const char *uuid,
3632 const char *url,
3633 const char *repos,
3635 apr_pool_t *pool);
3636
3637
3638/**
3639 * Similar to svn_wc_ensure_adm2(), but with @a repos set to @c NULL.
3640 *
3641 * @note as of 1.7, this function always returns #SVN_ERR_BAD_URL since
3642 * the @a repos parameter may not be @c NULL.
3643 *
3644 * @deprecated Provided for backwards compatibility with the 1.2 API.
3645 */
3649 const char *uuid,
3650 const char *url,
3652 apr_pool_t *pool);
3653
3654
3655/** Set the repository root URL of @a path to @a repos, if possible.
3656 *
3657 * Before Subversion 1.7 there could be working copy directories that
3658 * didn't have a stored repository root in some specific circumstances.
3659 * This function allowed setting this root later.
3660 *
3661 * Since Subversion 1.7 this function just returns #SVN_NO_ERROR.
3662 *
3663 * @since New in 1.3.
3664 * @deprecated Provided for backwards compatibility with the 1.6 API.
3665 */
3669 const char *path,
3670 const char *repos,
3671 apr_pool_t *pool);
3672
3673␌
3674/**
3675 * @defgroup svn_wc_status Working copy status.
3676 * @{
3677 *
3678 * We have three functions for getting working copy status: one function
3679 * for getting the status of exactly one thing, another for
3680 * getting the statuses of (potentially) multiple things and a third for
3681 * getting the working copy out-of-dateness with respect to the repository.
3682 *
3683 * Why do we have two different functions for getting working copy status?
3684 * The concept of depth, as explained in the documentation for
3685 * svn_depth_t, may be useful in understanding this. Suppose we're
3686 * getting the status of directory D:
3687 *
3688 * To offer all three levels, we could have one unified function,
3689 * taking a `depth' parameter. Unfortunately, because this function
3690 * would have to handle multiple return values as well as the single
3691 * return value case, getting the status of just one entity would
3692 * become cumbersome: you'd have to roll through a hash to find one
3693 * lone status.
3694 *
3695 * So we have svn_wc_status3() for depth-empty (just D itself), and
3696 * svn_wc_walk_status() for depth-immediates and depth-infinity,
3697 * since the latter two involve multiple return values. And for
3698 * out-of-dateness information we have svn_wc_get_status_editor5().
3699 */
3700
3701/** The type of status for the working copy. */
3703{
3704 /** does not exist */
3706
3707 /** is not a versioned thing in this wc */
3709
3710 /** exists, but uninteresting */
3712
3713 /** is scheduled for addition */
3715
3716 /** under v.c., but is missing */
3718
3719 /** scheduled for deletion */
3721
3722 /** was deleted and then re-added */
3724
3725 /** text or props have been modified */
3727
3728 /** local mods received repos mods (### unused) */
3730
3731 /** local mods received conflicting repos mods */
3733
3734 /** is unversioned but configured to be ignored */
3736
3737 /** an unversioned resource is in the way of the versioned resource */
3739
3740 /** an unversioned directory path populated by an svn:externals
3741 property; this status is not used for file externals */
3743
3744 /** a directory doesn't contain a complete entries list */
3746};
3747
3748/**
3749 * Structure for holding the "status" of a working copy item.
3750 *
3751 * @note Fields may be added to the end of this structure in future
3752 * versions. Therefore, to preserve binary compatibility, users
3753 * should not directly allocate structures of this type.
3754 *
3755 * @since New in 1.7.
3756 */
3757typedef struct svn_wc_status3_t
3758{
3759 /** The kind of node as recorded in the working copy */
3761
3762 /** The depth of the node as recorded in the working copy
3763 * (#svn_depth_unknown for files or when no depth is set) */
3765
3766 /** The actual size of the working file on disk, or SVN_INVALID_FILESIZE
3767 * if unknown (or if the item isn't a file at all). */
3769
3770 /** If the path is under version control, versioned is TRUE, otherwise
3771 * FALSE. */
3773
3774 /** Set to TRUE if the item is the victim of a conflict. */
3776
3777 /** The status of the node itself. In order of precedence: Obstructions,
3778 * structural changes, text changes. */
3780
3781 /** The status of the entry's text. */
3783
3784 /** The status of the entry's properties. */
3786
3787 /** a file or directory can be 'copied' if it's scheduled for
3788 * addition-with-history (or part of a subtree that is scheduled as such.).
3789 */
3791
3792 /** Base revision. */
3794
3795 /** Last revision this was changed */
3797
3798 /** Date of last commit. */
3799 apr_time_t changed_date;
3800
3801 /** Last commit author of this item */
3802 const char *changed_author;
3803
3804 /** The URL of the repository */
3805 const char *repos_root_url;
3806
3807 /** The UUID of the repository */
3808 const char *repos_uuid;
3809
3810 /** The in-repository path relative to the repository root. */
3811 const char *repos_relpath;
3812
3813 /** a file or directory can be 'switched' if the switch command has been
3814 * used. If this is TRUE, then file_external will be FALSE.
3815 */
3817
3818 /** This directory has a working copy lock */
3820
3821 /** The repository file lock. (Values of path, token, owner, comment
3822 * and are available if a lock is present) */
3824
3825 /** Which changelist this item is part of, or NULL if not part of any. */
3826 const char *changelist;
3827
3828 /**
3829 * @defgroup svn_wc_status_ood WC out-of-date info from the repository
3830 * @{
3831 *
3832 * When the working copy item is out-of-date compared to the
3833 * repository, the following fields represent the state of the
3834 * youngest revision of the item in the repository. If the working
3835 * copy is not out of date, the fields are initialized as described
3836 * below.
3837 */
3838
3839 /** Set to the node kind of the youngest commit, or #svn_node_none
3840 * if not out of date. */
3842
3843 /** The status of the node, based on the text status if the node has no
3844 * restructuring changes */
3846
3847 /** The entry's text status in the repository. */
3849
3850 /** The entry's property status in the repository. */
3852
3853 /** The entry's lock in the repository, if any. */
3855
3856 /** Set to the youngest committed revision, or #SVN_INVALID_REVNUM
3857 * if not out of date. */
3859
3860 /** Set to the most recent commit date, or @c 0 if not out of date. */
3862
3863 /** Set to the user name of the youngest commit, or @c NULL if not
3864 * out of date or non-existent. Because a non-existent @c
3865 * svn:author property has the same behavior as an out-of-date
3866 * working copy, examine @c ood_last_cmt_rev to determine whether
3867 * the working copy is out of date. */
3869
3870 /** @} */
3871
3872 /** Set to the local absolute path that this node was moved from, if this
3873 * file or directory has been moved here locally and is the root of that
3874 * move. Otherwise set to NULL.
3875 *
3876 * This will be NULL for moved-here nodes that are just part of a subtree
3877 * that was moved along (and are not themselves a root of a different move
3878 * operation).
3879 *
3880 * @since New in 1.8. */
3882
3883 /** Set to the local absolute path that this node was moved to, if this file
3884 * or directory has been moved away locally and corresponds to the root
3885 * of the destination side of the move. Otherwise set to NULL.
3886 *
3887 * Note: Saying just "root" here could be misleading. For example:
3888 * svn mv A AA;
3889 * svn mv AA/B BB;
3890 * creates a situation where A/B is moved-to BB, but one could argue that
3891 * the move source's root actually was AA/B. Note that, as far as the
3892 * working copy is concerned, above case is exactly identical to:
3893 * svn mv A/B BB;
3894 * svn mv A AA;
3895 * In both situations, @a moved_to_abspath would be set for nodes A (moved
3896 * to AA) and A/B (moved to BB), only.
3897 *
3898 * This will be NULL for moved-away nodes that were just part of a subtree
3899 * that was moved along (and are not themselves a root of a different move
3900 * operation).
3901 *
3902 * @since New in 1.8. */
3903 const char *moved_to_abspath;
3904
3905 /** @c TRUE iff the item is a file brought in by an svn:externals definition.
3906 * @since New in 1.8. */
3908
3909
3910 /** The actual kind of the node in the working copy. May differ from
3911 * @a kind on obstructions, deletes, etc. #svn_node_unknown if unavailable.
3912 *
3913 * @since New in 1.9 */
3915
3916 /* NOTE! Please update svn_wc_dup_status3() when adding new fields here. */
3918
3919/**
3920 * ### All diffs are not yet known.
3921 * Same as svn_wc_status3_t, but without the #svn_boolean_t 'versioned'
3922 * field. Instead an item that is not versioned has the 'entry' field set to
3923 * @c NULL.
3924 *
3925 * @since New in 1.2.
3926 * @deprecated Provided for backward compatibility with the 1.6 API.
3927 */
3928typedef struct svn_wc_status2_t
3929{
3930 /** Can be @c NULL if not under version control. */
3932
3933 /** The status of the entry itself, including its text if it is a file. */
3935
3936 /** The status of the entry's properties. */
3938
3939 /** a directory can be 'locked' if a working copy update was interrupted. */
3941
3942 /** a file or directory can be 'copied' if it's scheduled for
3943 * addition-with-history (or part of a subtree that is scheduled as such.).
3944 */
3946
3947 /** a file or directory can be 'switched' if the switch command has been
3948 * used. If this is TRUE, then file_external will be FALSE.
3949 */
3951
3952 /** The entry's text status in the repository. */
3954
3955 /** The entry's property status in the repository. */
3957
3958 /** The entry's lock in the repository, if any. */
3960
3961 /** Set to the URI (actual or expected) of the item.
3962 * @since New in 1.3
3963 */
3964 const char *url;
3965
3966 /**
3967 * @defgroup svn_wc_status_ood WC out-of-date info from the repository
3968 * @{
3969 *
3970 * When the working copy item is out-of-date compared to the
3971 * repository, the following fields represent the state of the
3972 * youngest revision of the item in the repository. If the working
3973 * copy is not out of date, the fields are initialized as described
3974 * below.
3975 */
3976
3977 /** Set to the youngest committed revision, or #SVN_INVALID_REVNUM
3978 * if not out of date.
3979 * @since New in 1.3
3980 */
3982
3983 /** Set to the most recent commit date, or @c 0 if not out of date.
3984 * @since New in 1.3
3985 */
3987
3988 /** Set to the node kind of the youngest commit, or #svn_node_none
3989 * if not out of date.
3990 * @since New in 1.3
3991 */
3993
3994 /** Set to the user name of the youngest commit, or @c NULL if not
3995 * out of date or non-existent. Because a non-existent @c
3996 * svn:author property has the same behavior as an out-of-date
3997 * working copy, examine @c ood_last_cmt_rev to determine whether
3998 * the working copy is out of date.
3999 * @since New in 1.3
4000 */
4002
4003 /** @} */
4004
4005 /** Non-NULL if the entry is the victim of a tree conflict.
4006 * @since New in 1.6
4007 */
4009
4010 /** If the item is a file that was added to the working copy with an
4011 * svn:externals; if file_external is TRUE, then switched is always
4012 * FALSE.
4013 * @since New in 1.6
4014 */
4016
4017 /** The actual status of the text compared to the pristine base of the
4018 * file. This value isn't masked by other working copy statuses.
4019 * @c pristine_text_status is #svn_wc_status_none if this value was
4020 * not calculated during the status walk.
4021 * @since New in 1.6
4022 */
4024
4025 /** The actual status of the properties compared to the pristine base of
4026 * the node. This value isn't masked by other working copy statuses.
4027 * @c pristine_prop_status is #svn_wc_status_none if this value was
4028 * not calculated during the status walk.
4029 * @since New in 1.6
4030 */
4032
4034
4035
4036
4037/**
4038 * Same as #svn_wc_status2_t, but without the #svn_lock_t 'repos_lock', const char 'url', #svn_revnum_t 'ood_last_cmt_rev', apr_time_t 'ood_last_cmt_date', #svn_node_kind_t 'ood_kind', const char 'ood_last_cmt_author', #svn_wc_conflict_description_t 'tree_conflict', #svn_boolean_t 'file_external', #svn_wc_status_kind 'pristine_text_status', and #svn_wc_status_kind 'pristine_prop_status' fields.
4039 *
4040 * @deprecated Provided for backward compatibility with the 1.1 API.
4041 */
4042typedef struct svn_wc_status_t
4043{
4044 /** Can be @c NULL if not under version control. */
4046
4047 /** The status of the entries text. */
4049
4050 /** The status of the entries properties. */
4052
4053 /** a directory can be 'locked' if a working copy update was interrupted. */
4055
4056 /** a file or directory can be 'copied' if it's scheduled for
4057 * addition-with-history (or part of a subtree that is scheduled as such.).
4058 */
4060
4061 /** a file or directory can be 'switched' if the switch command has been
4062 * used.
4063 */
4065
4066 /** The entry's text status in the repository. */
4068
4069 /** The entry's property status in the repository. */
4071
4073
4074
4075/**
4076 * Return a deep copy of the @a orig_stat status structure, allocated
4077 * in @a pool.
4078 *
4079 * @since New in 1.7.
4080 */
4083 apr_pool_t *pool);
4084
4085/**
4086 * Same as svn_wc_dup_status3(), but for older svn_wc_status_t structures.
4087 *
4088 * @since New in 1.2
4089 * @deprecated Provided for backward compatibility with the 1.6 API.
4090 */
4094 apr_pool_t *pool);
4095
4096
4097/**
4098 * Same as svn_wc_dup_status2(), but for older svn_wc_status_t structures.
4099 *
4100 * @deprecated Provided for backward compatibility with the 1.1 API.
4101 */
4105 apr_pool_t *pool);
4106
4107
4108/**
4109 * Fill @a *status for @a local_abspath, allocating in @a result_pool.
4110 * Use @a scratch_pool for temporary allocations.
4111 *
4112 * Here are some things to note about the returned structure. A quick
4113 * examination of the @c status->text_status after a successful return of
4114 * this function can reveal the following things:
4115 *
4116 * - #svn_wc_status_none : @a local_abspath is not versioned, and is
4117 * not present on disk
4118 *
4119 * - #svn_wc_status_missing : @a local_abspath is versioned, but is
4120 * missing from the working copy.
4121 *
4122 * - #svn_wc_status_unversioned : @a local_abspath is not versioned,
4123 * but is present on disk and not being
4124 * ignored (see above).
4125 *
4126 * The other available results for the @c text_status field are more
4127 * straightforward in their meanings. See the comments on the
4128 * #svn_wc_status_kind structure for some hints.
4129 *
4130 * @since New in 1.7.
4131 */
4134 svn_wc_context_t *wc_ctx,
4135 const char *local_abspath,
4136 apr_pool_t *result_pool,
4137 apr_pool_t *scratch_pool);
4138
4139/** Similar to svn_wc_status3(), but with a adm_access baton and absolute
4140 * path.
4141 *
4142 * @since New in 1.2.
4143 * @deprecated Provided for backward compatibility with the 1.6 API.
4144 */
4148 const char *path,
4149 svn_wc_adm_access_t *adm_access,
4150 apr_pool_t *pool);
4151
4152
4153/**
4154 * Same as svn_wc_status2(), but for older svn_wc_status_t structures.
4155 *
4156 * @deprecated Provided for backward compatibility with the 1.1 API.
4157 */
4161 const char *path,
4162 svn_wc_adm_access_t *adm_access,
4163 apr_pool_t *pool);
4164
4165
4166␌
4167
4168/**
4169 * A callback for reporting a @a status about @a local_abspath.
4170 *
4171 * @a baton is a closure object; it should be provided by the
4172 * implementation, and passed by the caller.
4173 *
4174 * @a scratch_pool will be cleared between invocations to the callback.
4175 *
4176 * @since New in 1.7.
4177 */
4178typedef svn_error_t *(*svn_wc_status_func4_t)(void *baton,
4179 const char *local_abspath,
4180 const svn_wc_status3_t *status,
4181 apr_pool_t *scratch_pool);
4182
4183/**
4184 * Same as svn_wc_status_func4_t, but with a non-const status and a relative
4185 * path.
4186 *
4187 * @since New in 1.6.
4188 * @deprecated Provided for backward compatibility with the 1.6 API.
4189 */
4190typedef svn_error_t *(*svn_wc_status_func3_t)(void *baton,
4191 const char *path,
4192 svn_wc_status2_t *status,
4193 apr_pool_t *pool);
4194
4195/**
4196 * Same as svn_wc_status_func3_t, but without a provided pool or
4197 * the ability to propagate errors.
4198 *
4199 * @since New in 1.2.
4200 * @deprecated Provided for backward compatibility with the 1.5 API.
4201 */
4202typedef void (*svn_wc_status_func2_t)(void *baton,
4203 const char *path,
4204 svn_wc_status2_t *status);
4205
4206/**
4207 * Same as svn_wc_status_func2_t, but for older svn_wc_status_t structures.
4208 *
4209 * @deprecated Provided for backward compatibility with the 1.1 API.
4210 */
4211typedef void (*svn_wc_status_func_t)(void *baton,
4212 const char *path,
4213 svn_wc_status_t *status);
4214
4215/**
4216 * Walk the working copy status of @a local_abspath using @a wc_ctx, by
4217 * creating #svn_wc_status3_t structures and sending these through
4218 * @a status_func / @a status_baton.
4219 *
4220 * * Assuming the target is a directory, then:
4221 *
4222 * - If @a get_all is FALSE, then only locally-modified entries will be
4223 * returned. If TRUE, then all entries will be returned.
4224 *
4225 * - If @a ignore_text_mods is TRUE, then the walk will not check for
4226 * modified files. Any #svn_wc_status3_t structures returned for files
4227 * will always have a text_status field set to svn_wc_status_normal.
4228 * If @a ignore_text_mods is FALSE, the walk checks for text changes
4229 * and returns #svn_wc_status3_t structures describing any changes.
4230 *
4231 * - If @a depth is #svn_depth_empty, a status structure will
4232 * be returned for the target only; if #svn_depth_files, for the
4233 * target and its immediate file children; if
4234 * #svn_depth_immediates, for the target and its immediate
4235 * children; if #svn_depth_infinity, for the target and
4236 * everything underneath it, fully recursively.
4237 *
4238 * If @a depth is #svn_depth_unknown, take depths from the
4239 * working copy and behave as above in each directory's case.
4240 *
4241 * If the given @a depth is incompatible with the depth found in a
4242 * working copy directory, the found depth always governs.
4243 *
4244 * If @a no_ignore is set, statuses that would typically be ignored
4245 * will instead be reported.
4246 *
4247 * @a ignore_patterns is an array of file patterns matching
4248 * unversioned files to ignore for the purposes of status reporting,
4249 * or @c NULL if the default set of ignorable file patterns should be used.
4250 * Patterns from #SVN_PROP_IGNORE (and, as of 1.8,
4251 * #SVN_PROP_INHERITABLE_IGNORES) properties are always used, even if not
4252 * specified in @a ignore_patterns.
4253 *
4254 * If @a cancel_func is non-NULL, call it with @a cancel_baton while walking
4255 * to determine if the client has canceled the operation.
4256 *
4257 * This function uses @a scratch_pool for temporary allocations.
4258 *
4259 * @since New in 1.7.
4260 */
4263 const char *local_abspath,
4264 svn_depth_t depth,
4265 svn_boolean_t get_all,
4266 svn_boolean_t no_ignore,
4267 svn_boolean_t ignore_text_mods,
4268 const apr_array_header_t *ignore_patterns,
4269 svn_wc_status_func4_t status_func,
4270 void *status_baton,
4271 svn_cancel_func_t cancel_func,
4272 void *cancel_baton,
4273 apr_pool_t *scratch_pool);
4274
4275/**
4276 * DEPRECATED -- please use APIs from svn_client.h
4277 *
4278 * ---
4279 *
4280 * Set @a *editor and @a *edit_baton to an editor that generates
4281 * #svn_wc_status3_t structures and sends them through @a status_func /
4282 * @a status_baton. @a anchor_abspath is a working copy directory
4283 * directory which will be used as the root of our editor. If @a
4284 * target_basename is not "", it represents a node in the @a anchor_abspath
4285 * which is the subject of the editor drive (otherwise, the @a
4286 * anchor_abspath is the subject).
4287 *
4288 * If @a set_locks_baton is non-@c NULL, it will be set to a baton that can
4289 * be used in a call to the svn_wc_status_set_repos_locks() function.
4290 *
4291 * Callers drive this editor to describe working copy out-of-dateness
4292 * with respect to the repository. If this information is not
4293 * available or not desired, callers should simply call the
4294 * close_edit() function of the @a editor vtable.
4295 *
4296 * If the editor driver calls @a editor's set_target_revision() vtable
4297 * function, then when the edit drive is completed, @a *edit_revision
4298 * will contain the revision delivered via that interface.
4299 *
4300 * Assuming the target is a directory, then:
4301 *
4302 * - If @a get_all is FALSE, then only locally-modified entries will be
4303 * returned. If TRUE, then all entries will be returned.
4304 *
4305 * - If @a depth is #svn_depth_empty, a status structure will
4306 * be returned for the target only; if #svn_depth_files, for the
4307 * target and its immediate file children; if
4308 * #svn_depth_immediates, for the target and its immediate
4309 * children; if #svn_depth_infinity, for the target and
4310 * everything underneath it, fully recursively.
4311 *
4312 * If @a depth is #svn_depth_unknown, take depths from the
4313 * working copy and behave as above in each directory's case.
4314 *
4315 * If the given @a depth is incompatible with the depth found in a
4316 * working copy directory, the found depth always governs.
4317 *
4318 * If @a no_ignore is set, statuses that would typically be ignored
4319 * will instead be reported.
4320 *
4321 * @a ignore_patterns is an array of file patterns matching
4322 * unversioned files to ignore for the purposes of status reporting,
4323 * or @c NULL if the default set of ignorable file patterns should be used.
4324 *
4325 * If @a cancel_func is non-NULL, call it with @a cancel_baton while building
4326 * the @a statushash to determine if the client has canceled the operation.
4327 *
4328 * If @a depth_as_sticky is set handle @a depth like when depth_is_sticky is
4329 * passed for updating. This will show excluded nodes show up as added in the
4330 * repository.
4331 *
4332 * If @a server_performs_filtering is TRUE, assume that the server handles
4333 * the ambient depth filtering, so this doesn't have to be handled in the
4334 * editor.
4335 *
4336 * Allocate the editor itself in @a result_pool, and use @a scratch_pool
4337 * for temporary allocations. The editor will do its temporary allocations
4338 * in a subpool of @a result_pool.
4339 *
4340 * @since New in 1.7.
4341 * @deprecated Provided for backward compatibility with the 1.7 API.
4342 */
4345svn_wc_get_status_editor5(const svn_delta_editor_t **editor,
4346 void **edit_baton,
4347 void **set_locks_baton,
4348 svn_revnum_t *edit_revision,
4349 svn_wc_context_t *wc_ctx,
4350 const char *anchor_abspath,
4351 const char *target_basename,
4352 svn_depth_t depth,
4353 svn_boolean_t get_all,
4354 svn_boolean_t no_ignore,
4355 svn_boolean_t depth_as_sticky,
4356 svn_boolean_t server_performs_filtering,
4357 const apr_array_header_t *ignore_patterns,
4358 svn_wc_status_func4_t status_func,
4359 void *status_baton,
4360 svn_cancel_func_t cancel_func,
4361 void *cancel_baton,
4362 apr_pool_t *result_pool,
4363 apr_pool_t *scratch_pool);
4364
4365/**
4366 * Same as svn_wc_get_status_editor5, but using #svn_wc_status_func3_t
4367 * instead of #svn_wc_status_func4_t. And @a server_performs_filtering
4368 * always set to #TRUE.
4369 *
4370 * This also uses a single pool parameter, stating that all temporary
4371 * allocations are performed in manually constructed/destroyed subpool.
4372 *
4373 * @since New in 1.6.
4374 * @deprecated Provided for backward compatibility with the 1.6 API.
4375 */
4378svn_wc_get_status_editor4(const svn_delta_editor_t **editor,
4379 void **edit_baton,
4380 void **set_locks_baton,
4381 svn_revnum_t *edit_revision,
4382 svn_wc_adm_access_t *anchor,
4383 const char *target,
4384 svn_depth_t depth,
4385 svn_boolean_t get_all,
4386 svn_boolean_t no_ignore,
4387 const apr_array_header_t *ignore_patterns,
4388 svn_wc_status_func3_t status_func,
4389 void *status_baton,
4390 svn_cancel_func_t cancel_func,
4391 void *cancel_baton,
4392 svn_wc_traversal_info_t *traversal_info,
4393 apr_pool_t *pool);
4394
4395/**
4396 * Same as svn_wc_get_status_editor4(), but using #svn_wc_status_func2_t
4397 * instead of #svn_wc_status_func3_t.
4398 *
4399 * @since New in 1.5.
4400 * @deprecated Provided for backward compatibility with the 1.5 API.
4401 */
4404svn_wc_get_status_editor3(const svn_delta_editor_t **editor,
4405 void **edit_baton,
4406 void **set_locks_baton,
4407 svn_revnum_t *edit_revision,
4408 svn_wc_adm_access_t *anchor,
4409 const char *target,
4410 svn_depth_t depth,
4411 svn_boolean_t get_all,
4412 svn_boolean_t no_ignore,
4413 const apr_array_header_t *ignore_patterns,
4414 svn_wc_status_func2_t status_func,
4415 void *status_baton,
4416 svn_cancel_func_t cancel_func,
4417 void *cancel_baton,
4418 svn_wc_traversal_info_t *traversal_info,
4419 apr_pool_t *pool);
4420
4421/**
4422 * Like svn_wc_get_status_editor3(), but with @a ignore_patterns
4423 * provided from the corresponding value in @a config, and @a recurse
4424 * instead of @a depth. If @a recurse is TRUE, behave as if for
4425 * #svn_depth_infinity; else if @a recurse is FALSE, behave as if for
4426 * #svn_depth_immediates.
4427 *
4428 * @since New in 1.2.
4429 * @deprecated Provided for backward compatibility with the 1.4 API.
4430 */
4433svn_wc_get_status_editor2(const svn_delta_editor_t **editor,
4434 void **edit_baton,
4435 void **set_locks_baton,
4436 svn_revnum_t *edit_revision,
4437 svn_wc_adm_access_t *anchor,
4438 const char *target,
4439 apr_hash_t *config,
4440 svn_boolean_t recurse,
4441 svn_boolean_t get_all,
4442 svn_boolean_t no_ignore,
4443 svn_wc_status_func2_t status_func,
4444 void *status_baton,
4445 svn_cancel_func_t cancel_func,
4446 void *cancel_baton,
4447 svn_wc_traversal_info_t *traversal_info,
4448 apr_pool_t *pool);
4449
4450/**
4451 * Same as svn_wc_get_status_editor2(), but with @a set_locks_baton set
4452 * to @c NULL, and taking a deprecated svn_wc_status_func_t argument.
4453 *
4454 * @deprecated Provided for backward compatibility with the 1.1 API.
4455 */
4458svn_wc_get_status_editor(const svn_delta_editor_t **editor,
4459 void **edit_baton,
4460 svn_revnum_t *edit_revision,
4461 svn_wc_adm_access_t *anchor,
4462 const char *target,
4463 apr_hash_t *config,
4464 svn_boolean_t recurse,
4465 svn_boolean_t get_all,
4466 svn_boolean_t no_ignore,
4467 svn_wc_status_func_t status_func,
4468 void *status_baton,
4469 svn_cancel_func_t cancel_func,
4470 void *cancel_baton,
4471 svn_wc_traversal_info_t *traversal_info,
4472 apr_pool_t *pool);
4473
4474
4475/**
4476 * Associate @a locks, a hash table mapping <tt>const char*</tt>
4477 * absolute repository paths to <tt>svn_lock_t</tt> objects, with a
4478 * @a set_locks_baton returned by an earlier call to
4479 * svn_wc_get_status_editor3(). @a repos_root is the repository root URL.
4480 * Perform all allocations in @a pool.
4481 *
4482 * @note @a locks will not be copied, so it must be valid throughout the
4483 * edit. @a pool must also not be destroyed or cleared before the edit is
4484 * finished.
4485 *
4486 * @since New in 1.2.
4487 */
4489svn_wc_status_set_repos_locks(void *set_locks_baton,
4490 apr_hash_t *locks,
4491 const char *repos_root,
4492 apr_pool_t *pool);
4493
4494/** @} */
4495
4496␌
4497/**
4498 * Copy @a src_abspath to @a dst_abspath, and schedule @a dst_abspath
4499 * for addition to the repository, remembering the copy history. @a wc_ctx
4500 * is used for accessing the working copy and must contain a write lock for
4501 * the parent directory of @a dst_abspath,
4502 *
4503 * If @a metadata_only is TRUE then this is a database-only operation and
4504 * the working directories and files are not copied.
4505 *
4506 * @a src_abspath must be a file or directory under version control;
4507 * the parent of @a dst_abspath must be a directory under version control
4508 * in the same working copy; @a dst_abspath will be the name of the copied
4509 * item, and it must not exist already if @a metadata_only is FALSE. Note that
4510 * when @a src points to a versioned file, the working file doesn't
4511 * necessarily exist in which case its text-base is used instead.
4512 *
4513 * If @a cancel_func is non-NULL, call it with @a cancel_baton at
4514 * various points during the operation. If it returns an error
4515 * (typically #SVN_ERR_CANCELLED), return that error immediately.
4516 *
4517 * If @a notify_func is non-NULL, call it with @a notify_baton and the path
4518 * of the root node (only) of the destination.
4519 *
4520 * Use @a scratch_pool for temporary allocations.
4521 *
4522 * @since New in 1.7.
4523 */
4526 const char *src_abspath,
4527 const char *dst_abspath,
4528 svn_boolean_t metadata_only,
4529 svn_cancel_func_t cancel_func,
4530 void *cancel_baton,
4531 svn_wc_notify_func2_t notify_func,
4532 void *notify_baton,
4533 apr_pool_t *scratch_pool);
4534
4535/** Similar to svn_wc_copy3(), but takes access batons and a relative path
4536 * and a basename instead of absolute paths and a working copy context.
4537 *
4538 * @since New in 1.2.
4539 * @deprecated Provided for backward compatibility with the 1.6 API.
4540 */
4543svn_wc_copy2(const char *src,
4544 svn_wc_adm_access_t *dst_parent,
4545 const char *dst_basename,
4546 svn_cancel_func_t cancel_func,
4547 void *cancel_baton,
4548 svn_wc_notify_func2_t notify_func,
4549 void *notify_baton,
4550 apr_pool_t *pool);
4551
4552/**
4553 * Similar to svn_wc_copy2(), but takes an #svn_wc_notify_func_t instead.
4554 *
4555 * @deprecated Provided for backward compatibility with the 1.1 API.
4556 */
4559svn_wc_copy(const char *src,
4560 svn_wc_adm_access_t *dst_parent,
4561 const char *dst_basename,
4562 svn_cancel_func_t cancel_func,
4563 void *cancel_baton,
4564 svn_wc_notify_func_t notify_func,
4565 void *notify_baton,
4566 apr_pool_t *pool);
4567
4568/**
4569 * Move @a src_abspath to @a dst_abspath, by scheduling @a dst_abspath
4570 * for addition to the repository, remembering the history. Mark @a src_abspath
4571 * as deleted after moving.@a wc_ctx is used for accessing the working copy and
4572 * must contain a write lock for the parent directory of @a src_abspath and
4573 * @a dst_abspath.
4574 *
4575 * If @a metadata_only is TRUE then this is a database-only operation and
4576 * the working directories and files are not changed.
4577 *
4578 * @a src_abspath must be a file or directory under version control;
4579 * the parent of @a dst_abspath must be a directory under version control
4580 * in the same working copy; @a dst_abspath will be the name of the copied
4581 * item, and it must not exist already if @a metadata_only is FALSE. Note that
4582 * when @a src points to a versioned file, the working file doesn't
4583 * necessarily exist in which case its text-base is used instead.
4584 *
4585 * If @a cancel_func is non-NULL, call it with @a cancel_baton at
4586 * various points during the operation. If it returns an error
4587 * (typically #SVN_ERR_CANCELLED), return that error immediately.
4588 *
4589 * If @a notify_func is non-NULL, call it with @a notify_baton and the path
4590 * of the root node (only) of the destination.
4591 *
4592 * Use @a scratch_pool for temporary allocations.
4593 *
4594 * @since New in 1.7.
4595 * @deprecated Provided for backward compatibility with the 1.7 API.
4596 * @see svn_client_move7()
4597 */
4601 const char *src_abspath,
4602 const char *dst_abspath,
4603 svn_boolean_t metadata_only,
4604 svn_cancel_func_t cancel_func,
4605 void *cancel_baton,
4606 svn_wc_notify_func2_t notify_func,
4607 void *notify_baton,
4608 apr_pool_t *scratch_pool);
4609
4610/**
4611 * Schedule @a local_abspath for deletion. It will be deleted from the
4612 * repository on the next commit. If @a local_abspath refers to a
4613 * directory, then a recursive deletion will occur. @a wc_ctx must hold
4614 * a write lock for the parent of @a local_abspath, @a local_abspath itself
4615 * and everything below @a local_abspath.
4616 *
4617 * If @a keep_local is FALSE, this function immediately deletes all files,
4618 * modified and unmodified, versioned and if @a delete_unversioned is TRUE,
4619 * unversioned from the working copy.
4620 * It also immediately deletes unversioned directories and directories that
4621 * are scheduled to be added below @a local_abspath. Only versioned may
4622 * remain in the working copy, these get deleted by the update following
4623 * the commit.
4624 *
4625 * If @a keep_local is TRUE, all files and directories will be kept in the
4626 * working copy (and will become unversioned on the next commit).
4627 *
4628 * If @a delete_unversioned_target is TRUE and @a local_abspath is not
4629 * versioned, @a local_abspath will be handled as an added files without
4630 * history. So it will be deleted if @a keep_local is FALSE. If @a
4631 * delete_unversioned is FALSE and @a local_abspath is not versioned a
4632 * #SVN_ERR_WC_PATH_NOT_FOUND error will be returned.
4633 *
4634 * If @a cancel_func is non-NULL, call it with @a cancel_baton at
4635 * various points during the operation. If it returns an error
4636 * (typically #SVN_ERR_CANCELLED), return that error immediately.
4637 *
4638 * For each path marked for deletion, @a notify_func will be called with
4639 * the @a notify_baton and that path. The @a notify_func callback may be
4640 * @c NULL if notification is not needed.
4641 *
4642 * Use @a scratch_pool for temporary allocations. It may be cleared
4643 * immediately upon returning from this function.
4644 *
4645 * @since New in 1.7.
4646 */
4647 /* ### BH: Maybe add a delete_switched flag that allows deny switched
4648 nodes like file externals? */
4651 const char *local_abspath,
4652 svn_boolean_t keep_local,
4653 svn_boolean_t delete_unversioned_target,
4654 svn_cancel_func_t cancel_func,
4655 void *cancel_baton,
4656 svn_wc_notify_func2_t notify_func,
4657 void *notify_baton,
4658 apr_pool_t *scratch_pool);
4659
4660/**
4661 * Similar to svn_wc_delete4, but uses an access baton and relative path
4662 * instead of a working copy context and absolute path. @a adm_access
4663 * must hold a write lock for the parent of @a path.
4664 *
4665 * @c delete_unversioned_target will always be set to TRUE.
4666 *
4667 * @since New in 1.5.
4668 * @deprecated Provided for backward compatibility with the 1.6 API.
4669 */
4673 svn_wc_adm_access_t *adm_access,
4674 svn_cancel_func_t cancel_func,
4675 void *cancel_baton,
4676 svn_wc_notify_func2_t notify_func,
4677 void *notify_baton,
4678 svn_boolean_t keep_local,
4679 apr_pool_t *pool);
4680
4681/**
4682 * Similar to svn_wc_delete3(), but with @a keep_local always set to FALSE.
4683 *
4684 * @deprecated Provided for backward compatibility with the 1.4 API.
4685 */
4689 svn_wc_adm_access_t *adm_access,
4690 svn_cancel_func_t cancel_func,
4691 void *cancel_baton,
4692 svn_wc_notify_func2_t notify_func,
4693 void *notify_baton,
4694 apr_pool_t *pool);
4695
4696/**
4697 * Similar to svn_wc_delete2(), but takes an #svn_wc_notify_func_t instead.
4698 *
4699 * @deprecated Provided for backward compatibility with the 1.1 API.
4700 */
4704 svn_wc_adm_access_t *adm_access,
4705 svn_cancel_func_t cancel_func,
4706 void *cancel_baton,
4707 svn_wc_notify_func_t notify_func,
4708 void *notify_baton,
4709 apr_pool_t *pool);
4710
4711
4712/**
4713 * Schedule the single node that exists on disk at @a local_abspath for
4714 * addition to the working copy. The added node will have the properties
4715 * provided in @a props, or none if that is NULL.
4716 *
4717 * Unless @a skip_checks is TRUE, check and canonicalize the properties in the
4718 * same way as svn_wc_prop_set4(). Return an error and don't add the node if
4719 * the properties are not valid on this node.
4720 *
4721 * ### The error code on validity check failure should be specified, and
4722 * preferably should be a single code.
4723 *
4724 * The versioned state of the parent path must be a modifiable directory,
4725 * and the versioned state of @a local_abspath must be either nonexistent or
4726 * deleted; if deleted, the new node will be a replacement.
4727 *
4728 * If @a local_abspath does not exist as file, directory or symlink, return
4729 * #SVN_ERR_WC_PATH_NOT_FOUND.
4730 *
4731 * If @a notify_func is non-NULL, invoke it with @a notify_baton to report
4732 * the item being added.
4733 *
4734 * ### TODO: Split into add_dir, add_file, add_symlink?
4735 *
4736 * @since New in 1.9.
4737 */
4740 const char *local_abspath,
4741 const apr_hash_t *props,
4742 svn_boolean_t skip_checks,
4743 svn_wc_notify_func2_t notify_func,
4744 void *notify_baton,
4745 apr_pool_t *scratch_pool);
4746
4747/**
4748 * Similar to svn_wc_add_from_disk3(), but always passes FALSE for
4749 * @a skip_checks
4750 *
4751 * @since New in 1.8.
4752 * @deprecated Provided for backward compatibility with the 1.8 API.
4753 */
4757 const char *local_abspath,
4758 const apr_hash_t *props,
4759 svn_wc_notify_func2_t notify_func,
4760 void *notify_baton,
4761 apr_pool_t *scratch_pool);
4762
4763
4764/**
4765 * Similar to svn_wc_add_from_disk2(), but always passes NULL for @a
4766 * props.
4767 *
4768 * This is a replacement for svn_wc_add4() case 2a (which see for
4769 * details).
4770
4771 * @see svn_wc_add4()
4772 *
4773 * @since New in 1.7.
4774 * @deprecated Provided for backward compatibility with the 1.7 API.
4775 */
4779 const char *local_abspath,
4780 svn_wc_notify_func2_t notify_func,
4781 void *notify_baton,
4782 apr_pool_t *scratch_pool);
4783
4784
4785/**
4786 * Put @a local_abspath under version control by registering it as addition
4787 * or copy in the database containing its parent. The new node is scheduled
4788 * for addition to the repository below its parent node.
4789 *
4790 * 1) If the node is already versioned, it MUST BE the root of a separate
4791 * working copy from the same repository as the parent WC. The new node
4792 * and anything below it will be scheduled for addition inside the parent
4793 * working copy as a copy of the original location. The separate working
4794 * copy will be integrated by this step. In this case, which is only used
4795 * by code like that of "svn cp URL@rev path" @a copyfrom_url and
4796 * @a copyfrom_rev MUST BE the url and revision of @a local_abspath
4797 * in the separate working copy.
4798 *
4799 * 2a) If the node was not versioned before it will be scheduled as a local
4800 * addition or 2b) if @a copyfrom_url and @a copyfrom_rev are set as a copy
4801 * of that location. In this last case the function doesn't set the pristine
4802 * version (of a file) and/or pristine properties, which callers should
4803 * handle via different APIs. Usually it is easier to call
4804 * svn_wc_add_repos_file4() (### or a possible svn_wc_add_repos_dir()) than
4805 * using this variant.
4806 *
4807 * If @a local_abspath does not exist as file, directory or symlink, return
4808 * #SVN_ERR_WC_PATH_NOT_FOUND.
4809 *
4810 * If @a local_abspath is an unversioned directory, record @a depth on it;
4811 * otherwise, ignore @a depth. (Use #svn_depth_infinity unless you exactly
4812 * know what you are doing, or you may create an unexpected sparse working
4813 * copy)
4814 *
4815 * If @a cancel_func is non-NULL, call it with @a cancel_baton at
4816 * various points during the operation. If it returns an error
4817 * (typically #SVN_ERR_CANCELLED), return that error immediately.
4818 *
4819 * When the @a local_abspath has been added, then @a notify_func will be
4820 * called (if it is not @c NULL) with the @a notify_baton and the path.
4821 *
4822 * @note Case 1 is deprecated. Consider doing a WC-to-WC copy instead.
4823 * @note For case 2a, prefer svn_wc_add_from_disk().
4824 *
4825 * @since New in 1.7.
4826 */
4829 const char *local_abspath,
4830 svn_depth_t depth,
4831 const char *copyfrom_url,
4832 svn_revnum_t copyfrom_rev,
4833 svn_cancel_func_t cancel_func,
4834 void *cancel_baton,
4835 svn_wc_notify_func2_t notify_func,
4836 void *notify_baton,
4837 apr_pool_t *scratch_pool);
4838
4839/**
4840 * Similar to svn_wc_add4(), but with an access baton
4841 * and relative path instead of a context and absolute path.
4842 * @since New in 1.6.
4843 * @deprecated Provided for backward compatibility with the 1.6 API.
4844 */
4847svn_wc_add3(const char *path,
4848 svn_wc_adm_access_t *parent_access,
4849 svn_depth_t depth,
4850 const char *copyfrom_url,
4851 svn_revnum_t copyfrom_rev,
4852 svn_cancel_func_t cancel_func,
4853 void *cancel_baton,
4854 svn_wc_notify_func2_t notify_func,
4855 void *notify_baton,
4856 apr_pool_t *pool);
4857
4858/**
4859 * Similar to svn_wc_add3(), but with the @a depth parameter always
4860 * #svn_depth_infinity.
4861 *
4862 * @since New in 1.2.
4863 * @deprecated Provided for backward compatibility with the 1.5 API.
4864 */
4867svn_wc_add2(const char *path,
4868 svn_wc_adm_access_t *parent_access,
4869 const char *copyfrom_url,
4870 svn_revnum_t copyfrom_rev,
4871 svn_cancel_func_t cancel_func,
4872 void *cancel_baton,
4873 svn_wc_notify_func2_t notify_func,
4874 void *notify_baton,
4875 apr_pool_t *pool);
4876
4877/**
4878 * Similar to svn_wc_add2(), but takes an #svn_wc_notify_func_t instead.
4879 *
4880 * @deprecated Provided for backward compatibility with the 1.1 API.
4881 */
4884svn_wc_add(const char *path,
4885 svn_wc_adm_access_t *parent_access,
4886 const char *copyfrom_url,
4887 svn_revnum_t copyfrom_rev,
4888 svn_cancel_func_t cancel_func,
4889 void *cancel_baton,
4890 svn_wc_notify_func_t notify_func,
4891 void *notify_baton,
4892 apr_pool_t *pool);
4893
4894/** Add a file to a working copy at @a local_abspath, obtaining the
4895 * text-base's contents from @a new_base_contents, the wc file's
4896 * content from @a new_contents, its unmodified properties from @a
4897 * new_base_props and its actual properties from @a new_props. Use
4898 * @a wc_ctx for accessing the working copy.
4899 *
4900 * The unmodified text and props normally come from the repository
4901 * file represented by the copyfrom args, see below. The new file
4902 * will be marked as copy.
4903 *
4904 * @a new_contents and @a new_props may be NULL, in which case
4905 * the working copy text and props are taken from the base files with
4906 * appropriate translation of the file's content.
4907 *
4908 * @a new_contents must be provided in Normal Form. This is required
4909 * in order to pass both special and non-special files through a stream.
4910 *
4911 * @a wc_ctx must contain a write lock for the parent of @a local_abspath.
4912 *
4913 * If @a copyfrom_url is non-NULL, then @a copyfrom_rev must be a
4914 * valid revision number, and together they are the copyfrom history
4915 * for the new file.
4916 *
4917 * The @a cancel_func and @a cancel_baton are a standard cancellation
4918 * callback, or NULL if no callback is needed. @a notify_func and
4919 * @a notify_baton are a notification callback, and (if not NULL)
4920 * will be notified of the addition of this file.
4921 *
4922 * Use @a scratch_pool for temporary allocations.
4923 *
4924 * ### This function is very redundant with svn_wc_add(). Ideally,
4925 * we'd merge them, so that svn_wc_add() would just take optional
4926 * new_props and optional copyfrom information. That way it could be
4927 * used for both 'svn add somefilesittingonmydisk' and for adding
4928 * files from repositories, with or without copyfrom history.
4929 *
4930 * The problem with this Ideal Plan is that svn_wc_add() also takes
4931 * care of recursive URL-rewriting. There's a whole comment in its
4932 * doc string about how that's really weird, outside its core mission,
4933 * etc, etc. So another part of the Ideal Plan is that that
4934 * functionality of svn_wc_add() would move into a separate function.
4935 *
4936 * @since New in 1.7.
4937 */
4940 const char *local_abspath,
4941 svn_stream_t *new_base_contents,
4942 svn_stream_t *new_contents,
4943 apr_hash_t *new_base_props,
4944 apr_hash_t *new_props,
4945 const char *copyfrom_url,
4946 svn_revnum_t copyfrom_rev,
4947 svn_cancel_func_t cancel_func,
4948 void *cancel_baton,
4949 apr_pool_t *scratch_pool);
4950
4951/** Similar to svn_wc_add_repos_file4, but uses access batons and a
4952 * relative path instead of a working copy context and absolute path.
4953 *
4954 * ### NOTE: the notification callback/baton is not yet used.
4955 *
4956 * @since New in 1.6.
4957 * @deprecated Provided for compatibility with the 1.6 API.
4958 */
4961svn_wc_add_repos_file3(const char *dst_path,
4962 svn_wc_adm_access_t *adm_access,
4963 svn_stream_t *new_base_contents,
4964 svn_stream_t *new_contents,
4965 apr_hash_t *new_base_props,
4966 apr_hash_t *new_props,
4967 const char *copyfrom_url,
4968 svn_revnum_t copyfrom_rev,
4969 svn_cancel_func_t cancel_func,
4970 void *cancel_baton,
4971 svn_wc_notify_func2_t notify_func,
4972 void *notify_baton,
4973 apr_pool_t *scratch_pool);
4974
4975
4976/** Same as svn_wc_add_repos_file3(), except that it has pathnames rather
4977 * than streams for the text base, and actual text, and has no cancellation.
4978 *
4979 * @since New in 1.4.
4980 * @deprecated Provided for compatibility with the 1.5 API
4981 */
4984svn_wc_add_repos_file2(const char *dst_path,
4985 svn_wc_adm_access_t *adm_access,
4986 const char *new_text_base_path,
4987 const char *new_text_path,
4988 apr_hash_t *new_base_props,
4989 apr_hash_t *new_props,
4990 const char *copyfrom_url,
4991 svn_revnum_t copyfrom_rev,
4992 apr_pool_t *pool);
4993
4994/** Same as svn_wc_add_repos_file3(), except that it doesn't have the
4995 * BASE arguments or cancellation.
4996 *
4997 * @deprecated Provided for compatibility with the 1.3 API
4998 */
5001svn_wc_add_repos_file(const char *dst_path,
5002 svn_wc_adm_access_t *adm_access,
5003 const char *new_text_path,
5004 apr_hash_t *new_props,
5005 const char *copyfrom_url,
5006 svn_revnum_t copyfrom_rev,
5007 apr_pool_t *pool);
5008
5009
5010/** Remove @a local_abspath from revision control. @a wc_ctx must
5011 * hold a write lock on the parent of @a local_abspath, or if that is a
5012 * WC root then on @a local_abspath itself.
5013 *
5014 * If @a local_abspath is a file, all its info will be removed from the
5015 * administrative area. If @a local_abspath is a directory, then the
5016 * administrative area will be deleted, along with *all* the administrative
5017 * areas anywhere in the tree below @a adm_access.
5018 *
5019 * Normally, only administrative data is removed. However, if
5020 * @a destroy_wf is TRUE, then all working file(s) and dirs are deleted
5021 * from disk as well. When called with @a destroy_wf, any locally
5022 * modified files will *not* be deleted, and the special error
5023 * #SVN_ERR_WC_LEFT_LOCAL_MOD might be returned. (Callers only need to
5024 * check for this special return value if @a destroy_wf is TRUE.)
5025 *
5026 * If @a instant_error is TRUE, then return
5027 * #SVN_ERR_WC_LEFT_LOCAL_MOD the instant a locally modified file is
5028 * encountered. Otherwise, leave locally modified files in place and
5029 * return the error only after all the recursion is complete.
5030 *
5031 * If @a cancel_func is non-NULL, call it with @a cancel_baton at
5032 * various points during the removal. If it returns an error
5033 * (typically #SVN_ERR_CANCELLED), return that error immediately.
5034 *
5035 * WARNING: This routine is exported for careful, measured use by
5036 * libsvn_client. Do *not* call this routine unless you really
5037 * understand what the heck you're doing.
5038 *
5039 * @since New in 1.7.
5040 */
5043 const char *local_abspath,
5044 svn_boolean_t destroy_wf,
5045 svn_boolean_t instant_error,
5046 svn_cancel_func_t cancel_func,
5047 void *cancel_baton,
5048 apr_pool_t *pool);
5049
5050/**
5051 * Similar to svn_wc_remove_from_revision_control2() but with a name
5052 * and access baton.
5053 *
5054 * WARNING: This routine was exported for careful, measured use by
5055 * libsvn_client. Do *not* call this routine unless you really
5056 * understand what the heck you're doing.
5057 *
5058 * @deprecated Provided for compatibility with the 1.6 API
5059 */
5063 const char *name,
5064 svn_boolean_t destroy_wf,
5065 svn_boolean_t instant_error,
5066 svn_cancel_func_t cancel_func,
5067 void *cancel_baton,
5068 apr_pool_t *pool);
5069
5070
5071/**
5072 * Assuming @a local_abspath is under version control or a tree conflict
5073 * victim and in a state of conflict, then take @a local_abspath *out*
5074 * of this state. If @a resolve_text is TRUE then any text conflict is
5075 * resolved, if @a resolve_tree is TRUE then any tree conflicts are
5076 * resolved. If @a resolve_prop is set to "" all property conflicts are
5077 * resolved, if it is set to any other string value, conflicts on that
5078 * specific property are resolved and when resolve_prop is NULL, no
5079 * property conflicts are resolved.
5080 *
5081 * If @a depth is #svn_depth_empty, act only on @a local_abspath; if
5082 * #svn_depth_files, resolve @a local_abspath and its conflicted file
5083 * children (if any); if #svn_depth_immediates, resolve @a local_abspath
5084 * and all its immediate conflicted children (both files and directories,
5085 * if any); if #svn_depth_infinity, resolve @a local_abspath and every
5086 * conflicted file or directory anywhere beneath it.
5087 *
5088 * If @a conflict_choice is #svn_wc_conflict_choose_base, resolve the
5089 * conflict with the old file contents; if
5090 * #svn_wc_conflict_choose_mine_full, use the original working contents;
5091 * if #svn_wc_conflict_choose_theirs_full, the new contents; and if
5092 * #svn_wc_conflict_choose_merged, don't change the contents at all,
5093 * just remove the conflict status, which is the pre-1.5 behavior.
5094 *
5095 * #svn_wc_conflict_choose_theirs_conflict and
5096 * #svn_wc_conflict_choose_mine_conflict are not legal for binary
5097 * files or properties.
5098 *
5099 * @a wc_ctx is a working copy context, with a write lock, for @a
5100 * local_abspath.
5101 *
5102 * Needless to say, this function doesn't touch conflict markers or
5103 * anything of that sort -- only a human can semantically resolve a
5104 * conflict. Instead, this function simply marks a file as "having
5105 * been resolved", clearing the way for a commit.
5106 *
5107 * The implementation details are opaque, as our "conflicted" criteria
5108 * might change over time. (At the moment, this routine removes the
5109 * three fulltext 'backup' files and any .prej file created in a conflict,
5110 * and modifies @a local_abspath's entry.)
5111 *
5112 * If @a local_abspath is not under version control and not a tree
5113 * conflict, return #SVN_ERR_ENTRY_NOT_FOUND. If @a path isn't in a
5114 * state of conflict to begin with, do nothing, and return #SVN_NO_ERROR.
5115 *
5116 * If @c local_abspath was successfully taken out of a state of conflict,
5117 * report this information to @c notify_func (if non-@c NULL.) If only
5118 * text, only property, or only tree conflict resolution was requested,
5119 * and it was successful, then success gets reported.
5120 *
5121 * Temporary allocations will be performed in @a scratch_pool.
5122 *
5123 * @since New in 1.7.
5124 * @deprecated Provided for backward compatibility with the 1.9 API.
5125 * Use svn_client_conflict_text_resolve(), svn_client_conflict_prop_resolve(),
5126 * and svn_client_conflict_tree_resolve() instead.
5127 */
5131 const char *local_abspath,
5132 svn_depth_t depth,
5133 svn_boolean_t resolve_text,
5134 const char *resolve_prop,
5135 svn_boolean_t resolve_tree,
5136 svn_wc_conflict_choice_t conflict_choice,
5137 svn_cancel_func_t cancel_func,
5138 void *cancel_baton,
5139 svn_wc_notify_func2_t notify_func,
5140 void *notify_baton,
5141 apr_pool_t *scratch_pool);
5142
5143/** Similar to svn_wc_resolved_conflict5, but takes an absolute path
5144 * and an access baton. This version doesn't support resolving a specific
5145 * property.conflict.
5146 *
5147 * @since New in 1.6.
5148 * @deprecated Provided for backward compatibility with the 1.6 API.
5149 */
5153 svn_wc_adm_access_t *adm_access,
5154 svn_boolean_t resolve_text,
5155 svn_boolean_t resolve_props,
5156 svn_boolean_t resolve_tree,
5157 svn_depth_t depth,
5158 svn_wc_conflict_choice_t conflict_choice,
5159 svn_wc_notify_func2_t notify_func,
5160 void *notify_baton,
5161 svn_cancel_func_t cancel_func,
5162 void *cancel_baton,
5163 apr_pool_t *pool);
5164
5165
5166/**
5167 * Similar to svn_wc_resolved_conflict4(), but without tree-conflict
5168 * resolution support.
5169 *
5170 * @since New in 1.5.
5171 * @deprecated Provided for backward compatibility with the 1.5 API.
5172 */
5176 svn_wc_adm_access_t *adm_access,
5177 svn_boolean_t resolve_text,
5178 svn_boolean_t resolve_props,
5179 svn_depth_t depth,
5180 svn_wc_conflict_choice_t conflict_choice,
5181 svn_wc_notify_func2_t notify_func,
5182 void *notify_baton,
5183 svn_cancel_func_t cancel_func,
5184 void *cancel_baton,
5185 apr_pool_t *pool);
5186
5187
5188/**
5189 * Similar to svn_wc_resolved_conflict3(), but without automatic conflict
5190 * resolution support, and with @a depth set according to @a recurse:
5191 * if @a recurse is TRUE, @a depth is #svn_depth_infinity, else it is
5192 * #svn_depth_files.
5193 *
5194 * @since New in 1.2.
5195 * @deprecated Provided for backward compatibility with the 1.4 API.
5196 */
5200 svn_wc_adm_access_t *adm_access,
5201 svn_boolean_t resolve_text,
5202 svn_boolean_t resolve_props,
5203 svn_boolean_t recurse,
5204 svn_wc_notify_func2_t notify_func,
5205 void *notify_baton,
5206 svn_cancel_func_t cancel_func,
5207 void *cancel_baton,
5208 apr_pool_t *pool);
5209
5210/**
5211 * Similar to svn_wc_resolved_conflict2(), but takes an
5212 * svn_wc_notify_func_t and doesn't have cancellation support.
5213 *
5214 * @deprecated Provided for backward compatibility with the 1.1 API.
5215 */
5219 svn_wc_adm_access_t *adm_access,
5220 svn_boolean_t resolve_text,
5221 svn_boolean_t resolve_props,
5222 svn_boolean_t recurse,
5223 svn_wc_notify_func_t notify_func,
5224 void *notify_baton,
5225 apr_pool_t *pool);
5226
5227␌
5228/* Commits. */
5229
5230
5231/**
5232 * Storage type for queued post-commit data.
5233 *
5234 * @since New in 1.5.
5235 */
5237
5238
5239/**
5240 * Create a queue for use with svn_wc_queue_committed() and
5241 * svn_wc_process_committed_queue().
5242 *
5243 * The returned queue and all further allocations required for queuing
5244 * new items will also be done from @a pool.
5245 *
5246 * @since New in 1.5.
5247 */
5250
5251
5252/**
5253 * Queue committed items to be processed later by
5254 * svn_wc_process_committed_queue2().
5255 *
5256 * Record in @a queue that @a local_abspath will need to be bumped
5257 * after a commit succeeds.
5258 *
5259 * If non-NULL, @a wcprop_changes is an array of <tt>svn_prop_t *</tt>
5260 * changes to wc properties; if an #svn_prop_t->value is NULL, then
5261 * that property is deleted.
5262 * ### [JAF] No, a prop whose value is NULL is ignored, not deleted. This
5263 * ### seems to be not a set of changes but rather the new complete set of
5264 * ### props. And it's renamed to 'new_dav_cache' inside; why?
5265 *
5266 * If @a is_committed is @c TRUE, the node will be processed as committed. This
5267 * turns the node and its implied descendants as the new unmodified state at
5268 * the new specified revision. Unless @a recurse is TRUE, changes on
5269 * descendants are not committed as changes directly. In this case they should
5270 * be queued as their own changes.
5271 *
5272 * If @a remove_lock is @c TRUE, any entryprops related to a repository
5273 * lock will be removed.
5274 *
5275 * If @a remove_changelist is @c TRUE, any association with a
5276 * changelist will be removed.
5277 *
5278 *
5279 * If @a sha1_checksum is non-NULL, use it to identify the node's pristine
5280 * text.
5281 *
5282 * If @a recurse is TRUE and @a local_abspath is a directory, then bump every
5283 * versioned object at or under @a local_abspath. This is usually done for
5284 * copied trees.
5285 *
5286 * ### In the present implementation, if a recursive directory item is in
5287 * the queue, then any children (at any depth) of that directory that
5288 * are also in the queue as separate items will get:
5289 * 'wcprop_changes' = NULL;
5290 * 'remove_lock' = FALSE;
5291 * 'remove_changelist' from the recursive parent item;
5292 * and any children (at any depth) of that directory that are NOT in
5293 * the queue as separate items will get:
5294 * 'wcprop_changes' = NULL;
5295 * 'remove_lock' = FALSE;
5296 * 'remove_changelist' from the recursive parent item;
5297 *
5298 * @note the @a recurse parameter should be used with extreme care since
5299 * it will bump ALL nodes under the directory, regardless of their
5300 * actual inclusion in the new revision.
5301 *
5302 * All pointer data passed to this function (@a local_abspath,
5303 * @a wcprop_changes and the checksums) should remain valid until the
5304 * queue has been processed by svn_wc_process_committed_queue2().
5305 *
5306 * Temporary allocations will be performed in @a scratch_pool, and persistent
5307 * allocations will use the same pool as @a queue used when it was created.
5308 *
5309 * @since New in 1.9.
5310 */
5313 svn_wc_context_t *wc_ctx,
5314 const char *local_abspath,
5315 svn_boolean_t recurse,
5316 svn_boolean_t is_committed,
5317 const apr_array_header_t *wcprop_changes,
5318 svn_boolean_t remove_lock,
5319 svn_boolean_t remove_changelist,
5320 const svn_checksum_t *sha1_checksum,
5321 apr_pool_t *scratch_pool);
5322
5323/** Similar to svn_wc_queue_committed4, but with is_committed always
5324 * TRUE.
5325 *
5326 * @since New in 1.7.
5327 * @deprecated Provided for backwards compatibility with the 1.8 API.
5328 */
5331 svn_wc_context_t *wc_ctx,
5332 const char *local_abspath,
5333 svn_boolean_t recurse,
5334 const apr_array_header_t *wcprop_changes,
5335 svn_boolean_t remove_lock,
5336 svn_boolean_t remove_changelist,
5337 const svn_checksum_t *sha1_checksum,
5338 apr_pool_t *scratch_pool);
5339
5340/** Same as svn_wc_queue_committed3() except @a path doesn't have to be an
5341 * abspath and @a adm_access is unused and a SHA-1 checksum cannot be
5342 * specified.
5343 *
5344 * @since New in 1.6.
5345 *
5346 * @deprecated Provided for backwards compatibility with the 1.6 API.
5347 */
5351 const char *path,
5352 svn_wc_adm_access_t *adm_access,
5353 svn_boolean_t recurse,
5354 const apr_array_header_t *wcprop_changes,
5355 svn_boolean_t remove_lock,
5356 svn_boolean_t remove_changelist,
5357 const svn_checksum_t *md5_checksum,
5358 apr_pool_t *scratch_pool);
5359
5360
5361/** Same as svn_wc_queue_committed2() but the @a queue parameter has an
5362 * extra indirection and @a digest is supplied instead of a checksum type.
5363 *
5364 * @note despite the extra indirection, this function does NOT allocate
5365 * the queue for you. svn_wc_committed_queue_create() must be called.
5366 *
5367 * @since New in 1.5
5368 *
5369 * @deprecated Provided for backwards compatibility with 1.5
5370 */
5374 const char *path,
5375 svn_wc_adm_access_t *adm_access,
5376 svn_boolean_t recurse,
5377 const apr_array_header_t *wcprop_changes,
5378 svn_boolean_t remove_lock,
5379 svn_boolean_t remove_changelist,
5380 const unsigned char *digest,
5381 apr_pool_t *pool);
5382
5383
5384/**
5385 * Bump all items in @a queue to @a new_revnum after a commit succeeds.
5386 * @a rev_date and @a rev_author are the (server-side) date and author
5387 * of the new revision; one or both may be @c NULL.
5388 *
5389 * If @a cancel_func is non-NULL, call it with @a cancel_baton to determine
5390 * if the client wants to cancel the operation.
5391 *
5392 * @since New in 1.7.
5393 */
5396 svn_wc_context_t *wc_ctx,
5397 svn_revnum_t new_revnum,
5398 const char *rev_date,
5399 const char *rev_author,
5400 svn_cancel_func_t cancel_func,
5401 void *cancel_baton,
5402 apr_pool_t *scratch_pool);
5403
5404/** @see svn_wc_process_committed_queue2()
5405 *
5406 * @since New in 1.5.
5407 * @deprecated Provided for backwards compatibility with the 1.6 API.
5408 */
5412 svn_wc_adm_access_t *adm_access,
5413 svn_revnum_t new_revnum,
5414 const char *rev_date,
5415 const char *rev_author,
5416 apr_pool_t *pool);
5417
5418
5419/**
5420 * @note this function has improper expectations around the operation and
5421 * execution of other parts of the Subversion WC library. The resulting
5422 * coupling makes this interface near-impossible to support. Documentation
5423 * has been removed, as a result.
5424 *
5425 * @deprecated Use the svn_wc_committed_queue_* functions instead. Provided
5426 * for backwards compatibility with the 1.5 API.
5427 */
5431 svn_wc_adm_access_t *adm_access,
5432 svn_boolean_t recurse,
5433 svn_revnum_t new_revnum,
5434 const char *rev_date,
5435 const char *rev_author,
5436 const apr_array_header_t *wcprop_changes,
5437 svn_boolean_t remove_lock,
5438 svn_boolean_t remove_changelist,
5439 const unsigned char *digest,
5440 apr_pool_t *pool);
5441
5442/** @see svn_wc_process_committed4()
5443 *
5444 * @deprecated Use the svn_wc_committed_queue_* functions instead. Provided
5445 * for backwards compatibility with the 1.4 API.
5446 */
5450 svn_wc_adm_access_t *adm_access,
5451 svn_boolean_t recurse,
5452 svn_revnum_t new_revnum,
5453 const char *rev_date,
5454 const char *rev_author,
5455 const apr_array_header_t *wcprop_changes,
5456 svn_boolean_t remove_lock,
5457 const unsigned char *digest,
5458 apr_pool_t *pool);
5459
5460/** @see svn_wc_process_committed4()
5461 *
5462 * @deprecated Use the svn_wc_committed_queue_* functions instead. Provided
5463 * for backwards compatibility with the 1.3 API.
5464 */
5468 svn_wc_adm_access_t *adm_access,
5469 svn_boolean_t recurse,
5470 svn_revnum_t new_revnum,
5471 const char *rev_date,
5472 const char *rev_author,
5473 const apr_array_header_t *wcprop_changes,
5474 svn_boolean_t remove_lock,
5475 apr_pool_t *pool);
5476
5477/** @see svn_wc_process_committed4()
5478 *
5479 * @deprecated Use the svn_wc_committed_queue_* functions instead. Provided
5480 * for backward compatibility with the 1.1 API.
5481 */
5485 svn_wc_adm_access_t *adm_access,
5486 svn_boolean_t recurse,
5487 svn_revnum_t new_revnum,
5488 const char *rev_date,
5489 const char *rev_author,
5490 const apr_array_header_t *wcprop_changes,
5491 apr_pool_t *pool);
5492
5493
5494
5495␌
5496
5497/**
5498 * Do a depth-first crawl in a working copy, beginning at @a local_abspath,
5499 * using @a wc_ctx for accessing the working copy.
5500 *
5501 * Communicate the `state' of the working copy's revisions and depths
5502 * to @a reporter/@a report_baton. Obviously, if @a local_abspath is a
5503 * file instead of a directory, this depth-first crawl will be a short one.
5504 *
5505 * No locks or logs are created, nor are any animals harmed in the
5506 * process unless @a restore_files is TRUE. No cleanup is necessary.
5507 *
5508 * After all revisions are reported, @a reporter->finish_report() is
5509 * called, which immediately causes the RA layer to update the working
5510 * copy. Thus the return value may very well reflect the result of
5511 * the update!
5512 *
5513 * If @a depth is #svn_depth_empty, then report state only for
5514 * @a path itself. If #svn_depth_files, do the same and include
5515 * immediate file children of @a path. If #svn_depth_immediates,
5516 * then behave as if for #svn_depth_files but also report the
5517 * property states of immediate subdirectories. If @a depth is
5518 * #svn_depth_infinity, then report state fully recursively. All
5519 * descents are only as deep as @a path's own depth permits, of
5520 * course. If @a depth is #svn_depth_unknown, then just use
5521 * #svn_depth_infinity, which in practice means depth of @a path.
5522 *
5523 * Iff @a honor_depth_exclude is TRUE, the crawler will report paths
5524 * whose ambient depth is #svn_depth_exclude as being excluded, and
5525 * thus prevent the server from pushing update data for those paths;
5526 * therefore, don't set this flag if you wish to pull in excluded paths.
5527 * Note that #svn_depth_exclude on the target @a path is never
5528 * honored, even if @a honor_depth_exclude is TRUE, because we need to
5529 * be able to explicitly pull in a target. For example, if this is
5530 * the working copy...
5531 *
5532 * svn co greek_tree_repos wc_dir
5533 * svn up --set-depth exclude wc_dir/A/B/E # now A/B/E is excluded
5534 *
5535 * ...then 'svn up wc_dir/A/B' would report E as excluded (assuming
5536 * @a honor_depth_exclude is TRUE), but 'svn up wc_dir/A/B/E' would
5537 * not, because the latter is trying to explicitly pull in E. In
5538 * general, we never report the update target as excluded.
5539 *
5540 * Iff @a depth_compatibility_trick is TRUE, then set the @c start_empty
5541 * flag on @a reporter->set_path() and @a reporter->link_path() calls
5542 * as necessary to trick a pre-1.5 (i.e., depth-unaware) server into
5543 * sending back all the items the client might need to upgrade a
5544 * working copy from a shallower depth to a deeper one.
5545 *
5546 * If @a restore_files is TRUE, then unexpectedly missing working files
5547 * will be restored from the administrative directory's cache. For each
5548 * file restored, the @a notify_func function will be called with the
5549 * @a notify_baton and the path of the restored file. @a notify_func may
5550 * be @c NULL if this notification is not required. If @a
5551 * use_commit_times is TRUE, then set restored files' timestamps to
5552 * their last-commit-times. For working copies that do not store local
5553 * pristine contents for all files, return @c SVN_ERR_WC_PRISTINE_DEHYDRATED
5554 * on an attempt to restore a file whose pristine contents is not present
5555 * locally.
5556 *
5557 * @note This is a relatively low-level function operating directly on a
5558 * working copy, so a caller is expected to be able to handle working copies
5559 * that do not store local copies of all pristine contents. This can be
5560 * achieved by synchronizing the text-base state before and optionally
5561 * after the function call. @see svn_wc_textbase_sync().
5562 *
5563 * @since New in 1.15.
5564 */
5566svn_wc_crawl_revisions6(svn_wc_context_t *wc_ctx,
5567 const char *local_abspath,
5568 const svn_ra_reporter3_t *reporter,
5569 void *report_baton,
5570 svn_boolean_t restore_files,
5571 svn_depth_t depth,
5572 svn_boolean_t honor_depth_exclude,
5573 svn_boolean_t depth_compatibility_trick,
5574 svn_boolean_t use_commit_times,
5575 svn_cancel_func_t cancel_func,
5576 void *cancel_baton,
5577 svn_wc_notify_func2_t notify_func,
5578 void *notify_baton,
5579 apr_pool_t *scratch_pool);
5580
5581/**
5582 * Similar to svn_wc_crawl_revisions6, but if @a restore_files is @c TRUE,
5583 * this function can only be used for working copies that store local
5584 * copies of all pristine contents.
5585 *
5586 * If @a restore_files is @c TRUE and a working copy doesn't store local copies
5587 * of all pristine contents, an #SVN_ERR_WC_DEPRECATED_API_STORE_PRISTINE
5588 * error will be returned.
5589 *
5590 * @since New in 1.7.
5591 * @deprecated Provided for compatibility with the 1.7 API.
5592 */
5596 const char *local_abspath,
5597 const svn_ra_reporter3_t *reporter,
5598 void *report_baton,
5599 svn_boolean_t restore_files,
5600 svn_depth_t depth,
5601 svn_boolean_t honor_depth_exclude,
5602 svn_boolean_t depth_compatibility_trick,
5603 svn_boolean_t use_commit_times,
5604 svn_cancel_func_t cancel_func,
5605 void *cancel_baton,
5606 svn_wc_notify_func2_t notify_func,
5607 void *notify_baton,
5608 apr_pool_t *scratch_pool);
5609
5610/**
5611 * Similar to svn_wc_crawl_revisions5, but with a relative path and
5612 * access baton instead of an absolute path and wc_ctx.
5613 *
5614 * Passes NULL for @a cancel_func and @a cancel_baton.
5615 *
5616 * @since New in 1.6.
5617 * @deprecated Provided for compatibility with the 1.6 API.
5618 */
5622 svn_wc_adm_access_t *adm_access,
5623 const svn_ra_reporter3_t *reporter,
5624 void *report_baton,
5625 svn_boolean_t restore_files,
5626 svn_depth_t depth,
5627 svn_boolean_t honor_depth_exclude,
5628 svn_boolean_t depth_compatibility_trick,
5629 svn_boolean_t use_commit_times,
5630 svn_wc_notify_func2_t notify_func,
5631 void *notify_baton,
5632 svn_wc_traversal_info_t *traversal_info,
5633 apr_pool_t *pool);
5634
5635
5636/**
5637 * Similar to svn_wc_crawl_revisions4, but with @a honor_depth_exclude always
5638 * set to false.
5639 *
5640 * @deprecated Provided for compatibility with the 1.5 API.
5641 */
5645 svn_wc_adm_access_t *adm_access,
5646 const svn_ra_reporter3_t *reporter,
5647 void *report_baton,
5648 svn_boolean_t restore_files,
5649 svn_depth_t depth,
5650 svn_boolean_t depth_compatibility_trick,
5651 svn_boolean_t use_commit_times,
5652 svn_wc_notify_func2_t notify_func,
5653 void *notify_baton,
5654 svn_wc_traversal_info_t *traversal_info,
5655 apr_pool_t *pool);
5656
5657/**
5658 * Similar to svn_wc_crawl_revisions3, but taking svn_ra_reporter2_t
5659 * instead of svn_ra_reporter3_t, and therefore only able to report
5660 * #svn_depth_infinity for depths; and taking @a recurse instead of @a
5661 * depth; and with @a depth_compatibility_trick always false.
5662 *
5663 * @deprecated Provided for compatibility with the 1.4 API.
5664 */
5668 svn_wc_adm_access_t *adm_access,
5669 const svn_ra_reporter2_t *reporter,
5670 void *report_baton,
5671 svn_boolean_t restore_files,
5672 svn_boolean_t recurse,
5673 svn_boolean_t use_commit_times,
5674 svn_wc_notify_func2_t notify_func,
5675 void *notify_baton,
5676 svn_wc_traversal_info_t *traversal_info,
5677 apr_pool_t *pool);
5678
5679/**
5680 * Similar to svn_wc_crawl_revisions2(), but takes an #svn_wc_notify_func_t
5681 * and a #svn_ra_reporter_t instead.
5682 *
5683 * @deprecated Provided for backward compatibility with the 1.1 API.
5684 */
5688 svn_wc_adm_access_t *adm_access,
5689 const svn_ra_reporter_t *reporter,
5690 void *report_baton,
5691 svn_boolean_t restore_files,
5692 svn_boolean_t recurse,
5693 svn_boolean_t use_commit_times,
5694 svn_wc_notify_func_t notify_func,
5695 void *notify_baton,
5696 svn_wc_traversal_info_t *traversal_info,
5697 apr_pool_t *pool);
5698
5699␌
5700/**
5701 * @defgroup svn_wc_roots Working copy roots
5702 * @{
5703 */
5704
5705/** If @a is_wcroot is not @c NULL, set @a *is_wcroot to @c TRUE if @a
5706 * local_abspath is the root of the working copy, otherwise to @c FALSE.
5707 *
5708 * If @a is_switched is not @c NULL, set @a *is_switched to @c TRUE if @a
5709 * local_abspath is not the root of the working copy, and switched against its
5710 * parent.
5711 *
5712 * If @a kind is not @c NULL, set @a *kind to the node kind of @a
5713 * local_abspath.
5714 *
5715 * Use @a scratch_pool for any temporary allocations.
5716 *
5717 * @since New in 1.8.
5718 */
5721 svn_boolean_t *is_switched,
5723 svn_wc_context_t *wc_ctx,
5724 const char *local_abspath,
5725 apr_pool_t *scratch_pool);
5726
5727/** Set @a *wc_root to @c TRUE if @a local_abspath represents a "working copy
5728 * root", @c FALSE otherwise. Here, @a local_abspath is a "working copy root"
5729 * if its parent directory is not a WC or if it is switched. Also, a deleted
5730 * tree-conflict victim is considered a "working copy root" because it has no
5731 * URL.
5732 *
5733 * If @a local_abspath is not found, return the error #SVN_ERR_ENTRY_NOT_FOUND.
5734 *
5735 * Use @a scratch_pool for any temporary allocations.
5736 *
5737 * @note For legacy reasons only a directory can be a wc-root. However, this
5738 * function will also set wc_root to @c TRUE for a switched file.
5739 *
5740 * @since New in 1.7.
5741 * @deprecated Provided for backward compatibility with the 1.7 API. Consider
5742 * using svn_wc_check_root() instead.
5743 */
5747 svn_wc_context_t *wc_ctx,
5748 const char *local_abspath,
5749 apr_pool_t *scratch_pool);
5750
5751
5752/**
5753 * Similar to svn_wc_is_wc_root2(), but with an access baton and relative
5754 * path.
5755 *
5756 * @note If @a path is '', this function will always return @c TRUE.
5757 *
5758 * @deprecated Provided for backward compatibility with the 1.6 API.
5759 */
5763 const char *path,
5764 svn_wc_adm_access_t *adm_access,
5765 apr_pool_t *pool);
5766
5767/** @} */
5768
5769
5770/* Updates. */
5771
5772/** Conditionally split @a path into an @a anchor and @a target for the
5773 * purpose of updating and committing.
5774 *
5775 * @a anchor is the directory at which the update or commit editor
5776 * should be rooted.
5777 *
5778 * @a target is the actual subject (relative to the @a anchor) of the
5779 * update/commit, or "" if the @a anchor itself is the subject.
5780 *
5781 * Allocate @a anchor and @a target in @a result_pool; @a scratch_pool
5782 * is used for temporary allocations.
5783 *
5784 * @note Even though this API uses a #svn_wc_context_t, it accepts a
5785 * (possibly) relative path and returns a (possibly) relative path in
5786 * @a *anchor. The reason being that the outputs are generally used to
5787 * open access batons, and such opening currently requires relative paths.
5788 * In the long-run, I expect this API to be removed from 1.7, due to the
5789 * remove of access batons, but for the time being, the #svn_wc_context_t
5790 * parameter allows us to avoid opening a duplicate database, just for this
5791 * function.
5792 *
5793 * @since New in 1.7.
5794 */
5796svn_wc_get_actual_target2(const char **anchor,
5797 const char **target,
5798 svn_wc_context_t *wc_ctx,
5799 const char *path,
5800 apr_pool_t *result_pool,
5801 apr_pool_t *scratch_pool);
5802
5803
5804/** Similar to svn_wc_get_actual_target2(), but without the wc context, and
5805 * with a absolute path.
5806 *
5807 * @deprecated Provided for backward compatibility with the 1.6 API.
5808 */
5812 const char **anchor,
5813 const char **target,
5814 apr_pool_t *pool);
5815
5816
5817/**
5818 * @defgroup svn_wc_update_switch Update and switch (update-like functionality)
5819 * @{
5820 */
5821
5822/**
5823 * A simple callback type to wrap svn_ra_get_file(); see that
5824 * docstring for more information.
5825 *
5826 * This technique allows libsvn_client to 'wrap' svn_ra_get_file() and
5827 * pass it down into libsvn_wc functions, thus allowing the WC layer
5828 * to legally call the RA function via (blind) callback.
5829 *
5830 * @since New in 1.5
5831 * @deprecated Provided for backward compatibility with the 1.6 API.
5832 */
5833typedef svn_error_t *(*svn_wc_get_file_t)(void *baton,
5834 const char *path,
5836 svn_stream_t *stream,
5837 svn_revnum_t *fetched_rev,
5838 apr_hash_t **props,
5839 apr_pool_t *pool);
5840
5841/**
5842 * A simple callback type to wrap svn_ra_get_dir2() for avoiding issue #3569,
5843 * where a directory is updated to a revision without some of its children
5844 * recorded in the working copy. A future update won't bring these files in
5845 * because the repository assumes they are already there.
5846 *
5847 * We really only need the names of the dirents for a not-present marking,
5848 * but we also store the node-kind if we receive one.
5849 *
5850 * @a *dirents should be set to a hash mapping <tt>const char *</tt> child
5851 * names, to <tt>const svn_dirent_t *</tt> instances.
5852 *
5853 * @since New in 1.7.
5854 */
5855typedef svn_error_t *(*svn_wc_dirents_func_t)(void *baton,
5856 apr_hash_t **dirents,
5857 const char *repos_root_url,
5858 const char *repos_relpath,
5859 apr_pool_t *result_pool,
5860 apr_pool_t *scratch_pool);
5861
5862
5863/**
5864 * DEPRECATED -- please use APIs from svn_client.h
5865 *
5866 * ---
5867 *
5868 * Set @a *editor and @a *edit_baton to an editor and baton for updating a
5869 * working copy.
5870 *
5871 * @a anchor_abspath is a local working copy directory, with a fully recursive
5872 * write lock in @a wc_ctx, which will be used as the root of our editor.
5873 *
5874 * @a target_basename is the entry in @a anchor_abspath that will actually be
5875 * updated, or the empty string if all of @a anchor_abspath should be updated.
5876 *
5877 * The editor invokes @a notify_func with @a notify_baton as the update
5878 * progresses, if @a notify_func is non-NULL.
5879 *
5880 * If @a cancel_func is non-NULL, the editor will invoke @a cancel_func with
5881 * @a cancel_baton as the update progresses to see if it should continue.
5882 *
5883 * If @a conflict_func is non-NULL, then invoke it with @a
5884 * conflict_baton whenever a conflict is encountered, giving the
5885 * callback a chance to resolve the conflict before the editor takes
5886 * more drastic measures (such as marking a file conflicted, or
5887 * bailing out of the update).
5888 *
5889 * If @a external_func is non-NULL, then invoke it with @a external_baton
5890 * whenever external changes are encountered, giving the callback a chance
5891 * to store the external information for processing.
5892 *
5893 * If @a diff3_cmd is non-NULL, then use it as the diff3 command for
5894 * any merging; otherwise, use the built-in merge code.
5895 *
5896 * @a preserved_exts is an array of filename patterns which, when
5897 * matched against the extensions of versioned files, determine for
5898 * which such files any related generated conflict files will preserve
5899 * the original file's extension as their own. If a file's extension
5900 * does not match any of the patterns in @a preserved_exts (which is
5901 * certainly the case if @a preserved_exts is @c NULL or empty),
5902 * generated conflict files will carry Subversion's custom extensions.
5903 *
5904 * @a target_revision is a pointer to a revision location which, after
5905 * successful completion of the drive of this editor, will be
5906 * populated with the revision to which the working copy was updated.
5907 *
5908 * If @a use_commit_times is TRUE, then all edited/added files will
5909 * have their working timestamp set to the last-committed-time. If
5910 * FALSE, the working files will be touched with the 'now' time.
5911 *
5912 * If @a allow_unver_obstructions is TRUE, then allow unversioned
5913 * obstructions when adding a path.
5914 *
5915 * If @a adds_as_modification is TRUE, a local addition at the same path
5916 * as an incoming addition of the same node kind results in a normal node
5917 * with a possible local modification, instead of a tree conflict.
5918 *
5919 * If @a depth is #svn_depth_infinity, update fully recursively.
5920 * Else if it is #svn_depth_immediates, update the uppermost
5921 * directory, its file entries, and the presence or absence of
5922 * subdirectories (but do not descend into the subdirectories).
5923 * Else if it is #svn_depth_files, update the uppermost directory
5924 * and its immediate file entries, but not subdirectories.
5925 * Else if it is #svn_depth_empty, update exactly the uppermost
5926 * target, and don't touch its entries.
5927 *
5928 * If @a depth_is_sticky is set and @a depth is not
5929 * #svn_depth_unknown, then in addition to updating PATHS, also set
5930 * their sticky ambient depth value to @a depth.
5931 *
5932 * If @a server_performs_filtering is TRUE, assume that the server handles
5933 * the ambient depth filtering, so this doesn't have to be handled in the
5934 * editor.
5935 *
5936 * If @a clean_checkout is TRUE, assume that we are checking out into an
5937 * empty directory, and so bypass a number of conflict checks that are
5938 * unnecessary in this case.
5939 *
5940 * If @a fetch_dirents_func is not NULL, the update editor may call this
5941 * callback, when asked to perform a depth restricted update. It will do this
5942 * before returning the editor to allow using the primary ra session for this.
5943 *
5944 * @since New in 1.7.
5945 * @deprecated Provided for backward compatibility with the 1.7 API.
5946 */
5949svn_wc_get_update_editor4(const svn_delta_editor_t **editor,
5950 void **edit_baton,
5951 svn_revnum_t *target_revision,
5952 svn_wc_context_t *wc_ctx,
5953 const char *anchor_abspath,
5954 const char *target_basename,
5955 svn_boolean_t use_commit_times,
5956 svn_depth_t depth,
5957 svn_boolean_t depth_is_sticky,
5958 svn_boolean_t allow_unver_obstructions,
5959 svn_boolean_t adds_as_modification,
5960 svn_boolean_t server_performs_filtering,
5961 svn_boolean_t clean_checkout,
5962 const char *diff3_cmd,
5963 const apr_array_header_t *preserved_exts,
5964 svn_wc_dirents_func_t fetch_dirents_func,
5965 void *fetch_dirents_baton,
5967 void *conflict_baton,
5968 svn_wc_external_update_t external_func,
5969 void *external_baton,
5970 svn_cancel_func_t cancel_func,
5971 void *cancel_baton,
5972 svn_wc_notify_func2_t notify_func,
5973 void *notify_baton,
5974 apr_pool_t *result_pool,
5975 apr_pool_t *scratch_pool);
5976
5977/** Similar to svn_wc_get_update_editor4, but uses access batons and relative
5978 * path instead of a working copy context-abspath pair and
5979 * svn_wc_traversal_info_t instead of an externals callback. Also,
5980 * @a fetch_func and @a fetch_baton are ignored.
5981 *
5982 * If @a ti is non-NULL, record traversal info in @a ti, for use by
5983 * post-traversal accessors such as svn_wc_edited_externals().
5984 *
5985 * All locks, both those in @a anchor and newly acquired ones, will be
5986 * released when the editor driver calls @c close_edit.
5987 *
5988 * Always sets @a adds_as_modification to TRUE, @a server_performs_filtering
5989 * and @a clean_checkout to FALSE.
5990 *
5991 * Uses a svn_wc_conflict_resolver_func_t conflict resolver instead of a
5992 * svn_wc_conflict_resolver_func2_t.
5993 *
5994 * This function assumes that @a diff3_cmd is path encoded. Later versions
5995 * assume utf-8.
5996 *
5997 * Always passes a null dirent function.
5998 *
5999 * @since New in 1.5.
6000 * @deprecated Provided for backward compatibility with the 1.6 API.
6001 */
6005 svn_wc_adm_access_t *anchor,
6006 const char *target,
6007 svn_boolean_t use_commit_times,
6008 svn_depth_t depth,
6009 svn_boolean_t depth_is_sticky,
6010 svn_boolean_t allow_unver_obstructions,
6011 svn_wc_notify_func2_t notify_func,
6012 void *notify_baton,
6013 svn_cancel_func_t cancel_func,
6014 void *cancel_baton,
6015 svn_wc_conflict_resolver_func_t conflict_func,
6016 void *conflict_baton,
6017 svn_wc_get_file_t fetch_func,
6018 void *fetch_baton,
6019 const char *diff3_cmd,
6020 const apr_array_header_t *preserved_exts,
6021 const svn_delta_editor_t **editor,
6022 void **edit_baton,
6024 apr_pool_t *pool);
6025
6026
6027/**
6028 * Similar to svn_wc_get_update_editor3() but with the @a
6029 * allow_unver_obstructions parameter always set to FALSE, @a
6030 * conflict_func and baton set to NULL, @a fetch_func and baton set to
6031 * NULL, @a preserved_exts set to NULL, @a depth_is_sticky set to
6032 * FALSE, and @a depth set according to @a recurse: if @a recurse is
6033 * TRUE, pass #svn_depth_infinity, if FALSE, pass #svn_depth_files.
6034 *
6035 * @deprecated Provided for backward compatibility with the 1.4 API.
6036 */
6040 svn_wc_adm_access_t *anchor,
6041 const char *target,
6042 svn_boolean_t use_commit_times,
6043 svn_boolean_t recurse,
6044 svn_wc_notify_func2_t notify_func,
6045 void *notify_baton,
6046 svn_cancel_func_t cancel_func,
6047 void *cancel_baton,
6048 const char *diff3_cmd,
6049 const svn_delta_editor_t **editor,
6050 void **edit_baton,
6052 apr_pool_t *pool);
6053
6054/**
6055 * Similar to svn_wc_get_update_editor2(), but takes an svn_wc_notify_func_t
6056 * instead.
6057 *
6058 * @deprecated Provided for backward compatibility with the 1.1 API.
6059 */
6063 svn_wc_adm_access_t *anchor,
6064 const char *target,
6065 svn_boolean_t use_commit_times,
6066 svn_boolean_t recurse,
6067 svn_wc_notify_func_t notify_func,
6068 void *notify_baton,
6069 svn_cancel_func_t cancel_func,
6070 void *cancel_baton,
6071 const char *diff3_cmd,
6072 const svn_delta_editor_t **editor,
6073 void **edit_baton,
6075 apr_pool_t *pool);
6076
6077/**
6078 * DEPRECATED -- please use APIs from svn_client.h
6079 *
6080 * ---
6081 *
6082 * A variant of svn_wc_get_update_editor4().
6083 *
6084 * Set @a *editor and @a *edit_baton to an editor and baton for "switching"
6085 * a working copy to a new @a switch_url. (Right now, this URL must be
6086 * within the same repository that the working copy already comes
6087 * from.) @a switch_url must not be @c NULL.
6088 *
6089 * All other parameters behave as for svn_wc_get_update_editor4().
6090 *
6091 * @since New in 1.7.
6092 * @deprecated Provided for backward compatibility with the 1.7 API.
6093 */
6096svn_wc_get_switch_editor4(const svn_delta_editor_t **editor,
6097 void **edit_baton,
6098 svn_revnum_t *target_revision,
6099 svn_wc_context_t *wc_ctx,
6100 const char *anchor_abspath,
6101 const char *target_basename,
6102 const char *switch_url,
6103 svn_boolean_t use_commit_times,
6104 svn_depth_t depth,
6105 svn_boolean_t depth_is_sticky,
6106 svn_boolean_t allow_unver_obstructions,
6107 svn_boolean_t server_performs_filtering,
6108 const char *diff3_cmd,
6109 const apr_array_header_t *preserved_exts,
6110 svn_wc_dirents_func_t fetch_dirents_func,
6111 void *fetch_dirents_baton,
6113 void *conflict_baton,
6114 svn_wc_external_update_t external_func,
6115 void *external_baton,
6116 svn_cancel_func_t cancel_func,
6117 void *cancel_baton,
6118 svn_wc_notify_func2_t notify_func,
6119 void *notify_baton,
6120 apr_pool_t *result_pool,
6121 apr_pool_t *scratch_pool);
6122
6123/** Similar to svn_wc_get_switch_editor4, but uses access batons and relative
6124 * path instead of a working copy context and svn_wc_traversal_info_t instead
6125 * of an externals callback.
6126 *
6127 * If @a ti is non-NULL, record traversal info in @a ti, for use by
6128 * post-traversal accessors such as svn_wc_edited_externals().
6129 *
6130 * All locks, both those in @a anchor and newly acquired ones, will be
6131 * released when the editor driver calls @c close_edit.
6132 *
6133 * Always sets @a server_performs_filtering to FALSE.
6134 *
6135 * Uses a svn_wc_conflict_resolver_func_t conflict resolver instead of a
6136 * svn_wc_conflict_resolver_func2_t.
6137 *
6138 * This function assumes that @a diff3_cmd is path encoded. Later versions
6139 * assume utf-8.
6140 *
6141 * @since New in 1.5.
6142 * @deprecated Provided for backward compatibility with the 1.6 API.
6143 */
6147 svn_wc_adm_access_t *anchor,
6148 const char *target,
6149 const char *switch_url,
6150 svn_boolean_t use_commit_times,
6151 svn_depth_t depth,
6152 svn_boolean_t depth_is_sticky,
6153 svn_boolean_t allow_unver_obstructions,
6154 svn_wc_notify_func2_t notify_func,
6155 void *notify_baton,
6156 svn_cancel_func_t cancel_func,
6157 void *cancel_baton,
6158 svn_wc_conflict_resolver_func_t conflict_func,
6159 void *conflict_baton,
6160 const char *diff3_cmd,
6161 const apr_array_header_t *preserved_exts,
6162 const svn_delta_editor_t **editor,
6163 void **edit_baton,
6165 apr_pool_t *pool);
6166
6167/**
6168 * Similar to svn_wc_get_switch_editor3() but with the
6169 * @a allow_unver_obstructions parameter always set to FALSE,
6170 * @a preserved_exts set to NULL, @a conflict_func and baton set to NULL,
6171 * @a depth_is_sticky set to FALSE, and @a depth set according to @a
6172 * recurse: if @a recurse is TRUE, pass #svn_depth_infinity, if
6173 * FALSE, pass #svn_depth_files.
6174 *
6175 * @deprecated Provided for backward compatibility with the 1.4 API.
6176 */
6180 svn_wc_adm_access_t *anchor,
6181 const char *target,
6182 const char *switch_url,
6183 svn_boolean_t use_commit_times,
6184 svn_boolean_t recurse,
6185 svn_wc_notify_func2_t notify_func,
6186 void *notify_baton,
6187 svn_cancel_func_t cancel_func,
6188 void *cancel_baton,
6189 const char *diff3_cmd,
6190 const svn_delta_editor_t **editor,
6191 void **edit_baton,
6193 apr_pool_t *pool);
6194
6195/**
6196 * Similar to svn_wc_get_switch_editor2(), but takes an
6197 * #svn_wc_notify_func_t instead.
6198 *
6199 * @deprecated Provided for backward compatibility with the 1.1 API.
6200 */
6204 svn_wc_adm_access_t *anchor,
6205 const char *target,
6206 const char *switch_url,
6207 svn_boolean_t use_commit_times,
6208 svn_boolean_t recurse,
6209 svn_wc_notify_func_t notify_func,
6210 void *notify_baton,
6211 svn_cancel_func_t cancel_func,
6212 void *cancel_baton,
6213 const char *diff3_cmd,
6214 const svn_delta_editor_t **editor,
6215 void **edit_baton,
6217 apr_pool_t *pool);
6218
6219/** @} */
6220
6221
6222/**
6223 * @defgroup svn_wc_properties Properties
6224 * @{
6225 */
6226
6227/** Set @a *props to a hash table mapping <tt>char *</tt> names onto
6228 * <tt>svn_string_t *</tt> values for all the regular properties of
6229 * @a local_abspath. Allocate the table, names, and values in
6230 * @a result_pool. If the node has no properties, then an empty hash
6231 * is returned. Use @a wc_ctx to access the working copy, and @a
6232 * scratch_pool for temporary allocations.
6233 *
6234 * If the node does not exist, #SVN_ERR_WC_PATH_NOT_FOUND is returned.
6235 *
6236 * @since New in 1.7.
6237 */
6239svn_wc_prop_list2(apr_hash_t **props,
6240 svn_wc_context_t *wc_ctx,
6241 const char *local_abspath,
6242 apr_pool_t *result_pool,
6243 apr_pool_t *scratch_pool);
6244
6245/** Similar to svn_wc_prop_list2() but with a #svn_wc_adm_access_t /
6246 * relative path parameter pair.
6247 *
6248 * @deprecated Provided for backwards compatibility with the 1.6 API.
6249 */
6252svn_wc_prop_list(apr_hash_t **props,
6253 const char *path,
6254 svn_wc_adm_access_t *adm_access,
6255 apr_pool_t *pool);
6256
6257
6258/** Return the set of "pristine" properties for @a local_abspath.
6259 *
6260 * There are node states where properties do not make sense. For these
6261 * cases, NULL will be returned in @a *props. Otherwise, a hash table
6262 * will always be returned (but may be empty, indicating no properties).
6263 *
6264 * If the node is locally-added, then @a *props will be set to NULL since
6265 * pristine properties are undefined. Note: if this addition is replacing a
6266 * previously-deleted node, then the replaced node's properties are not
6267 * available until the addition is reverted.
6268 *
6269 * If the node has been copied (from another node in the repository), then
6270 * the pristine properties will correspond to those original properties.
6271 *
6272 * If the node is locally-deleted, these properties will correspond to
6273 * the BASE node's properties, as checked-out from the repository. Note: if
6274 * this deletion is a child of a copy, then the pristine properties will
6275 * correspond to that copy's properties, not any potential BASE node. The
6276 * BASE node's properties will not be accessible until the copy is reverted.
6277 *
6278 * Nodes that are incomplete, excluded, absent, or not present at the
6279 * node's revision will return NULL in @a props.
6280 *
6281 * If the node is not versioned, SVN_ERR_WC_PATH_NOT_FOUND will be returned.
6282 *
6283 * @a props will be allocated in @a result_pool, and all temporary
6284 * allocations will be performed in @a scratch_pool.
6285 *
6286 * @since New in 1.7.
6287 */
6289svn_wc_get_pristine_props(apr_hash_t **props,
6290 svn_wc_context_t *wc_ctx,
6291 const char *local_abspath,
6292 apr_pool_t *result_pool,
6293 apr_pool_t *scratch_pool);
6294
6295
6296/** Set @a *value to the value of property @a name for @a local_abspath,
6297 * allocating @a *value in @a result_pool. If no such prop, set @a *value
6298 * to @c NULL. @a name may be a regular or wc property; if it is an
6299 * entry property, return the error #SVN_ERR_BAD_PROP_KIND. @a wc_ctx
6300 * is used to access the working copy.
6301 *
6302 * If @a local_abspath is not a versioned path, return
6303 * #SVN_ERR_WC_PATH_NOT_FOUND
6304 *
6305 * @since New in 1.7.
6306 */
6309 svn_wc_context_t *wc_ctx,
6310 const char *local_abspath,
6311 const char *name,
6312 apr_pool_t *result_pool,
6313 apr_pool_t *scratch_pool);
6314
6315/** Similar to svn_wc_prop_get2(), but with a #svn_wc_adm_access_t /
6316 * relative path parameter pair.
6317 *
6318 * When @a path is not versioned, set @a *value to NULL.
6319 *
6320 * @deprecated Provided for backwards compatibility with the 1.6 API.
6321 */
6325 const char *name,
6326 const char *path,
6327 svn_wc_adm_access_t *adm_access,
6328 apr_pool_t *pool);
6329
6330/**
6331 * Set property @a name to @a value for @a local_abspath, or if @a value is
6332 * NULL, remove property @a name from @a local_abspath. Use @a wc_ctx to
6333 * access @a local_abspath.
6334 *
6335 * @a name may be a regular property or a "wc property". If @a name is
6336 * an "entry property", return the error #SVN_ERR_BAD_PROP_KIND (even if
6337 * @a skip_checks is TRUE).
6338 *
6339 * If @a name is a "wc property", then just update the WC DAV cache for
6340 * @a local_abspath with @a name and @a value. In this case, @a depth
6341 * must be #svn_depth_empty.
6342 *
6343 * The rest of this description applies when @a name is a regular property.
6344 *
6345 * If @a name is a name in the reserved "svn:" name space, and @a value is
6346 * non-null, then canonicalize the property value and check the property
6347 * name and value as documented for svn_wc_canonicalize_svn_prop().
6348 * @a skip_checks controls the level of checking as documented there.
6349 *
6350 * Return an error if the canonicalization or the check fails.
6351 * The error will be either #SVN_ERR_ILLEGAL_TARGET (if the
6352 * property is not appropriate for @a path), or
6353 * #SVN_ERR_BAD_MIME_TYPE (if @a name is "svn:mime-type", but @a value
6354 * is not a valid mime-type).
6355 * ### That is not currently right -- several other errors can be raised.
6356 *
6357 * @a depth follows the usual semantics for depth.
6358 *
6359 * @a changelist_filter is an array of <tt>const char *</tt> changelist
6360 * names, used as a restrictive filter on items whose properties are
6361 * set; that is, don't set properties on any item unless it's a member
6362 * of one of those changelists. If @a changelist_filter is empty (or
6363 * altogether @c NULL), no changelist filtering occurs.
6364 *
6365 * If @a cancel_func is non-NULL, then it will be invoked (with the
6366 * @a cancel_baton value passed) during the processing of the property
6367 * set (i.e. when @a depth indicates some amount of recursion).
6368 *
6369 * For each file or directory operated on, @a notify_func will be called
6370 * with its path and the @a notify_baton. @a notify_func may be @c NULL
6371 * if you are not interested in this information.
6372 *
6373 * Use @a scratch_pool for temporary allocation.
6374 *
6375 * @note If the caller is setting both svn:mime-type and svn:eol-style in
6376 * separate calls, and @a skip_checks is false, there is an ordering
6377 * dependency between them, as the validity check for svn:eol-style makes
6378 * use of the current value of svn:mime-type.
6379 *
6380 * ### The error code on validity check failure should be specified, and
6381 * should be a single code or a very small set of possibilities.
6382 *
6383 * @since New in 1.7.
6384 */
6387 const char *local_abspath,
6388 const char *name,
6389 const svn_string_t *value,
6390 svn_depth_t depth,
6391 svn_boolean_t skip_checks,
6392 const apr_array_header_t *changelist_filter,
6393 svn_cancel_func_t cancel_func,
6394 void *cancel_baton,
6395 svn_wc_notify_func2_t notify_func,
6396 void *notify_baton,
6397 apr_pool_t *scratch_pool);
6398
6399/** Similar to svn_wc_prop_set4(), but with a #svn_wc_adm_access_t /
6400 * relative path parameter pair, no @a depth parameter, no changelist
6401 * filtering (for the depth-based property setting), and no cancellation.
6402 *
6403 * @since New in 1.6.
6404 * @deprecated Provided for backwards compatibility with the 1.6 API.
6405 */
6408svn_wc_prop_set3(const char *name,
6409 const svn_string_t *value,
6410 const char *path,
6411 svn_wc_adm_access_t *adm_access,
6412 svn_boolean_t skip_checks,
6413 svn_wc_notify_func2_t notify_func,
6414 void *notify_baton,
6415 apr_pool_t *pool);
6416
6417
6418/**
6419 * Like svn_wc_prop_set3(), but without the notification callbacks.
6420 *
6421 * @since New in 1.2.
6422 * @deprecated Provided for backwards compatibility with the 1.5 API.
6423 */
6426svn_wc_prop_set2(const char *name,
6427 const svn_string_t *value,
6428 const char *path,
6429 svn_wc_adm_access_t *adm_access,
6430 svn_boolean_t skip_checks,
6431 apr_pool_t *pool);
6432
6433
6434/**
6435 * Like svn_wc_prop_set2(), but with @a skip_checks always FALSE.
6436 *
6437 * @deprecated Provided for backward compatibility with the 1.1 API.
6438 */
6441svn_wc_prop_set(const char *name,
6442 const svn_string_t *value,
6443 const char *path,
6444 svn_wc_adm_access_t *adm_access,
6445 apr_pool_t *pool);
6446
6447
6448/** Return TRUE iff @a name is a 'normal' property name. 'Normal' is
6449 * defined as a user-visible and user-tweakable property that shows up
6450 * when you fetch a proplist.
6451 *
6452 * The function currently parses the namespace like so:
6453 *
6454 * - 'svn:wc:' ==> a wcprop, stored/accessed separately via different API.
6455 *
6456 * - 'svn:entry:' ==> an "entry" prop, shunted into the 'entries' file.
6457 *
6458 * If these patterns aren't found, then the property is assumed to be
6459 * Normal.
6460 */
6462svn_wc_is_normal_prop(const char *name);
6463
6464
6465
6466/** Return TRUE iff @a name is a 'wc' property name. */
6468svn_wc_is_wc_prop(const char *name);
6469
6470/** Return TRUE iff @a name is a 'entry' property name. */
6472svn_wc_is_entry_prop(const char *name);
6473
6474/** Callback type used by #svn_wc_canonicalize_svn_prop.
6475 *
6476 * If @a mime_type is non-null, it sets @a *mime_type to the value of
6477 * #SVN_PROP_MIME_TYPE for the path passed to
6478 * #svn_wc_canonicalize_svn_prop (allocated from @a pool). If @a
6479 * stream is non-null, it writes the contents of the file to @a
6480 * stream.
6481 *
6482 * (Currently, this is used if you are attempting to set the
6483 * #SVN_PROP_EOL_STYLE property, to make sure that the value matches
6484 * the mime type and contents.)
6485 *
6486 * @since New in 1.5.
6487 */
6488typedef svn_error_t *(*svn_wc_canonicalize_svn_prop_get_file_t)(
6489 const svn_string_t **mime_type,
6490 svn_stream_t *stream,
6491 void *baton,
6492 apr_pool_t *pool);
6493
6494
6495/** Canonicalize the value of an svn:* property @a propname with
6496 * value @a propval.
6497 *
6498 * If the property is not appropriate for a node of kind @a kind, or
6499 * is otherwise invalid, throw an error. Otherwise, set @a *propval_p
6500 * to a canonicalized version of the property value.
6501 *
6502 * The exact set of canonicalizations and checks may vary across different
6503 * versions of this API. Currently:
6504 *
6505 * - svn:executable
6506 * - svn:needs-lock
6507 * - svn:special
6508 * - set the value to '*'
6509 *
6510 * - svn:keywords
6511 * - strip leading and trailing white space
6512 *
6513 * - svn:ignore
6514 * - svn:global-ignores
6515 * - svn:auto-props
6516 * - add a final a newline character if missing
6517 *
6518 * - svn:externals
6519 * - add a final a newline character if missing
6520 * - check for valid syntax
6521 * - check for no duplicate entries
6522 *
6523 * - svn:mergeinfo
6524 * - canonicalize
6525 * - check for validity
6526 *
6527 * Also, unless @a skip_some_checks is TRUE:
6528 *
6529 * - svn:eol-style
6530 * - strip leading and trailing white space
6531 * - check value is recognized
6532 * - check file content has a self-consistent EOL style
6533 * (but not necessarily that it matches @a propval)
6534 *
6535 * - svn:mime-type
6536 * - strip white space
6537 * - check for reasonable syntax
6538 *
6539 * The EOL-style check (if not skipped) requires access to the contents and
6540 * MIME type of the target if it is a file. It will call @a prop_getter with
6541 * @a getter_baton. The callback must set the MIME type and/or write the
6542 * contents of the file to the given stream. If @a skip_some_checks is true,
6543 * then @a prop_getter is not used and may be NULL.
6544 *
6545 * @a path should be the path of the file in question; it is only used
6546 * for error messages.
6547 *
6548 * ### The error code on validity check failure should be specified, and
6549 * should be a single code or a very small set of possibilities.
6550 *
6551 * ### This is not actually related to the WC, but it does need to call
6552 * ### svn_wc_parse_externals_description3.
6553 *
6554 * @since New in 1.5.
6555 */
6558 const char *propname,
6559 const svn_string_t *propval,
6560 const char *path,
6562 svn_boolean_t skip_some_checks,
6564 void *getter_baton,
6565 apr_pool_t *pool);
6566
6567/** @} */
6568
6569␌
6570/**
6571 * @defgroup svn_wc_diffs Diffs
6572 * @{
6573 */
6574
6575/**
6576 * DEPRECATED -- please use APIs from svn_client.h
6577 *
6578 * ---
6579 *
6580 * Return an @a editor/@a edit_baton for diffing a working copy against the
6581 * repository. The editor is allocated in @a result_pool; temporary
6582 * calculations are performed in @a scratch_pool.
6583 *
6584 * This editor supports diffing either the actual files and properties in the
6585 * working copy (when @a use_text_base is #FALSE), or the current pristine
6586 * information (when @a use_text_base is #TRUE) against the editor driver.
6587 *
6588 * @a anchor_abspath/@a target represent the base of the hierarchy to be
6589 * compared. The diff callback paths will be relative to this path.
6590 *
6591 * Diffs will be reported as valid relpaths, with @a anchor_abspath being
6592 * the root ("").
6593 *
6594 * @a callbacks/@a callback_baton is the callback table to use.
6595 *
6596 * If @a depth is #svn_depth_empty, just diff exactly @a target or
6597 * @a anchor_path if @a target is empty. If #svn_depth_files then do the same
6598 * and for top-level file entries as well (if any). If
6599 * #svn_depth_immediates, do the same as #svn_depth_files but also diff
6600 * top-level subdirectories at #svn_depth_empty. If #svn_depth_infinity,
6601 * then diff fully recursively.
6602 *
6603 * @a ignore_ancestry determines whether paths that have discontinuous node
6604 * ancestry are treated as delete/add or as simple modifications. If
6605 * @a ignore_ancestry is @c FALSE, then any discontinuous node ancestry will
6606 * result in the diff given as a full delete followed by an add.
6607 *
6608 * @a show_copies_as_adds determines whether paths added with history will
6609 * appear as a diff against their copy source, or whether such paths will
6610 * appear as if they were newly added in their entirety.
6611 * @a show_copies_as_adds implies not @a ignore_ancestry.
6612 *
6613 * If @a use_git_diff_format is TRUE, copied paths will be treated as added
6614 * if they weren't modified after being copied. This allows the callbacks
6615 * to generate appropriate --git diff headers for such files.
6616 * @a use_git_diff_format implies @a show_copies_as_adds, and as such implies
6617 * not @a ignore_ancestry.
6618 *
6619 * Normally, the difference from repository->working_copy is shown.
6620 * If @a reverse_order is TRUE, then show working_copy->repository diffs.
6621 *
6622 * If @a cancel_func is non-NULL, it will be used along with @a cancel_baton
6623 * to periodically check if the client has canceled the operation.
6624 *
6625 * @a changelist_filter is an array of <tt>const char *</tt> changelist
6626 * names, used as a restrictive filter on items whose differences are
6627 * reported; that is, don't generate diffs about any item unless
6628 * it's a member of one of those changelists. If @a changelist_filter is
6629 * empty (or altogether @c NULL), no changelist filtering occurs.
6630 *
6631 * If @a server_performs_filtering is TRUE, assume that the server handles
6632 * the ambient depth filtering, so this doesn't have to be handled in the
6633 * editor.
6634 *
6635 * @since New in 1.7.
6636 * @deprecated Provided for backward compatibility with the 1.7 API.
6637 */
6640svn_wc_get_diff_editor6(const svn_delta_editor_t **editor,
6641 void **edit_baton,
6642 svn_wc_context_t *wc_ctx,
6643 const char *anchor_abspath,
6644 const char *target,
6645 svn_depth_t depth,
6646 svn_boolean_t ignore_ancestry,
6647 svn_boolean_t show_copies_as_adds,
6648 svn_boolean_t use_git_diff_format,
6649 svn_boolean_t use_text_base,
6650 svn_boolean_t reverse_order,
6651 svn_boolean_t server_performs_filtering,
6652 const apr_array_header_t *changelist_filter,
6653 const svn_wc_diff_callbacks4_t *callbacks,
6654 void *callback_baton,
6655 svn_cancel_func_t cancel_func,
6656 void *cancel_baton,
6657 apr_pool_t *result_pool,
6658 apr_pool_t *scratch_pool);
6659
6660/**
6661 * Similar to svn_wc_get_diff_editor6(), but with an access baton and relative
6662 * path. @a server_performs_filtering always true and with a
6663 * #svn_wc_diff_callbacks3_t instead of #svn_wc_diff_callbacks4_t,
6664 * @a show_copies_as_adds, and @a use_git_diff_format set to @c FALSE.
6665 *
6666 * Diffs will be reported as below the relative path stored in @a anchor.
6667 *
6668 * @since New in 1.6.
6669 *
6670 * @deprecated Provided for backward compatibility with the 1.6 API.
6671 */
6675 const char *target,
6676 const svn_wc_diff_callbacks3_t *callbacks,
6677 void *callback_baton,
6678 svn_depth_t depth,
6679 svn_boolean_t ignore_ancestry,
6680 svn_boolean_t use_text_base,
6681 svn_boolean_t reverse_order,
6682 svn_cancel_func_t cancel_func,
6683 void *cancel_baton,
6684 const apr_array_header_t *changelist_filter,
6685 const svn_delta_editor_t **editor,
6686 void **edit_baton,
6687 apr_pool_t *pool);
6688
6689/**
6690 * Similar to svn_wc_get_diff_editor5(), but with an
6691 * #svn_wc_diff_callbacks2_t instead of #svn_wc_diff_callbacks3_t.
6692 *
6693 * @deprecated Provided for backward compatibility with the 1.5 API.
6694 */
6698 const char *target,
6699 const svn_wc_diff_callbacks2_t *callbacks,
6700 void *callback_baton,
6701 svn_depth_t depth,
6702 svn_boolean_t ignore_ancestry,
6703 svn_boolean_t use_text_base,
6704 svn_boolean_t reverse_order,
6705 svn_cancel_func_t cancel_func,
6706 void *cancel_baton,
6707 const apr_array_header_t *changelist_filter,
6708 const svn_delta_editor_t **editor,
6709 void **edit_baton,
6710 apr_pool_t *pool);
6711
6712/**
6713 * Similar to svn_wc_get_diff_editor4(), but with @a changelist_filter
6714 * passed as @c NULL, and @a depth set to #svn_depth_infinity if @a
6715 * recurse is TRUE, or #svn_depth_files if @a recurse is FALSE.
6716 *
6717 * @deprecated Provided for backward compatibility with the 1.4 API.
6718
6719 * @since New in 1.2.
6720 */
6724 const char *target,
6725 const svn_wc_diff_callbacks2_t *callbacks,
6726 void *callback_baton,
6727 svn_boolean_t recurse,
6728 svn_boolean_t ignore_ancestry,
6729 svn_boolean_t use_text_base,
6730 svn_boolean_t reverse_order,
6731 svn_cancel_func_t cancel_func,
6732 void *cancel_baton,
6733 const svn_delta_editor_t **editor,
6734 void **edit_baton,
6735 apr_pool_t *pool);
6736
6737
6738/**
6739 * Similar to svn_wc_get_diff_editor3(), but with an
6740 * #svn_wc_diff_callbacks_t instead of #svn_wc_diff_callbacks2_t.
6741 *
6742 * @deprecated Provided for backward compatibility with the 1.1 API.
6743 */
6747 const char *target,
6748 const svn_wc_diff_callbacks_t *callbacks,
6749 void *callback_baton,
6750 svn_boolean_t recurse,
6751 svn_boolean_t ignore_ancestry,
6752 svn_boolean_t use_text_base,
6753 svn_boolean_t reverse_order,
6754 svn_cancel_func_t cancel_func,
6755 void *cancel_baton,
6756 const svn_delta_editor_t **editor,
6757 void **edit_baton,
6758 apr_pool_t *pool);
6759
6760
6761/**
6762 * Similar to svn_wc_get_diff_editor2(), but with @a ignore_ancestry
6763 * always set to @c FALSE.
6764 *
6765 * @deprecated Provided for backward compatibility with the 1.0 API.
6766 */
6770 const char *target,
6771 const svn_wc_diff_callbacks_t *callbacks,
6772 void *callback_baton,
6773 svn_boolean_t recurse,
6774 svn_boolean_t use_text_base,
6775 svn_boolean_t reverse_order,
6776 svn_cancel_func_t cancel_func,
6777 void *cancel_baton,
6778 const svn_delta_editor_t **editor,
6779 void **edit_baton,
6780 apr_pool_t *pool);
6781
6782
6783/**
6784 * Compare working copy against the text-base.
6785 *
6786 * @a target_abspath represents the base of the hierarchy to be compared.
6787 *
6788 * @a callbacks/@a callback_baton is the callback table to use when two
6789 * files are to be compared.
6790 *
6791 * If @a depth is #svn_depth_empty, just diff exactly @a target_path.
6792 * If #svn_depth_files then do the same
6793 * and for top-level file entries as well (if any). If
6794 * #svn_depth_immediates, do the same as #svn_depth_files but also diff
6795 * top-level subdirectories at #svn_depth_empty. If #svn_depth_infinity,
6796 * then diff fully recursively.
6797 *
6798 * @a ignore_ancestry determines whether paths that have discontinuous node
6799 * ancestry are treated as delete/add or as simple modifications. If
6800 * @a ignore_ancestry is @c FALSE, then any discontinuous node ancestry will
6801 * result in the diff given as a full delete followed by an add.
6802 *
6803 * @a show_copies_as_adds determines whether paths added with history will
6804 * appear as a diff against their copy source, or whether such paths will
6805 * appear as if they were newly added in their entirety.
6806 *
6807 * If @a use_git_diff_format is TRUE, copied paths will be treated as added
6808 * if they weren't modified after being copied. This allows the callbacks
6809 * to generate appropriate --git diff headers for such files.
6810 *
6811 * @a changelist_filter is an array of <tt>const char *</tt> changelist
6812 * names, used as a restrictive filter on items whose differences are
6813 * reported; that is, don't generate diffs about any item unless
6814 * it's a member of one of those changelists. If @a changelist_filter is
6815 * empty (or altogether @c NULL), no changelist filtering occurs.
6816 *
6817 * If @a cancel_func is non-NULL, invoke it with @a cancel_baton at various
6818 * points during the operation. If it returns an error (typically
6819 * #SVN_ERR_CANCELLED), return that error immediately.
6820 *
6821 * For working copies that do not store local pristine contents for all
6822 * files, return @c SVN_ERR_WC_PRISTINE_DEHYDRATED on an attempt to diff
6823 * a file whose pristine contents is not present locally.
6824 *
6825 * @note For general purposes, please consider using APIs from svn_client.h,
6826 * @see svn_client_diff7().
6827 *
6828 * @note This is a relatively low-level function operating directly on a
6829 * working copy, so a caller is expected to be able to handle working copies
6830 * that do not store local copies of all pristine contents. This can be
6831 * achieved by synchronizing the text-base state before and optionally
6832 * after the function call. @see svn_wc_textbase_sync().
6833 *
6834 * @since New in 1.15.
6835 */
6838 const char *target_abspath,
6839 const svn_wc_diff_callbacks4_t *callbacks,
6840 void *callback_baton,
6841 svn_depth_t depth,
6842 svn_boolean_t ignore_ancestry,
6843 svn_boolean_t show_copies_as_adds,
6844 svn_boolean_t use_git_diff_format,
6845 const apr_array_header_t *changelist_filter,
6846 svn_cancel_func_t cancel_func,
6847 void *cancel_baton,
6848 apr_pool_t *scratch_pool);
6849
6850/**
6851 * Similar to svn_wc_diff7(), but this function can only be used for
6852 * working copies that store local copies of all pristine contents.
6853 * Otherwise, an #SVN_ERR_WC_DEPRECATED_API_STORE_PRISTINE error will be
6854 * returned.
6855 *
6856 * @since New in 1.7.
6857 * @deprecated Provided for backward compatibility with the 1.7 API.
6858 */
6862 const char *target_abspath,
6863 const svn_wc_diff_callbacks4_t *callbacks,
6864 void *callback_baton,
6865 svn_depth_t depth,
6866 svn_boolean_t ignore_ancestry,
6867 svn_boolean_t show_copies_as_adds,
6868 svn_boolean_t use_git_diff_format,
6869 const apr_array_header_t *changelist_filter,
6870 svn_cancel_func_t cancel_func,
6871 void *cancel_baton,
6872 apr_pool_t *scratch_pool);
6873
6874/**
6875 * Similar to svn_wc_diff6(), but with a #svn_wc_diff_callbacks3_t argument
6876 * instead of #svn_wc_diff_callbacks4_t, @a show_copies_as_adds,
6877 * and @a use_git_diff_format set to * @c FALSE.
6878 * It also doesn't allow specifying a cancel function.
6879 *
6880 * @since New in 1.6.
6881 * @deprecated Provided for backward compatibility with the 1.6 API.
6882 */
6886 const char *target,
6887 const svn_wc_diff_callbacks3_t *callbacks,
6888 void *callback_baton,
6889 svn_depth_t depth,
6890 svn_boolean_t ignore_ancestry,
6891 const apr_array_header_t *changelist_filter,
6892 apr_pool_t *pool);
6893
6894/**
6895 * Similar to svn_wc_diff5(), but with a #svn_wc_diff_callbacks2_t argument
6896 * instead of #svn_wc_diff_callbacks3_t.
6897 *
6898 * @since New in 1.5.
6899 * @deprecated Provided for backward compatibility with the 1.5 API.
6900 */
6904 const char *target,
6905 const svn_wc_diff_callbacks2_t *callbacks,
6906 void *callback_baton,
6907 svn_depth_t depth,
6908 svn_boolean_t ignore_ancestry,
6909 const apr_array_header_t *changelist_filter,
6910 apr_pool_t *pool);
6911
6912/**
6913 * Similar to svn_wc_diff4(), but with @a changelist_filter passed @c NULL,
6914 * and @a depth set to #svn_depth_infinity if @a recurse is TRUE, or
6915 * #svn_depth_files if @a recurse is FALSE.
6916 *
6917 * @since New in 1.2.
6918 * @deprecated Provided for backward compatibility with the 1.4 API.
6919 */
6923 const char *target,
6924 const svn_wc_diff_callbacks2_t *callbacks,
6925 void *callback_baton,
6926 svn_boolean_t recurse,
6927 svn_boolean_t ignore_ancestry,
6928 apr_pool_t *pool);
6929
6930/**
6931 * Similar to svn_wc_diff3(), but with a #svn_wc_diff_callbacks_t argument
6932 * instead of #svn_wc_diff_callbacks2_t.
6933 *
6934 * @since New in 1.1.
6935 * @deprecated Provided for backward compatibility with the 1.1 API.
6936 */
6940 const char *target,
6941 const svn_wc_diff_callbacks_t *callbacks,
6942 void *callback_baton,
6943 svn_boolean_t recurse,
6944 svn_boolean_t ignore_ancestry,
6945 apr_pool_t *pool);
6946
6947/**
6948 * Similar to svn_wc_diff2(), but with @a ignore_ancestry always set
6949 * to @c FALSE.
6950 *
6951 * @deprecated Provided for backward compatibility with the 1.0 API.
6952 */
6956 const char *target,
6957 const svn_wc_diff_callbacks_t *callbacks,
6958 void *callback_baton,
6959 svn_boolean_t recurse,
6960 apr_pool_t *pool);
6961
6962
6963/** Given a @a local_abspath to a file or directory under version control,
6964 * discover any local changes made to properties and/or the set of 'pristine'
6965 * properties. @a wc_ctx will be used to access the working copy.
6966 *
6967 * If @a propchanges is non-@c NULL, return these changes as an array of
6968 * #svn_prop_t structures stored in @a *propchanges. The structures and
6969 * array will be allocated in @a result_pool. If there are no local property
6970 * modifications on @a local_abspath, then set @a *propchanges will be empty.
6971 *
6972 * If @a original_props is non-@c NULL, then set @a *original_props to
6973 * hashtable (<tt>const char *name</tt> -> <tt>const svn_string_t *value</tt>)
6974 * that represents the 'pristine' property list of @a path. This hashtable is
6975 * allocated in @a result_pool.
6976 *
6977 * Use @a scratch_pool for temporary allocations.
6978 */
6980svn_wc_get_prop_diffs2(apr_array_header_t **propchanges,
6981 apr_hash_t **original_props,
6982 svn_wc_context_t *wc_ctx,
6983 const char *local_abspath,
6984 apr_pool_t *result_pool,
6985 apr_pool_t *scratch_pool);
6986
6987/** Similar to svn_wc_get_prop_diffs2(), but with a #svn_wc_adm_access_t /
6988 * relative path parameter pair.
6989 *
6990 * @deprecated Provided for backwards compatibility with the 1.6 API.
6991 */
6994svn_wc_get_prop_diffs(apr_array_header_t **propchanges,
6995 apr_hash_t **original_props,
6996 const char *path,
6997 svn_wc_adm_access_t *adm_access,
6998 apr_pool_t *pool);
6999
7000/** @} */
7001
7002
7003/**
7004 * @defgroup svn_wc_merging Merging
7005 * @{
7006 */
7007
7008/** The outcome of a merge carried out (or tried as a dry-run) by
7009 * svn_wc_merge()
7010 */
7012{
7013 /** The working copy is (or would be) unchanged. The changes to be
7014 * merged were already present in the working copy
7015 */
7017
7018 /** The working copy has been (or would be) changed. */
7020
7021 /** The working copy has been (or would be) changed, but there was (or
7022 * would be) a conflict
7023 */
7025
7026 /** No merge was performed, probably because the target file was
7027 * either absent or not under version control.
7028 */
7030
7032
7033/** Given absolute paths to three fulltexts, merge the differences between
7034 * @a left_abspath and @a right_abspath into @a target_abspath.
7035 * It may help to know that @a left_abspath, @a right_abspath and @a
7036 * target_abspath correspond to "OLDER", "YOURS", and "MINE",
7037 * respectively, in the diff3 documentation.
7038 *
7039 * @a wc_ctx should contain a write lock for the directory containing @a
7040 * target_abspath.
7041 *
7042 * This function assumes that @a left_abspath and @a right_abspath are
7043 * in repository-normal form (linefeeds, with keywords contracted); if
7044 * necessary, @a target_abspath is temporarily converted to this form to
7045 * receive the changes, then translated back again.
7046 *
7047 * If @a target_abspath is absent, or present but not under version
7048 * control, then set @a *merge_content_outcome to #svn_wc_merge_no_merge and
7049 * return success without merging anything. (The reasoning is that if
7050 * the file is not versioned, then it is probably unrelated to the
7051 * changes being considered, so they should not be merged into it.
7052 * Furthermore, merging into an unversioned file is a lossy operation.)
7053 *
7054 * @a dry_run determines whether the working copy is modified. When it
7055 * is @c FALSE the merge will cause @a target_abspath to be modified, when
7056 * it is @c TRUE the merge will be carried out to determine the result but
7057 * @a target_abspath will not be modified.
7058 *
7059 * If @a diff3_cmd is non-NULL, then use it as the diff3 command for
7060 * any merging; otherwise, use the built-in merge code. If @a
7061 * merge_options is non-NULL, either pass its elements to @a diff3_cmd or
7062 * parse it and use as options to the internal merge code (see
7063 * svn_diff_file_options_parse()). @a merge_options must contain
7064 * <tt>const char *</tt> elements.
7065 *
7066 * If @a merge_props_state is non-NULL, merge @a prop_diff into the
7067 * working properties before merging the text. (If @a merge_props_state
7068 * is NULL, do not merge any property changes; in this case, @a prop_diff
7069 * is only used to help determine the text merge result.) Handle any
7070 * conflicts as described for svn_wc_merge_props3(), with the parameters
7071 * @a dry_run, @a conflict_func and @a conflict_baton. Return the
7072 * outcome of the property merge in @a *merge_props_state.
7073 *
7074 * The outcome of the text merge is returned in @a *merge_content_outcome. If
7075 * there is a conflict and @a dry_run is @c FALSE, then attempt to call @a
7076 * conflict_func with @a conflict_baton (if non-NULL). If the
7077 * conflict callback cannot resolve the conflict, then:
7078 *
7079 * * Put conflict markers around the conflicting regions in
7080 * @a target_abspath, labeled with @a left_label, @a right_label, and
7081 * @a target_label. (If any of these labels are @c NULL, default
7082 * values will be used.)
7083 *
7084 * * Copy @a left_abspath, @a right_abspath, and the original @a
7085 * target_abspath to unique names in the same directory as @a
7086 * target_abspath, ending with the suffixes ".LEFT_LABEL", ".RIGHT_LABEL",
7087 * and ".TARGET_LABEL" respectively.
7088 *
7089 * * Mark @a target_abspath as "text-conflicted", and track the above
7090 * mentioned backup files as well.
7091 *
7092 * * If @a left_version and/or @a right_version are not NULL, provide
7093 * these values to the conflict handler and track these while the conflict
7094 * exists.
7095 *
7096 * Binary case:
7097 *
7098 * If @a target_abspath is a binary file, then no merging is attempted,
7099 * the merge is deemed to be a conflict. If @a dry_run is @c FALSE the
7100 * working @a target_abspath is untouched, and copies of @a left_abspath and
7101 * @a right_abspath are created next to it using @a left_label and
7102 * @a right_label. @a target_abspath is marked as "text-conflicted", and
7103 * begins tracking the two backup files and the version information.
7104 *
7105 * If @a dry_run is @c TRUE no files are changed. The outcome of the merge
7106 * is returned in @a *merge_content_outcome.
7107 * ### (and what about @a *merge_props_state?)
7108 *
7109 * ### BH: Two kinds of outcome is not how it should be.
7110 *
7111 * ### For text, we report the outcome as 'merged' if there was some
7112 * incoming change that we dealt with (even if we decided to no-op?)
7113 * but the callers then convert this outcome into a notification
7114 * of 'merged' only if there was already a local modification;
7115 * otherwise they notify it as simply 'updated'. But for props
7116 * we report a notify state of 'merged' here if there was an
7117 * incoming change regardless of the local-mod state. Inconsistent.
7118 *
7119 * Use @a scratch_pool for any temporary allocation.
7120 *
7121 * For working copies that do not store local pristine contents for all
7122 * files, return @c SVN_ERR_WC_PRISTINE_DEHYDRATED on an attempt to merge
7123 * a file whose pristine contents is not present locally.
7124 *
7125 * @note This is a relatively low-level function operating directly on a
7126 * working copy, so a caller is expected to be able to handle working copies
7127 * that do not store local copies of all pristine contents. This can be
7128 * achieved by synchronizing the text-base state before and optionally
7129 * after the function call. @see svn_wc_textbase_sync().
7130 *
7131 * @since New in 1.15.
7132 */
7134svn_wc_merge6(enum svn_wc_merge_outcome_t *merge_content_outcome,
7135 enum svn_wc_notify_state_t *merge_props_state,
7136 svn_wc_context_t *wc_ctx,
7137 const char *left_abspath,
7138 const char *right_abspath,
7139 const char *target_abspath,
7140 const char *left_label,
7141 const char *right_label,
7142 const char *target_label,
7143 const svn_wc_conflict_version_t *left_version,
7144 const svn_wc_conflict_version_t *right_version,
7145 svn_boolean_t dry_run,
7146 const char *diff3_cmd,
7147 const apr_array_header_t *merge_options,
7148 apr_hash_t *original_props,
7149 const apr_array_header_t *prop_diff,
7151 void *conflict_baton,
7152 svn_cancel_func_t cancel_func,
7153 void *cancel_baton,
7154 apr_pool_t *scratch_pool);
7155
7156/** Similar to svn_wc_merge6(), but this function can only be used
7157 * for working copies that store local copies of all pristine contents.
7158 * Otherwise, an #SVN_ERR_WC_DEPRECATED_API_STORE_PRISTINE error will be
7159 * returned.
7160 *
7161 * @since New in 1.8.
7162 * @deprecated Provided for backwards compatibility with the 1.8 API.
7163 */
7166svn_wc_merge5(enum svn_wc_merge_outcome_t *merge_content_outcome,
7167 enum svn_wc_notify_state_t *merge_props_state,
7168 svn_wc_context_t *wc_ctx,
7169 const char *left_abspath,
7170 const char *right_abspath,
7171 const char *target_abspath,
7172 const char *left_label,
7173 const char *right_label,
7174 const char *target_label,
7175 const svn_wc_conflict_version_t *left_version,
7176 const svn_wc_conflict_version_t *right_version,
7177 svn_boolean_t dry_run,
7178 const char *diff3_cmd,
7179 const apr_array_header_t *merge_options,
7180 apr_hash_t *original_props,
7181 const apr_array_header_t *prop_diff,
7183 void *conflict_baton,
7184 svn_cancel_func_t cancel_func,
7185 void *cancel_baton,
7186 apr_pool_t *scratch_pool);
7187
7188/** Similar to svn_wc_merge5() but with @a merge_props_state and @a
7189 * original_props always passed as NULL.
7190 *
7191 * Unlike svn_wc_merge5(), this function doesn't merge property
7192 * changes. Callers of this function must first use
7193 * svn_wc_merge_props3() to get this functionality.
7194 *
7195 * @since New in 1.7.
7196 * @deprecated Provided for backwards compatibility with the 1.7 API.
7197 */
7201 svn_wc_context_t *wc_ctx,
7202 const char *left_abspath,
7203 const char *right_abspath,
7204 const char *target_abspath,
7205 const char *left_label,
7206 const char *right_label,
7207 const char *target_label,
7208 const svn_wc_conflict_version_t *left_version,
7209 const svn_wc_conflict_version_t *right_version,
7210 svn_boolean_t dry_run,
7211 const char *diff3_cmd,
7212 const apr_array_header_t *merge_options,
7213 const apr_array_header_t *prop_diff,
7215 void *conflict_baton,
7216 svn_cancel_func_t cancel_func,
7217 void *cancel_baton,
7218 apr_pool_t *scratch_pool);
7219
7220
7221/** Similar to svn_wc_merge4() but takes relative paths and an access
7222 * baton. It doesn't support a cancel function or tracking origin version
7223 * information.
7224 *
7225 * Uses a svn_wc_conflict_resolver_func_t conflict resolver instead of a
7226 * svn_wc_conflict_resolver_func2_t.
7227 *
7228 * This function assumes that @a diff3_cmd is path encoded. Later versions
7229 * assume utf-8.
7230 *
7231 * @since New in 1.5.
7232 * @deprecated Provided for backwards compatibility with the 1.6 API.
7233 */
7237 const char *left,
7238 const char *right,
7239 const char *merge_target,
7240 svn_wc_adm_access_t *adm_access,
7241 const char *left_label,
7242 const char *right_label,
7243 const char *target_label,
7244 svn_boolean_t dry_run,
7245 const char *diff3_cmd,
7246 const apr_array_header_t *merge_options,
7247 const apr_array_header_t *prop_diff,
7248 svn_wc_conflict_resolver_func_t conflict_func,
7249 void *conflict_baton,
7250 apr_pool_t *pool);
7251
7252
7253/** Similar to svn_wc_merge3(), but with @a prop_diff, @a
7254 * conflict_func, @a conflict_baton set to NULL.
7255 *
7256 * @deprecated Provided for backwards compatibility with the 1.4 API.
7257 */
7261 const char *left,
7262 const char *right,
7263 const char *merge_target,
7264 svn_wc_adm_access_t *adm_access,
7265 const char *left_label,
7266 const char *right_label,
7267 const char *target_label,
7268 svn_boolean_t dry_run,
7269 const char *diff3_cmd,
7270 const apr_array_header_t *merge_options,
7271 apr_pool_t *pool);
7272
7273
7274/** Similar to svn_wc_merge2(), but with @a merge_options set to NULL.
7275 *
7276 * @deprecated Provided for backwards compatibility with the 1.3 API.
7277 */
7280svn_wc_merge(const char *left,
7281 const char *right,
7282 const char *merge_target,
7283 svn_wc_adm_access_t *adm_access,
7284 const char *left_label,
7285 const char *right_label,
7286 const char *target_label,
7287 svn_boolean_t dry_run,
7288 enum svn_wc_merge_outcome_t *merge_outcome,
7289 const char *diff3_cmd,
7290 apr_pool_t *pool);
7291
7292
7293/** Given a @a local_abspath under version control, merge an array of @a
7294 * propchanges into the path's existing properties. @a propchanges is
7295 * an array of #svn_prop_t objects, and @a baseprops is a hash
7296 * representing the original set of properties that @a propchanges is
7297 * working against. @a wc_ctx contains a lock for @a local_abspath.
7298 *
7299 * Only the working properties will be changed.
7300 *
7301 * If @a state is non-NULL, set @a *state to the state of the properties
7302 * after the merge.
7303 *
7304 * If a conflict is found when merging a property, and @a dry_run is
7305 * false and @a conflict_func is not null, then call @a conflict_func
7306 * with @a conflict_baton and a description of the conflict. If any
7307 * conflicts are not resolved by such callbacks, describe the unresolved
7308 * conflicts in a temporary .prej file (or append to an already-existing
7309 * .prej file) and mark the path as conflicted in the WC DB.
7310 *
7311 * If @a cancel_func is non-NULL, invoke it with @a cancel_baton at various
7312 * points during the operation. If it returns an error (typically
7313 * #SVN_ERR_CANCELLED), return that error immediately.
7314 *
7315 * If @a local_abspath is not under version control, return the error
7316 * #SVN_ERR_WC_PATH_NOT_FOUND and don't touch anyone's properties.
7317 *
7318 * If @a local_abspath has a status in which it doesn't have properties
7319 * (E.g. deleted) return the error SVN_ERR_WC_PATH_UNEXPECTED_STATUS.
7320 *
7321 * @since New in 1.7.
7322 */
7325 svn_wc_context_t *wc_ctx,
7326 const char *local_abspath,
7327 const svn_wc_conflict_version_t *left_version,
7328 const svn_wc_conflict_version_t *right_version,
7329 apr_hash_t *baseprops,
7330 const apr_array_header_t *propchanges,
7331 svn_boolean_t dry_run,
7333 void *conflict_baton,
7334 svn_cancel_func_t cancel_func,
7335 void *cancel_baton,
7336 apr_pool_t *scratch_pool);
7337
7338
7339/** Similar to svn_wc_merge_props3, but takes an access baton and relative
7340 * path, no cancel_function, and no left and right version.
7341 *
7342 * This function has the @a base_merge parameter which (when TRUE) will
7343 * apply @a propchanges to this node's pristine set of properties. This
7344 * functionality is not supported since API version 1.7 and will give an
7345 * error if requested (unless @a dry_run is TRUE). For details see
7346 * 'notes/api-errata/1.7/wc006.txt'.
7347 *
7348 * Uses a svn_wc_conflict_resolver_func_t conflict resolver instead of a
7349 * svn_wc_conflict_resolver_func2_t.
7350 *
7351 * For compatibility reasons this function returns
7352 * #SVN_ERR_UNVERSIONED_RESOURCE, when svn_wc_merge_props3 would return either
7353 * #SVN_ERR_WC_PATH_NOT_FOUND or #SVN_ERR_WC_PATH_UNEXPECTED_STATUS.
7354 *
7355 * @since New in 1.5. The base_merge option is not supported since 1.7.
7356 * @deprecated Provided for backward compatibility with the 1.6 API.
7357 */
7361 const char *path,
7362 svn_wc_adm_access_t *adm_access,
7363 apr_hash_t *baseprops,
7364 const apr_array_header_t *propchanges,
7365 svn_boolean_t base_merge,
7366 svn_boolean_t dry_run,
7367 svn_wc_conflict_resolver_func_t conflict_func,
7368 void *conflict_baton,
7369 apr_pool_t *pool);
7370
7371
7372/**
7373 * Same as svn_wc_merge_props2(), but with a @a conflict_func (and
7374 * baton) of NULL.
7375 *
7376 * @since New in 1.3. The base_merge option is not supported since 1.7.
7377 * @deprecated Provided for backward compatibility with the 1.4 API.
7378 */
7382 const char *path,
7383 svn_wc_adm_access_t *adm_access,
7384 apr_hash_t *baseprops,
7385 const apr_array_header_t *propchanges,
7386 svn_boolean_t base_merge,
7387 svn_boolean_t dry_run,
7388 apr_pool_t *pool);
7389
7390
7391/**
7392 * Similar to svn_wc_merge_props(), but no baseprops are given.
7393 * Instead, it's assumed that the incoming propchanges are based
7394 * against the working copy's own baseprops. While this assumption is
7395 * correct for 'svn update', it's incorrect for 'svn merge', and can
7396 * cause flawed behavior. (See issue #2035.)
7397 *
7398 * @since The base_merge option is not supported since 1.7.
7399 * @deprecated Provided for backward compatibility with the 1.2 API.
7400 * Replaced by svn_wc_merge_props().
7401 */
7405 const char *path,
7406 svn_wc_adm_access_t *adm_access,
7407 const apr_array_header_t *propchanges,
7408 svn_boolean_t base_merge,
7409 svn_boolean_t dry_run,
7410 apr_pool_t *pool);
7411
7412/** @} */
7413
7414
7415/** Given a @a path to a wc file, return in @a *contents a readonly stream to
7416 * the pristine contents of the file that would serve as base content for the
7417 * next commit. That means:
7418 *
7419 * When there is no change in node history scheduled, i.e. when there are only
7420 * local text-mods, prop-mods or a delete, return the last checked-out or
7421 * updated-/switched-to contents of the file.
7422 *
7423 * If the file is simply added or replaced (no copy-/move-here involved),
7424 * set @a *contents to @c NULL.
7425 *
7426 * When the file has been locally copied-/moved-here, return the contents of
7427 * the copy/move source (even if the copy-/move-here replaces a locally
7428 * deleted file).
7429 *
7430 * If @a local_abspath refers to an unversioned or non-existent path, return
7431 * @c SVN_ERR_WC_PATH_NOT_FOUND. Use @a wc_ctx to access the working copy.
7432 * @a contents may not be @c NULL (unlike @a *contents).
7433 *
7434 * For working copies that do not store local pristine contents for all
7435 * files, the function may return a detranslated stream to the contents
7436 * of the file itself if the file is not modified. If the file is
7437 * modified and its pristine contents is not present locally, return
7438 * @c SVN_ERR_WC_PRISTINE_DEHYDRATED.
7439 *
7440 * @note This is a relatively low-level function operating directly on a
7441 * working copy, so a caller is expected to be able to handle working copies
7442 * that do not store local copies of all pristine contents. This can be
7443 * achieved by synchronizing the text-base state before and optionally
7444 * after the function call. @see svn_wc_textbase_sync().
7445 *
7446 * @since New in 1.15.
7447 */
7450 svn_wc_context_t *wc_ctx,
7451 const char *local_abspath,
7452 apr_pool_t *result_pool,
7453 apr_pool_t *scratch_pool);
7454
7455/** Similar to svn_wc_get_pristine_contents3, but this function can only be used
7456 * for working copies that store local copies of all pristine contents.
7457 * Otherwise, an #SVN_ERR_WC_DEPRECATED_API_STORE_PRISTINE error will be
7458 * returned.
7459 *
7460 * @since New in 1.7.
7461 * @deprecated Provided for backward compatibility with the 1.7 API.
7462 */
7466 svn_wc_context_t *wc_ctx,
7467 const char *local_abspath,
7468 apr_pool_t *result_pool,
7469 apr_pool_t *scratch_pool);
7470
7471/** Similar to svn_wc_get_pristine_contents2, but takes no working copy
7472 * context and a path that can be relative
7473 *
7474 * @since New in 1.6.
7475 * @deprecated Provided for backward compatibility with the 1.6 API.
7476 */
7480 const char *path,
7481 apr_pool_t *result_pool,
7482 apr_pool_t *scratch_pool);
7483
7484
7485/** Set @a *pristine_path to the path of the "normal" pristine text file for
7486 * the versioned file @a path.
7487 *
7488 * If @a path does not have a pristine text, set @a *pristine_path to a path where
7489 * nothing exists on disk (in a directory that does exist).
7490 *
7491 * @note: Before version 1.7, the behaviour in that case was to provide the
7492 * path where the pristine text *would be* if it were present. The new
7493 * behaviour is intended to provide backward compatibility for callers that
7494 * open or test the provided path immediately, and not for callers that
7495 * store the path for later use.
7496 *
7497 * @deprecated Provided for backwards compatibility with the 1.5 API.
7498 * Callers should use svn_wc_get_pristine_contents() instead.
7499 */
7503 const char **pristine_path,
7504 apr_pool_t *pool);
7505
7506
7507/** The callback invoked by svn_wc_textbase_sync() to provide the text-base
7508 * contents identified by @a repos_root_url, @a repos_relpath and @a revision.
7509 *
7510 * The callback is expected to write the contents to @a contents and close
7511 * the stream.
7512 *
7513 * @since New in 1.15.
7514 */
7515typedef svn_error_t *(*svn_wc_textbase_fetch_cb_t)(
7516 void *baton,
7517 const char *repos_root_url,
7518 const char *repos_relpath,
7520 svn_stream_t *contents,
7521 svn_cancel_func_t cancel_func,
7522 void *cancel_baton,
7523 apr_pool_t *scratch_pool);
7524
7525/** Synchronize the state of the text-base contents for the
7526 * @a local_abspath tree.
7527 *
7528 * If @a allow_hydrate is true, fetch the required but missing text-base
7529 * contents using the provided @a fetch_callback and @a fetch_baton.
7530 * If @a allow_hydrate is false, @a fetch_callback will not be used and
7531 * may be @c NULL.
7532 *
7533 * If @a allow_dehydrate is true, remove the on disk text-base contents
7534 * that is not required.
7535 *
7536 * If @a cancel_func is non-NULL, invoke it with @a cancel_baton at various
7537 * points during the operation. If it returns an error (typically
7538 * #SVN_ERR_CANCELLED), return that error immediately.
7539 *
7540 * If @a notify_func is non-NULL, invoke it with @a notify_baton to report
7541 * the progress of the operation.
7542 *
7543 * @see svn_wc_textbase_fetch_cb_t
7544 * @see svn_client__textbase_sync for usage/implementation example.
7545 *
7546 * @since New in 1.15.
7547 */
7550 const char *local_abspath,
7551 svn_boolean_t allow_hydrate,
7552 svn_boolean_t allow_dehydrate,
7553 svn_wc_textbase_fetch_cb_t fetch_callback,
7554 void *fetch_baton,
7555 svn_cancel_func_t cancel_func,
7556 void *cancel_baton,
7557 svn_wc_notify_func2_t notify_func,
7558 void *notify_baton,
7559 apr_pool_t *scratch_pool);
7560
7561/**
7562 * Recurse from @a local_abspath, cleaning up unfinished tasks. Perform
7563 * any temporary allocations in @a scratch_pool. If @a break_locks is TRUE
7564 * Any working copy locks under @a local_abspath will be taken over and then
7565 * cleared by this function.
7566 * WARNING: If @a break_locks is TRUE there is no mechanism that will protect
7567 * locks that are still being used.
7568 *
7569 * If @a fix_recorded_timestamps is TRUE the recorded timestamps of unmodified
7570 * files will be updated, which will improve performance of future is-modified
7571 * checks.
7572 *
7573 * If @a clear_dav_cache is @c TRUE, the caching of DAV information for older
7574 * mod_dav served repositories is cleared. This clearing invalidates some
7575 * cached information used for pre-HTTPv2 repositories.
7576 *
7577 * If @a vacuum_pristines is TRUE, try to remove unreferenced pristines from
7578 * the working copy. (Will not remove anything unless the obtained lock applies
7579 * to the entire working copy)
7580 *
7581 * If @a cancel_func is non-NULL, invoke it with @a cancel_baton at various
7582 * points during the operation. If it returns an error (typically
7583 * #SVN_ERR_CANCELLED), return that error immediately.
7584 *
7585 * If @a notify_func is non-NULL, invoke it with @a notify_baton to report
7586 * the progress of the operation.
7587 *
7588 * @note In 1.9, @a notify_func does not get called at all. This may change
7589 * in later releases.
7590 *
7591 * @since New in 1.9.
7592 */
7595 const char *local_abspath,
7596 svn_boolean_t break_locks,
7597 svn_boolean_t fix_recorded_timestamps,
7598 svn_boolean_t clear_dav_cache,
7599 svn_boolean_t vacuum_pristines,
7600 svn_cancel_func_t cancel_func,
7601 void *cancel_baton,
7602 svn_wc_notify_func2_t notify_func,
7603 void *notify_baton,
7604 apr_pool_t *scratch_pool);
7605
7606/**
7607 * Similar to svn_wc_cleanup4() but will always break locks, fix recorded
7608 * timestamps, clear the dav cache and vacuum pristines. This function also
7609 * doesn't support notifications.
7610 *
7611 * @since New in 1.7.
7612 * @deprecated Provided for backward compatibility with the 1.8 API.
7613 */
7617 const char *local_abspath,
7618 svn_cancel_func_t cancel_func,
7619 void *cancel_baton,
7620 apr_pool_t *scratch_pool);
7621
7622/**
7623 * Similar to svn_wc_cleanup3() but uses relative paths and creates its own
7624 * #svn_wc_context_t.
7625 *
7626 * @since New in 1.2.
7627 * @deprecated Provided for backward compatibility with the 1.6 API.
7628 */
7632 const char *diff3_cmd,
7633 svn_cancel_func_t cancel_func,
7634 void *cancel_baton,
7635 apr_pool_t *pool);
7636
7637/**
7638 * Similar to svn_wc_cleanup2(). @a optional_adm_access is an historic
7639 * relic and not used, it may be NULL.
7640 *
7641 * @deprecated Provided for backward compatibility with the 1.1 API.
7642 */
7646 svn_wc_adm_access_t *optional_adm_access,
7647 const char *diff3_cmd,
7648 svn_cancel_func_t cancel_func,
7649 void *cancel_baton,
7650 apr_pool_t *pool);
7651
7652/** Callback for retrieving a repository root for a url from upgrade.
7653 *
7654 * Called by svn_wc_upgrade() when no repository root and/or repository
7655 * uuid are recorded in the working copy. For normal Subversion 1.5 and
7656 * later working copies, this callback will not be used.
7657 *
7658 * @since New in 1.7.
7659 */
7660typedef svn_error_t * (*svn_wc_upgrade_get_repos_info_t)(
7661 const char **repos_root,
7662 const char **repos_uuid,
7663 void *baton,
7664 const char *url,
7665 apr_pool_t *result_pool,
7666 apr_pool_t *scratch_pool);
7667
7668
7669/**
7670 * Upgrade the working copy at @a local_abspath to the library's
7671 * default metadata storage format (#SVN_WC__DEFAULT_VERSION).
7672 * @a local_abspath should be an absolute path to the root of the
7673 * working copy.
7674 *
7675 * If @a cancel_func is non-NULL, invoke it with @a cancel_baton at
7676 * various points during the operation. If it returns an error
7677 * (typically #SVN_ERR_CANCELLED), return that error immediately.
7678 *
7679 * For each directory converted, @a notify_func will be called with
7680 * in @a notify_baton action #svn_wc_notify_upgraded_path and as path
7681 * the path of the upgraded directory. @a notify_func may be @c NULL
7682 * if this notification is not needed.
7683 *
7684 * If the old working copy doesn't contain a repository root and/or
7685 * repository uuid, @a repos_info_func (if non-NULL) will be called
7686 * with @a repos_info_baton to provide the missing information.
7687 *
7688 * @since New in 1.7.
7689 * @deprecated Provided for backward compatibility with the 1.14 API.
7690 * @see svn_wc__upgrade()
7691 */
7695 const char *local_abspath,
7696 svn_wc_upgrade_get_repos_info_t repos_info_func,
7697 void *repos_info_baton,
7698 svn_cancel_func_t cancel_func,
7699 void *cancel_baton,
7700 svn_wc_notify_func2_t notify_func,
7701 void *notify_baton,
7702 apr_pool_t *scratch_pool);
7703
7704
7705/** Relocation validation callback typedef.
7706 *
7707 * Called for each relocated file/directory. @a uuid, if non-NULL, contains
7708 * the expected repository UUID, @a url contains the tentative URL.
7709 *
7710 * @a baton is a closure object; it should be provided by the
7711 * implementation, and passed by the caller.
7712 *
7713 * If @a root_url is passed, then the implementation should make sure that
7714 * @a url is the repository root.
7715 * @a pool may be used for temporary allocations.
7716 *
7717 * @since New in 1.5.
7718 */
7719typedef svn_error_t *(*svn_wc_relocation_validator3_t)(void *baton,
7720 const char *uuid,
7721 const char *url,
7722 const char *root_url,
7723 apr_pool_t *pool);
7724
7725/** Similar to #svn_wc_relocation_validator3_t, but with
7726 * the @a root argument.
7727 *
7728 * If @a root is TRUE, then the implementation should make sure that @a url
7729 * is the repository root. Else, it can be a URL inside the repository.
7730 *
7731 * @deprecated Provided for backwards compatibility with the 1.4 API.
7732 */
7733typedef svn_error_t *(*svn_wc_relocation_validator2_t)(void *baton,
7734 const char *uuid,
7735 const char *url,
7736 svn_boolean_t root,
7737 apr_pool_t *pool);
7738
7739/** Similar to #svn_wc_relocation_validator2_t, but without
7740 * the @a root and @a pool arguments. @a uuid will not be NULL in this version
7741 * of the function.
7742 *
7743 * @deprecated Provided for backwards compatibility with the 1.3 API.
7744 */
7745typedef svn_error_t *(*svn_wc_relocation_validator_t)(void *baton,
7746 const char *uuid,
7747 const char *url);
7748
7749/** Recursively change repository references at @a wcroot_abspath
7750 * (which is the root directory of a working copy). The pre-change
7751 * URL should begin with @a from, and the post-change URL will begin
7752 * with @a to. @a validator (and its baton, @a validator_baton), will
7753 * be called for the newly generated base URL and calculated repo
7754 * root.
7755 *
7756 * @a wc_ctx is an working copy context.
7757 *
7758 * @a scratch_pool will be used for temporary allocations.
7759 *
7760 * @since New in 1.7.
7761 */
7764 const char *wcroot_abspath,
7765 const char *from,
7766 const char *to,
7768 void *validator_baton,
7769 apr_pool_t *scratch_pool);
7770
7771/** Similar to svn_wc_relocate4(), but with a #svn_wc_adm_access_t /
7772 * relative path parameter pair.
7773 *
7774 * @note As of the 1.7 API, @a path is required to be a working copy
7775 * root directory, and @a recurse is required to be TRUE.
7776 *
7777 * @since New in 1.5.
7778 * @deprecated Provided for limited backwards compatibility with the
7779 * 1.6 API.
7780 */
7784 svn_wc_adm_access_t *adm_access,
7785 const char *from,
7786 const char *to,
7787 svn_boolean_t recurse,
7789 void *validator_baton,
7790 apr_pool_t *pool);
7791
7792/** Similar to svn_wc_relocate3(), but uses #svn_wc_relocation_validator2_t.
7793 *
7794 * @since New in 1.4.
7795 * @deprecated Provided for backwards compatibility with the 1.4 API. */
7799 svn_wc_adm_access_t *adm_access,
7800 const char *from,
7801 const char *to,
7802 svn_boolean_t recurse,
7804 void *validator_baton,
7805 apr_pool_t *pool);
7806
7807/** Similar to svn_wc_relocate2(), but uses #svn_wc_relocation_validator_t.
7808 *
7809 * @deprecated Provided for backwards compatibility with the 1.3 API. */
7813 svn_wc_adm_access_t *adm_access,
7814 const char *from,
7815 const char *to,
7816 svn_boolean_t recurse,
7818 void *validator_baton,
7819 apr_pool_t *pool);
7820
7821
7822/**
7823 * Revert changes to @a local_abspath. Perform necessary allocations in
7824 * @a scratch_pool.
7825 *
7826 * @a wc_ctx contains the necessary locks required for performing the
7827 * operation.
7828 *
7829 * If @a depth is #svn_depth_empty, revert just @a path (if a
7830 * directory, then revert just the properties on that directory).
7831 * Else if #svn_depth_files, revert @a path and any files
7832 * directly under @a path if it is directory. Else if
7833 * #svn_depth_immediates, revert all of the preceding plus
7834 * properties on immediate subdirectories; else if #svn_depth_infinity,
7835 * revert path and everything under it fully recursively.
7836 *
7837 * @a changelist_filter is an array of <tt>const char *</tt> changelist
7838 * names, used as a restrictive filter on items reverted; that is,
7839 * don't revert any item unless it's a member of one of those
7840 * changelists. If @a changelist_filter is empty (or altogether @c NULL),
7841 * no changelist filtering occurs.
7842 *
7843 * If @a clear_changelists is TRUE, then changelist information for the
7844 * paths is cleared.
7845 *
7846 * The @a metadata_only and @a added_keep_local options control the
7847 * extent of reverting. If @a metadata_only is TRUE, the working copy
7848 * files are untouched, but if there are conflict marker files attached
7849 * to these files these markers are removed. Otherwise, if
7850 * @a added_keep_local is TRUE, then all items are reverted except an
7851 * item that was scheduled as plain 'add' (not a copy) will not be
7852 * removed from the working copy. Otherwise, all items are reverted and
7853 * their on-disk state changed to match.
7854 *
7855 * If @a cancel_func is non-NULL, call it with @a cancel_baton at
7856 * various points during the reversion process. If it returns an
7857 * error (typically #SVN_ERR_CANCELLED), return that error
7858 * immediately.
7859 *
7860 * If @a use_commit_times is TRUE, then all reverted working-files
7861 * will have their timestamp set to the last-committed-time. If
7862 * FALSE, the reverted working-files will be touched with the 'now' time.
7863 *
7864 * For each item reverted, @a notify_func will be called with @a notify_baton
7865 * and the path of the reverted item. @a notify_func may be @c NULL if this
7866 * notification is not needed.
7867 *
7868 * If @a path is not under version control, return the error
7869 * #SVN_ERR_UNVERSIONED_RESOURCE.
7870 *
7871 * For working copies that do not store local pristine contents for all
7872 * files, return @c SVN_ERR_WC_PRISTINE_DEHYDRATED on an attempt to revert
7873 * a file whose pristine contents is not present locally.
7874 *
7875 * @note For general purposes, please consider using APIs from svn_client.h,
7876 * @see svn_client_revert4().
7877 *
7878 * @note This is a relatively low-level function operating directly on a
7879 * working copy, so a caller is expected to be able to handle working copies
7880 * that do not store local copies of all pristine contents. This can be
7881 * achieved by synchronizing the text-base state before and optionally
7882 * after the function call. @see svn_wc_textbase_sync().
7883 *
7884 * @since New in 1.15.
7885 */
7888 const char *local_abspath,
7889 svn_depth_t depth,
7890 svn_boolean_t use_commit_times,
7891 const apr_array_header_t *changelist_filter,
7892 svn_boolean_t clear_changelists,
7893 svn_boolean_t metadata_only,
7894 svn_boolean_t added_keep_local,
7895 svn_cancel_func_t cancel_func,
7896 void *cancel_baton,
7897 svn_wc_notify_func2_t notify_func,
7898 void *notify_baton,
7899 apr_pool_t *scratch_pool);
7900
7901/** Similar to svn_wc_revert7(), but this function can only be used
7902 * for working copies that store local copies of all pristine contents.
7903 * Otherwise, an #SVN_ERR_WC_DEPRECATED_API_STORE_PRISTINE error will be
7904 * returned.
7905 *
7906 * @since New in 1.11.
7907 * @deprecated Provided for backward compatibility with the 1.11 API.
7908 */
7912 const char *local_abspath,
7913 svn_depth_t depth,
7914 svn_boolean_t use_commit_times,
7915 const apr_array_header_t *changelist_filter,
7916 svn_boolean_t clear_changelists,
7917 svn_boolean_t metadata_only,
7918 svn_boolean_t added_keep_local,
7919 svn_cancel_func_t cancel_func,
7920 void *cancel_baton,
7921 svn_wc_notify_func2_t notify_func,
7922 void *notify_baton,
7923 apr_pool_t *scratch_pool);
7924
7925/** Similar to svn_wc_revert6() but with @a added_keep_local always
7926 * set to TRUE.
7927 *
7928 * @since New in 1.9.
7929 * @deprecated Provided for backward compatibility with the 1.10 API.
7930 */
7934 const char *local_abspath,
7935 svn_depth_t depth,
7936 svn_boolean_t use_commit_times,
7937 const apr_array_header_t *changelist_filter,
7938 svn_boolean_t clear_changelists,
7939 svn_boolean_t metadata_only,
7940 svn_cancel_func_t cancel_func,
7941 void *cancel_baton,
7942 svn_wc_notify_func2_t notify_func,
7943 void *notify_baton,
7944 apr_pool_t *scratch_pool);
7945
7946/** Similar to svn_wc_revert5() but with @a clear_changelists always set to
7947 * FALSE and @a metadata_only set to FALSE.
7948 *
7949 * @since New in 1.7.
7950 * @deprecated Provided for backward compatibility with the 1.8 API.
7951 */
7955 const char *local_abspath,
7956 svn_depth_t depth,
7957 svn_boolean_t use_commit_times,
7958 const apr_array_header_t *changelist_filter,
7959 svn_cancel_func_t cancel_func,
7960 void *cancel_baton,
7961 svn_wc_notify_func2_t notify_func,
7962 void *notify_baton,
7963 apr_pool_t *scratch_pool);
7964
7965/** Similar to svn_wc_revert4() but takes a relative path and access baton.
7966 *
7967 * @since New in 1.5.
7968 * @deprecated Provided for backward compatibility with the 1.6 API.
7969 */
7973 svn_wc_adm_access_t *parent_access,
7974 svn_depth_t depth,
7975 svn_boolean_t use_commit_times,
7976 const apr_array_header_t *changelist_filter,
7977 svn_cancel_func_t cancel_func,
7978 void *cancel_baton,
7979 svn_wc_notify_func2_t notify_func,
7980 void *notify_baton,
7981 apr_pool_t *pool);
7982
7983/**
7984 * Similar to svn_wc_revert3(), but with @a changelist_filter passed as @c
7985 * NULL, and @a depth set according to @a recursive: if @a recursive
7986 * is TRUE, @a depth is #svn_depth_infinity; if FALSE, @a depth is
7987 * #svn_depth_empty.
7988 *
7989 * @note Most APIs map @a recurse==FALSE to @a depth==svn_depth_files;
7990 * revert is deliberately different.
7991 *
7992 * @since New in 1.2.
7993 * @deprecated Provided for backward compatibility with the 1.4 API.
7994 */
7998 svn_wc_adm_access_t *parent_access,
7999 svn_boolean_t recursive,
8000 svn_boolean_t use_commit_times,
8001 svn_cancel_func_t cancel_func,
8002 void *cancel_baton,
8003 svn_wc_notify_func2_t notify_func,
8004 void *notify_baton,
8005 apr_pool_t *pool);
8006
8007/**
8008 * Similar to svn_wc_revert2(), but takes an #svn_wc_notify_func_t instead.
8009 *
8010 * @deprecated Provided for backward compatibility with the 1.1 API.
8011 */
8015 svn_wc_adm_access_t *parent_access,
8016 svn_boolean_t recursive,
8017 svn_boolean_t use_commit_times,
8018 svn_cancel_func_t cancel_func,
8019 void *cancel_baton,
8020 svn_wc_notify_func_t notify_func,
8021 void *notify_baton,
8022 apr_pool_t *pool);
8023
8024/**
8025 * Restores a missing node, @a local_abspath using the @a wc_ctx. Records
8026 * the new last modified time of the file for status processing.
8027 *
8028 * If @a use_commit_times is TRUE, then set restored files' timestamps
8029 * to their last-commit-times.
8030 *
8031 * Returns SVN_ERROR_WC_PATH_NOT_FOUND if LOCAL_ABSPATH is not versioned and
8032 * SVN_ERROR_WC_PATH_UNEXPECTED_STATUS if LOCAL_ABSPATH is in a status where
8033 * it can't be restored.
8034 *
8035 * For working copies that do not store local pristine contents for all
8036 * files, return @c SVN_ERR_WC_PRISTINE_DEHYDRATED on an attempt to restore
8037 * a file whose pristine contents is not present locally.
8038 *
8039 * @note This is a relatively low-level function operating directly on a
8040 * working copy, so a caller is expected to be able to handle working copies
8041 * that do not store local copies of all pristine contents. This can be
8042 * achieved by synchronizing the text-base state before and optionally
8043 * after the function call. @see svn_wc_textbase_sync().
8044 *
8045 * @since New in 1.15.
8046 */
8049 const char *local_abspath,
8050 svn_boolean_t use_commit_times,
8051 apr_pool_t *scratch_pool);
8052
8053/**
8054 * Similar to svn_wc_restore2(), but this function can only be used
8055 * for working copies that store local copies of all pristine contents.
8056 * Otherwise, an #SVN_ERR_WC_DEPRECATED_API_STORE_PRISTINE error will be
8057 * returned.
8058 *
8059 * @since New in 1.7.
8060 * @deprecated Provided for backward compatibility with the 1.7 API.
8061 */
8065 const char *local_abspath,
8066 svn_boolean_t use_commit_times,
8067 apr_pool_t *scratch_pool);
8068
8069␌
8070/* Tmp files */
8071
8072/** Create a unique temporary file in administrative tmp/ area of
8073 * directory @a path. Return a handle in @a *fp and the path
8074 * in @a *new_name. Either @a fp or @a new_name can be NULL.
8075 *
8076 * The flags will be <tt>APR_WRITE | APR_CREATE | APR_EXCL</tt> and
8077 * optionally @c APR_DELONCLOSE (if the @a delete_when argument is
8078 * set to #svn_io_file_del_on_close).
8079 *
8080 * This means that as soon as @a fp is closed, the tmp file will vanish.
8081 *
8082 * @since New in 1.4
8083 * @deprecated For compatibility with 1.6 API
8084 */
8088 const char **new_name,
8089 const char *path,
8090 svn_io_file_del_t delete_when,
8091 apr_pool_t *pool);
8092
8093
8094/** Same as svn_wc_create_tmp_file2(), but with @a new_name set to @c NULL,
8095 * and without the ability to delete the file on pool cleanup.
8096 *
8097 * @deprecated For compatibility with 1.3 API
8098 */
8102 const char *path,
8103 svn_boolean_t delete_on_close,
8104 apr_pool_t *pool);
8105
8106
8107/**
8108 * @defgroup svn_wc_translate EOL conversion and keyword expansion
8109 * @{
8110 */
8111
8112
8113/** Set @a xlated_path to a translated copy of @a src
8114 * or to @a src itself if no translation is necessary.
8115 * That is, if @a versioned_file's properties indicate newline conversion or
8116 * keyword expansion, point @a *xlated_path to a copy of @a src
8117 * whose newlines and keywords are converted using the translation
8118 * as requested by @a flags.
8119 *
8120 * If @a cancel_func is non-NULL, call it with @a cancel_baton to determine
8121 * if the client has canceled the operation.
8122 *
8123 * When translating to the normal form, inconsistent eol styles will be
8124 * repaired when appropriate for the given setting. When translating
8125 * from normal form, no EOL repair is performed (consistency is assumed).
8126 * This behaviour can be overridden by specifying
8127 * #SVN_WC_TRANSLATE_FORCE_EOL_REPAIR.
8128 *
8129 * The caller can explicitly request a new file to be returned by setting the
8130 * #SVN_WC_TRANSLATE_FORCE_COPY flag in @a flags.
8131 *
8132 * This function is generally used to get a file that can be compared
8133 * meaningfully against @a versioned_file's text base, if
8134 * @c SVN_WC_TRANSLATE_TO_NF is specified, against @a versioned_file itself
8135 * if @c SVN_WC_TRANSLATE_FROM_NF is specified.
8136 *
8137 * If a new output file is created, it is created in the temp file area
8138 * belonging to @a versioned_file. By default it will be deleted at pool
8139 * cleanup. If @c SVN_WC_TRANSLATE_NO_OUTPUT_CLEANUP is specified, the
8140 * default pool cleanup handler to remove @a *xlated_path is not registered.
8141 * If the input file is returned as the output, its lifetime is not
8142 * specified.
8143 *
8144 * If an error is returned, the effect on @a *xlated_path is undefined.
8145 *
8146 * @since New in 1.4
8147 * @deprecated Provided for compatibility with the 1.6 API
8148 */
8151svn_wc_translated_file2(const char **xlated_path,
8152 const char *src,
8153 const char *versioned_file,
8154 svn_wc_adm_access_t *adm_access,
8155 apr_uint32_t flags,
8156 apr_pool_t *pool);
8157
8158
8159/** Same as svn_wc_translated_file2, but will never clean up
8160 * temporary files.
8161 *
8162 * @deprecated Provided for compatibility with the 1.3 API
8163 */
8166svn_wc_translated_file(const char **xlated_p,
8167 const char *vfile,
8168 svn_wc_adm_access_t *adm_access,
8169 svn_boolean_t force_repair,
8170 apr_pool_t *pool);
8171
8172
8173/** Returns a @a stream allocated in @a pool with access to the given
8174 * @a path taking the file properties from @a versioned_file using
8175 * @a adm_access.
8176 *
8177 * If @a flags includes #SVN_WC_TRANSLATE_FROM_NF, the stream will
8178 * translate from Normal Form to working copy form while writing to
8179 * @a path; stream read operations are not supported.
8180 * Conversely, if @a flags includes #SVN_WC_TRANSLATE_TO_NF, the stream will
8181 * translate from working copy form to Normal Form while reading from
8182 * @a path; stream write operations are not supported.
8183 *
8184 * The @a flags are the same constants as those used for
8185 * svn_wc_translated_file2().
8186 *
8187 * @since New in 1.5.
8188 * @deprecated Provided for compatibility with the 1.6 API.
8189 */
8193 const char *path,
8194 const char *versioned_file,
8195 svn_wc_adm_access_t *adm_access,
8196 apr_uint32_t flags,
8197 apr_pool_t *pool);
8198
8199␌/** @} */
8200
8201
8202/**
8203 * @defgroup svn_wc_deltas Text/Prop Deltas Using an Editor
8204 * @{
8205 */
8206
8207/** Send the local modifications for versioned file @a local_abspath (with
8208 * matching @a file_baton) through @a editor, then close @a file_baton
8209 * afterwards. Use @a scratch_pool for any temporary allocation.
8210 *
8211 * If @a new_text_base_md5_checksum is non-NULL, set
8212 * @a *new_text_base_md5_checksum to the MD5 checksum of (@a local_abspath
8213 * translated to repository-normal form), allocated in @a result_pool.
8214 *
8215 * If @a new_text_base_sha1_checksum in non-NULL, store a copy of (@a
8216 * local_abspath translated to repository-normal form) in the pristine text
8217 * store, and set @a *new_text_base_sha1_checksum to its SHA-1 checksum.
8218 *
8219 * If @a fulltext, send the untranslated copy of @a local_abspath through
8220 * @a editor as full-text; else send it as svndiff against the current text
8221 * base.
8222 *
8223 * If sending a diff, and the recorded checksum for @a local_abspath's
8224 * text-base does not match the current actual checksum, then remove the tmp
8225 * copy (and set @a *tempfile to NULL if appropriate), and return the
8226 * error #SVN_ERR_WC_CORRUPT_TEXT_BASE.
8227 *
8228 * @note This is intended for use with both infix and postfix
8229 * text-delta styled editor drivers.
8230 *
8231 * @note For general purposes, please consider using APIs from svn_client.h,
8232 * @see svn_client_commit6().
8233 *
8234 * @note This is a relatively low-level function operating directly on a
8235 * working copy, so a caller is expected to be able to handle working copies
8236 * that do not store local copies of all pristine contents. This can be
8237 * achieved by synchronizing the text-base state before and optionally
8238 * after the function call. @see svn_wc_textbase_sync().
8239 *
8240 * @since New in 1.15.
8241 */
8243svn_wc_transmit_text_deltas4(const svn_checksum_t **new_text_base_md5_checksum,
8244 const svn_checksum_t **new_text_base_sha1_checksum,
8245 svn_wc_context_t *wc_ctx,
8246 const char *local_abspath,
8247 svn_boolean_t fulltext,
8248 const svn_delta_editor_t *editor,
8249 void *file_baton,
8250 apr_pool_t *result_pool,
8251 apr_pool_t *scratch_pool);
8252
8253/** Similar to svn_wc_transmit_text_deltas4(), but this function can only be
8254 * used for working copies that store local copies of all pristine contents.
8255 * Otherwise, an #SVN_ERR_WC_DEPRECATED_API_STORE_PRISTINE error will be
8256 * returned.
8257 *
8258 * @since New in 1.7.
8259 * @deprecated Provided for backwards compatibility with the 1.7 API.
8260 */
8263svn_wc_transmit_text_deltas3(const svn_checksum_t **new_text_base_md5_checksum,
8264 const svn_checksum_t **new_text_base_sha1_checksum,
8265 svn_wc_context_t *wc_ctx,
8266 const char *local_abspath,
8267 svn_boolean_t fulltext,
8268 const svn_delta_editor_t *editor,
8269 void *file_baton,
8270 apr_pool_t *result_pool,
8271 apr_pool_t *scratch_pool);
8272
8273/** Similar to svn_wc_transmit_text_deltas3(), but with a relative path
8274 * and adm_access baton, and the checksum output is an MD5 digest instead of
8275 * two svn_checksum_t objects.
8276 *
8277 * If @a tempfile is non-NULL, make a copy of @a path with keywords
8278 * and eol translated to repository-normal form, and set @a *tempfile to the
8279 * absolute path to this copy, allocated in @a result_pool. The copy will
8280 * be in the temporary-text-base directory. Do not clean up the copy;
8281 * caller can do that. (The purpose of handing back the tmp copy is that it
8282 * is usually about to become the new text base anyway, but the installation
8283 * of the new text base is outside the scope of this function.)
8284 *
8285 * @since New in 1.4.
8286 * @deprecated Provided for backwards compatibility with the 1.6 API.
8287 */
8290svn_wc_transmit_text_deltas2(const char **tempfile,
8291 unsigned char digest[],
8292 const char *path,
8293 svn_wc_adm_access_t *adm_access,
8294 svn_boolean_t fulltext,
8295 const svn_delta_editor_t *editor,
8296 void *file_baton,
8297 apr_pool_t *pool);
8298
8299/** Similar to svn_wc_transmit_text_deltas2(), but with @a digest set to NULL.
8300 *
8301 * @deprecated Provided for backwards compatibility with the 1.3 API.
8302 */
8306 svn_wc_adm_access_t *adm_access,
8307 svn_boolean_t fulltext,
8308 const svn_delta_editor_t *editor,
8309 void *file_baton,
8310 const char **tempfile,
8311 apr_pool_t *pool);
8312
8313
8314/** Given a @a local_abspath, transmit all local property
8315 * modifications using the appropriate @a editor method (in conjunction
8316 * with @a baton). Use @a scratch_pool for any temporary allocation.
8317 *
8318 * @since New in 1.7.
8319 */
8322 const char *local_abspath,
8323 const svn_delta_editor_t *editor,
8324 void *baton,
8325 apr_pool_t *scratch_pool);
8326
8327
8328/** Similar to svn_wc_transmit_prop_deltas2(), but with a relative path,
8329 * adm_access baton and tempfile.
8330 *
8331 * If a temporary file remains after this function is finished, the
8332 * path to that file is returned in @a *tempfile (so the caller can
8333 * clean this up if it wishes to do so).
8334 *
8335 * @note Starting version 1.5, no tempfile will ever be returned
8336 * anymore. If @a *tempfile is passed, its value is set to @c NULL.
8337 *
8338 * @deprecated Provided for backwards compatibility with the 1.6 API.
8339 */
8343 svn_wc_adm_access_t *adm_access,
8344 const svn_wc_entry_t *entry,
8345 const svn_delta_editor_t *editor,
8346 void *baton,
8347 const char **tempfile,
8348 apr_pool_t *pool);
8349
8350/** @} */
8351
8352
8353/**
8354 * @defgroup svn_wc_ignore Ignoring unversioned files and directories
8355 * @{
8356 */
8357
8358/** Get the run-time configured list of ignore patterns from the
8359 * #svn_config_t's in the @a config hash, and store them in @a *patterns.
8360 * Allocate @a *patterns and its contents in @a pool.
8361 */
8363svn_wc_get_default_ignores(apr_array_header_t **patterns,
8364 apr_hash_t *config,
8365 apr_pool_t *pool);
8366
8367/** Get the list of ignore patterns from the #svn_config_t's in the
8368 * @a config hash and the local ignore patterns from the directory
8369 * at @a local_abspath, using @a wc_ctx, and store them in @a *patterns.
8370 * Allocate @a *patterns and its contents in @a result_pool, use @a
8371 * scratch_pool for temporary allocations.
8372 *
8373 * @since New in 1.7.
8374 */
8376svn_wc_get_ignores2(apr_array_header_t **patterns,
8377 svn_wc_context_t *wc_ctx,
8378 const char *local_abspath,
8379 apr_hash_t *config,
8380 apr_pool_t *result_pool,
8381 apr_pool_t *scratch_pool);
8382
8383/** Similar to svn_wc_get_ignores2(), but with a #svn_wc_adm_access_t
8384 * parameter in place of #svn_wc_context_t and @c local_abspath parameters.
8385 *
8386 * @since New in 1.3.
8387 * @deprecated Provided for backwards compatibility with the 1.6 API.
8388 */
8391svn_wc_get_ignores(apr_array_header_t **patterns,
8392 apr_hash_t *config,
8393 svn_wc_adm_access_t *adm_access,
8394 apr_pool_t *pool);
8395
8396/** Return TRUE iff @a str matches any of the elements of @a list, a
8397 * list of zero or more ignore patterns.
8398 *
8399 * @since New in 1.5.
8400 */
8403 const apr_array_header_t *list,
8404 apr_pool_t *pool);
8405
8406/** @} */
8407
8408
8409/**
8410 * @defgroup svn_wc_repos_locks Repository locks
8411 * @{
8412 */
8413
8414/** Add @a lock to the working copy for @a local_abspath. If @a
8415 * local_abspath is read-only, due to locking properties, make it writable.
8416 * Perform temporary allocations in @a scratch_pool.
8417 *
8418 * @since New in 1.7.
8419 */
8422 const char *abspath,
8423 const svn_lock_t *lock,
8424 apr_pool_t *scratch_pool);
8425
8426/**
8427 * Similar to svn_wc_add_lock2(), but with a #svn_wc_adm_access_t /
8428 * relative path parameter pair.
8429 *
8430 * @deprecated Provided for backward compatibility with the 1.6 API.
8431 * @since New in 1.2.
8432 */
8436 const svn_lock_t *lock,
8437 svn_wc_adm_access_t *adm_access,
8438 apr_pool_t *pool);
8439
8440/** Remove any lock from @a local_abspath. If @a local_abspath has a
8441 * lock and the locking so specifies, make the file read-only. Don't
8442 * return an error if @a local_abspath didn't have a lock. Perform temporary
8443 * allocations in @a scratch_pool.
8444 *
8445 * @since New in 1.7.
8446 */
8449 const char *local_abspath,
8450 apr_pool_t *scratch_pool);
8451
8452/**
8453 * Similar to svn_wc_remove_lock2(), but with a #svn_wc_adm_access_t /
8454 * relative path parameter pair.
8455 *
8456 * @deprecated Provided for backward compatibility with the 1.6 API.
8457 * @since New in 1.2.
8458 */
8462 svn_wc_adm_access_t *adm_access,
8463 apr_pool_t *pool);
8464
8465/** @} */
8466
8467
8468/** A structure to report a summary of a working copy, including the
8469 * mix of revisions found within it, whether any parts are switched or
8470 * locally modified, and whether it is a sparse checkout.
8471 *
8472 * @note Fields may be added to the end of this structure in future
8473 * versions. Therefore, to preserve binary compatibility, users
8474 * should not directly allocate structures of this type.
8475 *
8476 * @since New in 1.4
8477 */
8479{
8480 svn_revnum_t min_rev; /**< Lowest revision found */
8481 svn_revnum_t max_rev; /**< Highest revision found */
8482
8483 svn_boolean_t switched; /**< Is anything switched? */
8484 svn_boolean_t modified; /**< Is anything modified? */
8485
8486 /** Whether any WC paths are at a depth other than #svn_depth_infinity or
8487 * are user excluded.
8488 * @since New in 1.5.
8489 */
8492
8493/** Set @a *result_p to point to a new #svn_wc_revision_status_t structure
8494 * containing a summary of the revision range and status of the working copy
8495 * at @a local_abspath (not including "externals"). @a local_abspath must
8496 * be absolute. Return SVN_ERR_WC_PATH_NOT_FOUND if @a local_abspath is not
8497 * a working copy path.
8498 *
8499 * Set @a (*result_p)->min_rev and @a (*result_p)->max_rev respectively to the
8500 * lowest and highest revision numbers in the working copy. If @a committed
8501 * is TRUE, summarize the last-changed revisions, else the base revisions.
8502 *
8503 * Set @a (*result_p)->switched to indicate whether any item in the WC is
8504 * switched relative to its parent. If @a trail_url is non-NULL, use it to
8505 * determine if @a local_abspath itself is switched. It should be any trailing
8506 * portion of @a local_abspath's expected URL, long enough to include any parts
8507 * that the caller considers might be changed by a switch. If it does not
8508 * match the end of @a local_abspath's actual URL, then report a "switched"
8509 * status.
8510 *
8511 * Set @a (*result_p)->modified to indicate whether any item is locally
8512 * modified.
8513 *
8514 * If @a cancel_func is non-NULL, call it with @a cancel_baton to determine
8515 * if the client has canceled the operation.
8516 *
8517 * Allocate *result_p in @a result_pool, use @a scratch_pool for temporary
8518 * allocations.
8519 *
8520 * @a wc_ctx should be a valid working copy context.
8521 *
8522 * @since New in 1.7
8523 */
8526 svn_wc_context_t *wc_ctx,
8527 const char *local_abspath,
8528 const char *trail_url,
8529 svn_boolean_t committed,
8530 svn_cancel_func_t cancel_func,
8531 void *cancel_baton,
8532 apr_pool_t *result_pool,
8533 apr_pool_t *scratch_pool);
8534
8535
8536/** Similar to svn_wc_revision_status2(), but with a (possibly) local
8537 * path and no wc_ctx parameter.
8538 *
8539 * @since New in 1.4.
8540 * @deprecated Provided for backward compatibility with the 1.6 API.
8541 */
8545 const char *wc_path,
8546 const char *trail_url,
8547 svn_boolean_t committed,
8548 svn_cancel_func_t cancel_func,
8549 void *cancel_baton,
8550 apr_pool_t *pool);
8551
8552
8553/**
8554 * Set @a local_abspath's 'changelist' attribute to @a changelist iff
8555 * @a changelist is not @c NULL; otherwise, remove any current
8556 * changelist assignment from @a local_abspath. @a changelist may not
8557 * be the empty string. Recurse to @a depth.
8558 *
8559 * @a changelist_filter is an array of <tt>const char *</tt> changelist
8560 * names, used as a restrictive filter on items whose changelist
8561 * assignments are adjusted; that is, don't tweak the changeset of any
8562 * item unless it's currently a member of one of those changelists.
8563 * If @a changelist_filter is empty (or altogether @c NULL), no changelist
8564 * filtering occurs.
8565 *
8566 * If @a cancel_func is not @c NULL, call it with @a cancel_baton to
8567 * determine if the client has canceled the operation.
8568 *
8569 * If @a notify_func is not @c NULL, call it with @a notify_baton to
8570 * report the change (using notification types
8571 * #svn_wc_notify_changelist_set and #svn_wc_notify_changelist_clear).
8572 *
8573 * Use @a scratch_pool for temporary allocations.
8574 *
8575 * @note For now, directories are NOT allowed to be associated with
8576 * changelists; there is confusion about whether they should behave
8577 * as depth-0 or depth-infinity objects. If @a local_abspath is a directory,
8578 * return an error.
8579 *
8580 * @note This metadata is purely a client-side "bookkeeping"
8581 * convenience, and is entirely managed by the working copy.
8582 *
8583 * @since New in 1.7.
8584 */
8587 const char *local_abspath,
8588 const char *changelist,
8589 svn_depth_t depth,
8590 const apr_array_header_t *changelist_filter,
8591 svn_cancel_func_t cancel_func,
8592 void *cancel_baton,
8593 svn_wc_notify_func2_t notify_func,
8594 void *notify_baton,
8595 apr_pool_t *scratch_pool);
8596
8597/** Similar to svn_wc_set_changelist2(), but with an access baton and
8598 * relative path.
8599 *
8600 * @since New in 1.5.
8601 * @deprecated Provided for backward compatibility with the 1.6 API.
8602 */
8606 const char *changelist,
8607 svn_wc_adm_access_t *adm_access,
8608 svn_cancel_func_t cancel_func,
8609 void *cancel_baton,
8610 svn_wc_notify_func2_t notify_func,
8611 void *notify_baton,
8612 apr_pool_t *pool);
8613
8614
8615
8616/**
8617 * The callback type used by svn_wc_get_changelists() and
8618 * svn_client_get_changelists().
8619 *
8620 * On each invocation, @a path is a newly discovered member of the
8621 * changelist, and @a baton is a private function closure.
8622 *
8623 * @since New in 1.5.
8624 */
8625typedef svn_error_t *(*svn_changelist_receiver_t) (void *baton,
8626 const char *path,
8627 const char *changelist,
8628 apr_pool_t *pool);
8629
8630
8631/**
8632 * Beginning at @a local_abspath, crawl to @a depth to discover every path in
8633 * or under @a local_abspath which belongs to one of the changelists in @a
8634 * changelist_filter (an array of <tt>const char *</tt> changelist names).
8635 * If @a changelist_filter is @c NULL, discover paths with any changelist.
8636 * Call @a callback_func (with @a callback_baton) each time a
8637 * changelist-having path is discovered.
8638 *
8639 * @a local_abspath is a local WC path.
8640 *
8641 * If @a cancel_func is not @c NULL, invoke it passing @a cancel_baton
8642 * during the recursive walk.
8643 *
8644 * @since New in 1.7.
8645 */
8648 const char *local_abspath,
8649 svn_depth_t depth,
8650 const apr_array_header_t *changelist_filter,
8651 svn_changelist_receiver_t callback_func,
8652 void *callback_baton,
8653 svn_cancel_func_t cancel_func,
8654 void *cancel_baton,
8655 apr_pool_t *scratch_pool);
8656
8657
8658/** Crop @a local_abspath according to @a depth.
8659 *
8660 * Remove any item that exceeds the boundary of @a depth (relative to
8661 * @a local_abspath) from revision control. Leave modified items behind
8662 * (unversioned), while removing unmodified ones completely.
8663 *
8664 * @a depth can be svn_depth_empty, svn_depth_files or svn_depth_immediates.
8665 * Excluding nodes is handled by svn_wc_exclude().
8666 *
8667 * If @a local_abspath starts out with a shallower depth than @a depth,
8668 * do not upgrade it to @a depth (that would not be cropping); however, do
8669 * check children and crop them appropriately according to @a depth.
8670 *
8671 * Returns immediately with an #SVN_ERR_UNSUPPORTED_FEATURE error if @a
8672 * local_abspath is not a directory, or if @a depth is not restrictive
8673 * (e.g., #svn_depth_infinity).
8674 *
8675 * @a wc_ctx contains a tree lock, for the local path to the working copy
8676 * which will be used as the root of this operation.
8677 *
8678 * If @a cancel_func is not @c NULL, call it with @a cancel_baton at
8679 * various points to determine if the client has canceled the operation.
8680 *
8681 * If @a notify_func is not @c NULL, call it with @a notify_baton to
8682 * report changes as they are made.
8683 *
8684 * @since New in 1.7
8685 */
8688 const char *local_abspath,
8689 svn_depth_t depth,
8690 svn_cancel_func_t cancel_func,
8691 void *cancel_baton,
8692 svn_wc_notify_func2_t notify_func,
8693 void *notify_baton,
8694 apr_pool_t *scratch_pool);
8695
8696/** Similar to svn_wc_crop_tree2(), but uses an access baton and target.
8697 *
8698 * svn_wc_crop_tree() also allows #svn_depth_exclude, which is now
8699 * handled via svn_wc_exclude()
8700 *
8701 * @a target is a basename in @a anchor or "" for @a anchor itself.
8702 *
8703 * @since New in 1.6
8704 * @deprecated Provided for backward compatibility with the 1.6 API.
8705 */
8709 const char *target,
8710 svn_depth_t depth,
8711 svn_wc_notify_func2_t notify_func,
8712 void *notify_baton,
8713 svn_cancel_func_t cancel_func,
8714 void *cancel_baton,
8715 apr_pool_t *pool);
8716
8717/** Remove the local node for @a local_abspath from the working copy and
8718 * add an excluded node placeholder in its place.
8719 *
8720 * This feature is only supported for unmodified nodes. An
8721 * #SVN_ERR_UNSUPPORTED_FEATURE error is returned if the node can't be
8722 * excluded in its current state.
8723 *
8724 * @a wc_ctx contains a tree lock, for the local path to the working copy
8725 * which will be used as the root of this operation
8726 *
8727 * If @a notify_func is not @c NULL, call it with @a notify_baton to
8728 * report changes as they are made.
8729 *
8730 * If @a cancel_func is not @c NULL, call it with @a cancel_baton at
8731 * various points to determine if the client has canceled the operation.
8732 *
8733 *
8734 * @since New in 1.7
8735 */
8738 const char *local_abspath,
8739 svn_cancel_func_t cancel_func,
8740 void *cancel_baton,
8741 svn_wc_notify_func2_t notify_func,
8742 void *notify_baton,
8743 apr_pool_t *scratch_pool);
8744
8745␌
8746/** @} */
8747
8748/**
8749 * Set @a kind to the #svn_node_kind_t of @a abspath. Use @a wc_ctx to access
8750 * the working copy, and @a scratch_pool for all temporary allocations.
8751 *
8752 * If @a abspath is not under version control, set @a kind to #svn_node_none.
8753 *
8754 * If @a show_hidden and @a show_deleted are both @c FALSE, the kind of
8755 * scheduled for delete, administrative only 'not present' and excluded
8756 * nodes is reported as #svn_node_none. This is recommended as a check
8757 * for 'is there a versioned file or directory here?'
8758 *
8759 * If @a show_deleted is FALSE, but @a show_hidden is @c TRUE then only
8760 * scheduled for delete and administrative only 'not present' nodes are
8761 * reported as #svn_node_none. This is recommended as check for
8762 * 'Can I add a node here?'
8763 *
8764 * If @a show_deleted is TRUE, but @a show_hidden is FALSE, then only
8765 * administrative only 'not present' nodes and excluded nodes are reported as
8766 * #svn_node_none. This behavior is the behavior bescribed as 'hidden'
8767 * before Subversion 1.7.
8768 *
8769 * If @a show_hidden and @a show_deleted are both @c TRUE all nodes are
8770 * reported.
8771 *
8772 * @since New in 1.8.
8773 */
8776 svn_wc_context_t *wc_ctx,
8777 const char *local_abspath,
8778 svn_boolean_t show_deleted,
8779 svn_boolean_t show_hidden,
8780 apr_pool_t *scratch_pool);
8781
8782/** Similar to svn_wc_read_kind2() but with @a show_deleted always
8783 * passed as TRUE.
8784 *
8785 * @since New in 1.7.
8786 * @deprecated Provided for backward compatibility with the 1.7 API.
8787 */
8791 svn_wc_context_t *wc_ctx,
8792 const char *abspath,
8793 svn_boolean_t show_hidden,
8794 apr_pool_t *scratch_pool);
8795
8796
8797/** @} */
8798
8799#ifdef __cplusplus
8800}
8801#endif /* __cplusplus */
8802
8803#endif /* SVN_WC_H */
struct svn_stream_t svn_stream_t
An abstract stream of bytes–either incoming or outgoing or both.
Definition svn_io.h:863
svn_error_t * svn_wc_adm_close2(svn_wc_adm_access_t *adm_access, apr_pool_t *scratch_pool)
Give up the access baton adm_access, and its lock if any.
svn_error_t * svn_wc_adm_probe_open(svn_wc_adm_access_t **adm_access, svn_wc_adm_access_t *associated, const char *path, svn_boolean_t write_lock, svn_boolean_t tree_lock, apr_pool_t *pool)
Similar to svn_wc_adm_probe_open2(), but with tree_lock instead of levels_to_lock.
svn_error_t * svn_wc_adm_probe_retrieve(svn_wc_adm_access_t **adm_access, svn_wc_adm_access_t *associated, const char *path, apr_pool_t *pool)
Check the working copy to determine the node type of path.
struct svn_wc_adm_access_t svn_wc_adm_access_t
Baton for access to a working copy administrative area.
Definition svn_wc.h:237
svn_error_t * svn_wc_adm_probe_open3(svn_wc_adm_access_t **adm_access, svn_wc_adm_access_t *associated, const char *path, svn_boolean_t write_lock, int levels_to_lock, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *pool)
Checks the working copy to determine the node type of path.
svn_error_t * svn_wc_adm_open2(svn_wc_adm_access_t **adm_access, svn_wc_adm_access_t *associated, const char *path, svn_boolean_t write_lock, int levels_to_lock, apr_pool_t *pool)
Similar to svn_wc_adm_open3(), but without cancellation support.
apr_pool_t * svn_wc_adm_access_pool(const svn_wc_adm_access_t *adm_access)
Return the pool used by access baton adm_access.
svn_error_t * svn_wc_adm_probe_try(svn_wc_adm_access_t **adm_access, svn_wc_adm_access_t *associated, const char *path, svn_boolean_t write_lock, svn_boolean_t tree_lock, apr_pool_t *pool)
Similar to svn_wc_adm_probe_try2(), but with tree_lock instead of levels_to_lock.
const char * svn_wc_adm_access_path(const svn_wc_adm_access_t *adm_access)
Return the path used to open the access baton adm_access.
svn_error_t * svn_wc_adm_open(svn_wc_adm_access_t **adm_access, svn_wc_adm_access_t *associated, const char *path, svn_boolean_t write_lock, svn_boolean_t tree_lock, apr_pool_t *pool)
Similar to svn_wc_adm_open2(), but with tree_lock instead of levels_to_lock.
svn_error_t * svn_wc_adm_probe_try3(svn_wc_adm_access_t **adm_access, svn_wc_adm_access_t *associated, const char *path, svn_boolean_t write_lock, int levels_to_lock, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *pool)
Try various ways to obtain an access baton for path.
svn_error_t * svn_wc_adm_probe_open2(svn_wc_adm_access_t **adm_access, svn_wc_adm_access_t *associated, const char *path, svn_boolean_t write_lock, int levels_to_lock, apr_pool_t *pool)
Similar to svn_wc_adm_probe_open3() without the cancel functionality.
svn_error_t * svn_wc_adm_open3(svn_wc_adm_access_t **adm_access, svn_wc_adm_access_t *associated, const char *path, svn_boolean_t write_lock, int levels_to_lock, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *pool)
Return, in *adm_access, a pointer to a new access baton for the working copy administrative area asso...
svn_error_t * svn_wc_adm_open_anchor(svn_wc_adm_access_t **anchor_access, svn_wc_adm_access_t **target_access, const char **target, const char *path, svn_boolean_t write_lock, int levels_to_lock, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *pool)
Open access batons for path and return in *anchor_access and *target the anchor and target required t...
svn_boolean_t svn_wc_adm_locked(const svn_wc_adm_access_t *adm_access)
Return TRUE is the access baton adm_access has a write lock, FALSE otherwise.
svn_error_t * svn_wc_adm_retrieve(svn_wc_adm_access_t **adm_access, svn_wc_adm_access_t *associated, const char *path, apr_pool_t *pool)
Return, in *adm_access, a pointer to an existing access baton associated with path.
svn_error_t * svn_wc_adm_probe_try2(svn_wc_adm_access_t **adm_access, svn_wc_adm_access_t *associated, const char *path, svn_boolean_t write_lock, int levels_to_lock, apr_pool_t *pool)
Similar to svn_wc_adm_probe_try3() without the cancel functionality.
svn_error_t * svn_wc_adm_close(svn_wc_adm_access_t *adm_access)
Similar to svn_wc_adm_close2(), but with the internal pool of adm_access used for temporary allocatio...
const char * svn_wc_get_adm_dir(apr_pool_t *pool)
Return the name of the administrative directory.
svn_error_t * svn_wc_set_adm_dir(const char *name, apr_pool_t *pool)
Use name for the administrative directory in the working copy.
svn_boolean_t svn_wc_is_adm_dir(const char *name, apr_pool_t *pool)
Return TRUE if name is the name of the WC administrative directory.
svn_wc_conflict_choice_t
The way in which the conflict callback chooses a course of action.
Definition svn_wc.h:2184
svn_wc_conflict_description2_t * svn_wc_conflict_description2_dup(const svn_wc_conflict_description2_t *conflict, apr_pool_t *result_pool)
Return a duplicate of conflict, allocated in result_pool.
svn_wc_conflict_description_t * svn_wc_conflict_description_create_tree(const char *path, svn_wc_adm_access_t *adm_access, svn_node_kind_t node_kind, svn_wc_operation_t operation, svn_wc_conflict_version_t *src_left_version, svn_wc_conflict_version_t *src_right_version, apr_pool_t *pool)
Similar to svn_wc_conflict_description_create_tree(), but returns a svn_wc_conflict_description_t *.
svn_wc_conflict_version_t * svn_wc_conflict_version_create2(const char *repos_root_url, const char *repos_uuid, const char *repos_relpath, svn_revnum_t revision, svn_node_kind_t kind, apr_pool_t *result_pool)
Allocate an svn_wc_conflict_version_t structure in pool, initialize to contain a conflict origin,...
svn_wc_conflict_version_t * svn_wc_conflict_version_dup(const svn_wc_conflict_version_t *version, apr_pool_t *pool)
Return a duplicate of version, allocated in pool.
svn_wc_conflict_result_t * svn_wc_create_conflict_result(svn_wc_conflict_choice_t choice, const char *merged_file, apr_pool_t *pool)
Allocate an svn_wc_conflict_result_t structure in pool, initialize and return it.
svn_wc_conflict_reason_t
The pre-existing condition which is causing a state of conflict.
Definition svn_wc.h:1658
svn_wc_conflict_description_t * svn_wc_conflict_description_create_prop(const char *path, svn_wc_adm_access_t *adm_access, svn_node_kind_t node_kind, const char *property_name, apr_pool_t *pool)
Similar to svn_wc_conflict_descriptor_create_prop(), but returns a svn_wc_conflict_description_t *.
svn_wc_operation_t
The user operation that exposed a conflict.
Definition svn_wc.h:1702
svn_wc_conflict_description2_t * svn_wc_conflict_description_create_tree2(const char *local_abspath, svn_node_kind_t node_kind, svn_wc_operation_t operation, const svn_wc_conflict_version_t *src_left_version, const svn_wc_conflict_version_t *src_right_version, apr_pool_t *result_pool)
Allocate an svn_wc_conflict_description2_t structure in pool, initialize to represent a tree conflict...
svn_wc_conflict_kind_t
The type of conflict being described by an svn_wc_conflict_description2_t (see below).
Definition svn_wc.h:1687
svn_wc_conflict_action_t
The type of action being attempted on an object.
Definition svn_wc.h:1644
svn_wc_conflict_version_t * svn_wc_conflict_version_create(const char *repos_url, const char *path_in_repos, svn_revnum_t peg_rev, svn_node_kind_t node_kind, apr_pool_t *pool)
Similar to svn_wc_conflict_version_create2(), but doesn't set all required values.
svn_wc_conflict_description2_t * svn_wc_conflict_description_create_prop2(const char *local_abspath, svn_node_kind_t node_kind, const char *property_name, apr_pool_t *result_pool)
Allocate an svn_wc_conflict_description2_t structure in result_pool, initialize to represent a proper...
svn_error_t *(* svn_wc_conflict_resolver_func2_t)(svn_wc_conflict_result_t **result, const svn_wc_conflict_description2_t *description, void *baton, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
A callback used in merge, update and switch for resolving conflicts during the application of a tree ...
Definition svn_wc.h:2296
svn_wc_conflict_description2_t * svn_wc_conflict_description_create_text2(const char *local_abspath, apr_pool_t *result_pool)
Allocate an svn_wc_conflict_description2_t structure in result_pool, initialize to represent a text c...
svn_error_t *(* svn_wc_conflict_resolver_func_t)(svn_wc_conflict_result_t **result, const svn_wc_conflict_description_t *description, void *baton, apr_pool_t *pool)
Similar to svn_wc_conflict_resolver_func2_t, but using svn_wc_conflict_description_t instead of svn_w...
Definition svn_wc.h:2311
svn_wc_conflict_description2_t * svn_wc__conflict_description2_dup(const svn_wc_conflict_description2_t *conflict, apr_pool_t *result_pool)
Like svn_wc_conflict_description2_dup(), but is improperly named as a private function when it is int...
svn_wc_conflict_description_t * svn_wc_conflict_description_create_text(const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
Similar to svn_wc_conflict_description_create_text2(), but returns a svn_wc_conflict_description_t *.
@ svn_wc_conflict_choose_mine_conflict
own (for conflicted hunks)
Definition svn_wc.h:2206
@ svn_wc_conflict_choose_theirs_full
incoming version
Definition svn_wc.h:2203
@ svn_wc_conflict_choose_undefined
Undefined; for private use only.
Definition svn_wc.h:2192
@ svn_wc_conflict_choose_mine_full
own version
Definition svn_wc.h:2204
@ svn_wc_conflict_choose_unspecified
undecided
Definition svn_wc.h:2210
@ svn_wc_conflict_choose_merged
merged version
Definition svn_wc.h:2207
@ svn_wc_conflict_choose_theirs_conflict
incoming (for conflicted hunks)
Definition svn_wc.h:2205
@ svn_wc_conflict_choose_base
If there were files to choose from, select one as a way of resolving the conflict here and now.
Definition svn_wc.h:2202
@ svn_wc_conflict_choose_postpone
Don't resolve the conflict now.
Definition svn_wc.h:2196
@ svn_wc_conflict_reason_obstructed
Another object is in the way.
Definition svn_wc.h:1662
@ svn_wc_conflict_reason_edited
Local edits are already present.
Definition svn_wc.h:1660
@ svn_wc_conflict_reason_added
Object is already added or schedule-add.
Definition svn_wc.h:1670
@ svn_wc_conflict_reason_replaced
Object is already replaced.
Definition svn_wc.h:1672
@ svn_wc_conflict_reason_deleted
Object is already schedule-delete.
Definition svn_wc.h:1664
@ svn_wc_conflict_reason_moved_away
Object is moved away.
Definition svn_wc.h:1674
@ svn_wc_conflict_reason_unversioned
Object is unversioned.
Definition svn_wc.h:1668
@ svn_wc_conflict_reason_moved_here
Object is moved here.
Definition svn_wc.h:1676
@ svn_wc_conflict_reason_missing
Object is unknown or missing.
Definition svn_wc.h:1666
@ svn_wc_conflict_kind_text
textual conflict (on a file)
Definition svn_wc.h:1689
@ svn_wc_conflict_kind_property
property conflict (on a file or dir)
Definition svn_wc.h:1691
@ svn_wc_conflict_kind_tree
tree conflict (on a dir)
Definition svn_wc.h:1693
@ svn_wc_conflict_action_add
attempting to add object
Definition svn_wc.h:1646
@ svn_wc_conflict_action_edit
attempting to change text or props
Definition svn_wc.h:1645
@ svn_wc_conflict_action_replace
attempting to replace object,
Definition svn_wc.h:1648
@ svn_wc_conflict_action_delete
attempting to delete object
Definition svn_wc.h:1647
struct svn_wc_context_t svn_wc_context_t
The context for all working copy interactions.
Definition svn_wc.h:179
svn_error_t * svn_wc_context_create(svn_wc_context_t **wc_ctx, const svn_config_t *config, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
Create a context for the working copy, and return it in *wc_ctx.
svn_error_t * svn_wc_context_destroy(svn_wc_context_t *wc_ctx)
Destroy the working copy context described by wc_ctx, releasing any acquired resources.
svn_error_t * svn_wc_transmit_text_deltas3(const svn_checksum_t **new_text_base_md5_checksum, const svn_checksum_t **new_text_base_sha1_checksum, svn_wc_context_t *wc_ctx, const char *local_abspath, svn_boolean_t fulltext, const svn_delta_editor_t *editor, void *file_baton, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
Similar to svn_wc_transmit_text_deltas4(), but this function can only be used for working copies that...
svn_error_t * svn_wc_transmit_prop_deltas(const char *path, svn_wc_adm_access_t *adm_access, const svn_wc_entry_t *entry, const svn_delta_editor_t *editor, void *baton, const char **tempfile, apr_pool_t *pool)
Similar to svn_wc_transmit_prop_deltas2(), but with a relative path, adm_access baton and tempfile.
svn_error_t * svn_wc_transmit_text_deltas4(const svn_checksum_t **new_text_base_md5_checksum, const svn_checksum_t **new_text_base_sha1_checksum, svn_wc_context_t *wc_ctx, const char *local_abspath, svn_boolean_t fulltext, const svn_delta_editor_t *editor, void *file_baton, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
Send the local modifications for versioned file local_abspath (with matching file_baton) through edit...
svn_error_t * svn_wc_transmit_text_deltas2(const char **tempfile, unsigned char digest[], const char *path, svn_wc_adm_access_t *adm_access, svn_boolean_t fulltext, const svn_delta_editor_t *editor, void *file_baton, apr_pool_t *pool)
Similar to svn_wc_transmit_text_deltas3(), but with a relative path and adm_access baton,...
svn_error_t * svn_wc_transmit_prop_deltas2(svn_wc_context_t *wc_ctx, const char *local_abspath, const svn_delta_editor_t *editor, void *baton, apr_pool_t *scratch_pool)
Given a local_abspath, transmit all local property modifications using the appropriate editor method ...
svn_error_t * svn_wc_transmit_text_deltas(const char *path, svn_wc_adm_access_t *adm_access, svn_boolean_t fulltext, const svn_delta_editor_t *editor, void *file_baton, const char **tempfile, apr_pool_t *pool)
Similar to svn_wc_transmit_text_deltas2(), but with digest set to NULL.
svn_error_t * svn_wc_diff4(svn_wc_adm_access_t *anchor, const char *target, const svn_wc_diff_callbacks2_t *callbacks, void *callback_baton, svn_depth_t depth, svn_boolean_t ignore_ancestry, const apr_array_header_t *changelist_filter, apr_pool_t *pool)
Similar to svn_wc_diff5(), but with a svn_wc_diff_callbacks2_t argument instead of svn_wc_diff_callba...
svn_error_t * svn_wc_get_diff_editor2(svn_wc_adm_access_t *anchor, const char *target, const svn_wc_diff_callbacks_t *callbacks, void *callback_baton, svn_boolean_t recurse, svn_boolean_t ignore_ancestry, svn_boolean_t use_text_base, svn_boolean_t reverse_order, svn_cancel_func_t cancel_func, void *cancel_baton, const svn_delta_editor_t **editor, void **edit_baton, apr_pool_t *pool)
Similar to svn_wc_get_diff_editor3(), but with an svn_wc_diff_callbacks_t instead of svn_wc_diff_call...
svn_error_t * svn_wc_diff2(svn_wc_adm_access_t *anchor, const char *target, const svn_wc_diff_callbacks_t *callbacks, void *callback_baton, svn_boolean_t recurse, svn_boolean_t ignore_ancestry, apr_pool_t *pool)
Similar to svn_wc_diff3(), but with a svn_wc_diff_callbacks_t argument instead of svn_wc_diff_callbac...
svn_error_t * svn_wc_diff5(svn_wc_adm_access_t *anchor, const char *target, const svn_wc_diff_callbacks3_t *callbacks, void *callback_baton, svn_depth_t depth, svn_boolean_t ignore_ancestry, const apr_array_header_t *changelist_filter, apr_pool_t *pool)
Similar to svn_wc_diff6(), but with a svn_wc_diff_callbacks3_t argument instead of svn_wc_diff_callba...
svn_error_t * svn_wc_diff6(svn_wc_context_t *wc_ctx, const char *target_abspath, const svn_wc_diff_callbacks4_t *callbacks, void *callback_baton, svn_depth_t depth, svn_boolean_t ignore_ancestry, svn_boolean_t show_copies_as_adds, svn_boolean_t use_git_diff_format, const apr_array_header_t *changelist_filter, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *scratch_pool)
Similar to svn_wc_diff7(), but this function can only be used for working copies that store local cop...
svn_error_t * svn_wc_get_diff_editor3(svn_wc_adm_access_t *anchor, const char *target, const svn_wc_diff_callbacks2_t *callbacks, void *callback_baton, svn_boolean_t recurse, svn_boolean_t ignore_ancestry, svn_boolean_t use_text_base, svn_boolean_t reverse_order, svn_cancel_func_t cancel_func, void *cancel_baton, const svn_delta_editor_t **editor, void **edit_baton, apr_pool_t *pool)
Similar to svn_wc_get_diff_editor4(), but with changelist_filter passed as NULL, and depth set to svn...
svn_error_t * svn_wc_get_prop_diffs2(apr_array_header_t **propchanges, apr_hash_t **original_props, svn_wc_context_t *wc_ctx, const char *local_abspath, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
Given a local_abspath to a file or directory under version control, discover any local changes made t...
svn_error_t * svn_wc_diff7(svn_wc_context_t *wc_ctx, const char *target_abspath, const svn_wc_diff_callbacks4_t *callbacks, void *callback_baton, svn_depth_t depth, svn_boolean_t ignore_ancestry, svn_boolean_t show_copies_as_adds, svn_boolean_t use_git_diff_format, const apr_array_header_t *changelist_filter, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *scratch_pool)
Compare working copy against the text-base.
svn_error_t * svn_wc_diff(svn_wc_adm_access_t *anchor, const char *target, const svn_wc_diff_callbacks_t *callbacks, void *callback_baton, svn_boolean_t recurse, apr_pool_t *pool)
Similar to svn_wc_diff2(), but with ignore_ancestry always set to FALSE.
svn_error_t * svn_wc_get_prop_diffs(apr_array_header_t **propchanges, apr_hash_t **original_props, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
Similar to svn_wc_get_prop_diffs2(), but with a svn_wc_adm_access_t / relative path parameter pair.
svn_error_t * svn_wc_get_diff_editor6(const svn_delta_editor_t **editor, void **edit_baton, svn_wc_context_t *wc_ctx, const char *anchor_abspath, const char *target, svn_depth_t depth, svn_boolean_t ignore_ancestry, svn_boolean_t show_copies_as_adds, svn_boolean_t use_git_diff_format, svn_boolean_t use_text_base, svn_boolean_t reverse_order, svn_boolean_t server_performs_filtering, const apr_array_header_t *changelist_filter, const svn_wc_diff_callbacks4_t *callbacks, void *callback_baton, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
DEPRECATED – please use APIs from svn_client.h.
svn_error_t * svn_wc_get_diff_editor5(svn_wc_adm_access_t *anchor, const char *target, const svn_wc_diff_callbacks3_t *callbacks, void *callback_baton, svn_depth_t depth, svn_boolean_t ignore_ancestry, svn_boolean_t use_text_base, svn_boolean_t reverse_order, svn_cancel_func_t cancel_func, void *cancel_baton, const apr_array_header_t *changelist_filter, const svn_delta_editor_t **editor, void **edit_baton, apr_pool_t *pool)
Similar to svn_wc_get_diff_editor6(), but with an access baton and relative path.
svn_error_t * svn_wc_get_diff_editor4(svn_wc_adm_access_t *anchor, const char *target, const svn_wc_diff_callbacks2_t *callbacks, void *callback_baton, svn_depth_t depth, svn_boolean_t ignore_ancestry, svn_boolean_t use_text_base, svn_boolean_t reverse_order, svn_cancel_func_t cancel_func, void *cancel_baton, const apr_array_header_t *changelist_filter, const svn_delta_editor_t **editor, void **edit_baton, apr_pool_t *pool)
Similar to svn_wc_get_diff_editor5(), but with an svn_wc_diff_callbacks2_t instead of svn_wc_diff_cal...
svn_error_t * svn_wc_get_diff_editor(svn_wc_adm_access_t *anchor, const char *target, const svn_wc_diff_callbacks_t *callbacks, void *callback_baton, svn_boolean_t recurse, svn_boolean_t use_text_base, svn_boolean_t reverse_order, svn_cancel_func_t cancel_func, void *cancel_baton, const svn_delta_editor_t **editor, void **edit_baton, apr_pool_t *pool)
Similar to svn_wc_get_diff_editor2(), but with ignore_ancestry always set to FALSE.
svn_error_t * svn_wc_diff3(svn_wc_adm_access_t *anchor, const char *target, const svn_wc_diff_callbacks2_t *callbacks, void *callback_baton, svn_boolean_t recurse, svn_boolean_t ignore_ancestry, apr_pool_t *pool)
Similar to svn_wc_diff4(), but with changelist_filter passed NULL, and depth set to svn_depth_infinit...
svn_wc_schedule_t
The schedule states an entry can be in.
Definition svn_wc.h:2887
svn_error_t * svn_wc_entry(const svn_wc_entry_t **entry, const char *path, svn_wc_adm_access_t *adm_access, svn_boolean_t show_hidden, apr_pool_t *pool)
Set *entry to an entry for path, allocated in the access baton pool.
svn_wc_entry_t * svn_wc_entry_dup(const svn_wc_entry_t *entry, apr_pool_t *pool)
Parse the `entries' file for adm_access and return a hash entries, whose keys are (const char *) entr...
@ svn_wc_schedule_normal
Nothing special here.
Definition svn_wc.h:2889
@ svn_wc_schedule_replace
Slated for replacement (delete + add).
Definition svn_wc.h:2898
@ svn_wc_schedule_delete
Slated for deletion.
Definition svn_wc.h:2895
@ svn_wc_schedule_add
Slated for addition.
Definition svn_wc.h:2892
svn_error_t * svn_wc_external_item2_create(svn_wc_external_item2_t **item, apr_pool_t *pool)
Initialize an external item.
svn_error_t * svn_wc_parse_externals_description2(apr_array_header_t **externals_p, const char *parent_directory, const char *desc, apr_pool_t *pool)
Similar to svn_wc_parse_externals_description3() with canonicalize_url set to TRUE,...
void svn_wc_edited_externals(apr_hash_t **externals_old, apr_hash_t **externals_new, svn_wc_traversal_info_t *traversal_info)
Set *externals_old and *externals_new to hash tables representing changes to values of the svn:extern...
svn_wc_external_item_t * svn_wc_external_item_dup(const svn_wc_external_item_t *item, apr_pool_t *pool)
Return a duplicate of item, allocated in pool.
svn_error_t * svn_wc_parse_externals_description3(apr_array_header_t **externals_p, const char *defining_directory, const char *desc, svn_boolean_t canonicalize_url, apr_pool_t *pool)
If externals_p is non-NULL, set *externals_p to an array of svn_wc_external_item2_t * objects based o...
svn_error_t *(* svn_wc_external_update_t)(void *baton, const char *local_abspath, const svn_string_t *old_val, const svn_string_t *new_val, svn_depth_t depth, apr_pool_t *scratch_pool)
Callback for external definitions updates.
Definition svn_wc.h:688
svn_error_t * svn_wc_parse_externals_description(apr_hash_t **externals_p, const char *parent_directory, const char *desc, apr_pool_t *pool)
Similar to svn_wc_parse_externals_description2(), but returns the parsed externals in a hash instead ...
void svn_wc_traversed_depths(apr_hash_t **depths, svn_wc_traversal_info_t *traversal_info)
Set *depths to a hash table mapping const char * directory names (directories traversed by traversal_...
svn_wc_external_item2_t * svn_wc_external_item2_dup(const svn_wc_external_item2_t *item, apr_pool_t *pool)
Return a duplicate of item, allocated in pool.
struct svn_wc_traversal_info_t svn_wc_traversal_info_t
Traversal information is information gathered by a working copy crawl or update.
Definition svn_wc.h:707
svn_error_t * svn_wc_external_item_create(const svn_wc_external_item2_t **item, apr_pool_t *pool)
Same as svn_wc_external_item2_create() except the pointer to the new empty item is 'const' which is s...
svn_wc_traversal_info_t * svn_wc_init_traversal_info(apr_pool_t *pool)
Return a new, empty traversal info object, allocated in pool.
svn_error_t * svn_wc_get_ignores2(apr_array_header_t **patterns, svn_wc_context_t *wc_ctx, const char *local_abspath, apr_hash_t *config, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
Get the list of ignore patterns from the svn_config_t's in the config hash and the local ignore patte...
svn_error_t * svn_wc_get_ignores(apr_array_header_t **patterns, apr_hash_t *config, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
Similar to svn_wc_get_ignores2(), but with a svn_wc_adm_access_t parameter in place of svn_wc_context...
svn_error_t * svn_wc_get_default_ignores(apr_array_header_t **patterns, apr_hash_t *config, apr_pool_t *pool)
Get the run-time configured list of ignore patterns from the svn_config_t's in the config hash,...
svn_boolean_t svn_wc_match_ignore_list(const char *str, const apr_array_header_t *list, apr_pool_t *pool)
Return TRUE iff str matches any of the elements of list, a list of zero or more ignore patterns.
svn_error_t * svn_wc_merge(const char *left, const char *right, const char *merge_target, svn_wc_adm_access_t *adm_access, const char *left_label, const char *right_label, const char *target_label, svn_boolean_t dry_run, enum svn_wc_merge_outcome_t *merge_outcome, const char *diff3_cmd, apr_pool_t *pool)
Similar to svn_wc_merge2(), but with merge_options set to NULL.
svn_error_t * svn_wc_merge_props3(svn_wc_notify_state_t *state, svn_wc_context_t *wc_ctx, const char *local_abspath, const svn_wc_conflict_version_t *left_version, const svn_wc_conflict_version_t *right_version, apr_hash_t *baseprops, const apr_array_header_t *propchanges, svn_boolean_t dry_run, svn_wc_conflict_resolver_func2_t conflict_func, void *conflict_baton, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *scratch_pool)
Given a local_abspath under version control, merge an array of propchanges into the path's existing p...
svn_error_t * svn_wc_merge4(enum svn_wc_merge_outcome_t *merge_outcome, svn_wc_context_t *wc_ctx, const char *left_abspath, const char *right_abspath, const char *target_abspath, const char *left_label, const char *right_label, const char *target_label, const svn_wc_conflict_version_t *left_version, const svn_wc_conflict_version_t *right_version, svn_boolean_t dry_run, const char *diff3_cmd, const apr_array_header_t *merge_options, const apr_array_header_t *prop_diff, svn_wc_conflict_resolver_func2_t conflict_func, void *conflict_baton, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *scratch_pool)
Similar to svn_wc_merge5() but with merge_props_state and original_props always passed as NULL.
svn_error_t * svn_wc_merge2(enum svn_wc_merge_outcome_t *merge_outcome, const char *left, const char *right, const char *merge_target, svn_wc_adm_access_t *adm_access, const char *left_label, const char *right_label, const char *target_label, svn_boolean_t dry_run, const char *diff3_cmd, const apr_array_header_t *merge_options, apr_pool_t *pool)
Similar to svn_wc_merge3(), but with prop_diff, conflict_func, conflict_baton set to NULL.
svn_error_t * svn_wc_merge_props2(svn_wc_notify_state_t *state, const char *path, svn_wc_adm_access_t *adm_access, apr_hash_t *baseprops, const apr_array_header_t *propchanges, svn_boolean_t base_merge, svn_boolean_t dry_run, svn_wc_conflict_resolver_func_t conflict_func, void *conflict_baton, apr_pool_t *pool)
Similar to svn_wc_merge_props3, but takes an access baton and relative path, no cancel_function,...
svn_error_t * svn_wc_merge_props(svn_wc_notify_state_t *state, const char *path, svn_wc_adm_access_t *adm_access, apr_hash_t *baseprops, const apr_array_header_t *propchanges, svn_boolean_t base_merge, svn_boolean_t dry_run, apr_pool_t *pool)
Same as svn_wc_merge_props2(), but with a conflict_func (and baton) of NULL.
svn_wc_merge_outcome_t
The outcome of a merge carried out (or tried as a dry-run) by svn_wc_merge().
Definition svn_wc.h:7012
svn_error_t * svn_wc_merge3(enum svn_wc_merge_outcome_t *merge_outcome, const char *left, const char *right, const char *merge_target, svn_wc_adm_access_t *adm_access, const char *left_label, const char *right_label, const char *target_label, svn_boolean_t dry_run, const char *diff3_cmd, const apr_array_header_t *merge_options, const apr_array_header_t *prop_diff, svn_wc_conflict_resolver_func_t conflict_func, void *conflict_baton, apr_pool_t *pool)
Similar to svn_wc_merge4() but takes relative paths and an access baton.
svn_error_t * svn_wc_merge6(enum svn_wc_merge_outcome_t *merge_content_outcome, enum svn_wc_notify_state_t *merge_props_state, svn_wc_context_t *wc_ctx, const char *left_abspath, const char *right_abspath, const char *target_abspath, const char *left_label, const char *right_label, const char *target_label, const svn_wc_conflict_version_t *left_version, const svn_wc_conflict_version_t *right_version, svn_boolean_t dry_run, const char *diff3_cmd, const apr_array_header_t *merge_options, apr_hash_t *original_props, const apr_array_header_t *prop_diff, svn_wc_conflict_resolver_func2_t conflict_func, void *conflict_baton, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *scratch_pool)
Given absolute paths to three fulltexts, merge the differences between left_abspath and right_abspath...
svn_error_t * svn_wc_merge5(enum svn_wc_merge_outcome_t *merge_content_outcome, enum svn_wc_notify_state_t *merge_props_state, svn_wc_context_t *wc_ctx, const char *left_abspath, const char *right_abspath, const char *target_abspath, const char *left_label, const char *right_label, const char *target_label, const svn_wc_conflict_version_t *left_version, const svn_wc_conflict_version_t *right_version, svn_boolean_t dry_run, const char *diff3_cmd, const apr_array_header_t *merge_options, apr_hash_t *original_props, const apr_array_header_t *prop_diff, svn_wc_conflict_resolver_func2_t conflict_func, void *conflict_baton, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *scratch_pool)
Similar to svn_wc_merge6(), but this function can only be used for working copies that store local co...
svn_error_t * svn_wc_merge_prop_diffs(svn_wc_notify_state_t *state, const char *path, svn_wc_adm_access_t *adm_access, const apr_array_header_t *propchanges, svn_boolean_t base_merge, svn_boolean_t dry_run, apr_pool_t *pool)
Similar to svn_wc_merge_props(), but no baseprops are given.
@ svn_wc_merge_unchanged
The working copy is (or would be) unchanged.
Definition svn_wc.h:7016
@ svn_wc_merge_merged
The working copy has been (or would be) changed.
Definition svn_wc.h:7019
@ svn_wc_merge_no_merge
No merge was performed, probably because the target file was either absent or not under version contr...
Definition svn_wc.h:7029
@ svn_wc_merge_conflict
The working copy has been (or would be) changed, but there was (or would be) a conflict.
Definition svn_wc.h:7024
const svn_lock_t * lock
Points to the lock structure received from the repository when action is svn_wc_notify_locked.
Definition svn_wc.h:1431
const char * prop_name
If action relates to properties, specifies the name of the property.
Definition svn_wc.h:1480
apr_hash_t * rev_props
If action is svn_wc_notify_blame_revision, contains a list of revision properties for the specified r...
Definition svn_wc.h:1485
const char * mime_type
If non-NULL, indicates the mime-type of path.
Definition svn_wc.h:1426
svn_wc_notify_action_t action
Action that describes what happened to svn_wc_notify_t.path.
Definition svn_wc.h:1419
svn_linenum_t hunk_matched_line
The line at which a hunk was matched (and applied).
Definition svn_wc.h:1506
svn_linenum_t hunk_fuzz
The fuzz factor the hunk was applied with.
Definition svn_wc.h:1510
svn_revnum_t revision
When action is svn_wc_notify_update_completed, target revision of the update, or SVN_INVALID_REVNUM i...
Definition svn_wc.h:1455
void(* svn_wc_notify_func_t)(void *baton, const char *path, svn_wc_notify_action_t action, svn_node_kind_t kind, const char *mime_type, svn_wc_notify_state_t content_state, svn_wc_notify_state_t prop_state, svn_revnum_t revision)
Similar to svn_wc_notify_func2_t, but takes the information as arguments instead of struct fields.
Definition svn_wc.h:1583
const char * path
Structure used in the svn_wc_notify_func2_t function.
Definition svn_wc.h:1416
void(* svn_wc_notify_func2_t)(void *baton, const svn_wc_notify_t *notify, apr_pool_t *pool)
Notify the world that notify->action has happened to notify->path.
Definition svn_wc.h:1573
svn_wc_notify_state_t prop_state
The type of notification that is occurring about node properties.
Definition svn_wc.h:1443
svn_merge_range_t * merge_range
When action is svn_wc_notify_merge_begin or svn_wc_notify_foreign_merge_begin or svn_wc_notify_merge_...
Definition svn_wc.h:1466
svn_wc_notify_action_t
The type of action occurring.
Definition svn_wc.h:982
svn_wc_notify_state_t
The type of notification that is occurring.
Definition svn_wc.h:1333
svn_wc_notify_t * svn_wc_create_notify(const char *path, svn_wc_notify_action_t action, apr_pool_t *pool)
Allocate an svn_wc_notify_t structure in pool, initialize and return it.
svn_wc_notify_t * svn_wc_create_notify_url(const char *url, svn_wc_notify_action_t action, apr_pool_t *pool)
Allocate an svn_wc_notify_t structure in pool, initialize and return it.
svn_wc_notify_t * svn_wc_dup_notify(const svn_wc_notify_t *notify, apr_pool_t *pool)
Return a deep copy of notify, allocated in pool.
const char * path_prefix
If non-NULL, specifies an absolute path prefix that can be subtracted from the start of the absolute ...
Definition svn_wc.h:1476
const char * changelist_name
If action pertains to a changelist, this is the changelist name.
Definition svn_wc.h:1459
svn_wc_notify_state_t content_state
The type of notification that is occurring about node content.
Definition svn_wc.h:1440
svn_linenum_t hunk_original_start
These fields are used by svn patch to identify the hunk the notification is for.
Definition svn_wc.h:1498
svn_error_t * err
Points to an error describing the reason for the failure when action is one of the following: svn_wc_...
Definition svn_wc.h:1437
svn_wc_notify_lock_state_t
What happened to a lock during an operation.
Definition svn_wc.h:1368
svn_node_kind_t kind
Node kind of path.
Definition svn_wc.h:1422
svn_revnum_t old_revision
If action is svn_wc_notify_update_update or svn_wc_notify_update_add, contains the revision before th...
Definition svn_wc.h:1491
const char * url
Similar to path, but if non-NULL the notification is about a url.
Definition svn_wc.h:1470
svn_wc_notify_lock_state_t lock_state
Reflects the addition or removal of a lock token in the working copy.
Definition svn_wc.h:1446
@ svn_wc_notify_conflict_resolver_done
Conflict resolver is done.
Definition svn_wc.h:1248
@ svn_wc_notify_update_broken_lock
Just the lock on a file was removed during update.
Definition svn_wc.h:1232
@ svn_wc_notify_exists
Tried adding a path that already exists.
Definition svn_wc.h:1062
@ svn_wc_notify_failed_out_of_date
Operation failed because a node is out of date.
Definition svn_wc.h:1212
@ svn_wc_notify_update_external_removed
An update operation removed an external working copy.
Definition svn_wc.h:1134
@ svn_wc_notify_upgraded_path
A working copy directory was upgraded to the latest format.
Definition svn_wc.h:1153
@ svn_wc_notify_exclude
Removing a path by excluding it.
Definition svn_wc.h:1200
@ svn_wc_notify_merge_record_info
The mergeinfo on path was updated.
Definition svn_wc.h:1149
@ svn_wc_notify_resolved
All conflicts on a path were marked as resolved.
Definition svn_wc.h:1005
@ svn_wc_notify_property_deleted
Property deleted.
Definition svn_wc.h:1093
@ svn_wc_notify_failed_revert
A revert operation has failed.
Definition svn_wc.h:999
@ svn_wc_notify_commit_deleted
Committing a deletion.
Definition svn_wc.h:1038
@ svn_wc_notify_resolved_prop
A property conflict on a path was marked as resolved.
Definition svn_wc.h:1289
@ svn_wc_notify_update_skip_access_denied
An update tried to update a file or directory to which access could not be obtained.
Definition svn_wc.h:1130
@ svn_wc_notify_property_added
Property added.
Definition svn_wc.h:1087
@ svn_wc_notify_patch
A file in the working copy was patched.
Definition svn_wc.h:1165
@ svn_wc_notify_update_delete
Got a delete in an update.
Definition svn_wc.h:1011
@ svn_wc_notify_update_skip_working_only
An explicit update tried to update a file or directory that doesn't live in the repository and can't ...
Definition svn_wc.h:1126
@ svn_wc_notify_resolved_text
All text conflicts in a file were marked as resolved.
Definition svn_wc.h:1284
@ svn_wc_notify_path_nonexistent
The operation was attempted on a path which doesn't exist.
Definition svn_wc.h:1196
@ svn_wc_notify_cleanup_external
Running cleanup on an external module.
Definition svn_wc.h:1267
@ svn_wc_notify_changelist_moved
Warn user that a path has moved from one changelist to another.
Definition svn_wc.h:1073
@ svn_wc_notify_revert
Reverting a modified path.
Definition svn_wc.h:996
@ svn_wc_notify_conflict_resolver_starting
Conflict resolver is starting.
Definition svn_wc.h:1242
@ svn_wc_notify_commit_modified
Committing a modification.
Definition svn_wc.h:1032
@ svn_wc_notify_url_redirect
The server has instructed the client to follow a URL redirection.
Definition svn_wc.h:1192
@ svn_wc_notify_hydrating_end
Hydrating (fetching text-bases): finished a batch of fetching within the WC subtree at svn_wc_notify_...
Definition svn_wc.h:1322
@ svn_wc_notify_restore
Restoring a missing path from the pristine text-base.
Definition svn_wc.h:993
@ svn_wc_notify_skip
Skipping a path.
Definition svn_wc.h:1008
@ svn_wc_notify_commit_copied_replaced
Committing an overwriting (replace) copy (path is the target of the copy, not the source).
Definition svn_wc.h:1187
@ svn_wc_notify_update_add
Got an add in an update.
Definition svn_wc.h:1014
@ svn_wc_notify_resolved_tree
A tree conflict on a path was marked as resolved.
Definition svn_wc.h:1293
@ svn_wc_notify_commit_added
Committing an addition.
Definition svn_wc.h:1035
@ svn_wc_notify_move_broken
A move in the working copy has been broken, i.e.
Definition svn_wc.h:1263
@ svn_wc_notify_tree_conflict
The path is a tree-conflict victim of the intended action (not a persistent tree-conflict from an ear...
Definition svn_wc.h:1110
@ svn_wc_notify_changelist_set
Changelist name set.
Definition svn_wc.h:1065
@ svn_wc_notify_update_completed
The last notification in an update (including updates of externals).
Definition svn_wc.h:1020
@ svn_wc_notify_hydrating_start
Hydrating (fetching text-bases): starting a batch of fetching within the WC subtree at svn_wc_notify_...
Definition svn_wc.h:1312
@ svn_wc_notify_failed_no_parent
Operation failed because an added parent is not selected.
Definition svn_wc.h:1216
@ svn_wc_notify_failed_conflict
Operation failed because the node remains in conflict.
Definition svn_wc.h:1204
@ svn_wc_notify_merge_record_info_begin
Mergeinfo describing a merge was recorded.
Definition svn_wc.h:1157
@ svn_wc_notify_failed_unlock
Failed to unlock a path.
Definition svn_wc.h:1059
@ svn_wc_notify_update_external
Updating an external module.
Definition svn_wc.h:1023
@ svn_wc_notify_update_update
Got any other action in an update.
Definition svn_wc.h:1017
@ svn_wc_notify_commit_copied
Committing a non-overwriting copy (path is the target of the copy, not the source).
Definition svn_wc.h:1182
@ svn_wc_notify_merge_elide_info
Mergeinfo was removed due to elision.
Definition svn_wc.h:1161
@ svn_wc_notify_failed_forbidden_by_server
Operation failed because the operation was forbidden by the server.
Definition svn_wc.h:1224
@ svn_wc_notify_patch_hunk_already_applied
A hunk from a patch was found to already be applied.
Definition svn_wc.h:1177
@ svn_wc_notify_commit_postfix_txdelta
Transmitting post-fix text-delta data for a file.
Definition svn_wc.h:1044
@ svn_wc_notify_changelist_clear
Changelist name cleared.
Definition svn_wc.h:1068
@ svn_wc_notify_skip_conflicted
The operation skipped the path because it was conflicted.
Definition svn_wc.h:1228
@ svn_wc_notify_update_shadowed_delete
A node below an existing node was deleted during update.
Definition svn_wc.h:1146
@ svn_wc_notify_status_completed
The last notification in a status (including status on externals).
Definition svn_wc.h:1026
@ svn_wc_notify_failed_missing
Operation failed because an added node is missing.
Definition svn_wc.h:1208
@ svn_wc_notify_revprop_set
Revprop set.
Definition svn_wc.h:1099
@ svn_wc_notify_commit_finalizing
Finalizing commit.
Definition svn_wc.h:1280
@ svn_wc_notify_update_started
Starting an update operation.
Definition svn_wc.h:1117
@ svn_wc_notify_failed_lock
Failed to lock a path.
Definition svn_wc.h:1056
@ svn_wc_notify_begin_search_tree_conflict_details
Starting to search the repository for details about a tree conflict.
Definition svn_wc.h:1297
@ svn_wc_notify_update_shadowed_add
A node below an existing node was added during update.
Definition svn_wc.h:1138
@ svn_wc_notify_revprop_deleted
Revprop deleted.
Definition svn_wc.h:1102
@ svn_wc_notify_unlocked
Unlocking a path.
Definition svn_wc.h:1053
@ svn_wc_notify_failed_locked
Operation failed because a node is locked by another user and/or working copy.
Definition svn_wc.h:1220
@ svn_wc_notify_commit_replaced
Committing a replacement.
Definition svn_wc.h:1041
@ svn_wc_notify_add
Adding a path to revision control.
Definition svn_wc.h:984
@ svn_wc_notify_status_external
Running status on an external module.
Definition svn_wc.h:1029
@ svn_wc_notify_tree_conflict_details_progress
Progressing in search of repository for details about a tree conflict.
Definition svn_wc.h:1302
@ svn_wc_notify_hydrating_file
Hydrating (fetching text-bases): about to fetch a file from svn_wc_notify_t.url at svn_wc_notify_t....
Definition svn_wc.h:1317
@ svn_wc_notify_foreign_merge_begin
A merge operation (to path) from a foreign repository has begun.
Definition svn_wc.h:1081
@ svn_wc_notify_info_external
Running info on an external module.
Definition svn_wc.h:1276
@ svn_wc_notify_update_replace
Replace notification.
Definition svn_wc.h:1084
@ svn_wc_notify_warning
A warning, specified in svn_wc_notify_t.err.
Definition svn_wc.h:1326
@ svn_wc_notify_blame_revision
Processed a single revision's blame.
Definition svn_wc.h:1047
@ svn_wc_notify_copy
Copying a versioned path.
Definition svn_wc.h:987
@ svn_wc_notify_patch_applied_hunk
A hunk from a patch was applied.
Definition svn_wc.h:1169
@ svn_wc_notify_failed_requires_target
The operation failed because the operation (E.g.
Definition svn_wc.h:1272
@ svn_wc_notify_update_shadowed_update
A node below an existing node was updated during update.
Definition svn_wc.h:1142
@ svn_wc_notify_property_modified
Property updated.
Definition svn_wc.h:1090
@ svn_wc_notify_merge_completed
The last notification in a merge.
Definition svn_wc.h:1105
@ svn_wc_notify_foreign_copy_begin
A copy from a foreign repository has started.
Definition svn_wc.h:1257
@ svn_wc_notify_failed_external
The path is a subdirectory referenced in an externals definition which is unable to be operated on.
Definition svn_wc.h:1114
@ svn_wc_notify_merge_begin
A merge operation (to path) has begun.
Definition svn_wc.h:1077
@ svn_wc_notify_update_skip_obstruction
An update tried to add a file or directory at a path where a separate working copy was found.
Definition svn_wc.h:1121
@ svn_wc_notify_end_search_tree_conflict_details
Done searching the repository for details about a conflict.
Definition svn_wc.h:1306
@ svn_wc_notify_failed_obstruction
Operation failed because a node is obstructed.
Definition svn_wc.h:1236
@ svn_wc_notify_left_local_modifications
The current operation left local changes of something that was deleted The changes are available on (...
Definition svn_wc.h:1253
@ svn_wc_notify_patch_rejected_hunk
A hunk from a patch was rejected.
Definition svn_wc.h:1173
@ svn_wc_notify_property_deleted_nonexistent
Nonexistent property deleted.
Definition svn_wc.h:1096
@ svn_wc_notify_delete
Deleting a versioned path.
Definition svn_wc.h:990
@ svn_wc_notify_locked
Locking a path.
Definition svn_wc.h:1050
@ svn_wc_notify_state_obstructed
An unversioned item obstructed work.
Definition svn_wc.h:1346
@ svn_wc_notify_state_conflicted
Modified state got conflicting mods.
Definition svn_wc.h:1355
@ svn_wc_notify_state_missing
The item wasn't present.
Definition svn_wc.h:1343
@ svn_wc_notify_state_unknown
Notifier doesn't know or isn't saying.
Definition svn_wc.h:1337
@ svn_wc_notify_state_merged
Modified state had mods merged in.
Definition svn_wc.h:1352
@ svn_wc_notify_state_unchanged
The state did not change.
Definition svn_wc.h:1340
@ svn_wc_notify_state_source_missing
The source to copy the file from is missing.
Definition svn_wc.h:1358
@ svn_wc_notify_state_changed
Pristine state was modified.
Definition svn_wc.h:1349
@ svn_wc_notify_lock_state_unlocked
The item was unlocked.
Definition svn_wc.h:1380
@ svn_wc_notify_lock_state_locked
The item was locked.
Definition svn_wc.h:1377
@ svn_wc_notify_lock_state_unchanged
The lock wasn't changed.
Definition svn_wc.h:1374
svn_error_t * svn_wc_canonicalize_svn_prop(const svn_string_t **propval_p, const char *propname, const svn_string_t *propval, const char *path, svn_node_kind_t kind, svn_boolean_t skip_some_checks, svn_wc_canonicalize_svn_prop_get_file_t prop_getter, void *getter_baton, apr_pool_t *pool)
Canonicalize the value of an svn:* property propname with value propval.
svn_error_t *(* svn_wc_canonicalize_svn_prop_get_file_t)(const svn_string_t **mime_type, svn_stream_t *stream, void *baton, apr_pool_t *pool)
Callback type used by svn_wc_canonicalize_svn_prop.
Definition svn_wc.h:6488
svn_error_t * svn_wc_prop_set(const char *name, const svn_string_t *value, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
Like svn_wc_prop_set2(), but with skip_checks always FALSE.
svn_error_t * svn_wc_prop_set4(svn_wc_context_t *wc_ctx, const char *local_abspath, const char *name, const svn_string_t *value, svn_depth_t depth, svn_boolean_t skip_checks, const apr_array_header_t *changelist_filter, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Set property name to value for local_abspath, or if value is NULL, remove property name from local_ab...
svn_boolean_t svn_wc_is_normal_prop(const char *name)
Return TRUE iff name is a 'normal' property name.
svn_error_t * svn_wc_prop_set2(const char *name, const svn_string_t *value, const char *path, svn_wc_adm_access_t *adm_access, svn_boolean_t skip_checks, apr_pool_t *pool)
Like svn_wc_prop_set3(), but without the notification callbacks.
svn_error_t * svn_wc_prop_list2(apr_hash_t **props, svn_wc_context_t *wc_ctx, const char *local_abspath, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
Set *props to a hash table mapping char * names onto svn_string_t * values for all the regular proper...
svn_error_t * svn_wc_prop_get2(const svn_string_t **value, svn_wc_context_t *wc_ctx, const char *local_abspath, const char *name, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
Set *value to the value of property name for local_abspath, allocating *value in result_pool.
svn_boolean_t svn_wc_is_wc_prop(const char *name)
Return TRUE iff name is a 'wc' property name.
svn_error_t * svn_wc_prop_get(const svn_string_t **value, const char *name, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
Similar to svn_wc_prop_get2(), but with a svn_wc_adm_access_t / relative path parameter pair.
svn_error_t * svn_wc_prop_set3(const char *name, const svn_string_t *value, const char *path, svn_wc_adm_access_t *adm_access, svn_boolean_t skip_checks, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *pool)
Similar to svn_wc_prop_set4(), but with a svn_wc_adm_access_t / relative path parameter pair,...
svn_error_t * svn_wc_prop_list(apr_hash_t **props, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
Similar to svn_wc_prop_list2() but with a svn_wc_adm_access_t / relative path parameter pair.
svn_error_t * svn_wc_get_pristine_props(apr_hash_t **props, svn_wc_context_t *wc_ctx, const char *local_abspath, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
Return the set of "pristine" properties for local_abspath.
svn_boolean_t svn_wc_is_entry_prop(const char *name)
Return TRUE iff name is a 'entry' property name.
svn_error_t * svn_wc_add_lock2(svn_wc_context_t *wc_ctx, const char *abspath, const svn_lock_t *lock, apr_pool_t *scratch_pool)
Add lock to the working copy for local_abspath.
svn_error_t * svn_wc_add_lock(const char *path, const svn_lock_t *lock, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
Similar to svn_wc_add_lock2(), but with a svn_wc_adm_access_t / relative path parameter pair.
svn_error_t * svn_wc_remove_lock(const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
Similar to svn_wc_remove_lock2(), but with a svn_wc_adm_access_t / relative path parameter pair.
svn_error_t * svn_wc_remove_lock2(svn_wc_context_t *wc_ctx, const char *local_abspath, apr_pool_t *scratch_pool)
Remove any lock from local_abspath.
svn_error_t * svn_wc_is_wc_root2(svn_boolean_t *wc_root, svn_wc_context_t *wc_ctx, const char *local_abspath, apr_pool_t *scratch_pool)
Set *wc_root to TRUE if local_abspath represents a "working copyroot", FALSE otherwise....
svn_error_t * svn_wc_check_root(svn_boolean_t *is_wcroot, svn_boolean_t *is_switched, svn_node_kind_t *kind, svn_wc_context_t *wc_ctx, const char *local_abspath, apr_pool_t *scratch_pool)
If is_wcroot is not NULL, set *is_wcroot to TRUE if local_abspath is the root of the working copy,...
svn_error_t * svn_wc_is_wc_root(svn_boolean_t *wc_root, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
Similar to svn_wc_is_wc_root2(), but with an access baton and relative path.
apr_time_t ood_last_cmt_date
Set to the most recent commit date, or 0 if not out of date.
Definition svn_wc.h:3986
enum svn_wc_status_kind repos_node_status
The status of the node, based on the text status if the node has no restructuring changes.
Definition svn_wc.h:3845
apr_time_t ood_changed_date
Set to the most recent commit date, or 0 if not out of date.
Definition svn_wc.h:3861
const svn_lock_t * repos_lock
The entry's lock in the repository, if any.
Definition svn_wc.h:3854
enum svn_wc_status_kind repos_text_status
The entry's text status in the repository.
Definition svn_wc.h:3848
const char * ood_last_cmt_author
Set to the user name of the youngest commit, or NULL if not out of date or non-existent.
Definition svn_wc.h:4001
svn_node_kind_t ood_kind
Set to the node kind of the youngest commit, or svn_node_none if not out of date.
Definition svn_wc.h:3841
const char * ood_changed_author
Set to the user name of the youngest commit, or NULL if not out of date or non-existent.
Definition svn_wc.h:3868
svn_revnum_t ood_changed_rev
Set to the youngest committed revision, or SVN_INVALID_REVNUM if not out of date.
Definition svn_wc.h:3858
svn_node_kind_t ood_kind
Set to the node kind of the youngest commit, or svn_node_none if not out of date.
Definition svn_wc.h:3992
enum svn_wc_status_kind repos_prop_status
The entry's property status in the repository.
Definition svn_wc.h:3851
svn_revnum_t ood_last_cmt_rev
Set to the youngest committed revision, or SVN_INVALID_REVNUM if not out of date.
Definition svn_wc.h:3981
svn_error_t * svn_wc_get_status_editor4(const svn_delta_editor_t **editor, void **edit_baton, void **set_locks_baton, svn_revnum_t *edit_revision, svn_wc_adm_access_t *anchor, const char *target, svn_depth_t depth, svn_boolean_t get_all, svn_boolean_t no_ignore, const apr_array_header_t *ignore_patterns, svn_wc_status_func3_t status_func, void *status_baton, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_traversal_info_t *traversal_info, apr_pool_t *pool)
Same as svn_wc_get_status_editor5, but using svn_wc_status_func3_t instead of svn_wc_status_func4_t.
svn_wc_status3_t * svn_wc_dup_status3(const svn_wc_status3_t *orig_stat, apr_pool_t *pool)
Return a deep copy of the orig_stat status structure, allocated in pool.
svn_error_t * svn_wc_status_set_repos_locks(void *set_locks_baton, apr_hash_t *locks, const char *repos_root, apr_pool_t *pool)
Associate locks, a hash table mapping const char* absolute repository paths to svn_lock_t objects,...
svn_error_t * svn_wc_get_status_editor5(const svn_delta_editor_t **editor, void **edit_baton, void **set_locks_baton, svn_revnum_t *edit_revision, svn_wc_context_t *wc_ctx, const char *anchor_abspath, const char *target_basename, svn_depth_t depth, svn_boolean_t get_all, svn_boolean_t no_ignore, svn_boolean_t depth_as_sticky, svn_boolean_t server_performs_filtering, const apr_array_header_t *ignore_patterns, svn_wc_status_func4_t status_func, void *status_baton, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
DEPRECATED – please use APIs from svn_client.h.
svn_wc_status_t * svn_wc_dup_status(const svn_wc_status_t *orig_stat, apr_pool_t *pool)
Same as svn_wc_dup_status2(), but for older svn_wc_status_t structures.
void(* svn_wc_status_func_t)(void *baton, const char *path, svn_wc_status_t *status)
Same as svn_wc_status_func2_t, but for older svn_wc_status_t structures.
Definition svn_wc.h:4211
svn_wc_status2_t * svn_wc_dup_status2(const svn_wc_status2_t *orig_stat, apr_pool_t *pool)
Same as svn_wc_dup_status3(), but for older svn_wc_status_t structures.
svn_error_t * svn_wc_get_status_editor2(const svn_delta_editor_t **editor, void **edit_baton, void **set_locks_baton, svn_revnum_t *edit_revision, svn_wc_adm_access_t *anchor, const char *target, apr_hash_t *config, svn_boolean_t recurse, svn_boolean_t get_all, svn_boolean_t no_ignore, svn_wc_status_func2_t status_func, void *status_baton, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_traversal_info_t *traversal_info, apr_pool_t *pool)
Like svn_wc_get_status_editor3(), but with ignore_patterns provided from the corresponding value in c...
svn_error_t * svn_wc_get_status_editor(const svn_delta_editor_t **editor, void **edit_baton, svn_revnum_t *edit_revision, svn_wc_adm_access_t *anchor, const char *target, apr_hash_t *config, svn_boolean_t recurse, svn_boolean_t get_all, svn_boolean_t no_ignore, svn_wc_status_func_t status_func, void *status_baton, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_traversal_info_t *traversal_info, apr_pool_t *pool)
Same as svn_wc_get_status_editor2(), but with set_locks_baton set to NULL, and taking a deprecated sv...
svn_error_t * svn_wc_walk_status(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_depth_t depth, svn_boolean_t get_all, svn_boolean_t no_ignore, svn_boolean_t ignore_text_mods, const apr_array_header_t *ignore_patterns, svn_wc_status_func4_t status_func, void *status_baton, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *scratch_pool)
Walk the working copy status of local_abspath using wc_ctx, by creating svn_wc_status3_t structures a...
svn_error_t *(* svn_wc_status_func4_t)(void *baton, const char *local_abspath, const svn_wc_status3_t *status, apr_pool_t *scratch_pool)
A callback for reporting a status about local_abspath.
Definition svn_wc.h:4178
svn_error_t *(* svn_wc_status_func3_t)(void *baton, const char *path, svn_wc_status2_t *status, apr_pool_t *pool)
Same as svn_wc_status_func4_t, but with a non-const status and a relative path.
Definition svn_wc.h:4190
svn_error_t * svn_wc_get_status_editor3(const svn_delta_editor_t **editor, void **edit_baton, void **set_locks_baton, svn_revnum_t *edit_revision, svn_wc_adm_access_t *anchor, const char *target, svn_depth_t depth, svn_boolean_t get_all, svn_boolean_t no_ignore, const apr_array_header_t *ignore_patterns, svn_wc_status_func2_t status_func, void *status_baton, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_traversal_info_t *traversal_info, apr_pool_t *pool)
Same as svn_wc_get_status_editor4(), but using svn_wc_status_func2_t instead of svn_wc_status_func3_t...
svn_error_t * svn_wc_status2(svn_wc_status2_t **status, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
Similar to svn_wc_status3(), but with a adm_access baton and absolute path.
svn_wc_status_kind
Definition svn_wc.h:3703
svn_error_t * svn_wc_status(svn_wc_status_t **status, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
Same as svn_wc_status2(), but for older svn_wc_status_t structures.
void(* svn_wc_status_func2_t)(void *baton, const char *path, svn_wc_status2_t *status)
Same as svn_wc_status_func3_t, but without a provided pool or the ability to propagate errors.
Definition svn_wc.h:4202
svn_error_t * svn_wc_status3(svn_wc_status3_t **status, svn_wc_context_t *wc_ctx, const char *local_abspath, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
Fill *status for local_abspath, allocating in result_pool.
@ svn_wc_status_added
is scheduled for addition
Definition svn_wc.h:3714
@ svn_wc_status_normal
exists, but uninteresting
Definition svn_wc.h:3711
@ svn_wc_status_external
an unversioned directory path populated by an svn:externals property; this status is not used for fil...
Definition svn_wc.h:3742
@ svn_wc_status_conflicted
local mods received conflicting repos mods
Definition svn_wc.h:3732
@ svn_wc_status_missing
under v.c., but is missing
Definition svn_wc.h:3717
@ svn_wc_status_unversioned
is not a versioned thing in this wc
Definition svn_wc.h:3708
@ svn_wc_status_replaced
was deleted and then re-added
Definition svn_wc.h:3723
@ svn_wc_status_obstructed
an unversioned resource is in the way of the versioned resource
Definition svn_wc.h:3738
@ svn_wc_status_merged
local mods received repos mods (### unused)
Definition svn_wc.h:3729
@ svn_wc_status_incomplete
a directory doesn't contain a complete entries list
Definition svn_wc.h:3745
@ svn_wc_status_none
does not exist
Definition svn_wc.h:3705
@ svn_wc_status_modified
text or props have been modified
Definition svn_wc.h:3726
@ svn_wc_status_ignored
is unversioned but configured to be ignored
Definition svn_wc.h:3735
@ svn_wc_status_deleted
scheduled for deletion
Definition svn_wc.h:3720
svn_error_t * svn_wc_translated_file2(const char **xlated_path, const char *src, const char *versioned_file, svn_wc_adm_access_t *adm_access, apr_uint32_t flags, apr_pool_t *pool)
Set xlated_path to a translated copy of src or to src itself if no translation is necessary.
svn_error_t * svn_wc_translated_stream(svn_stream_t **stream, const char *path, const char *versioned_file, svn_wc_adm_access_t *adm_access, apr_uint32_t flags, apr_pool_t *pool)
Returns a stream allocated in pool with access to the given path taking the file properties from vers...
svn_error_t * svn_wc_translated_file(const char **xlated_p, const char *vfile, svn_wc_adm_access_t *adm_access, svn_boolean_t force_repair, apr_pool_t *pool)
Same as svn_wc_translated_file2, but will never clean up temporary files.
svn_error_t * svn_wc_get_update_editor2(svn_revnum_t *target_revision, svn_wc_adm_access_t *anchor, const char *target, svn_boolean_t use_commit_times, svn_boolean_t recurse, svn_wc_notify_func2_t notify_func, void *notify_baton, svn_cancel_func_t cancel_func, void *cancel_baton, const char *diff3_cmd, const svn_delta_editor_t **editor, void **edit_baton, svn_wc_traversal_info_t *ti, apr_pool_t *pool)
Similar to svn_wc_get_update_editor3() but with the allow_unver_obstructions parameter always set to ...
svn_error_t *(* svn_wc_get_file_t)(void *baton, const char *path, svn_revnum_t revision, svn_stream_t *stream, svn_revnum_t *fetched_rev, apr_hash_t **props, apr_pool_t *pool)
A simple callback type to wrap svn_ra_get_file(); see that docstring for more information.
Definition svn_wc.h:5833
svn_error_t * svn_wc_get_update_editor3(svn_revnum_t *target_revision, svn_wc_adm_access_t *anchor, const char *target, svn_boolean_t use_commit_times, svn_depth_t depth, svn_boolean_t depth_is_sticky, svn_boolean_t allow_unver_obstructions, svn_wc_notify_func2_t notify_func, void *notify_baton, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_conflict_resolver_func_t conflict_func, void *conflict_baton, svn_wc_get_file_t fetch_func, void *fetch_baton, const char *diff3_cmd, const apr_array_header_t *preserved_exts, const svn_delta_editor_t **editor, void **edit_baton, svn_wc_traversal_info_t *ti, apr_pool_t *pool)
Similar to svn_wc_get_update_editor4, but uses access batons and relative path instead of a working c...
svn_error_t * svn_wc_get_update_editor4(const svn_delta_editor_t **editor, void **edit_baton, svn_revnum_t *target_revision, svn_wc_context_t *wc_ctx, const char *anchor_abspath, const char *target_basename, svn_boolean_t use_commit_times, svn_depth_t depth, svn_boolean_t depth_is_sticky, svn_boolean_t allow_unver_obstructions, svn_boolean_t adds_as_modification, svn_boolean_t server_performs_filtering, svn_boolean_t clean_checkout, const char *diff3_cmd, const apr_array_header_t *preserved_exts, svn_wc_dirents_func_t fetch_dirents_func, void *fetch_dirents_baton, svn_wc_conflict_resolver_func2_t conflict_func, void *conflict_baton, svn_wc_external_update_t external_func, void *external_baton, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
DEPRECATED – please use APIs from svn_client.h.
svn_error_t * svn_wc_get_switch_editor3(svn_revnum_t *target_revision, svn_wc_adm_access_t *anchor, const char *target, const char *switch_url, svn_boolean_t use_commit_times, svn_depth_t depth, svn_boolean_t depth_is_sticky, svn_boolean_t allow_unver_obstructions, svn_wc_notify_func2_t notify_func, void *notify_baton, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_conflict_resolver_func_t conflict_func, void *conflict_baton, const char *diff3_cmd, const apr_array_header_t *preserved_exts, const svn_delta_editor_t **editor, void **edit_baton, svn_wc_traversal_info_t *ti, apr_pool_t *pool)
Similar to svn_wc_get_switch_editor4, but uses access batons and relative path instead of a working c...
svn_error_t *(* svn_wc_dirents_func_t)(void *baton, apr_hash_t **dirents, const char *repos_root_url, const char *repos_relpath, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
A simple callback type to wrap svn_ra_get_dir2() for avoiding issue #3569, where a directory is updat...
Definition svn_wc.h:5855
svn_error_t * svn_wc_get_switch_editor(svn_revnum_t *target_revision, svn_wc_adm_access_t *anchor, const char *target, const char *switch_url, svn_boolean_t use_commit_times, svn_boolean_t recurse, svn_wc_notify_func_t notify_func, void *notify_baton, svn_cancel_func_t cancel_func, void *cancel_baton, const char *diff3_cmd, const svn_delta_editor_t **editor, void **edit_baton, svn_wc_traversal_info_t *ti, apr_pool_t *pool)
Similar to svn_wc_get_switch_editor2(), but takes an svn_wc_notify_func_t instead.
svn_error_t * svn_wc_get_switch_editor2(svn_revnum_t *target_revision, svn_wc_adm_access_t *anchor, const char *target, const char *switch_url, svn_boolean_t use_commit_times, svn_boolean_t recurse, svn_wc_notify_func2_t notify_func, void *notify_baton, svn_cancel_func_t cancel_func, void *cancel_baton, const char *diff3_cmd, const svn_delta_editor_t **editor, void **edit_baton, svn_wc_traversal_info_t *ti, apr_pool_t *pool)
Similar to svn_wc_get_switch_editor3() but with the allow_unver_obstructions parameter always set to ...
svn_error_t * svn_wc_get_switch_editor4(const svn_delta_editor_t **editor, void **edit_baton, svn_revnum_t *target_revision, svn_wc_context_t *wc_ctx, const char *anchor_abspath, const char *target_basename, const char *switch_url, svn_boolean_t use_commit_times, svn_depth_t depth, svn_boolean_t depth_is_sticky, svn_boolean_t allow_unver_obstructions, svn_boolean_t server_performs_filtering, const char *diff3_cmd, const apr_array_header_t *preserved_exts, svn_wc_dirents_func_t fetch_dirents_func, void *fetch_dirents_baton, svn_wc_conflict_resolver_func2_t conflict_func, void *conflict_baton, svn_wc_external_update_t external_func, void *external_baton, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
DEPRECATED – please use APIs from svn_client.h.
svn_error_t * svn_wc_get_update_editor(svn_revnum_t *target_revision, svn_wc_adm_access_t *anchor, const char *target, svn_boolean_t use_commit_times, svn_boolean_t recurse, svn_wc_notify_func_t notify_func, void *notify_baton, svn_cancel_func_t cancel_func, void *cancel_baton, const char *diff3_cmd, const svn_delta_editor_t **editor, void **edit_baton, svn_wc_traversal_info_t *ti, apr_pool_t *pool)
Similar to svn_wc_get_update_editor2(), but takes an svn_wc_notify_func_t instead.
svn_error_t * svn_wc_ensure_adm4(svn_wc_context_t *wc_ctx, const char *local_abspath, const char *url, const char *repos_root_url, const char *repos_uuid, svn_revnum_t revision, svn_depth_t depth, apr_pool_t *scratch_pool)
Ensure that an administrative area exists for local_abspath, so that local_abspath is a working copy ...
svn_error_t * svn_wc_delete3(const char *path, svn_wc_adm_access_t *adm_access, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, svn_boolean_t keep_local, apr_pool_t *pool)
Similar to svn_wc_delete4, but uses an access baton and relative path instead of a working copy conte...
svn_error_t * svn_wc_crawl_revisions3(const char *path, svn_wc_adm_access_t *adm_access, const svn_ra_reporter3_t *reporter, void *report_baton, svn_boolean_t restore_files, svn_depth_t depth, svn_boolean_t depth_compatibility_trick, svn_boolean_t use_commit_times, svn_wc_notify_func2_t notify_func, void *notify_baton, svn_wc_traversal_info_t *traversal_info, apr_pool_t *pool)
Similar to svn_wc_crawl_revisions4, but with honor_depth_exclude always set to false.
svn_error_t * svn_wc_ensure_adm3(const char *path, const char *uuid, const char *url, const char *repos, svn_revnum_t revision, svn_depth_t depth, apr_pool_t *pool)
Similar to svn_wc_ensure_adm4(), but without the wc context parameter.
svn_error_t * svn_wc_create_tmp_file2(apr_file_t **fp, const char **new_name, const char *path, svn_io_file_del_t delete_when, apr_pool_t *pool)
Create a unique temporary file in administrative tmp/ area of directory path.
svn_error_t * svn_wc_add_from_disk(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Similar to svn_wc_add_from_disk2(), but always passes NULL for props.
svn_error_t * svn_wc_copy2(const char *src, svn_wc_adm_access_t *dst_parent, const char *dst_basename, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *pool)
Similar to svn_wc_copy3(), but takes access batons and a relative path and a basename instead of abso...
svn_error_t * svn_wc_walk_entries2(const char *path, svn_wc_adm_access_t *adm_access, const svn_wc_entry_callbacks_t *walk_callbacks, void *walk_baton, svn_boolean_t show_hidden, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *pool)
Similar to svn_wc_walk_entries3(), but without cancellation support or error handling from walk_callb...
svn_error_t * svn_wc_revert6(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_depth_t depth, svn_boolean_t use_commit_times, const apr_array_header_t *changelist_filter, svn_boolean_t clear_changelists, svn_boolean_t metadata_only, svn_boolean_t added_keep_local, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Similar to svn_wc_revert7(), but this function can only be used for working copies that store local c...
svn_error_t *(* svn_changelist_receiver_t)(void *baton, const char *path, const char *changelist, apr_pool_t *pool)
The callback type used by svn_wc_get_changelists() and svn_client_get_changelists().
Definition svn_wc.h:8625
svn_error_t * svn_wc_set_changelist2(svn_wc_context_t *wc_ctx, const char *local_abspath, const char *changelist, svn_depth_t depth, const apr_array_header_t *changelist_filter, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Set local_abspath's 'changelist' attribute to changelist iff changelist is not NULL; otherwise,...
svn_error_t * svn_wc_revision_status2(svn_wc_revision_status_t **result_p, svn_wc_context_t *wc_ctx, const char *local_abspath, const char *trail_url, svn_boolean_t committed, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
Set *result_p to point to a new svn_wc_revision_status_t structure containing a summary of the revisi...
svn_error_t * svn_wc_restore(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_boolean_t use_commit_times, apr_pool_t *scratch_pool)
Similar to svn_wc_restore2(), but this function can only be used for working copies that store local ...
svn_error_t * svn_wc_revert(const char *path, svn_wc_adm_access_t *parent_access, svn_boolean_t recursive, svn_boolean_t use_commit_times, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func_t notify_func, void *notify_baton, apr_pool_t *pool)
Similar to svn_wc_revert2(), but takes an svn_wc_notify_func_t instead.
svn_error_t * svn_wc_get_ancestry(char **url, svn_revnum_t *rev, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
Set *url and *rev to the ancestor URL and revision for path, allocating in pool.
svn_wc_info_t * svn_wc_info_dup(const svn_wc_info_t *info, apr_pool_t *pool)
Return a duplicate of info, allocated in pool.
svn_error_t *(* svn_wc_relocation_validator_t)(void *baton, const char *uuid, const char *url)
Similar to svn_wc_relocation_validator2_t, but without the root and pool arguments.
Definition svn_wc.h:7745
svn_error_t * svn_wc_get_actual_target2(const char **anchor, const char **target, svn_wc_context_t *wc_ctx, const char *path, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
Conditionally split path into an anchor and target for the purpose of updating and committing.
svn_error_t * svn_wc_queue_committed(svn_wc_committed_queue_t **queue, const char *path, svn_wc_adm_access_t *adm_access, svn_boolean_t recurse, const apr_array_header_t *wcprop_changes, svn_boolean_t remove_lock, svn_boolean_t remove_changelist, const unsigned char *digest, apr_pool_t *pool)
Same as svn_wc_queue_committed2() but the queue parameter has an extra indirection and digest is supp...
svn_error_t * svn_wc_maybe_set_repos_root(svn_wc_adm_access_t *adm_access, const char *path, const char *repos, apr_pool_t *pool)
Set the repository root URL of path to repos, if possible.
svn_error_t * svn_wc_process_committed4(const char *path, svn_wc_adm_access_t *adm_access, svn_boolean_t recurse, svn_revnum_t new_revnum, const char *rev_date, const char *rev_author, const apr_array_header_t *wcprop_changes, svn_boolean_t remove_lock, svn_boolean_t remove_changelist, const unsigned char *digest, apr_pool_t *pool)
svn_error_t * svn_wc_add_repos_file2(const char *dst_path, svn_wc_adm_access_t *adm_access, const char *new_text_base_path, const char *new_text_path, apr_hash_t *new_base_props, apr_hash_t *new_props, const char *copyfrom_url, svn_revnum_t copyfrom_rev, apr_pool_t *pool)
Same as svn_wc_add_repos_file3(), except that it has pathnames rather than streams for the text base,...
svn_error_t * svn_wc_add_repos_file4(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_stream_t *new_base_contents, svn_stream_t *new_contents, apr_hash_t *new_base_props, apr_hash_t *new_props, const char *copyfrom_url, svn_revnum_t copyfrom_rev, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *scratch_pool)
Add a file to a working copy at local_abspath, obtaining the text-base's contents from new_base_conte...
svn_error_t * svn_wc_process_committed_queue2(svn_wc_committed_queue_t *queue, svn_wc_context_t *wc_ctx, svn_revnum_t new_revnum, const char *rev_date, const char *rev_author, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *scratch_pool)
Bump all items in queue to new_revnum after a commit succeeds.
svn_error_t * svn_wc_get_pristine_contents(svn_stream_t **contents, const char *path, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
Similar to svn_wc_get_pristine_contents2, but takes no working copy context and a path that can be re...
svn_error_t * svn_wc_process_committed(const char *path, svn_wc_adm_access_t *adm_access, svn_boolean_t recurse, svn_revnum_t new_revnum, const char *rev_date, const char *rev_author, const apr_array_header_t *wcprop_changes, apr_pool_t *pool)
svn_error_t * svn_wc_delete(const char *path, svn_wc_adm_access_t *adm_access, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func_t notify_func, void *notify_baton, apr_pool_t *pool)
Similar to svn_wc_delete2(), but takes an svn_wc_notify_func_t instead.
svn_error_t * svn_wc_check_wc(const char *path, int *wc_format, apr_pool_t *pool)
Similar to svn_wc_check_wc2(), but with a relative path and no supplied working copy context.
svn_error_t * svn_wc_revert5(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_depth_t depth, svn_boolean_t use_commit_times, const apr_array_header_t *changelist_filter, svn_boolean_t clear_changelists, svn_boolean_t metadata_only, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Similar to svn_wc_revert6() but with added_keep_local always set to TRUE.
svn_error_t *(* svn_wc_relocation_validator2_t)(void *baton, const char *uuid, const char *url, svn_boolean_t root, apr_pool_t *pool)
Similar to svn_wc_relocation_validator3_t, but with the root argument.
Definition svn_wc.h:7733
svn_error_t * svn_wc_relocate2(const char *path, svn_wc_adm_access_t *adm_access, const char *from, const char *to, svn_boolean_t recurse, svn_wc_relocation_validator2_t validator, void *validator_baton, apr_pool_t *pool)
Similar to svn_wc_relocate3(), but uses svn_wc_relocation_validator2_t.
svn_error_t * svn_wc_ensure_adm2(const char *path, const char *uuid, const char *url, const char *repos, svn_revnum_t revision, apr_pool_t *pool)
Similar to svn_wc_ensure_adm3(), but with depth set to svn_depth_infinity.
svn_error_t * svn_wc_remove_from_revision_control(svn_wc_adm_access_t *adm_access, const char *name, svn_boolean_t destroy_wf, svn_boolean_t instant_error, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *pool)
Similar to svn_wc_remove_from_revision_control2() but with a name and access baton.
svn_error_t * svn_wc_delete4(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_boolean_t keep_local, svn_boolean_t delete_unversioned_target, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Schedule local_abspath for deletion.
svn_error_t *(* svn_wc_upgrade_get_repos_info_t)(const char **repos_root, const char **repos_uuid, void *baton, const char *url, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
Callback for retrieving a repository root for a url from upgrade.
Definition svn_wc.h:7660
svn_error_t * svn_wc_crawl_revisions(const char *path, svn_wc_adm_access_t *adm_access, const svn_ra_reporter_t *reporter, void *report_baton, svn_boolean_t restore_files, svn_boolean_t recurse, svn_boolean_t use_commit_times, svn_wc_notify_func_t notify_func, void *notify_baton, svn_wc_traversal_info_t *traversal_info, apr_pool_t *pool)
Similar to svn_wc_crawl_revisions2(), but takes an svn_wc_notify_func_t and a svn_ra_reporter_t inste...
svn_error_t * svn_wc_get_changelists(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_depth_t depth, const apr_array_header_t *changelist_filter, svn_changelist_receiver_t callback_func, void *callback_baton, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *scratch_pool)
Beginning at local_abspath, crawl to depth to discover every path in or under local_abspath which bel...
svn_error_t * svn_wc_queue_committed2(svn_wc_committed_queue_t *queue, const char *path, svn_wc_adm_access_t *adm_access, svn_boolean_t recurse, const apr_array_header_t *wcprop_changes, svn_boolean_t remove_lock, svn_boolean_t remove_changelist, const svn_checksum_t *md5_checksum, apr_pool_t *scratch_pool)
Same as svn_wc_queue_committed3() except path doesn't have to be an abspath and adm_access is unused ...
svn_error_t * svn_wc_upgrade(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_wc_upgrade_get_repos_info_t repos_info_func, void *repos_info_baton, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Upgrade the working copy at local_abspath to the library's default metadata storage format (SVN_WC__D...
svn_error_t *(* svn_wc_relocation_validator3_t)(void *baton, const char *uuid, const char *url, const char *root_url, apr_pool_t *pool)
Relocation validation callback typedef.
Definition svn_wc.h:7719
svn_error_t * svn_wc_process_committed2(const char *path, svn_wc_adm_access_t *adm_access, svn_boolean_t recurse, svn_revnum_t new_revnum, const char *rev_date, const char *rev_author, const apr_array_header_t *wcprop_changes, svn_boolean_t remove_lock, apr_pool_t *pool)
svn_error_t * svn_wc_exclude(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Remove the local node for local_abspath from the working copy and add an excluded node placeholder in...
svn_error_t * svn_wc_resolved_conflict2(const char *path, svn_wc_adm_access_t *adm_access, svn_boolean_t resolve_text, svn_boolean_t resolve_props, svn_boolean_t recurse, svn_wc_notify_func2_t notify_func, void *notify_baton, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *pool)
Similar to svn_wc_resolved_conflict3(), but without automatic conflict resolution support,...
svn_error_t * svn_wc_process_committed3(const char *path, svn_wc_adm_access_t *adm_access, svn_boolean_t recurse, svn_revnum_t new_revnum, const char *rev_date, const char *rev_author, const apr_array_header_t *wcprop_changes, svn_boolean_t remove_lock, const unsigned char *digest, apr_pool_t *pool)
svn_error_t * svn_wc_resolved_conflict(const char *path, svn_wc_adm_access_t *adm_access, svn_boolean_t resolve_text, svn_boolean_t resolve_props, svn_boolean_t recurse, svn_wc_notify_func_t notify_func, void *notify_baton, apr_pool_t *pool)
Similar to svn_wc_resolved_conflict2(), but takes an svn_wc_notify_func_t and doesn't have cancellati...
svn_error_t * svn_wc_cleanup(const char *path, svn_wc_adm_access_t *optional_adm_access, const char *diff3_cmd, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *pool)
Similar to svn_wc_cleanup2().
svn_error_t * svn_wc_create_tmp_file(apr_file_t **fp, const char *path, svn_boolean_t delete_on_close, apr_pool_t *pool)
Same as svn_wc_create_tmp_file2(), but with new_name set to NULL, and without the ability to delete t...
svn_error_t * svn_wc_relocate3(const char *path, svn_wc_adm_access_t *adm_access, const char *from, const char *to, svn_boolean_t recurse, svn_wc_relocation_validator3_t validator, void *validator_baton, apr_pool_t *pool)
Similar to svn_wc_relocate4(), but with a svn_wc_adm_access_t / relative path parameter pair.
svn_error_t * svn_wc_revert2(const char *path, svn_wc_adm_access_t *parent_access, svn_boolean_t recursive, svn_boolean_t use_commit_times, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *pool)
Similar to svn_wc_revert3(), but with changelist_filter passed as NULL, and depth set according to re...
svn_error_t * svn_wc_add4(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_depth_t depth, const char *copyfrom_url, svn_revnum_t copyfrom_rev, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Put local_abspath under version control by registering it as addition or copy in the database contain...
svn_error_t * svn_wc_relocate(const char *path, svn_wc_adm_access_t *adm_access, const char *from, const char *to, svn_boolean_t recurse, svn_wc_relocation_validator_t validator, void *validator_baton, apr_pool_t *pool)
Similar to svn_wc_relocate2(), but uses svn_wc_relocation_validator_t.
svn_error_t * svn_wc_crawl_revisions2(const char *path, svn_wc_adm_access_t *adm_access, const svn_ra_reporter2_t *reporter, void *report_baton, svn_boolean_t restore_files, svn_boolean_t recurse, svn_boolean_t use_commit_times, svn_wc_notify_func2_t notify_func, void *notify_baton, svn_wc_traversal_info_t *traversal_info, apr_pool_t *pool)
Similar to svn_wc_crawl_revisions3, but taking svn_ra_reporter2_t instead of svn_ra_reporter3_t,...
svn_error_t * svn_wc_text_modified_p2(svn_boolean_t *modified_p, svn_wc_context_t *wc_ctx, const char *local_abspath, svn_boolean_t unused, apr_pool_t *scratch_pool)
Set *modified_p to non-zero if local_abspath's text is modified with regard to the base revision,...
svn_error_t * svn_wc_ensure_adm(const char *path, const char *uuid, const char *url, svn_revnum_t revision, apr_pool_t *pool)
Similar to svn_wc_ensure_adm2(), but with repos set to NULL.
svn_error_t * svn_wc_revision_status(svn_wc_revision_status_t **result_p, const char *wc_path, const char *trail_url, svn_boolean_t committed, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *pool)
Similar to svn_wc_revision_status2(), but with a (possibly) local path and no wc_ctx parameter.
svn_error_t * svn_wc_crawl_revisions5(svn_wc_context_t *wc_ctx, const char *local_abspath, const svn_ra_reporter3_t *reporter, void *report_baton, svn_boolean_t restore_files, svn_depth_t depth, svn_boolean_t honor_depth_exclude, svn_boolean_t depth_compatibility_trick, svn_boolean_t use_commit_times, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Do a depth-first crawl in a working copy, beginning at local_abspath, using wc_ctx for accessing the ...
svn_error_t * svn_wc_move(svn_wc_context_t *wc_ctx, const char *src_abspath, const char *dst_abspath, svn_boolean_t metadata_only, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Move src_abspath to dst_abspath, by scheduling dst_abspath for addition to the repository,...
svn_error_t * svn_wc_resolved_conflict4(const char *path, svn_wc_adm_access_t *adm_access, svn_boolean_t resolve_text, svn_boolean_t resolve_props, svn_boolean_t resolve_tree, svn_depth_t depth, svn_wc_conflict_choice_t conflict_choice, svn_wc_notify_func2_t notify_func, void *notify_baton, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *pool)
Similar to svn_wc_resolved_conflict5, but takes an absolute path and an access baton.
svn_error_t * svn_wc_add2(const char *path, svn_wc_adm_access_t *parent_access, const char *copyfrom_url, svn_revnum_t copyfrom_rev, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *pool)
Similar to svn_wc_add3(), but with the depth parameter always svn_depth_infinity.
svn_error_t * svn_wc_add(const char *path, svn_wc_adm_access_t *parent_access, const char *copyfrom_url, svn_revnum_t copyfrom_rev, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func_t notify_func, void *notify_baton, apr_pool_t *pool)
Similar to svn_wc_add2(), but takes an svn_wc_notify_func_t instead.
svn_error_t * svn_wc_revert4(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_depth_t depth, svn_boolean_t use_commit_times, const apr_array_header_t *changelist_filter, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Similar to svn_wc_revert5() but with clear_changelists always set to FALSE and metadata_only set to F...
svn_error_t * svn_wc_resolved_conflict3(const char *path, svn_wc_adm_access_t *adm_access, svn_boolean_t resolve_text, svn_boolean_t resolve_props, svn_depth_t depth, svn_wc_conflict_choice_t conflict_choice, svn_wc_notify_func2_t notify_func, void *notify_baton, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *pool)
Similar to svn_wc_resolved_conflict4(), but without tree-conflict resolution support.
svn_error_t * svn_wc_get_pristine_copy_path(const char *path, const char **pristine_path, apr_pool_t *pool)
Set *pristine_path to the path of the "normal" pristine text file for the versioned file path.
svn_error_t * svn_wc_props_modified_p(svn_boolean_t *modified_p, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
Similar to svn_wc_props_modified_p2(), but with a relative path and adm_access baton.
svn_error_t * svn_wc_copy3(svn_wc_context_t *wc_ctx, const char *src_abspath, const char *dst_abspath, svn_boolean_t metadata_only, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Copy src_abspath to dst_abspath, and schedule dst_abspath for addition to the repository,...
svn_error_t * svn_wc_remove_from_revision_control2(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_boolean_t destroy_wf, svn_boolean_t instant_error, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *pool)
Remove local_abspath from revision control.
svn_error_t * svn_wc_get_pristine_contents3(svn_stream_t **contents, svn_wc_context_t *wc_ctx, const char *local_abspath, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
Given a path to a wc file, return in *contents a readonly stream to the pristine contents of the file...
svn_error_t * svn_wc_restore2(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_boolean_t use_commit_times, apr_pool_t *scratch_pool)
Restores a missing node, local_abspath using the wc_ctx.
svn_error_t * svn_wc_queue_committed3(svn_wc_committed_queue_t *queue, svn_wc_context_t *wc_ctx, const char *local_abspath, svn_boolean_t recurse, const apr_array_header_t *wcprop_changes, svn_boolean_t remove_lock, svn_boolean_t remove_changelist, const svn_checksum_t *sha1_checksum, apr_pool_t *scratch_pool)
Similar to svn_wc_queue_committed4, but with is_committed always TRUE.
svn_error_t * svn_wc_set_changelist(const char *path, const char *changelist, svn_wc_adm_access_t *adm_access, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *pool)
Similar to svn_wc_set_changelist2(), but with an access baton and relative path.
svn_error_t * svn_wc_add_from_disk2(svn_wc_context_t *wc_ctx, const char *local_abspath, const apr_hash_t *props, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Similar to svn_wc_add_from_disk3(), but always passes FALSE for skip_checks.
svn_error_t * svn_wc_walk_entries(const char *path, svn_wc_adm_access_t *adm_access, const svn_wc_entry_callbacks_t *walk_callbacks, void *walk_baton, svn_boolean_t show_hidden, apr_pool_t *pool)
Similar to svn_wc_walk_entries2(), but without cancellation support.
svn_error_t * svn_wc_get_pristine_contents2(svn_stream_t **contents, svn_wc_context_t *wc_ctx, const char *local_abspath, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
Similar to svn_wc_get_pristine_contents3, but this function can only be used for working copies that ...
struct svn_wc_committed_queue_t svn_wc_committed_queue_t
Storage type for queued post-commit data.
Definition svn_wc.h:5236
svn_error_t * svn_wc_conflicted_p2(svn_boolean_t *text_conflicted_p, svn_boolean_t *prop_conflicted_p, svn_boolean_t *tree_conflicted_p, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
Given local_abspath in a dir under version control, decide if it is in a state of conflict; return th...
svn_error_t * svn_wc_process_committed_queue(svn_wc_committed_queue_t *queue, svn_wc_adm_access_t *adm_access, svn_revnum_t new_revnum, const char *rev_date, const char *rev_author, apr_pool_t *pool)
svn_error_t * svn_wc_revert3(const char *path, svn_wc_adm_access_t *parent_access, svn_depth_t depth, svn_boolean_t use_commit_times, const apr_array_header_t *changelist_filter, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *pool)
Similar to svn_wc_revert4() but takes a relative path and access baton.
svn_error_t * svn_wc_get_actual_target(const char *path, const char **anchor, const char **target, apr_pool_t *pool)
Similar to svn_wc_get_actual_target2(), but without the wc context, and with a absolute path.
svn_error_t * svn_wc_delete2(const char *path, svn_wc_adm_access_t *adm_access, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *pool)
Similar to svn_wc_delete3(), but with keep_local always set to FALSE.
svn_error_t * svn_wc_add3(const char *path, svn_wc_adm_access_t *parent_access, svn_depth_t depth, const char *copyfrom_url, svn_revnum_t copyfrom_rev, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *pool)
Similar to svn_wc_add4(), but with an access baton and relative path instead of a context and absolut...
svn_error_t * svn_wc_walk_entries3(const char *path, svn_wc_adm_access_t *adm_access, const svn_wc_entry_callbacks2_t *walk_callbacks, void *walk_baton, svn_depth_t depth, svn_boolean_t show_hidden, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *pool)
A generic entry-walker.
svn_error_t * svn_wc_check_wc2(int *wc_format, svn_wc_context_t *wc_ctx, const char *local_abspath, apr_pool_t *scratch_pool)
Set *wc_format to local_abspath's working copy format version number if local_abspath is a valid work...
svn_error_t * svn_wc_copy(const char *src, svn_wc_adm_access_t *dst_parent, const char *dst_basename, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func_t notify_func, void *notify_baton, apr_pool_t *pool)
Similar to svn_wc_copy2(), but takes an svn_wc_notify_func_t instead.
svn_error_t * svn_wc_has_binary_prop(svn_boolean_t *has_binary_prop, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
Set *has_binary_prop to TRUE iff path has been marked with a property indicating that it is non-text ...
svn_wc_committed_queue_t * svn_wc_committed_queue_create(apr_pool_t *pool)
Create a queue for use with svn_wc_queue_committed() and svn_wc_process_committed_queue().
svn_error_t * svn_wc_text_modified_p(svn_boolean_t *modified_p, const char *filename, svn_boolean_t force_comparison, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
Similar to svn_wc_text_modified_p2(), but with a relative path and adm_access baton?
svn_error_t * svn_wc_props_modified_p2(svn_boolean_t *modified_p, svn_wc_context_t *wc_ctx, const char *local_abspath, apr_pool_t *scratch_pool)
Set *modified_p to non-zero if path's properties are modified with regard to the base revision,...
svn_error_t * svn_wc_resolved_conflict5(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_depth_t depth, svn_boolean_t resolve_text, const char *resolve_prop, svn_boolean_t resolve_tree, svn_wc_conflict_choice_t conflict_choice, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Assuming local_abspath is under version control or a tree conflict victim and in a state of conflict,...
svn_error_t * svn_wc_crawl_revisions4(const char *path, svn_wc_adm_access_t *adm_access, const svn_ra_reporter3_t *reporter, void *report_baton, svn_boolean_t restore_files, svn_depth_t depth, svn_boolean_t honor_depth_exclude, svn_boolean_t depth_compatibility_trick, svn_boolean_t use_commit_times, svn_wc_notify_func2_t notify_func, void *notify_baton, svn_wc_traversal_info_t *traversal_info, apr_pool_t *pool)
Similar to svn_wc_crawl_revisions5, but with a relative path and access baton instead of an absolute ...
svn_error_t * svn_wc_crop_tree(svn_wc_adm_access_t *anchor, const char *target, svn_depth_t depth, svn_wc_notify_func2_t notify_func, void *notify_baton, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *pool)
Similar to svn_wc_crop_tree2(), but uses an access baton and target.
svn_error_t * svn_wc_queue_committed4(svn_wc_committed_queue_t *queue, svn_wc_context_t *wc_ctx, const char *local_abspath, svn_boolean_t recurse, svn_boolean_t is_committed, const apr_array_header_t *wcprop_changes, svn_boolean_t remove_lock, svn_boolean_t remove_changelist, const svn_checksum_t *sha1_checksum, apr_pool_t *scratch_pool)
Queue committed items to be processed later by svn_wc_process_committed_queue2().
svn_error_t * svn_wc_relocate4(svn_wc_context_t *wc_ctx, const char *wcroot_abspath, const char *from, const char *to, svn_wc_relocation_validator3_t validator, void *validator_baton, apr_pool_t *scratch_pool)
Recursively change repository references at wcroot_abspath (which is the root directory of a working ...
svn_error_t *(* svn_wc_textbase_fetch_cb_t)(void *baton, const char *repos_root_url, const char *repos_relpath, svn_revnum_t revision, svn_stream_t *contents, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *scratch_pool)
The callback invoked by svn_wc_textbase_sync() to provide the text-base contents identified by repos_...
Definition svn_wc.h:7515
svn_error_t * svn_wc_add_repos_file3(const char *dst_path, svn_wc_adm_access_t *adm_access, svn_stream_t *new_base_contents, svn_stream_t *new_contents, apr_hash_t *new_base_props, apr_hash_t *new_props, const char *copyfrom_url, svn_revnum_t copyfrom_rev, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Similar to svn_wc_add_repos_file4, but uses access batons and a relative path instead of a working co...
svn_error_t * svn_wc_locked2(svn_boolean_t *locked_here, svn_boolean_t *locked, svn_wc_context_t *wc_ctx, const char *local_abspath, apr_pool_t *scratch_pool)
Gets up to two booleans indicating whether a path is locked for writing.
svn_error_t * svn_wc_add_repos_file(const char *dst_path, svn_wc_adm_access_t *adm_access, const char *new_text_path, apr_hash_t *new_props, const char *copyfrom_url, svn_revnum_t copyfrom_rev, apr_pool_t *pool)
Same as svn_wc_add_repos_file3(), except that it doesn't have the BASE arguments or cancellation.
svn_error_t * svn_wc_textbase_sync(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_boolean_t allow_hydrate, svn_boolean_t allow_dehydrate, svn_wc_textbase_fetch_cb_t fetch_callback, void *fetch_baton, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Synchronize the state of the text-base contents for the local_abspath tree.
svn_error_t * svn_wc_cleanup4(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_boolean_t break_locks, svn_boolean_t fix_recorded_timestamps, svn_boolean_t clear_dav_cache, svn_boolean_t vacuum_pristines, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Recurse from local_abspath, cleaning up unfinished tasks.
svn_error_t * svn_wc_cleanup3(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *scratch_pool)
Similar to svn_wc_cleanup4() but will always break locks, fix recorded timestamps,...
svn_error_t * svn_wc_cleanup2(const char *path, const char *diff3_cmd, svn_cancel_func_t cancel_func, void *cancel_baton, apr_pool_t *pool)
Similar to svn_wc_cleanup3() but uses relative paths and creates its own svn_wc_context_t.
svn_error_t * svn_wc_locked(svn_boolean_t *locked, const char *path, apr_pool_t *pool)
Set *locked to non-zero if path is locked, else set it to zero.
svn_error_t * svn_wc_conflicted_p(svn_boolean_t *text_conflicted_p, svn_boolean_t *prop_conflicted_p, const char *dir_path, const svn_wc_entry_t *entry, apr_pool_t *pool)
Given a dir_path under version control, decide if one of its entries (entry) is in a state of conflic...
svn_error_t * svn_wc_crop_tree2(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_depth_t depth, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Crop local_abspath according to depth.
svn_error_t * svn_wc_revert7(svn_wc_context_t *wc_ctx, const char *local_abspath, svn_depth_t depth, svn_boolean_t use_commit_times, const apr_array_header_t *changelist_filter, svn_boolean_t clear_changelists, svn_boolean_t metadata_only, svn_boolean_t added_keep_local, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Revert changes to local_abspath.
svn_error_t * svn_wc_add_from_disk3(svn_wc_context_t *wc_ctx, const char *local_abspath, const apr_hash_t *props, svn_boolean_t skip_checks, svn_wc_notify_func2_t notify_func, void *notify_baton, apr_pool_t *scratch_pool)
Schedule the single node that exists on disk at local_abspath for addition to the working copy.
svn_error_t * svn_wc_mark_missing_deleted(const char *path, svn_wc_adm_access_t *parent, apr_pool_t *pool)
Mark missing path as 'deleted' in its parent's list of entries.
A generic checksum representation.
Subversion error object.
Definition svn_types.h:177
A lock object, for client & server to share.
Definition svn_types.h:1105
Mergeinfo representing a merge of a range of revisions.
Definition svn_types.h:1154
A revision, specified in one of svn_opt_revision_kind ways.
Definition svn_opt.h:470
Similar to svn_ra_reporter3_t, but without support for depths.
Definition svn_ra.h:446
The update Reporter.
Definition svn_ra.h:357
Similar to svn_ra_reporter2_t, but without support for lock tokens.
Definition svn_ra.h:487
A simple counted string.
Definition svn_string.h:97
Version information.
A struct that describes a conflict that has occurred in the working copy.
Definition svn_wc.h:1824
const char * merged_file
merged version; may contain conflict markers
Definition svn_wc.h:1899
const svn_wc_conflict_version_t * src_right_version
Info on the "merge-right source" or "their" version of incoming change.
Definition svn_wc.h:1910
svn_wc_conflict_kind_t kind
What sort of conflict are we describing?
Definition svn_wc.h:1835
const svn_string_t * prop_value_incoming_old
For property conflicts, the incoming old value of the property, i.e.
Definition svn_wc.h:1936
const char * their_abspath
their version of the file
Definition svn_wc.h:1892
svn_boolean_t is_binary
Whether svn thinks ('my' version of) path is a 'binary' file.
Definition svn_wc.h:1843
svn_node_kind_t node_kind
The node type of the local node involved in this conflict.
Definition svn_wc.h:1832
const svn_string_t * prop_value_working
For property conflicts, the local working value of the property, i.e.
Definition svn_wc.h:1930
const char * my_abspath
my locally-edited version of the file
Definition svn_wc.h:1895
const svn_wc_conflict_version_t * src_left_version
Info on the "merge-left source" or "older" version of incoming change.
Definition svn_wc.h:1907
svn_wc_conflict_action_t action
The incoming action being attempted on the conflicted node or property.
Definition svn_wc.h:1853
svn_wc_conflict_reason_t reason
The local change or state of the target node or property, relative to its merge-left source,...
Definition svn_wc.h:1863
const char * local_abspath
The path that is in conflict (for a tree conflict, it is the victim).
Definition svn_wc.h:1826
const char * prop_reject_abspath
For property conflicts, the absolute path to the .prej file.
Definition svn_wc.h:1914
svn_wc_operation_t operation
The operation that exposed the conflict.
Definition svn_wc.h:1904
const svn_string_t * prop_value_incoming_new
For property conflicts, the incoming new value of the property, i.e.
Definition svn_wc.h:1942
const char * base_abspath
If this is text-conflict and involves the merging of two files descended from a common ancestor,...
Definition svn_wc.h:1887
const svn_string_t * prop_value_base
For property conflicts, the local base value of the property, i.e.
Definition svn_wc.h:1923
const char * mime_type
The svn:mime-type property of ('my' version of) path, if available, else NULL.
Definition svn_wc.h:1848
const char * property_name
The name of the property whose conflict is being described.
Definition svn_wc.h:1839
Similar to svn_wc_conflict_description2_t, but with relative paths and adm_access batons.
Definition svn_wc.h:1960
svn_wc_adm_access_t * access
If not NULL, an open working copy access baton to either the path itself (if path is a directory),...
Definition svn_wc.h:1991
const char * merged_file
merged version; may contain conflict markers
Definition svn_wc.h:2026
svn_wc_conflict_action_t action
The action being attempted on the conflicted node or property.
Definition svn_wc.h:1995
const char * their_file
their version of the file
Definition svn_wc.h:2020
svn_wc_conflict_version_t * src_left_version
Info on the "merge-left source" or "older" version of incoming change.
Definition svn_wc.h:2037
const char * base_file
If this is text-conflict and involves the merging of two files descended from a common ancestor,...
Definition svn_wc.h:2017
const char * path
The path that is in conflict (for a tree conflict, it is the victim).
Definition svn_wc.h:1962
const char * my_file
my locally-edited version of the file
Definition svn_wc.h:2023
svn_node_kind_t node_kind
The local node type of the path being operated on (for a tree conflict, this specifies the local node...
Definition svn_wc.h:1967
svn_boolean_t is_binary
Whether svn thinks ('my' version of) path is a 'binary' file.
Definition svn_wc.h:1978
svn_wc_conflict_reason_t reason
The state of the target node or property, relative to its merge-left source, that is the reason for t...
Definition svn_wc.h:2000
svn_wc_conflict_version_t * src_right_version
Info on the "merge-right source" or "their" version of incoming change.
Definition svn_wc.h:2041
const char * property_name
The name of the property whose conflict is being described.
Definition svn_wc.h:1974
svn_wc_operation_t operation
The operation that exposed the conflict.
Definition svn_wc.h:2033
svn_wc_conflict_kind_t kind
What sort of conflict are we describing?
Definition svn_wc.h:1970
const char * mime_type
The svn:mime-type property of ('my' version of) path, if available, else NULL.
Definition svn_wc.h:1983
The final result returned by svn_wc_conflict_resolver_func_t.
Definition svn_wc.h:2226
const svn_string_t * merged_value
If not NULL, this is the new merged property, used when choosing svn_wc_conflict_choose_merged.
Definition svn_wc.h:2248
svn_boolean_t save_merged
If true, save a backup copy of merged_file (or the original merged_file from the conflict description...
Definition svn_wc.h:2240
const char * merged_file
If not NULL, this is a path to a file which contains the client's (or more likely,...
Definition svn_wc.h:2235
svn_wc_conflict_choice_t choice
A choice to either delay the conflict resolution or select a particular file to resolve the conflict.
Definition svn_wc.h:2229
Info about one of the conflicting versions of a node.
Definition svn_wc.h:1728
const char * repos_uuid
UUID of the repository (or NULL if unknown.).
Definition svn_wc.h:1748
const char * repos_url
URL of repository root.
Definition svn_wc.h:1733
svn_node_kind_t node_kind
The node kind.
Definition svn_wc.h:1744
svn_revnum_t peg_rev
revision at which to look up path_in_repos
Definition svn_wc.h:1736
const char * path_in_repos
path within repos; must not start with '/'
Definition svn_wc.h:1740
Similar to svn_wc_diff_callbacks3_t, but without the dir_opened and dir_closed functions,...
Definition svn_wc.h:2636
Similar to svn_wc_diff_callbacks4_t, but without copyfrom_path and copyfrom_revision arguments to fil...
Definition svn_wc.h:2540
A callback vtable invoked by our diff-editors, as they receive diffs from the server.
Definition svn_wc.h:2345
Similar to svn_wc_diff_callbacks2_t, but with file additions/content changes and property changes spl...
Definition svn_wc.h:2708
A callback vtable invoked by the generic entry-walker function.
Definition svn_wc.h:3428
Definition svn_wc.h:3448
A working copy entry – that is, revision control information about one versioned entity.
Definition svn_wc.h:2923
svn_depth_t depth
The depth of this entry.
Definition svn_wc.h:3106
svn_revnum_t copyfrom_rev
copyfrom revision
Definition svn_wc.h:2980
const char * repos
canonical repository URL or NULL if not known
Definition svn_wc.h:2938
const char * url
url in repository
Definition svn_wc.h:2935
svn_wc_schedule_t schedule
scheduling (add, delete, replace ...)
Definition svn_wc.h:2949
const char * conflict_wrk
working version of conflicted file.
Definition svn_wc.h:2992
apr_off_t working_size
Size of the file after being translated into local representation, or SVN_WC_ENTRY_WORKING_SIZE_UNKNO...
Definition svn_wc.h:3089
const char * file_external_path
The entry is a intra-repository file external and this is the repository root relative path to the fi...
Definition svn_wc.h:3119
const char * uuid
repository uuid
Definition svn_wc.h:2941
const char * changelist
which changelist this item is part of, or NULL if not part of any.
Definition svn_wc.h:3081
svn_boolean_t has_props
Whether this entry has any working properties.
Definition svn_wc.h:3048
apr_time_t text_time
last up-to-date time for text contents (0 means no information available)
Definition svn_wc.h:3000
svn_boolean_t deleted
The directory containing this entry had a versioned child of this name, but this entry represents a d...
Definition svn_wc.h:2967
const char * cmt_author
last commit author of this item
Definition svn_wc.h:3022
svn_boolean_t copied
in a copied state (possibly because the entry is a child of a path that is svn_wc_schedule_add or svn...
Definition svn_wc.h:2958
svn_revnum_t revision
base revision
Definition svn_wc.h:2932
svn_node_kind_t kind
node kind (file, dir, ...)
Definition svn_wc.h:2944
const char * lock_comment
lock comment or NULL if not locked in this WC or no comment
Definition svn_wc.h:3037
const char * prejfile
property reject file.
Definition svn_wc.h:2996
const char * conflict_old
old version of conflicted file.
Definition svn_wc.h:2984
const char * cachable_props
A space-separated list of all properties whose presence/absence is cached in this entry.
Definition svn_wc.h:3066
apr_time_t prop_time
last up-to-date time for properties (0 means no information available)
Definition svn_wc.h:3006
apr_time_t lock_creation_date
Lock creation date or 0 if not locked in this WC.
Definition svn_wc.h:3042
const char * tree_conflict_data
Serialized data for all of the tree conflicts detected in this_dir.
Definition svn_wc.h:3111
const char * lock_token
lock token or NULL if path not locked in this WC
Definition svn_wc.h:3027
const char * copyfrom_url
copyfrom location
Definition svn_wc.h:2977
const char * present_props
Cached property existence for this entry.
Definition svn_wc.h:3076
svn_opt_revision_t file_external_peg_rev
The entry is a intra-repository file external and this is the peg revision number specified in the ex...
Definition svn_wc.h:3131
svn_boolean_t absent
absent – we know an entry of this name exists, but that's all (usually this happens because of authz ...
Definition svn_wc.h:2971
const char * name
entry's name
Definition svn_wc.h:2929
const char * lock_owner
lock owner, or NULL if not locked in this WC
Definition svn_wc.h:3032
svn_boolean_t keep_local
Whether a local copy of this entry should be kept in the working copy after a deletion has been commi...
Definition svn_wc.h:3096
svn_boolean_t has_prop_mods
Whether this entry has property modifications.
Definition svn_wc.h:3057
svn_opt_revision_t file_external_rev
The entry is an intra-repository file external and this is the operative revision number specified in...
Definition svn_wc.h:3143
svn_boolean_t incomplete
for THIS_DIR entry, implies whole entries file is incomplete
Definition svn_wc.h:2974
apr_time_t cmt_date
last date this was changed
Definition svn_wc.h:3019
svn_revnum_t cmt_rev
last revision this was changed
Definition svn_wc.h:3016
const char * checksum
Hex MD5 checksum for the untranslated text base file, can be NULL for backwards compatibility.
Definition svn_wc.h:3011
const char * conflict_new
new version of conflicted file.
Definition svn_wc.h:2988
One external item.
Definition svn_wc.h:790
const char * url
Where to check out from.
Definition svn_wc.h:800
svn_opt_revision_t peg_revision
The peg revision to use when checking out.
Definition svn_wc.h:810
const char * target_dir
The name of the subdirectory into which this external should be checked out.
Definition svn_wc.h:796
svn_opt_revision_t revision
What revision to check out.
Definition svn_wc.h:805
One external item.
Definition svn_wc.h:862
const char * url
Same as svn_wc_external_item2_t.url.
Definition svn_wc.h:867
svn_opt_revision_t revision
Same as svn_wc_external_item2_t.revision.
Definition svn_wc.h:870
const char * target_dir
Same as svn_wc_external_item2_t.target_dir.
Definition svn_wc.h:864
This struct contains information about a working copy node.
Definition svn_wc.h:3263
const apr_array_header_t * conflicts
Array of const svn_wc_conflict_description2_t * which contains info on any conflict of which this nod...
Definition svn_wc.h:3299
svn_revnum_t copyfrom_rev
If copied, the revision from which the copy was made, else SVN_INVALID_REVNUM.
Definition svn_wc.h:3273
const char * wcroot_abspath
The local absolute path of the working copy root.
Definition svn_wc.h:3302
apr_time_t recorded_time
The time at which the file had the recorded size recorded_size and was considered unmodified.
Definition svn_wc.h:3295
const char * changelist
A changelist the item is in, NULL if this node is not in a changelist.
Definition svn_wc.h:3280
svn_wc_schedule_t schedule
The schedule of this item.
Definition svn_wc.h:3266
svn_depth_t depth
The depth of the item, see svn_depth_t.
Definition svn_wc.h:3283
const char * moved_to_abspath
The path the node was moved to, if it was moved away.
Definition svn_wc.h:3310
const char * copyfrom_url
If copied, the URL from which the copy was made, else NULL.
Definition svn_wc.h:3269
svn_filesize_t recorded_size
The size of the file after being translated into its local representation, or SVN_INVALID_FILESIZE if...
Definition svn_wc.h:3290
int wc_format
The format of the working copy.
Definition svn_wc.h:3316
svn_boolean_t store_pristine
Whether pristine content is stored locally or is being fetched on-demand.
Definition svn_wc.h:3322
const svn_checksum_t * checksum
The checksum of the node, if it is a file.
Definition svn_wc.h:3276
const char * moved_from_abspath
The path the node was moved from, if it was moved here.
Definition svn_wc.h:3306
A structure to report a summary of a working copy, including the mix of revisions found within it,...
Definition svn_wc.h:8479
svn_revnum_t max_rev
Highest revision found.
Definition svn_wc.h:8481
svn_revnum_t min_rev
Lowest revision found.
Definition svn_wc.h:8480
svn_boolean_t sparse_checkout
Whether any WC paths are at a depth other than svn_depth_infinity or are user excluded.
Definition svn_wc.h:8490
svn_boolean_t switched
Is anything switched?
Definition svn_wc.h:8483
svn_boolean_t modified
Is anything modified?
Definition svn_wc.h:8484
svn_boolean_t switched
a file or directory can be 'switched' if the switch command has been used.
Definition svn_wc.h:3950
enum svn_wc_status_kind pristine_prop_status
The actual status of the properties compared to the pristine base of the node.
Definition svn_wc.h:4031
enum svn_wc_status_kind text_status
The status of the entry itself, including its text if it is a file.
Definition svn_wc.h:3934
const char * url
Set to the URI (actual or expected) of the item.
Definition svn_wc.h:3964
svn_boolean_t locked
a directory can be 'locked' if a working copy update was interrupted.
Definition svn_wc.h:3940
svn_boolean_t file_external
If the item is a file that was added to the working copy with an svn:externals; if file_external is T...
Definition svn_wc.h:4015
enum svn_wc_status_kind repos_prop_status
The entry's property status in the repository.
Definition svn_wc.h:3956
enum svn_wc_status_kind pristine_text_status
The actual status of the text compared to the pristine base of the file.
Definition svn_wc.h:4023
svn_wc_conflict_description_t * tree_conflict
Non-NULL if the entry is the victim of a tree conflict.
Definition svn_wc.h:4008
const svn_wc_entry_t * entry
Can be NULL if not under version control.
Definition svn_wc.h:3931
svn_lock_t * repos_lock
The entry's lock in the repository, if any.
Definition svn_wc.h:3959
enum svn_wc_status_kind repos_text_status
The entry's text status in the repository.
Definition svn_wc.h:3953
svn_boolean_t copied
a file or directory can be 'copied' if it's scheduled for addition-with-history (or part of a subtree...
Definition svn_wc.h:3945
enum svn_wc_status_kind prop_status
The status of the entry's properties.
Definition svn_wc.h:3937
Structure for holding the "status" of a working copy item.
Definition svn_wc.h:3758
const char * moved_to_abspath
Set to the local absolute path that this node was moved to, if this file or directory has been moved ...
Definition svn_wc.h:3903
const char * repos_relpath
The in-repository path relative to the repository root.
Definition svn_wc.h:3811
svn_boolean_t copied
a file or directory can be 'copied' if it's scheduled for addition-with-history (or part of a subtree...
Definition svn_wc.h:3790
svn_depth_t depth
The depth of the node as recorded in the working copy (svn_depth_unknown for files or when no depth i...
Definition svn_wc.h:3764
const char * changed_author
Last commit author of this item.
Definition svn_wc.h:3802
const char * repos_uuid
The UUID of the repository.
Definition svn_wc.h:3808
const char * repos_root_url
The URL of the repository.
Definition svn_wc.h:3805
svn_node_kind_t kind
The kind of node as recorded in the working copy.
Definition svn_wc.h:3760
svn_boolean_t locked
This directory has a working copy lock.
Definition svn_wc.h:3819
svn_revnum_t revision
Base revision.
Definition svn_wc.h:3793
svn_node_kind_t actual_kind
The actual kind of the node in the working copy.
Definition svn_wc.h:3914
svn_boolean_t conflicted
Set to TRUE if the item is the victim of a conflict.
Definition svn_wc.h:3775
const svn_lock_t * lock
The repository file lock.
Definition svn_wc.h:3823
const char * moved_from_abspath
Set to the local absolute path that this node was moved from, if this file or directory has been move...
Definition svn_wc.h:3881
enum svn_wc_status_kind text_status
The status of the entry's text.
Definition svn_wc.h:3782
svn_boolean_t file_external
TRUE iff the item is a file brought in by an svn:externals definition.
Definition svn_wc.h:3907
const char * changelist
Which changelist this item is part of, or NULL if not part of any.
Definition svn_wc.h:3826
svn_boolean_t switched
a file or directory can be 'switched' if the switch command has been used.
Definition svn_wc.h:3816
svn_filesize_t filesize
The actual size of the working file on disk, or SVN_INVALID_FILESIZE if unknown (or if the item isn't...
Definition svn_wc.h:3768
svn_boolean_t versioned
If the path is under version control, versioned is TRUE, otherwise FALSE.
Definition svn_wc.h:3772
enum svn_wc_status_kind node_status
The status of the node itself.
Definition svn_wc.h:3779
apr_time_t changed_date
Date of last commit.
Definition svn_wc.h:3799
enum svn_wc_status_kind prop_status
The status of the entry's properties.
Definition svn_wc.h:3785
svn_revnum_t changed_rev
Last revision this was changed.
Definition svn_wc.h:3796
Same as svn_wc_status2_t, but without the svn_lock_t 'repos_lock', const char 'url',...
Definition svn_wc.h:4043
enum svn_wc_status_kind repos_text_status
The entry's text status in the repository.
Definition svn_wc.h:4067
enum svn_wc_status_kind repos_prop_status
The entry's property status in the repository.
Definition svn_wc.h:4070
svn_boolean_t copied
a file or directory can be 'copied' if it's scheduled for addition-with-history (or part of a subtree...
Definition svn_wc.h:4059
svn_boolean_t locked
a directory can be 'locked' if a working copy update was interrupted.
Definition svn_wc.h:4054
enum svn_wc_status_kind text_status
The status of the entries text.
Definition svn_wc.h:4048
svn_boolean_t switched
a file or directory can be 'switched' if the switch command has been used.
Definition svn_wc.h:4064
enum svn_wc_status_kind prop_status
The status of the entries properties.
Definition svn_wc.h:4051
const svn_wc_entry_t * entry
Can be NULL if not under version control.
Definition svn_wc.h:4045
Subversion checksum routines.
struct svn_config_t svn_config_t
Opaque structure describing a set of configuration options.
Definition svn_config.h:54
Delta-parsing.
General file I/O for Subversion.
svn_io_file_del_t
Used as an argument when creating temporary files to indicate when a file should be removed.
Definition svn_io.h:59
Option and argument parsing for Subversion command lines.
Repository Access.
Counted-length strings for Subversion, plus some C string goodies.
Subversion's data types.
int svn_boolean_t
YABT: Yet Another Boolean Type.
Definition svn_types.h:137
apr_int64_t svn_filesize_t
The size of a file in the Subversion FS.
Definition svn_types.h:430
unsigned long svn_linenum_t
A line number, such as in a file or a stream.
Definition svn_types.h:1241
svn_error_t *(* svn_cancel_func_t)(void *cancel_baton)
A user defined callback that subversion will call with a user defined baton to see if the current ope...
Definition svn_types.h:1081
#define SVN_DEPRECATED
Macro used to mark deprecated functions.
Definition svn_types.h:62
svn_depth_t
The concept of depth for directories.
svn_node_kind_t
The various types of nodes in the Subversion filesystem.
long int svn_revnum_t
A revision number.
svn_error_t * svn_wc_read_kind(svn_node_kind_t *kind, svn_wc_context_t *wc_ctx, const char *abspath, svn_boolean_t show_hidden, apr_pool_t *scratch_pool)
Similar to svn_wc_read_kind2() but with show_deleted always passed as TRUE.
svn_error_t * svn_wc_read_kind2(svn_node_kind_t *kind, svn_wc_context_t *wc_ctx, const char *local_abspath, svn_boolean_t show_deleted, svn_boolean_t show_hidden, apr_pool_t *scratch_pool)
Set kind to the svn_node_kind_t of abspath.
const svn_version_t * svn_wc_version(void)
Get libsvn_wc version information.