#include <svn_wc.h>

Collaboration diagram for svn_wc_notify_t:

Public Attributes
const char *	path
svn_wc_notify_action_t	action
svn_node_kind_t	kind
const char *	mime_type
const svn_lock_t *	lock
svn_error_t *	err
svn_wc_notify_state_t	content_state
svn_wc_notify_state_t	prop_state
svn_wc_notify_lock_state_t	lock_state
svn_revnum_t	revision
const char *	changelist_name
svn_merge_range_t *	merge_range
const char *	url
const char *	path_prefix
const char *	prop_name
apr_hash_t *	rev_props
svn_revnum_t	old_revision
svn_linenum_t	hunk_matched_line
svn_linenum_t	hunk_fuzz

svn_linenum_t	hunk_original_start
svn_linenum_t	hunk_original_length
svn_linenum_t	hunk_modified_start
svn_linenum_t	hunk_modified_length

Detailed Description

Structure used in the svn_wc_notify_func2_t function.

kind, content_state, prop_state and lock_state are from after action, not before.

Note:: If action is svn_wc_notify_update_completed, then path has already been installed, so it is legitimate for an implementation of svn_wc_notify_func2_t to examine path in the working copy.; The purpose of the kind, mime_type, content_state, and prop_state fields is to provide "for free" information that an implementation is likely to want, and which it would otherwise be forced to deduce via expensive operations such as reading entries and properties. However, if the caller does not have this information, it will simply pass the corresponding `*_unknown' values, and it is up to the implementation how to handle that (i.e., whether to attempt deduction, or just to punt and give a less informative notification).; Callers of notification functions should use svn_wc_create_notify() or svn_wc_create_notify_url() to create structures of this type to allow for extensibility.

Since:: New in 1.2.

Definition at line 1342 of file svn_wc.h.

Member Data Documentation

svn_wc_notify_action_t svn_wc_notify_t::action

Action that describes what happened to svn_wc_notify_t.path.

Definition at line 1351 of file svn_wc.h.

const char* svn_wc_notify_t::changelist_name

If action pertains to a changelist, this is the changelist name. In all other cases, it is NULL.

Since:: New in 1.5

Definition at line 1391 of file svn_wc.h.

svn_wc_notify_state_t svn_wc_notify_t::content_state

The type of notification that is occurring about node content.

Definition at line 1372 of file svn_wc.h.

svn_error_t* svn_wc_notify_t::err

Points to an error describing the reason for the failure when action is one of the following: svn_wc_notify_failed_lock, svn_wc_notify_failed_unlock, svn_wc_notify_failed_external. Is NULL otherwise.

Definition at line 1369 of file svn_wc.h.

svn_linenum_t svn_wc_notify_t::hunk_fuzz

The fuzz factor the hunk was applied with.

Since:: New in 1.7

Definition at line 1442 of file svn_wc.h.

svn_linenum_t svn_wc_notify_t::hunk_matched_line

The line at which a hunk was matched (and applied).

Since:: New in 1.7.

Definition at line 1438 of file svn_wc.h.

svn_linenum_t svn_wc_notify_t::hunk_modified_length

Definition at line 1433 of file svn_wc.h.

svn_linenum_t svn_wc_notify_t::hunk_modified_start

Definition at line 1432 of file svn_wc.h.

svn_linenum_t svn_wc_notify_t::hunk_original_length

Definition at line 1431 of file svn_wc.h.

svn_linenum_t svn_wc_notify_t::hunk_original_start

These fields are used by svn patch to identify the hunk the notification is for. They are line-based offsets and lengths parsed from the unidiff hunk header.

Since:: New in 1.7.

Definition at line 1430 of file svn_wc.h.

svn_node_kind_t svn_wc_notify_t::kind

Node kind of path.

Definition at line 1354 of file svn_wc.h.

const svn_lock_t* svn_wc_notify_t::lock

Points to the lock structure received from the repository when action is svn_wc_notify_locked. For other actions, it is NULL.

Definition at line 1363 of file svn_wc.h.

svn_wc_notify_lock_state_t svn_wc_notify_t::lock_state

Reflects the addition or removal of a lock token in the working copy.

Definition at line 1378 of file svn_wc.h.

svn_merge_range_t* svn_wc_notify_t::merge_range

When action is svn_wc_notify_merge_begin or svn_wc_notify_foreign_merge_begin or svn_wc_notify_merge_record_info_begin, and both the left and right sides of the merge are from the same URL. In all other cases, it is NULL.

Since:: New in 1.5

Definition at line 1398 of file svn_wc.h.

const char* svn_wc_notify_t::mime_type

If non-NULL, indicates the mime-type of path. It is always NULL for directories.

Definition at line 1358 of file svn_wc.h.

svn_revnum_t svn_wc_notify_t::old_revision

If action is svn_wc_notify_update_update or svn_wc_notify_update_add, contains the revision before the update. In all other cases, it is SVN_INVALID_REVNUM.

Since:: New in 1.7

Definition at line 1423 of file svn_wc.h.

const char* svn_wc_notify_t::path

Path, either absolute or relative to the current working directory (i.e., not relative to an anchor). path is "." or another valid path value for compatibility reasons when the real target is a url that is available in url.

Definition at line 1348 of file svn_wc.h.

const char* svn_wc_notify_t::path_prefix

If non-NULL, specifies an absolute path prefix that can be subtracted from the start of the absolute path in path or url. Its purpose is to allow notification to remove a common prefix from all the paths displayed for an operation.