svn_props.h

Go to the documentation of this file.

/* ==================================================================== */

#ifndef SVN_PROPS_H
#define SVN_PROPS_H

#include <apr_pools.h>   /* for apr_pool_t */
#include <apr_tables.h>  /* for apr_array_header_t */
#include <apr_hash.h>    /* for apr_hash_t */

#include "svn_types.h"   /* for svn_boolean_t, svn_error_t */
#include "svn_string.h"  /* for svn_string_t */

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */



typedef struct svn_prop_t
{
  const char *name;           
  const svn_string_t *value;  
} svn_prop_t;


svn_prop_t *
svn_prop_dup(const svn_prop_t *prop,
             apr_pool_t *pool);


apr_array_header_t *
svn_prop_array_dup(const apr_array_header_t *array,
                   apr_pool_t *pool);


typedef struct svn_prop_inherited_item_t
{
  const char *path_or_url;

  apr_hash_t *prop_hash;

} svn_prop_inherited_item_t;


apr_array_header_t *
svn_prop_hash_to_array(const apr_hash_t *hash,
                       apr_pool_t *pool);

apr_hash_t *
svn_prop_array_to_hash(const apr_array_header_t *properties,
                       apr_pool_t *result);

apr_hash_t *
svn_prop_hash_dup(const apr_hash_t *hash,
                  apr_pool_t *pool);

const char *
svn_prop_get_value(const apr_hash_t *properties,
                   const char *prop_name);

typedef enum svn_prop_kind
{
  svn_prop_entry_kind,

  svn_prop_wc_kind,

  svn_prop_regular_kind
} svn_prop_kind_t;

svn_prop_kind_t
svn_property_kind2(const char *prop_name);

SVN_DEPRECATED
svn_prop_kind_t
svn_property_kind(int *prefix_len,
                  const char *prop_name);


svn_boolean_t
svn_prop_is_svn_prop(const char *prop_name);


svn_boolean_t
svn_prop_has_svn_prop(const apr_hash_t *props,
                      apr_pool_t *pool);

svn_boolean_t
svn_prop_is_boolean(const char *prop_name);

svn_boolean_t
svn_prop_is_known_svn_rev_prop(const char *prop_name);

svn_boolean_t
svn_prop_is_known_svn_node_prop(const char *prop_name);

svn_boolean_t
svn_prop_is_known_svn_file_prop(const char *prop_name);

svn_boolean_t
svn_prop_is_known_svn_dir_prop(const char *prop_name);

svn_boolean_t
svn_prop_needs_translation(const char *prop_name);


svn_error_t *
svn_categorize_props(const apr_array_header_t *proplist,
                     apr_array_header_t **entry_props,
                     apr_array_header_t **wc_props,
                     apr_array_header_t **regular_props,
                     apr_pool_t *pool);


svn_error_t *
svn_prop_diffs(apr_array_header_t **propdiffs,
               const apr_hash_t *target_props,
               const apr_hash_t *source_props,
               apr_pool_t *pool);


svn_boolean_t
svn_prop_name_is_valid(const char *prop_name);



/* Defines for reserved ("svn:") property names.  */

#define SVN_PROP_PREFIX "svn:"


#define SVN_PROP_BOOLEAN_TRUE "*"

#define SVN_PROP_MIME_TYPE  SVN_PROP_PREFIX "mime-type"

#define SVN_PROP_IGNORE  SVN_PROP_PREFIX "ignore"

#define SVN_PROP_EOL_STYLE  SVN_PROP_PREFIX "eol-style"

#define SVN_PROP_KEYWORDS  SVN_PROP_PREFIX "keywords"

#define SVN_PROP_EXECUTABLE  SVN_PROP_PREFIX "executable"

#define SVN_PROP_EXECUTABLE_VALUE SVN_PROP_BOOLEAN_TRUE

#define SVN_PROP_NEEDS_LOCK  SVN_PROP_PREFIX "needs-lock"

#define SVN_PROP_NEEDS_LOCK_VALUE SVN_PROP_BOOLEAN_TRUE

#define SVN_PROP_SPECIAL  SVN_PROP_PREFIX "special"

#define SVN_PROP_SPECIAL_VALUE SVN_PROP_BOOLEAN_TRUE

#define SVN_PROP_EXTERNALS  SVN_PROP_PREFIX "externals"

#define SVN_PROP_MERGEINFO SVN_PROP_PREFIX "mergeinfo"

#define SVN_PROP_INHERITABLE_AUTO_PROPS SVN_PROP_PREFIX "auto-props"

#define SVN_PROP_INHERITABLE_IGNORES SVN_PROP_PREFIX "global-ignores"

#define SVN_PROP_TEXT_TIME  SVN_PROP_PREFIX "text-time"

