working copy status.

Data Structures
struct	svn_wc_status2_t
struct	svn_wc_status_t
Typedefs
typedef svn_wc_status2_t	svn_wc_status2_t
typedef svn_wc_status_t	svn_wc_status_t
typedef void(*	svn_wc_status_func2_t )(void *baton, const char *path, svn_wc_status2_t *status)
typedef void(*	svn_wc_status_func_t )(void *baton, const char *path, svn_wc_status_t *status)
Enumerations
enum	svn_wc_status_kind {   svn_wc_status_none = 1,   svn_wc_status_unversioned,   svn_wc_status_normal,   svn_wc_status_added,   svn_wc_status_missing,   svn_wc_status_deleted,   svn_wc_status_replaced,   svn_wc_status_modified,   svn_wc_status_merged,   svn_wc_status_conflicted,   svn_wc_status_ignored,   svn_wc_status_obstructed,   svn_wc_status_external,   svn_wc_status_incomplete }
Functions
svn_wc_status2_t *	svn_wc_dup_status2 (svn_wc_status2_t *orig_stat, apr_pool_t *pool)
svn_wc_status_t *	svn_wc_dup_status (svn_wc_status_t *orig_stat, apr_pool_t *pool)
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)
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)
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)
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)
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)

---

Detailed Description

We have two functions for getting working copy status: one function for getting the status of exactly one thing, and another for getting the statuses of (potentially) multiple things.

The WebDAV concept of "depth" may be useful in understanding the motivation behind this. Suppose we're getting the status of directory D. The three depth levels would mean

depth 0: D itself (just the named directory) depth 1: D and its immediate children (D + its entries) depth Infinity: D and all its descendants (full recursion)

