Success build TortoiseMerge.

[tortoisegit/TortoiseGitJp.git] / src / TortoiseMerge / svninclude / svn_types.h

/**\r
 * @copyright\r
 * ====================================================================\r
 * Copyright (c) 2000-2008 CollabNet.  All rights reserved.\r
 *\r
 * This software is licensed as described in the file COPYING, which\r
 * you should have received as part of this distribution.  The terms\r
 * are also available at http://subversion.tigris.org/license-1.html.\r
 * If newer versions of this license are posted there, you may use a\r
 * newer version instead, at your option.\r
 *\r
 * This software consists of voluntary contributions made by many\r
 * individuals.  For exact contribution history, see the revision\r
 * history and logs, available at http://subversion.tigris.org/.\r
 * ====================================================================\r
 * @endcopyright\r
 *\r
 * @file svn_types.h\r
 * @brief Subversion's data types\r
 */\r
\r
#ifndef SVN_TYPES_H\r
#define SVN_TYPES_H\r
\r
/* ### this should go away, but it causes too much breakage right now */\r
#include <stdlib.h>\r
\r
#include <apr.h>         /* for apr_size_t, apr_int64_t, ... */\r
#include <apr_errno.h>   /* for apr_status_t */\r
#include <apr_pools.h>   /* for apr_pool_t */\r
#include <apr_hash.h>    /* for apr_hash_t */\r
#include <apr_tables.h>  /* for apr_array_push() */\r
#include <apr_time.h>    /* for apr_time_t */\r
#include <apr_strings.h> /* for apr_atoi64() */\r
\r
#define _(x) x\r
#define N_(x) x\r
#ifdef __cplusplus\r
extern "C" {\r
#endif /* __cplusplus */\r
\r
\r
\f\r
/** Macro used to mark deprecated functions.\r
 *\r
 * @since New in 1.6.\r
 */\r
#ifndef SVN_DEPRECATED\r
#if !defined(SWIGPERL) && !defined(SWIGPYTHON) && !defined(SWIGRUBY)\r
#if defined(__GNUC__) && (__GNUC__ >= 4 || (__GNUC__==3 && __GNUC_MINOR__>=1))\r
#define SVN_DEPRECATED __attribute__((deprecated))\r
#elif defined(_MSC_VER) && _MSC_VER >= 1300\r
#define SVN_DEPRECATED __declspec(deprecated)\r
#else\r
#define SVN_DEPRECATED\r
#endif\r
#else\r
#define SVN_DEPRECATED\r
#endif\r
#endif\r
\r
\r
\f\r
/** Subversion error object.\r
 *\r
 * Defined here, rather than in svn_error.h, to avoid a recursive @#include\r
 * situation.\r
 */\r
typedef struct svn_error_t\r
{\r
  /** APR error value, possibly SVN_ custom err */\r
  apr_status_t apr_err;\r
\r
  /** details from producer of error */\r
  const char *message;\r
\r
  /** ptr to the error we "wrap" */\r
  struct svn_error_t *child;\r
\r
  /** The pool holding this error and any child errors it wraps */\r
  apr_pool_t *pool;\r
\r
  /** Source file where the error originated.  Only used iff @c SVN_DEBUG. */\r
  const char *file;\r
\r
  /** Source line where the error originated.  Only used iff @c SVN_DEBUG. */\r
  long line;\r
\r
} svn_error_t;\r
\r
\r
\f\r
/** @defgroup APR_ARRAY_compat_macros APR Array Compatibility Helper Macros\r
 * These macros are provided by APR itself from version 1.3.\r
 * Definitions are provided here for when using older versions of APR.\r
 * @{\r
 */\r
\r
/** index into an apr_array_header_t */\r
#ifndef APR_ARRAY_IDX\r
#define APR_ARRAY_IDX(ary,i,type) (((type *)(ary)->elts)[i])\r
#endif\r
\r
/** easier array-pushing syntax */\r
#ifndef APR_ARRAY_PUSH\r
#define APR_ARRAY_PUSH(ary,type) (*((type *)apr_array_push(ary)))\r
#endif\r
\r
/** @} */\r
\f\r
/** The various types of nodes in the Subversion filesystem. */\r
typedef enum\r
{\r
  /** absent */\r
  svn_node_none,\r
\r
  /** regular file */\r
  svn_node_file,\r
\r
  /** directory */\r
  svn_node_dir,\r
\r
  /** something's here, but we don't know what */\r
  svn_node_unknown\r
} svn_node_kind_t;\r
\r
/** Return a constant string expressing @a kind as an English word, e.g.,\r
 * "file", "dir", etc.  The string is not localized, as it may be used for\r
 * client<->server communications.  If the kind is not recognized, return\r
 * "unknown".\r
 *\r
 * @since New in 1.6.\r
 */\r
const char *\r
svn_node_kind_to_word(svn_node_kind_t kind);\r
\r
/** Return the appropriate node_kind for @a word.  @a word is as\r
 * returned from svn_node_kind_to_word().  If @a word does not\r
 * represent a recognized kind or is @c NULL, return @c svn_node_unknown.\r
 *\r
 * @since New in 1.6.\r
 */\r
svn_node_kind_t\r
svn_node_kind_from_word(const char *word);\r
\r
/** About Special Files in Subversion\r
 *\r
 * Subversion denotes files that cannot be portably created or\r
 * modified as "special" files (svn_node_special).  It stores these\r
 * files in the repository as a plain text file with the svn:special\r
 * property set.  The file contents contain: a platform-specific type\r
 * string, a space character, then any information necessary to create\r
 * the file on a supported platform.  For example, if a symbolic link\r
 * were being represented, the repository file would have the\r
 * following contents:\r
 *\r
 * "link /path/to/link/target"\r
 *\r
 * Where 'link' is the identifier string showing that this special\r
 * file should be a symbolic link and '/path/to/link/target' is the\r
 * destination of the symbolic link.\r
 *\r
 * Special files are stored in the text-base exactly as they are\r
 * stored in the repository.  The platform specific files are created\r
 * in the working copy at EOL/keyword translation time using\r
 * svn_subst_copy_and_translate2().  If the current platform does not\r
 * support a specific special file type, the file is copied into the\r
 * working copy as it is seen in the repository.  Because of this,\r
 * users of other platforms can still view and modify the special\r
 * files, even if they do not have their unique properties.\r
 *\r
 * New types of special files can be added by:\r
 *  1. Implementing a platform-dependent routine to create a uniquely\r
 *     named special file and one to read the special file in\r
 *     libsvn_subr/io.c.\r
 *  2. Creating a new textual name similar to\r
 *     SVN_SUBST__SPECIAL_LINK_STR in libsvn_subr/subst.c.\r
 *  3. Handling the translation/detranslation case for the new type in\r
 *     create_special_file and detranslate_special_file, using the\r
 *     routines from 1.\r
 */\r
\r
/** A revision number. */\r
typedef long int svn_revnum_t;\r
\r
/** Valid revision numbers begin at 0 */\r
#define SVN_IS_VALID_REVNUM(n) ((n) >= 0)\r
\r
/** The 'official' invalid revision num */\r
#define SVN_INVALID_REVNUM ((svn_revnum_t) -1)\r
\r
/** Not really invalid...just unimportant -- one day, this can be its\r
 * own unique value, for now, just make it the same as\r
 * @c SVN_INVALID_REVNUM.\r
 */\r
#define SVN_IGNORED_REVNUM ((svn_revnum_t) -1)\r
\r
/** Convert NULL-terminated C string @a str to a revision number. */\r
#define SVN_STR_TO_REV(str) ((svn_revnum_t) atol(str))\r
\r
/**\r
 * Parse NULL-terminated C string @a str as a revision number and\r
 * store its value in @a rev.  If @a endptr is non-NULL, then the\r
 * address of the first non-numeric character in @a str is stored in\r
 * it.  If there are no digits in @a str, then @a endptr is set (if\r
 * non-NULL), and the error @c SVN_ERR_REVNUM_PARSE_FAILURE error is\r
 * returned.  Negative numbers parsed from @a str are considered\r
 * invalid, and result in the same error.\r
 *\r
 * @since New in 1.5.\r
 */\r
svn_error_t *\r
svn_revnum_parse(svn_revnum_t *rev,\r
                 const char *str,\r
                 const char **endptr);\r
\r
/** Originally intended to be used in printf()-style functions to format\r
 * revision numbers.  Deprecated due to incompatibilities with language\r
 * translation tools (e.g. gettext).\r
 *\r
 * New code should use a bare "%ld" format specifier for formatting revision\r
 * numbers.\r
 *\r
 * @deprecated Provided for backward compatibility with the 1.0 API.\r
 */\r
#define SVN_REVNUM_T_FMT "ld"\r
\r
\r
/** The size of a file in the Subversion FS. */\r
typedef apr_int64_t svn_filesize_t;\r
\r
/** The 'official' invalid file size constant. */\r
#define SVN_INVALID_FILESIZE ((svn_filesize_t) -1)\r
\r
/** In printf()-style functions, format file sizes using this. */\r
#define SVN_FILESIZE_T_FMT APR_INT64_T_FMT\r
\r
#ifndef DOXYGEN_SHOULD_SKIP_THIS\r
/* Parse a base-10 numeric string into a 64-bit unsigned numeric value. */\r
/* NOTE: Private. For use by Subversion's own code only. See issue #1644. */\r
/* FIXME: APR should supply a function to do this, such as "apr_atoui64". */\r
#define svn__atoui64(X) ((apr_uint64_t) apr_atoi64(X))\r
#endif\r
\r
\r
/** YABT:  Yet Another Boolean Type */\r
typedef int svn_boolean_t;\r
\r
#ifndef TRUE\r
/** uhh... true */\r
#define TRUE 1\r
#endif /* TRUE */\r
\r
#ifndef FALSE\r
/** uhh... false */\r
#define FALSE 0\r
#endif /* FALSE */\r
\r
\r
/** An enum to indicate whether recursion is needed. */\r
enum svn_recurse_kind\r
{\r
  svn_nonrecursive = 1,\r
  svn_recursive\r
};\r
\r
/** The concept of depth for directories.\r
 *\r
 * @note This is similar to, but not exactly the same as, the WebDAV\r
 * and LDAP concepts of depth.\r
 *\r
 * @since New in 1.5.\r
 */\r
typedef enum\r
{\r
  /* The order of these depths is important: the higher the number,\r
     the deeper it descends.  This allows us to compare two depths\r
     numerically to decide which should govern. */\r
\r
  /* Depth undetermined or ignored.  In some contexts, this means the\r
     client should choose an appropriate default depth.  The server\r
     will generally treat it as @c svn_depth_infinity. */\r
  svn_depth_unknown    = -2,\r
\r
  /* Exclude (i.e., don't descend into) directory D. */\r
  /* NOTE: In Subversion 1.5, svn_depth_exclude is *not* supported\r
     anywhere in the client-side (libsvn_wc/libsvn_client/etc) code;\r
     it is only supported as an argument to set_path functions in the\r
     ra and repos reporters.  (This will enable future versions of\r
     Subversion to run updates, etc, against 1.5 servers with proper\r
     svn_depth_exclude behavior, once we get a chance to implement\r
     client-side support for svn_depth_exclude.)\r
  */\r
  svn_depth_exclude    = -1,\r
\r
  /* Just the named directory D, no entries.  Updates will not pull in\r
     any files or subdirectories not already present. */\r
  svn_depth_empty      =  0,\r
\r
  /* D + its file children, but not subdirs.  Updates will pull in any\r
     files not already present, but not subdirectories. */\r
  svn_depth_files      =  1,\r
\r
  /* D + immediate children (D and its entries).  Updates will pull in\r
     any files or subdirectories not already present; those\r
     subdirectories' this_dir entries will have depth-empty. */\r
  svn_depth_immediates =  2,\r
\r
  /* D + all descendants (full recursion from D).  Updates will pull\r
     in any files or subdirectories not already present; those\r
     subdirectories' this_dir entries will have depth-infinity.\r
     Equivalent to the pre-1.5 default update behavior. */\r
  svn_depth_infinity   =  3\r
\r
} svn_depth_t;\r
\r
\r
/** Return a constant string expressing @a depth as an English word,\r
 * e.g., "infinity", "immediates", etc.  The string is not localized,\r
 * as it may be used for client<->server communications.\r
 *\r
 * @since New in 1.5.\r
 */\r
const char *\r
svn_depth_to_word(svn_depth_t depth);\r
\r
\r
/** Return the appropriate depth for @a depth_str.  @a word is as\r
 * returned from svn_depth_to_word().  If @a depth_str does not\r
 * represent a recognized depth, return @c svn_depth_unknown.\r
 *\r
 * @since New in 1.5.\r
 */\r
svn_depth_t\r
svn_depth_from_word(const char *word);\r
\r
\r
/* Return @c svn_depth_infinity if boolean @a recurse is TRUE, else\r
 * return @c svn_depth_files.\r
 *\r
 * @note New code should never need to use this, it is called only\r
 * from pre-depth APIs, for compatibility.\r
 *\r
 * @since New in 1.5.\r
 */\r
#define SVN_DEPTH_INFINITY_OR_FILES(recurse) \\r
  ((recurse) ? svn_depth_infinity : svn_depth_files)\r
\r
\r
/* Return @c svn_depth_infinity if boolean @a recurse is TRUE, else\r
 * return @c svn_depth_immediates.\r
 *\r
 * @note New code should never need to use this, it is called only\r
 * from pre-depth APIs, for compatibility.\r
 *\r
 * @since New in 1.5.\r
 */\r
#define SVN_DEPTH_INFINITY_OR_IMMEDIATES(recurse) \\r
  ((recurse) ? svn_depth_infinity : svn_depth_immediates)\r
\r
\r
/* Return @c svn_depth_infinity if boolean @a recurse is TRUE, else\r
 * return @c svn_depth_empty.\r
 *\r
 * @note New code should never need to use this, it is called only\r
 * from pre-depth APIs, for compatibility.\r
 *\r
 * @since New in 1.5.\r
 */\r
#define SVN_DEPTH_INFINITY_OR_EMPTY(recurse) \\r
  ((recurse) ? svn_depth_infinity : svn_depth_empty)\r
\r
\r
/* Return a recursion boolean based on @a depth.\r
 *\r
 * Although much code has been converted to use depth, some code still\r
 * takes a recurse boolean.  In most cases, it makes sense to treat\r
 * unknown or infinite depth as recursive, and any other depth as\r
 * non-recursive (which in turn usually translates to @c svn_depth_files).\r
 */\r
#define SVN_DEPTH_IS_RECURSIVE(depth)                              \\r
  (((depth) == svn_depth_infinity || (depth) == svn_depth_unknown) \\r
   ? TRUE : FALSE)\r
\r
\r
/**\r
 * It is sometimes convenient to indicate which parts of an @c svn_dirent_t\r
 * object you are actually interested in, so that calculating and sending\r
 * the data corresponding to the other fields can be avoided.  These values\r
 * can be used for that purpose.\r
 *\r
 * @defgroup svn_dirent_fields Dirent fields\r
 * @{\r
 */\r
\r
/** An indication that you are interested in the @c kind field */\r
#define SVN_DIRENT_KIND        0x00001\r
\r
/** An indication that you are interested in the @c size field */\r
#define SVN_DIRENT_SIZE        0x00002\r
\r
/** An indication that you are interested in the @c has_props field */\r
#define SVN_DIRENT_HAS_PROPS   0x00004\r
\r
/** An indication that you are interested in the @c created_rev field */\r
#define SVN_DIRENT_CREATED_REV 0x00008\r
\r
/** An indication that you are interested in the @c time field */\r
#define SVN_DIRENT_TIME        0x00010\r
\r
/** An indication that you are interested in the @c last_author field */\r
#define SVN_DIRENT_LAST_AUTHOR 0x00020\r
\r
/** A combination of all the dirent fields */\r
#define SVN_DIRENT_ALL ~((apr_uint32_t ) 0)\r
\r
/** @} */\r
\r
/** A general subversion directory entry. */\r
typedef struct svn_dirent_t\r
{\r
  /** node kind */\r
  svn_node_kind_t kind;\r
\r
  /** length of file text, or 0 for directories */\r
  svn_filesize_t size;\r
\r
  /** does the node have props? */\r
  svn_boolean_t has_props;\r
\r
  /** last rev in which this node changed */\r
  svn_revnum_t created_rev;\r
\r
  /** time of created_rev (mod-time) */\r
  apr_time_t time;\r
\r
  /** author of created_rev */\r
  const char *last_author;\r
\r
  /* IMPORTANT: If you extend this struct, check svn_dirent_dup(). */\r
} svn_dirent_t;\r
\r
\r
/** Return a deep copy of @a dirent, allocated in @a pool.\r
 *\r
 * @since New in 1.4.\r
 */\r
svn_dirent_t *\r
svn_dirent_dup(const svn_dirent_t *dirent,\r
               apr_pool_t *pool);\r
\r
\f\r
\r
/** Keyword substitution.\r
 *\r
 * All the keywords Subversion recognizes.\r
 *\r
 * Note that there is a better, more general proposal out there, which\r
 * would take care of both internationalization issues and custom\r
 * keywords (e.g., $NetBSD$).  See\r
 *\r
 * @verbatim\r
      http://subversion.tigris.org/servlets/ReadMsg?list=dev&msgNo=8921\r
      =====\r
      From: "Jonathan M. Manning" <jmanning@alisa-jon.net>\r
      To: dev@subversion.tigris.org\r
      Date: Fri, 14 Dec 2001 11:56:54 -0500\r
      Message-ID: <87970000.1008349014@bdldevel.bl.bdx.com>\r
      Subject: Re: keywords @endverbatim\r
 *\r
 * and Eric Gillespie's support of same:\r
 *\r
 * @verbatim\r
      http://subversion.tigris.org/servlets/ReadMsg?list=dev&msgNo=8757\r
      =====\r
      From: "Eric Gillespie, Jr." <epg@pretzelnet.org>\r
      To: dev@subversion.tigris.org\r
      Date: Wed, 12 Dec 2001 09:48:42 -0500\r
      Message-ID: <87k7vsebp1.fsf@vger.pretzelnet.org>\r
      Subject: Re: Customizable Keywords @endverbatim\r
 *\r
 * However, it is considerably more complex than the scheme below.\r
 * For now we're going with simplicity, hopefully the more general\r
 * solution can be done post-1.0.\r
 *\r
 * @defgroup svn_types_keywords Keyword definitions\r
 * @{\r
 */\r
\r
/** The maximum size of an expanded or un-expanded keyword. */\r
#define SVN_KEYWORD_MAX_LEN    255\r
\r
/** The most recent revision in which this file was changed. */\r
#define SVN_KEYWORD_REVISION_LONG    "LastChangedRevision"\r
\r
/** Short version of LastChangedRevision */\r
#define SVN_KEYWORD_REVISION_SHORT   "Rev"\r
\r
/** Medium version of LastChangedRevision, matching the one CVS uses.\r
 * @since New in 1.1. */\r
#define SVN_KEYWORD_REVISION_MEDIUM  "Revision"\r
\r
/** The most recent date (repository time) when this file was changed. */\r
#define SVN_KEYWORD_DATE_LONG        "LastChangedDate"\r
\r
/** Short version of LastChangedDate */\r
#define SVN_KEYWORD_DATE_SHORT       "Date"\r
\r
/** Who most recently committed to this file. */\r
#define SVN_KEYWORD_AUTHOR_LONG      "LastChangedBy"\r
\r
/** Short version of LastChangedBy */\r
#define SVN_KEYWORD_AUTHOR_SHORT     "Author"\r
\r
/** The URL for the head revision of this file. */\r
#define SVN_KEYWORD_URL_LONG         "HeadURL"\r
\r
/** Short version of HeadURL */\r
#define SVN_KEYWORD_URL_SHORT        "URL"\r
\r
/** A compressed combination of the other four keywords. */\r
#define SVN_KEYWORD_ID               "Id"\r
\r
/** A full combination of the first four keywords.\r
 * @since New in 1.6. */\r
#define SVN_KEYWORD_HEADER           "Header"\r
\r
/** @} */\r
\r
\f\r
/** All information about a commit.\r
 *\r
 * @note Objects of this type should always be created using the\r
 * svn_create_commit_info() function.\r
 *\r
 * @since New in 1.3.\r
 */\r
typedef struct svn_commit_info_t\r
{\r
  /** just-committed revision. */\r
  svn_revnum_t revision;\r
\r
  /** server-side date of the commit. */\r
  const char *date;\r
\r
  /** author of the commit. */\r
  const char *author;\r
\r
  /** error message from post-commit hook, or NULL. */\r
  const char *post_commit_err;\r
\r
} svn_commit_info_t;\r
\r
\f\r
/**\r
 * Allocate an object of type @c svn_commit_info_t in @a pool and\r
 * return it.\r
 *\r
 * The @c revision field of the new struct is set to @c\r
 * SVN_INVALID_REVNUM.  All other fields are initialized to @c NULL.\r
 *\r
 * @note Any object of the type @c svn_commit_info_t should\r
 * be created using this function.\r
 * This is to provide for extending the svn_commit_info_t in\r
 * the future.\r
 *\r
 * @since New in 1.3.\r
 */\r
svn_commit_info_t *\r
svn_create_commit_info(apr_pool_t *pool);\r
\r
\f\r
/**\r
 * Return a deep copy @a src_commit_info allocated in @a pool.\r
 *\r
 * @since New in 1.4.\r
 */\r
svn_commit_info_t *\r
svn_commit_info_dup(const svn_commit_info_t *src_commit_info,\r
                    apr_pool_t *pool);\r
\r
\f\r
/**\r
 * A structure to represent a path that changed for a log entry.\r
 *\r
 * @note To allow for extending the @c svn_log_changed_path2_t structure in\r
 * future releases, always use svn_log_changed_path2_create() to allocate\r
 * the structure.\r
 *\r
 * @since New in 1.6.\r
 */\r
typedef struct svn_log_changed_path2_t\r
{\r
  /** 'A'dd, 'D'elete, 'R'eplace, 'M'odify */\r
  char action;\r
\r
  /** Source path of copy (if any). */\r
  const char *copyfrom_path;\r
\r
  /** Source revision of copy (if any). */\r
  svn_revnum_t copyfrom_rev;\r
\r
  /** The type of the node, may be svn_node_unknown. */\r
  svn_node_kind_t node_kind;\r
\r
  /* NOTE: Add new fields at the end to preserve binary compatibility.\r
     Also, if you add fields here, you have to update\r
     svn_log_changed_path2_dup(). */\r
} svn_log_changed_path2_t;\r
\r
/**\r
 * Returns an @c svn_log_changed_path2_t, allocated in @a pool with all fields\r
 * initialized to NULL, None or empty values.\r
 *\r
 * @note To allow for extending the @c svn_log_changed_path2_t structure in\r
 * future releases, this function should always be used to allocate the\r
 * structure.\r
 *\r
 * @since New in 1.6.\r
 */\r
svn_log_changed_path2_t *\r
svn_log_changed_path2_create(apr_pool_t *pool);\r
\r
/**\r
 * Return a deep copy of @a changed_path, allocated in @a pool.\r
 *\r
 * @since New in 1.6.\r
 */\r
svn_log_changed_path2_t *\r
svn_log_changed_path2_dup(const svn_log_changed_path2_t *changed_path,\r
                          apr_pool_t *pool);\r
\r
/**\r
 * A structure to represent a path that changed for a log entry.  Same as\r
 * @c svn_log_changed_path2_t, but without the node kind.\r
 *\r
 * @deprecated Provided for backward compatibility with the 1.5 API.\r
 */\r
typedef struct svn_log_changed_path_t\r
{\r
  /** 'A'dd, 'D'elete, 'R'eplace, 'M'odify */\r
  char action;\r
\r
  /** Source path of copy (if any). */\r
  const char *copyfrom_path;\r
\r
  /** Source revision of copy (if any). */\r
  svn_revnum_t copyfrom_rev;\r
\r
} svn_log_changed_path_t;\r
\r
\r
/**\r
 * Return a deep copy of @a changed_path, allocated in @a pool.\r
 *\r
 * @since New in 1.3.\r
 * @deprecated Provided for backward compatibility with the 1.5 API.\r
 */\r
SVN_DEPRECATED\r
svn_log_changed_path_t *\r
svn_log_changed_path_dup(const svn_log_changed_path_t *changed_path,\r
                         apr_pool_t *pool);\r
\r
/**\r
 * A structure to represent all the information about a particular log entry.\r
 *\r
 * @note To allow for extending the @c svn_log_entry_t structure in future\r
 * releases, always use svn_log_entry_create() to allocate the structure.\r
 *\r
 * @since New in 1.5.\r
 */\r
typedef struct svn_log_entry_t\r
{\r
  /** A hash containing as keys every path committed in @a revision; the\r
   * values are (@c svn_log_changed_path_t *) stuctures.\r
   *\r
   * The subversion core libraries will always set this field to the same\r
   * value as changed_paths2 for compatibity reasons.\r
   *\r
   * @deprecated Provided for backward compatibility with the 1.5 API.\r
   */\r
  apr_hash_t *changed_paths;\r
\r
  /** The revision of the commit. */\r
  svn_revnum_t revision;\r
\r
  /** The hash of requested revision properties, which may be NULL if it\r
   * would contain no revprops. */\r
  apr_hash_t *revprops;\r
\r
  /**\r
   * Whether or not this message has children.\r
   *\r
   * When a log operation requests additional merge information, extra log\r
   * entries may be returned as a result of this entry.  The new entries, are\r
   * considered children of the original entry, and will follow it.  When\r
   * the HAS_CHILDREN flag is set, the receiver should increment its stack\r
   * depth, and wait until an entry is provided with SVN_INVALID_REVNUM which\r
   * indicates the end of the children.\r
   *\r
   * For log operations which do not request additional merge information, the\r
   * HAS_CHILDREN flag is always FALSE.\r
   *\r
   * For more information see:\r
   * http://subversion.tigris.org/merge-tracking/design.html#commutative-reporting\r
   */\r
  svn_boolean_t has_children;\r
\r
  /** A hash containing as keys every path committed in @a revision; the\r
   * values are (@c svn_log_changed_path2_t *) stuctures.\r
   *\r
   * If this value is not @c NULL, it MUST have the same value as\r
   * changed_paths or svn_log_entry_dup() will not create an identical copy.\r
   *\r
   * The subversion core libraries will always set this field to the same\r
   * value as changed_paths for compatibity with users assuming an older\r
   * version.\r
   *\r
   * @since New in 1.6.\r
   */\r
  apr_hash_t *changed_paths2;\r
\r
  /* NOTE: Add new fields at the end to preserve binary compatibility.\r
     Also, if you add fields here, you have to update\r
     svn_log_entry_dup(). */\r
} svn_log_entry_t;\r
\r
/**\r
 * Returns an @c svn_log_entry_t, allocated in @a pool with all fields\r
 * initialized to NULL values.\r
 *\r
 * @note To allow for extending the @c svn_log_entry_t structure in future\r
 * releases, this function should always be used to allocate the structure.\r
 *\r
 * @since New in 1.5.\r
 */\r
svn_log_entry_t *\r
svn_log_entry_create(apr_pool_t *pool);\r
\r
/** Return a deep copy of @a log_entry, allocated in @a pool.\r
 *\r
 * The resulting svn_log_entry_t has @c changed_paths set to the same\r
 * value as @c changed_path2. @c changed_paths will be @c NULL if\r
 * @c changed_paths2 was @c NULL.\r
 *\r
 * @since New in 1.6.\r
 */\r
svn_log_entry_t *\r
svn_log_entry_dup(svn_log_entry_t *log_entry, apr_pool_t *pool);\r
\r
/** The callback invoked by log message loopers, such as\r
 * @c svn_ra_plugin_t.get_log() and svn_repos_get_logs().\r
 *\r
 * This function is invoked once on each log message, in the order\r
 * determined by the caller (see above-mentioned functions).\r
 *\r
 * @a baton is what you think it is, and @a log_entry contains relevent\r
 * information for the log message.  Any of @a log_entry->author,\r
 * @a log_entry->date, or @a log_entry->message may be @c NULL.\r
 *\r
 * If @a log_entry->date is neither NULL nor the empty string, it was\r
 * generated by svn_time_to_cstring() and can be converted to\r
 * @c apr_time_t with svn_time_from_cstring().\r
 *\r
 * If @a log_entry->changed_paths is non-@c NULL, then it contains as keys\r
 * every path committed in @a log_entry->revision; the values are\r
 * (@c svn_log_changed_path_t *) structures.\r
 *\r
 * If @a log_entry->has_children is @c TRUE, the message will be followed\r
 * immediately by any number of merged revisions (child messages), which are\r
 * terminated by an invocation with SVN_INVALID_REVNUM.  This usage may\r
 * be recursive.\r
 *\r
 * Use @a pool for temporary allocation.  If the caller is iterating\r
 * over log messages, invoking this receiver on each, we recommend the\r
 * standard pool loop recipe: create a subpool, pass it as @a pool to\r
 * each call, clear it after each iteration, destroy it after the loop\r
 * is done.  (For allocation that must last beyond the lifetime of a\r
 * given receiver call, use a pool in @a baton.)\r
 *\r
 * @since New in 1.5.\r
 */\r
\r
typedef svn_error_t *(*svn_log_entry_receiver_t)\r
  (void *baton,\r
   svn_log_entry_t *log_entry,\r
   apr_pool_t *pool);\r
\r
/**\r
 * Similar to @c svn_log_entry_receiver_t, except this uses separate\r
 * parameters for each part of the log entry.\r
 *\r
 * @deprecated Provided for backward compatibility with the 1.4 API.\r
 */\r
typedef svn_error_t *(*svn_log_message_receiver_t)\r
  (void *baton,\r
   apr_hash_t *changed_paths,\r
   svn_revnum_t revision,\r
   const char *author,\r
   const char *date,  /* use svn_time_from_cstring() if need apr_time_t */\r
   const char *message,\r
   apr_pool_t *pool);\r
\r
\f\r
/** Callback function type for commits.\r
 *\r
 * When a commit succeeds, an instance of this is invoked with the\r
 * @a commit_info, along with the @a baton closure.\r
 * @a pool can be used for temporary allocations.\r
 *\r
 * @since New in 1.4.\r
 */\r
typedef svn_error_t *(*svn_commit_callback2_t)\r
  (const svn_commit_info_t *commit_info,\r
   void *baton,\r
   apr_pool_t *pool);\r
\r
/** Same as @c svn_commit_callback2_t, but uses individual\r
 * data elements instead of the @c svn_commit_info_t structure\r
 *\r
 * @deprecated Provided for backward compatibility with the 1.3 API.\r
 */\r
typedef svn_error_t *(*svn_commit_callback_t)\r
  (svn_revnum_t new_revision,\r
   const char *date,\r
   const char *author,\r
   void *baton);\r
\r
\f\r
/** A buffer size that may be used when processing a stream of data.\r
 *\r
 * @note We don't use this constant any longer, since it is considered to be\r
 * unnecessarily large.\r
 *\r
 * @deprecated Provided for backwards compatibility with the 1.3 API.\r
 */\r
#define SVN_STREAM_CHUNK_SIZE 102400\r
\r
#ifndef DOXYGEN_SHOULD_SKIP_THIS\r
/*\r
 * The maximum amount we (ideally) hold in memory at a time when\r
 * processing a stream of data.\r
 *\r
 * For example, when copying data from one stream to another, do it in\r
 * blocks of this size.\r
 *\r
 * NOTE: This is an internal macro, put here for convenience.\r
 * No public API may depend on the particular value of this macro.\r
 */\r
#define SVN__STREAM_CHUNK_SIZE 16384\r
#endif\r
\r
/** The maximum amount we can ever hold in memory. */\r
/* FIXME: Should this be the same as SVN_STREAM_CHUNK_SIZE? */\r
#define SVN_MAX_OBJECT_SIZE (((apr_size_t) -1) / 2)\r
\r
\r
\f\r
/* ### Note: despite being about mime-TYPES, these probably don't\r
 * ### belong in svn_types.h.  However, no other header is more\r
 * ### appropriate, and didn't feel like creating svn_validate.h for\r
 * ### so little.\r
 */\r
\r
/** Validate @a mime_type.\r
 *\r
 * If @a mime_type does not contain a "/", or ends with non-alphanumeric\r
 * data, return @c SVN_ERR_BAD_MIME_TYPE, else return success.\r
 *\r
 * Use @a pool only to find error allocation.\r
 *\r
 * Goal: to match both "foo/bar" and "foo/bar; charset=blah", without\r
 * being too strict about it, but to disallow mime types that have\r
 * quotes, newlines, or other garbage on the end, such as might be\r
 * unsafe in an HTTP header.\r
 */\r
svn_error_t *\r
svn_mime_type_validate(const char *mime_type,\r
                       apr_pool_t *pool);\r
\r
\r
/** Return FALSE iff @a mime_type is a textual type.\r
 *\r
 * All mime types that start with "text/" are textual, plus some special\r
 * cases (for example, "image/x-xbitmap").\r
 */\r
svn_boolean_t\r
svn_mime_type_is_binary(const char *mime_type);\r
\r
\r
\f\r
/** A user defined callback that subversion will call with a user defined\r
 * baton to see if the current operation should be continued.  If the operation\r
 * should continue, the function should return @c SVN_NO_ERROR, if not, it\r
 * should return @c SVN_ERR_CANCELLED.\r
 */\r
typedef svn_error_t *(*svn_cancel_func_t)(void *cancel_baton);\r
\r
\r
\f\r
/**\r
 * A lock object, for client & server to share.\r
 *\r
 * A lock represents the exclusive right to add, delete, or modify a\r
 * path.  A lock is created in a repository, wholly controlled by the\r
 * repository.  A "lock-token" is the lock's UUID, and can be used to\r
 * learn more about a lock's fields, and or/make use of the lock.\r
 * Because a lock is immutable, a client is free to not only cache the\r
 * lock-token, but the lock's fields too, for convenience.\r
 *\r
 * Note that the 'is_dav_comment' field is wholly ignored by every\r
 * library except for mod_dav_svn.  The field isn't even marshalled\r
 * over the network to the client.  Assuming lock structures are\r
 * created with apr_pcalloc(), a default value of 0 is universally safe.\r
 *\r
 * @note in the current implementation, only files are lockable.\r
 *\r
 * @since New in 1.2.\r
 */\r
typedef struct svn_lock_t\r
{\r
  const char *path;              /**< the path this lock applies to */\r
  const char *token;             /**< unique URI representing lock */\r
  const char *owner;             /**< the username which owns the lock */\r
  const char *comment;           /**< (optional) description of lock  */\r
  svn_boolean_t is_dav_comment;  /**< was comment made by generic DAV client? */\r
  apr_time_t creation_date;      /**< when lock was made */\r
  apr_time_t expiration_date;    /**< (optional) when lock will expire;\r
                                      If value is 0, lock will never expire. */\r
} svn_lock_t;\r
\r
/**\r
 * Returns an @c svn_lock_t, allocated in @a pool with all fields initialized\r
 * to NULL values.\r
 *\r
 * @note To allow for extending the @c svn_lock_t structure in the future\r
 * releases, this function should always be used to allocate the structure.\r
 *\r
 * @since New in 1.2.\r
 */\r
svn_lock_t *\r
svn_lock_create(apr_pool_t *pool);\r
\r
/**\r
 * Return a deep copy of @a lock, allocated in @a pool.\r
 *\r
 * @since New in 1.2.\r
 */\r
svn_lock_t *\r
svn_lock_dup(const svn_lock_t *lock, apr_pool_t *pool);\r
\r
/**\r
 * Return a formatted Universal Unique IDentifier (UUID) string.\r
 *\r
 * @since New in 1.4.\r
 */\r
const char *\r
svn_uuid_generate(apr_pool_t *pool);\r
\r
/**\r
 * Mergeinfo representing a merge of a range of revisions.\r
 *\r
 * @since New in 1.5\r
 */\r
typedef struct svn_merge_range_t\r
{\r
  /**\r
   * If the 'start' field is less than the 'end' field then 'start' is\r
   * exclusive and 'end' inclusive of the range described.  This is termed\r
   * a forward merge range.  If 'start' is greater than 'end' then the\r
   * opposite is true.  This is termed a reverse merge range.  If 'start'\r
   * equals 'end' the meaning of the range is not defined.\r
   */\r
  svn_revnum_t start;\r
  svn_revnum_t end;\r
\r
  /**\r
   * Whether this merge range should be inherited by treewise\r
   * descendants of the path to which the range applies. */\r
  svn_boolean_t inheritable;\r
} svn_merge_range_t;\r
\r
/**\r
 * Return a copy of @a range, allocated in @a pool.\r
 *\r
 * @since New in 1.5.\r
 */\r
svn_merge_range_t *\r
svn_merge_range_dup(svn_merge_range_t *range, apr_pool_t *pool);\r
\r
/**\r
 * Returns true if the changeset committed in revision @a rev is one\r
 * of the changesets in the range @a range.\r
 *\r
 * @since New in 1.5.\r
 */\r
svn_boolean_t\r
svn_merge_range_contains_rev(svn_merge_range_t *range, svn_revnum_t rev);\r
\r
\r
\f\r
/** @defgroup node_location_seg_reporting Node location segment reporting.\r
 *  @{ */\r
\r
/**\r
 * A representation of a segment of a object's version history with an\r
 * emphasis on the object's location in the repository as of various\r
 * revisions.\r
 *\r
 * @since New in 1.5.\r
 */\r
typedef struct svn_location_segment_t\r
{\r
  /** The beginning (oldest) and ending (youngest) revisions for this\r
      segment. */\r
  svn_revnum_t range_start;\r
  svn_revnum_t range_end;\r
\r
  /** The absolute (sans leading slash) path for this segment.  May be\r
      NULL to indicate gaps in an object's history.  */\r
  const char *path;\r
\r
} svn_location_segment_t;\r
\r
\r
/**\r
 * A callback invoked by generators of @c svn_location_segment_t\r
 * objects, used to report information about a versioned object's\r
 * history in terms of its location in the repository filesystem over\r
 * time.\r
 */\r
typedef svn_error_t *(*svn_location_segment_receiver_t)\r
  (svn_location_segment_t *segment,\r
   void *baton,\r
   apr_pool_t *pool);\r
\r
\r
/**\r
 * Return a deep copy of @a segment, allocated in @a pool.\r
 *\r
 * @since New in 1.5.\r
 */\r
svn_location_segment_t *\r
svn_location_segment_dup(svn_location_segment_t *segment,\r
                         apr_pool_t *pool);\r
/** @} */\r
\r
\r
#ifdef __cplusplus\r
}\r
#endif /* __cplusplus */\r
\r
\r
/*\r
 * Everybody and their brother needs to deal with svn_error_t, the error\r
 * codes, and whatever else. While they *should* go and include svn_error.h\r
 * in order to do that... bah. Let's just help everybody out and include\r
 * that header whenever somebody grabs svn_types.h.\r
 *\r
 * Note that we do this at the END of this header so that its contents\r
 * are available to svn_error.h (our guards will prevent the circular\r
 * include). We also need to do the include *outside* of the cplusplus\r
 * guard.\r
 */\r
#include "svn_error.h"\r
\r
\r
#endif /* SVN_TYPES_H */\r