#define SVN_PROP_OWNER SVN_PROP_PREFIX "owner"

#define SVN_PROP_GROUP  SVN_PROP_PREFIX "group"

#define SVN_PROP_UNIX_MODE  SVN_PROP_PREFIX "unix-mode"
 /* Meta-data properties */

#define SVN_PROP_NODE_ALL_PROPS SVN_PROP_MIME_TYPE, \
                                SVN_PROP_IGNORE, \
                                SVN_PROP_EOL_STYLE, \
                                SVN_PROP_KEYWORDS, \
                                SVN_PROP_EXECUTABLE, \
                                SVN_PROP_NEEDS_LOCK, \
                                SVN_PROP_SPECIAL, \
                                SVN_PROP_EXTERNALS, \
                                SVN_PROP_MERGEINFO, \
                                SVN_PROP_INHERITABLE_AUTO_PROPS, \
                                SVN_PROP_INHERITABLE_IGNORES, \
                                \
                                SVN_PROP_TEXT_TIME, \
                                SVN_PROP_OWNER, \
                                SVN_PROP_GROUP, \
                                SVN_PROP_UNIX_MODE,

#define SVN_PROP_WC_PREFIX     SVN_PROP_PREFIX "wc:"

#define SVN_PROP_ENTRY_PREFIX  SVN_PROP_PREFIX "entry:"

#define SVN_PROP_ENTRY_COMMITTED_REV     SVN_PROP_ENTRY_PREFIX "committed-rev"

#define SVN_PROP_ENTRY_COMMITTED_DATE    SVN_PROP_ENTRY_PREFIX "committed-date"

#define SVN_PROP_ENTRY_LAST_AUTHOR       SVN_PROP_ENTRY_PREFIX "last-author"

#define SVN_PROP_ENTRY_UUID       SVN_PROP_ENTRY_PREFIX "uuid"

#define SVN_PROP_ENTRY_LOCK_TOKEN SVN_PROP_ENTRY_PREFIX "lock-token"

#define SVN_PROP_CUSTOM_PREFIX SVN_PROP_PREFIX "custom:"

#define SVN_PROP_REVISION_AUTHOR  SVN_PROP_PREFIX "author"

#define SVN_PROP_REVISION_LOG  SVN_PROP_PREFIX "log"

#define SVN_PROP_REVISION_DATE  SVN_PROP_PREFIX "date"

#define SVN_PROP_REVISION_ORIG_DATE  SVN_PROP_PREFIX "original-date"

#define SVN_PROP_REVISION_AUTOVERSIONED  SVN_PROP_PREFIX "autoversioned"


/* More reserved revision props in the 'svn:' namespace, used by the
   svnsync tool:   */

#define SVNSYNC_PROP_PREFIX             SVN_PROP_PREFIX "sync-"

/* The following revision properties are set on revision 0 of
 * destination repositories by svnsync:
 */

#define SVNSYNC_PROP_LOCK               SVNSYNC_PROP_PREFIX "lock"

#define SVNSYNC_PROP_FROM_URL           SVNSYNC_PROP_PREFIX "from-url"

#define SVNSYNC_PROP_FROM_UUID          SVNSYNC_PROP_PREFIX "from-uuid"

#define SVNSYNC_PROP_LAST_MERGED_REV    SVNSYNC_PROP_PREFIX "last-merged-rev"

#define SVNSYNC_PROP_CURRENTLY_COPYING  SVNSYNC_PROP_PREFIX "currently-copying"


#define SVN_PROP_REVISION_ALL_PROPS SVN_PROP_REVISION_AUTHOR, \
                                    SVN_PROP_REVISION_LOG, \
                                    SVN_PROP_REVISION_DATE, \
                                    SVN_PROP_REVISION_AUTOVERSIONED, \
                                    SVN_PROP_REVISION_ORIG_DATE, \
                                    SVNSYNC_PROP_LOCK, \
                                    SVNSYNC_PROP_FROM_URL, \
                                    SVNSYNC_PROP_FROM_UUID, \
                                    SVNSYNC_PROP_LAST_MERGED_REV, \
                                    SVNSYNC_PROP_CURRENTLY_COPYING,

#define SVN_PROP_TXN_PREFIX  SVN_PROP_PREFIX "txn-"

#define SVN_PROP_TXN_CLIENT_COMPAT_VERSION \
            SVN_PROP_TXN_PREFIX "client-compat-version"

#define SVN_PROP_TXN_USER_AGENT \
            SVN_PROP_TXN_PREFIX "user-agent"

#define SVN_PROP_REVISION_PREFIX  SVN_PROP_PREFIX "revision-"




#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* SVN_PROPS_H */