To offer all three levels, we could have one unified function, taking a `depth' parameter. Unfortunately, because this function would have to handle multiple return values as well as the single return value case, getting the status of just one entity would become cumbersome: you'd have to roll through a hash to find one lone status.

So we have svn_wc_status() for depth 0, and svn_wc_get_status_editor() for depths 1 and 2, since the latter two involve multiple return values.

NOTE: The status structures may contain a NULL ->entry field. This indicates an item that is not versioned in the working copy.

---

Typedef Documentation

typedef struct svn_wc_status2_t svn_wc_status2_t

Since: New in 1.2. Structure for holding the "status" of a working copy item. The item's entry data is in entry, augmented and possibly shadowed by the other fields. entry is NULL if this item is not under version control. Note: Fields may be added to the end of this structure in future versions. Therefore, users shouldn't allocate structures of this type, to preserve binary compatibility.

typedef void(* svn_wc_status_func2_t)(void *baton, const char *path, svn_wc_status2_t *status)

Since: New in 1.2. A callback for reporting a status about path. baton is a closure object; it should be provided by the implementation, and passed by the caller. Definition at line 1579 of file svn_wc.h.

typedef void(* svn_wc_status_func_t)(void *baton, const char *path, svn_wc_status_t *status)

Deprecated: Provided for backwards compatibility with the 1.1 API. Same as svn_wc_status_func2_t(), but for older svn_wc_status_t structures. Definition at line 1587 of file svn_wc.h.

typedef struct svn_wc_status_t svn_wc_status_t

Deprecated: Provided for backwards compatibility with the 1.1 API. Same as svn_wc_status2_t, but without the svn_lock_t 'repos_lock' field.

---

Enumeration Type Documentation

enum svn_wc_status_kind

Enumerator: svn_wc_status_none  does not exist svn_wc_status_unversioned  is not a versioned thing in this wc svn_wc_status_normal  exists, but uninteresting. svn_wc_status_added  is scheduled for addition svn_wc_status_missing  under v.c. , but is missing svn_wc_status_deleted  scheduled for deletion svn_wc_status_replaced  was deleted and then re-added svn_wc_status_modified  text or props have been modified svn_wc_status_merged  local mods received repos mods svn_wc_status_conflicted  local mods received conflicting repos mods svn_wc_status_ignored  a resource marked as ignored svn_wc_status_obstructed  an unversioned resource is in the way of the versioned resource svn_wc_status_external  an unversioned path populated by an svn:external property svn_wc_status_incomplete  a directory doesn't contain a complete entries list Definition at line 1378 of file svn_wc.h.

---

Function Documentation

svn_wc_status_t* svn_wc_dup_status (  svn_wc_status_t *  orig_stat, apr_pool_t *  pool )

Deprecated: Provided for backwards compatibility with the 1.1 API. Same as svn_wc_dup_status2(), but for older svn_wc_status_t structures.

svn_wc_status2_t* svn_wc_dup_status2 (  svn_wc_status2_t *  orig_stat, apr_pool_t *  pool )

Since: New in 1.2. Return a deep copy of the orig_stat status structure, allocated in pool.

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 )

Deprecated: Provided for backwards compatibility with the 1.1 API. Same as svn_wc_get_status_editor2, but with set_locks_baton set to NULL, and taking a deprecated svn_wc_status_func_t argument.

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 )

Since: New in 1.2. Set *editor and *edit_baton to an editor that generates svn_wc_status2_t structures and sends them through status_func / status_baton. anchor is an access baton, with a tree lock, for the local path to the working copy which will be used as the root of our editor. If target is not empty, it represents an entry in the anchor path which is the subject of the editor drive (otherwise, the anchor is the subject). If set_locks_baton is non-NULL, it will be set to a baton that can be used in a call to the svn_wc_status_set_repos_locks function. Callers drive this editor to describe working copy out-of-dateness with respect to the repository. If this information is not available or not desired, callers should simply call the close_edit() function of the editor vtable. If the editor driver calls editor's set_target_revision() vtable function, then when the edit drive is completed, *edit_revision will contain the revision delivered via that interface, and any status items reported during the drive will have their repos_rev field set to this same revision. config is a hash mapping SVN_CONFIG_CATEGORY's to svn_config_t's. Assuming the target is a directory, then: If get_all is false, then only locally-modified entries will be returned. If true, then all entries will be returned. If recurse is false, status structures will be returned only for the target and its immediate children. Otherwise, this operation is fully recursive. If no_ignore is set, statuses that would typically be ignored will instead be reported. If cancel_func is non-null, call it with cancel_baton while building the statushash to determine if the client has cancelled the operation. If traversal_info is non-null, then record pre-update traversal state in it. (Caller should obtain traversal_info from svn_wc_init_traversal_info.) Allocate the editor itself in pool, but the editor does temporary allocations in a subpool of pool.

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 )

Deprecated: Provided for backwards compatibility with the 1.1 API. Same as svn_wc_status2(), but for older svn_wc_status_t structures.

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 )

Since: New in 1.2. Fill *status for path, allocating in pool, with the exception of the repos_rev field, which is normally filled in by the caller. adm_access must be an access baton for path. Here are some things to note about the returned structure. A quick examination of the status->text_status after a successful return of this function can reveal the following things: svn_wc_status_none : path is not versioned, and is either not present on disk, or is ignored by svn's default ignore regular expressions or the svn:ignore property setting for path's parent directory. svn_wc_status_missing : path is versioned, but is missing from the working copy. svn_wc_status_unversioned : path is not versioned, but is present on disk and not being ignored (see above). The other available results for the text_status field are more straightforward in their meanings. See the comments on the svn_wc_status_kind structure for some hints.

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 )

Since: New in 1.2. Associate locks, a hash table mapping const char* absolute repository paths to svn_lock_t objects, with a set_locks_baton returned by an earlier call to svn_wc_get_status_editor2. repos_root is the repository root URL. Perform all allocations in pool. Note: locks will not be copied, so it must be valid throughout the edit. pool must also not be destroyed or cleared before the edit is finished.

---