Subversion
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Fields
svn_wc_status3_t Struct Reference

Structure for holding the "status" of a working copy item. More...

#include <svn_wc.h>

Data Fields

svn_node_kind_t kind
 The kind of node as recorded in the working copy.
 
svn_depth_t depth
 The depth of the node as recorded in the working copy (svn_depth_unknown for files or when no depth is set)
 
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 a file at all). More...
 
svn_boolean_t versioned
 If the path is under version control, versioned is TRUE, otherwise FALSE. More...
 
svn_boolean_t conflicted
 Set to TRUE if the item is the victim of a conflict. More...
 
enum svn_wc_status_kind node_status
 The status of the node itself. More...
 
enum svn_wc_status_kind text_status
 The status of the entry's text. More...
 
enum svn_wc_status_kind prop_status
 The status of the entry's properties. More...
 
svn_boolean_t copied
 a file or directory can be 'copied' if it's scheduled for addition-with-history (or part of a subtree that is scheduled as such.).
 
svn_revnum_t revision
 Base revision. More...
 
svn_revnum_t changed_rev
 Last revision this was changed.
 
apr_time_t changed_date
 Date of last commit. More...
 
const char * changed_author
 Last commit author of this item.
 
const char * repos_root_url
 The URL of the repository.
 
const char * repos_uuid
 The UUID of the repository.
 
const char * repos_relpath
 The in-repository path relative to the repository root. More...
 
svn_boolean_t switched
 a file or directory can be 'switched' if the switch command has been used. More...
 
svn_boolean_t locked
 This directory has a working copy lock.
 
const svn_lock_tlock
 The repository file lock. More...
 
const char * changelist
 Which changelist this item is part of, or NULL if not part of any. More...
 
svn_node_kind_t ood_kind
 Set to the node kind of the youngest commit, or svn_node_none if not out of date. More...
 
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.
 
enum svn_wc_status_kind repos_text_status
 The entry's text status in the repository. More...
 
enum svn_wc_status_kind repos_prop_status
 The entry's property status in the repository. More...
 
const svn_lock_trepos_lock
 The entry's lock in the repository, if any. More...
 
svn_revnum_t ood_changed_rev
 Set to the youngest committed revision, or SVN_INVALID_REVNUM if not out of date. More...
 
apr_time_t ood_changed_date
 Set to the most recent commit date, or 0 if not out of date. More...
 
const char * ood_changed_author
 Set to the user name of the youngest commit, or NULL if not out of date or non-existent. More...
 
const char * moved_from_abspath
 Set to the local absolute path that this node was moved from, if this file or directory has been moved here locally and is the root of that move. More...
 
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 away locally and corresponds to the root of the destination side of the move. More...
 
svn_boolean_t file_external
 TRUE iff the item is a file brought in by an svn:externals definition. More...
 
svn_node_kind_t actual_kind
 The actual kind of the node in the working copy. More...
 

Detailed Description

Structure for holding the "status" of a working copy item.

Note
Fields may be added to the end of this structure in future versions. Therefore, to preserve binary compatibility, users should not directly allocate structures of this type.
Since
New in 1.7.

Definition at line 3686 of file svn_wc.h.

Field Documentation

svn_node_kind_t svn_wc_status3_t::actual_kind

The actual kind of the node in the working copy.

May differ from kind on obstructions, deletes, etc. svn_node_unknown if unavailable.

Since
New in 1.9

Definition at line 3843 of file svn_wc.h.

apr_time_t svn_wc_status3_t::changed_date

Date of last commit.

Definition at line 3728 of file svn_wc.h.

const char* svn_wc_status3_t::changelist

Which changelist this item is part of, or NULL if not part of any.

Definition at line 3755 of file svn_wc.h.

svn_boolean_t svn_wc_status3_t::conflicted

Set to TRUE if the item is the victim of a conflict.

Definition at line 3704 of file svn_wc.h.

svn_boolean_t svn_wc_status3_t::file_external

TRUE iff the item is a file brought in by an svn:externals definition.

Since
New in 1.8.

Definition at line 3836 of file svn_wc.h.

svn_filesize_t svn_wc_status3_t::filesize

The actual size of the working file on disk, or SVN_INVALID_FILESIZE if unknown (or if the item isn't a file at all).

Definition at line 3697 of file svn_wc.h.

const svn_lock_t* svn_wc_status3_t::lock

The repository file lock.

(Values of path, token, owner, comment and are available if a lock is present)

Definition at line 3752 of file svn_wc.h.

const char* svn_wc_status3_t::moved_from_abspath

Set to the local absolute path that this node was moved from, if this file or directory has been moved here locally and is the root of that move.

Otherwise set to NULL.

This will be NULL for moved-here nodes that are just part of a subtree that was moved along (and are not themselves a root of a different move operation).

Since
New in 1.8.

Definition at line 3810 of file svn_wc.h.

const char* svn_wc_status3_t::moved_to_abspath

Set to the local absolute path that this node was moved to, if this file or directory has been moved away locally and corresponds to the root of the destination side of the move.

Otherwise set to NULL.

Note: Saying just "root" here could be misleading. For example: svn mv A AA; svn mv AA/B BB; creates a situation where A/B is moved-to BB, but one could argue that the move source's root actually was AA/B. Note that, as far as the working copy is concerned, above case is exactly identical to: svn mv A/B BB; svn mv A AA; In both situations, moved_to_abspath would be set for nodes A (moved to AA) and A/B (moved to BB), only.

This will be NULL for moved-away nodes that were just part of a subtree that was moved along (and are not themselves a root of a different move operation).

Since
New in 1.8.

Definition at line 3832 of file svn_wc.h.

enum svn_wc_status_kind svn_wc_status3_t::node_status

The status of the node itself.

In order of precedence: Obstructions, structural changes, text changes.

Definition at line 3708 of file svn_wc.h.

enum svn_wc_status_kind svn_wc_status3_t::prop_status

The status of the entry's properties.

Definition at line 3714 of file svn_wc.h.

const char* svn_wc_status3_t::repos_relpath

The in-repository path relative to the repository root.

Definition at line 3740 of file svn_wc.h.

svn_revnum_t svn_wc_status3_t::revision

Base revision.

Definition at line 3722 of file svn_wc.h.

svn_boolean_t svn_wc_status3_t::switched

a file or directory can be 'switched' if the switch command has been used.

If this is TRUE, then file_external will be FALSE.

Definition at line 3745 of file svn_wc.h.

enum svn_wc_status_kind svn_wc_status3_t::text_status

The status of the entry's text.

Definition at line 3711 of file svn_wc.h.

svn_boolean_t svn_wc_status3_t::versioned

If the path is under version control, versioned is TRUE, otherwise FALSE.

Definition at line 3701 of file svn_wc.h.


The documentation for this struct was generated from the following file: