Subversion
svn_types.h
Go to the documentation of this file.
1 /**
2  * @copyright
3  * ====================================================================
4  * Licensed to the Apache Software Foundation (ASF) under one
5  * or more contributor license agreements. See the NOTICE file
6  * distributed with this work for additional information
7  * regarding copyright ownership. The ASF licenses this file
8  * to you under the Apache License, Version 2.0 (the
9  * "License"); you may not use this file except in compliance
10  * with the License. You may obtain a copy of the License at
11  *
12  * http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing,
15  * software distributed under the License is distributed on an
16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17  * KIND, either express or implied. See the License for the
18  * specific language governing permissions and limitations
19  * under the License.
20  * ====================================================================
21  * @endcopyright
22  *
23  * @file svn_types.h
24  * @brief Subversion's data types
25  */
26 
27 #ifndef SVN_TYPES_H
28 #define SVN_TYPES_H
29 
30 #include "svn_types_impl.h"
31 
32 /* ### this should go away, but it causes too much breakage right now */
33 #include <stdlib.h>
34 #include <limits.h> /* for ULONG_MAX */
35 
36 #include <apr.h> /* for apr_size_t, apr_int64_t, ... */
37 #include <apr_version.h>
38 #include <apr_errno.h> /* for apr_status_t */
39 #include <apr_pools.h> /* for apr_pool_t */
40 #include <apr_hash.h> /* for apr_hash_t */
41 #include <apr_tables.h> /* for apr_array_push() */
42 #include <apr_time.h> /* for apr_time_t */
43 #include <apr_strings.h> /* for apr_atoi64() */
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif /* __cplusplus */
48 
49 
50 
51 /** Macro used to mark deprecated functions.
52  *
53  * @since New in 1.6.
54  */
55 #ifndef SVN_DEPRECATED
56 # if !defined(SWIGPERL) && !defined(SWIGPYTHON) && !defined(SWIGRUBY)
57 # if defined(__GNUC__) && (__GNUC__ >= 4 || (__GNUC__==3 && __GNUC_MINOR__>=1))
58 # define SVN_DEPRECATED __attribute__((deprecated))
59 # elif defined(_MSC_VER) && _MSC_VER >= 1300
60 # define SVN_DEPRECATED __declspec(deprecated)
61 # else
62 # define SVN_DEPRECATED
63 # endif
64 # else
65 # define SVN_DEPRECATED
66 # endif
67 #endif
68 
69 
70 /** Macro used to mark experimental functions.
71  *
72  * @since New in 1.9.
73  */
74 #ifndef SVN_EXPERIMENTAL
75 # if !defined(SWIGPERL) && !defined(SWIGPYTHON) && !defined(SWIGRUBY)
76 # if defined(__has_attribute)
77 # if __has_attribute(__warning__)
78 # define SVN_EXPERIMENTAL __attribute__((warning("experimental function used")))
79 # else
80 # define SVN_EXPERIMENTAL
81 # endif
82 # elif !defined(__llvm__) && defined(__GNUC__) \
83  && (__GNUC__ >= 4 || (__GNUC__==3 && __GNUC_MINOR__>=1))
84 # define SVN_EXPERIMENTAL __attribute__((warning("experimental function used")))
85 # elif defined(_MSC_VER) && _MSC_VER >= 1300
86 # define SVN_EXPERIMENTAL __declspec(deprecated("experimental function used"))
87 # else
88 # define SVN_EXPERIMENTAL
89 # endif
90 # else
91 # define SVN_EXPERIMENTAL
92 # endif
93 #endif
94 
95 /** Macro used to mark functions that require a final null sentinel argument.
96  *
97  * @since New in 1.9.
98  */
99 #ifndef SVN_NEEDS_SENTINEL_NULL
100 # if defined(__has_attribute)
101 # if __has_attribute(__sentinel__)
102 # define SVN_NEEDS_SENTINEL_NULL __attribute__((sentinel))
103 # else
104 # define SVN_NEEDS_SENTINEL_NULL
105 # endif
106 # elif defined(__GNUC__) && (__GNUC__ >= 4)
107 # define SVN_NEEDS_SENTINEL_NULL __attribute__((sentinel))
108 # else
109 # define SVN_NEEDS_SENTINEL_NULL
110 # endif
111 #endif
112 
113 
114 /** Indicate whether the current platform supports unaligned data access.
115  *
116  * On the majority of machines running SVN (x86 / x64), unaligned access
117  * is much cheaper than repeated aligned access. Define this macro to 1
118  * on those machines.
119  * Unaligned access on other machines (e.g. IA64) will trigger memory
120  * access faults or simply misbehave.
121  *
122  * Note: Some platforms may only support unaligned access for integers
123  * (PowerPC). As a result this macro should only be used to determine
124  * if unaligned access is supported for integers.
125  *
126  * @since New in 1.7.
127  */
128 #ifndef SVN_UNALIGNED_ACCESS_IS_OK
129 # if defined(_M_IX86) || defined(i386) \
130  || defined(_M_X64) || defined(__x86_64) \
131  || defined(__powerpc__) || defined(__ppc__)
132 # define SVN_UNALIGNED_ACCESS_IS_OK 1
133 # else
134 # define SVN_UNALIGNED_ACCESS_IS_OK 0
135 # endif
136 #endif
137 
138 
139 
140 /** YABT: Yet Another Boolean Type */
141 typedef int svn_boolean_t;
142 
143 #ifndef TRUE
144 /** uhh... true */
145 #define TRUE 1
146 #endif /* TRUE */
147 
148 #ifndef FALSE
149 /** uhh... false */
150 #define FALSE 0
151 #endif /* FALSE */
152 
153 
154 
155 /* Declaration of a unique type, never defined, for the SVN_VA_NULL macro.
156  *
157  * NOTE: Private. Not for direct use by third-party code.
158  */
159 struct svn__null_pointer_constant_stdarg_sentinel_t;
160 
161 /** Null pointer constant used as a sentinel in variable argument lists.
162  *
163  * Use of this macro ensures that the argument is of the correct size when a
164  * pointer is expected. (The macro @c NULL is not defined as a pointer on
165  * all systems, and the arguments to variadic functions are not converted
166  * automatically to the expected type.)
167  *
168  * @since New in 1.9.
169  */
170 #define SVN_VA_NULL ((struct svn__null_pointer_constant_stdarg_sentinel_t*)0)
171 /* See? (char*)NULL -- They have the same length, but the cast looks ugly. */
172 
173 
174 
175 /** Subversion error object.
176  *
177  * Defined here, rather than in svn_error.h, to avoid a recursive @#include
178  * situation.
179  */
180 typedef struct svn_error_t
181 {
182  /** APR error value; possibly an SVN_ custom error code (see
183  * `svn_error_codes.h' for a full listing).
184  */
185  apr_status_t apr_err;
186 
187  /** Details from the producer of error.
188  *
189  * Note that if this error was generated by Subversion's API, you'll
190  * probably want to use svn_err_best_message() to get a single
191  * descriptive string for this error chain (see the @a child member)
192  * or svn_handle_error2() to print the error chain in full. This is
193  * because Subversion's API functions sometimes add many links to
194  * the error chain that lack details (used only to produce virtual
195  * stack traces). (Use svn_error_purge_tracing() to remove those
196  * trace-only links from the error chain.)
197  */
198  const char *message;
199 
200  /** Pointer to the error we "wrap" (may be @c NULL). Via this
201  * member, individual error object can be strung together into an
202  * "error chain".
203  */
205 
206  /** The pool in which this error object is allocated. (If
207  * Subversion's APIs are used to manage error chains, then this pool
208  * will contain the whole error chain of which this object is a
209  * member.) */
210  apr_pool_t *pool;
211 
212  /** Source file where the error originated (iff @c SVN_DEBUG;
213  * undefined otherwise).
214  */
215  const char *file;
216 
217  /** Source line where the error originated (iff @c SVN_DEBUG;
218  * undefined otherwise).
219  */
220  long line;
221 
223 
224 
225 
226 /* See svn_version.h.
227  Defined here to avoid including svn_version.h from all public headers. */
228 typedef struct svn_version_t svn_version_t;
229 
230 
231 
232 /** @defgroup APR_ARRAY_compat_macros APR Array Compatibility Helper Macros
233  * These macros are provided by APR itself from version 1.3.
234  * Definitions are provided here for when using older versions of APR.
235  * @{
236  */
237 
238 /** index into an apr_array_header_t */
239 #ifndef APR_ARRAY_IDX
240 #define APR_ARRAY_IDX(ary,i,type) (((type *)(ary)->elts)[i])
241 #endif
242 
243 /** easier array-pushing syntax */
244 #ifndef APR_ARRAY_PUSH
245 #define APR_ARRAY_PUSH(ary,type) (*((type *)apr_array_push(ary)))
246 #endif
247 
248 /** @} */
249 
250 
251 
252 /** On Windows, APR_STATUS_IS_ENOTDIR includes several kinds of
253  * invalid-pathname error but not ERROR_INVALID_NAME, so we include it.
254  * We also include ERROR_DIRECTORY as that was not included in apr versions
255  * before 1.4.0 and this fix is not backported */
256 /* ### These fixes should go into APR. */
257 #ifndef WIN32
258 #define SVN__APR_STATUS_IS_ENOTDIR(s) APR_STATUS_IS_ENOTDIR(s)
259 #else
260 #define SVN__APR_STATUS_IS_ENOTDIR(s) (APR_STATUS_IS_ENOTDIR(s) \
261  || ((s) == APR_OS_START_SYSERR + ERROR_DIRECTORY) \
262  || ((s) == APR_OS_START_SYSERR + ERROR_INVALID_NAME))
263 #endif
264 
265 /** On Windows, APR_STATUS_IS_EPIPE does not include ERROR_NO_DATA error.
266  * So we include it.*/
267 /* ### These fixes should go into APR. */
268 #ifndef WIN32
269 #define SVN__APR_STATUS_IS_EPIPE(s) APR_STATUS_IS_EPIPE(s)
270 #else
271 #define SVN__APR_STATUS_IS_EPIPE(s) (APR_STATUS_IS_EPIPE(s) \
272  || ((s) == APR_OS_START_SYSERR + ERROR_NO_DATA))
273 #endif
274 
275 /** @} */
276 
277 
278 
279 /* NOTE: svn_node_kind_t is defined in svn_types_impl.h */
280 
281 /** Return a constant string expressing @a kind as an English word, e.g.,
282  * "file", "dir", etc. The string is not localized, as it may be used for
283  * client<->server communications. If the kind is not recognized, return
284  * "unknown".
285  *
286  * @since New in 1.6.
287  */
288 const char *
290 
291 /** Return the appropriate node_kind for @a word. @a word is as
292  * returned from svn_node_kind_to_word(). If @a word does not
293  * represent a recognized kind or is @c NULL, return #svn_node_unknown.
294  *
295  * @since New in 1.6.
296  */
298 svn_node_kind_from_word(const char *word);
299 
300 
301 /* NOTE: svn_tristate_t is defined in svn_types_impl.h */
302 
303 /** Return a constant string "true", "false" or NULL representing the value of
304  * @a tristate.
305  *
306  * @since New in 1.7.
307  */
308 const char *
310 
311 /** Return the appropriate tristate for @a word. If @a word is "true", returns
312  * #svn_tristate_true; if @a word is "false", returns #svn_tristate_false,
313  * for all other values (including NULL) returns #svn_tristate_unknown.
314  *
315  * @since New in 1.7.
316  */
318 svn_tristate__from_word(const char * word);
319 
320 
321 
322 /** About Special Files in Subversion
323  *
324  * Subversion denotes files that cannot be portably created or
325  * modified as "special" files (svn_node_special). It stores these
326  * files in the repository as a plain text file with the svn:special
327  * property set. The file contents contain: a platform-specific type
328  * string, a space character, then any information necessary to create
329  * the file on a supported platform. For example, if a symbolic link
330  * were being represented, the repository file would have the
331  * following contents:
332  *
333  * "link /path/to/link/target"
334  *
335  * Where 'link' is the identifier string showing that this special
336  * file should be a symbolic link and '/path/to/link/target' is the
337  * destination of the symbolic link.
338  *
339  * Special files are stored in the text-base exactly as they are
340  * stored in the repository. The platform specific files are created
341  * in the working copy at EOL/keyword translation time using
342  * svn_subst_copy_and_translate2(). If the current platform does not
343  * support a specific special file type, the file is copied into the
344  * working copy as it is seen in the repository. Because of this,
345  * users of other platforms can still view and modify the special
346  * files, even if they do not have their unique properties.
347  *
348  * New types of special files can be added by:
349  * 1. Implementing a platform-dependent routine to create a uniquely
350  * named special file and one to read the special file in
351  * libsvn_subr/io.c.
352  * 2. Creating a new textual name similar to
353  * SVN_SUBST__SPECIAL_LINK_STR in libsvn_subr/subst.c.
354  * 3. Handling the translation/detranslation case for the new type in
355  * create_special_file_from_stream and detranslate_special_file, using the
356  * routines from 1.
357  */
358 
359 
360 
361 /* NOTE: svn_revnum_t and SVN_INVALID_REVNUM are defined in svn_types_impl.h */
362 
363 /** Valid revision numbers begin at 0 */
364 #define SVN_IS_VALID_REVNUM(n) ((n) >= 0)
365 
366 /** Not really invalid...just unimportant -- one day, this can be its
367  * own unique value, for now, just make it the same as
368  * #SVN_INVALID_REVNUM.
369  */
370 #define SVN_IGNORED_REVNUM ((svn_revnum_t) -1)
371 
372 /** Convert NULL-terminated C string @a str to a revision number. */
373 #define SVN_STR_TO_REV(str) ((svn_revnum_t) atol(str))
374 
375 /**
376  * Parse NULL-terminated C string @a str as a revision number and
377  * store its value in @a rev. If @a endptr is non-NULL, then the
378  * address of the first non-numeric character in @a str is stored in
379  * it. If there are no digits in @a str, then @a endptr is set (if
380  * non-NULL), and the error #SVN_ERR_REVNUM_PARSE_FAILURE error is
381  * returned. Negative numbers parsed from @a str are considered
382  * invalid, and result in the same error.
383  *
384  * @since New in 1.5.
385  */
386 svn_error_t *
388  const char *str,
389  const char **endptr);
390 
391 /** Originally intended to be used in printf()-style functions to format
392  * revision numbers. Deprecated due to incompatibilities with language
393  * translation tools (e.g. gettext).
394  *
395  * New code should use a bare "%ld" format specifier for formatting revision
396  * numbers.
397  *
398  * @deprecated Provided for backward compatibility with the 1.0 API.
399  */
400 #define SVN_REVNUM_T_FMT "ld"
401 
402 
403 
404 /** The size of a file in the Subversion FS. */
405 typedef apr_int64_t svn_filesize_t;
406 
407 /** The 'official' invalid file size constant. */
408 #define SVN_INVALID_FILESIZE ((svn_filesize_t) -1)
409 
410 /** In printf()-style functions, format file sizes using this. */
411 #define SVN_FILESIZE_T_FMT APR_INT64_T_FMT
412 
413 #ifndef DOXYGEN_SHOULD_SKIP_THIS
414 /* Parse a base-10 numeric string into a 64-bit unsigned numeric value. */
415 /* NOTE: Private. For use by Subversion's own code only. See issue #1644. */
416 /* FIXME: APR should supply a function to do this, such as "apr_atoui64". */
417 #define svn__atoui64(X) ((apr_uint64_t) apr_atoi64(X))
418 #endif
419 
420 
421 
422 /** An enum to indicate whether recursion is needed. */
424 {
425  svn_nonrecursive = 1,
426  svn_recursive
427 };
428 
429 /* NOTE: svn_depth_t is defined in svn_types_impl.h */
430 
431 /** Return a constant string expressing @a depth as an English word,
432  * e.g., "infinity", "immediates", etc. The string is not localized,
433  * as it may be used for client<->server communications.
434  *
435  * @since New in 1.5.
436  */
437 const char *
439 
440 /** Return the appropriate depth for @a depth_str. @a word is as
441  * returned from svn_depth_to_word(). If @a depth_str does not
442  * represent a recognized depth, return #svn_depth_unknown.
443  *
444  * @since New in 1.5.
445  */
447 svn_depth_from_word(const char *word);
448 
449 /** Return #svn_depth_infinity if boolean @a recurse is TRUE, else
450  * return #svn_depth_files.
451  *
452  * @note New code should never need to use this, it is called only
453  * from pre-depth APIs, for compatibility.
454  *
455  * @since New in 1.5.
456  */
457 #define SVN_DEPTH_INFINITY_OR_FILES(recurse) \
458  ((recurse) ? svn_depth_infinity : svn_depth_files)
459 
460 /** Return #svn_depth_infinity if boolean @a recurse is TRUE, else
461  * return #svn_depth_immediates.
462  *
463  * @note New code should never need to use this, it is called only
464  * from pre-depth APIs, for compatibility.
465  *
466  * @since New in 1.5.
467  */
468 #define SVN_DEPTH_INFINITY_OR_IMMEDIATES(recurse) \
469  ((recurse) ? svn_depth_infinity : svn_depth_immediates)
470 
471 /** Return #svn_depth_infinity if boolean @a recurse is TRUE, else
472  * return #svn_depth_empty.
473  *
474  * @note New code should never need to use this, it is called only
475  * from pre-depth APIs, for compatibility.
476  *
477  * @since New in 1.5.
478  */
479 #define SVN_DEPTH_INFINITY_OR_EMPTY(recurse) \
480  ((recurse) ? svn_depth_infinity : svn_depth_empty)
481 
482 /** Return a recursion boolean based on @a depth.
483  *
484  * Although much code has been converted to use depth, some code still
485  * takes a recurse boolean. In most cases, it makes sense to treat
486  * unknown or infinite depth as recursive, and any other depth as
487  * non-recursive (which in turn usually translates to #svn_depth_files).
488  */
489 #define SVN_DEPTH_IS_RECURSIVE(depth) \
490  ((depth) == svn_depth_infinity || (depth) == svn_depth_unknown)
491 
492 
493 
494 /**
495  * It is sometimes convenient to indicate which parts of an #svn_dirent_t
496  * object you are actually interested in, so that calculating and sending
497  * the data corresponding to the other fields can be avoided. These values
498  * can be used for that purpose.
499  *
500  * @defgroup svn_dirent_fields Dirent fields
501  * @{
502  */
503 
504 /** An indication that you are interested in the @c kind field */
505 #define SVN_DIRENT_KIND 0x00001
506 
507 /** An indication that you are interested in the @c size field */
508 #define SVN_DIRENT_SIZE 0x00002
509 
510 /** An indication that you are interested in the @c has_props field */
511 #define SVN_DIRENT_HAS_PROPS 0x00004
512 
513 /** An indication that you are interested in the @c created_rev field */
514 #define SVN_DIRENT_CREATED_REV 0x00008
515 
516 /** An indication that you are interested in the @c time field */
517 #define SVN_DIRENT_TIME 0x00010
518 
519 /** An indication that you are interested in the @c last_author field */
520 #define SVN_DIRENT_LAST_AUTHOR 0x00020
521 
522 /** A combination of all the dirent fields */
523 #define SVN_DIRENT_ALL ~((apr_uint32_t ) 0)
524 
525 /** @} */
526 
527 /** A general subversion directory entry.
528  *
529  * @note To allow for extending the #svn_dirent_t structure in future
530  * releases, always use svn_dirent_create() to allocate the stucture.
531  *
532  * @since New in 1.6.
533  */
534 typedef struct svn_dirent_t
535 {
536  /** node kind */
538 
539  /** length of file text, otherwise SVN_INVALID_FILESIZE */
541 
542  /** does the node have props? */
544 
545  /** last rev in which this node changed */
547 
548  /** time of created_rev (mod-time) */
549  apr_time_t time;
550 
551  /** author of created_rev */
552  const char *last_author;
553 
554  /* IMPORTANT: If you extend this struct, check svn_dirent_dup(). */
556 
557 /** Return a deep copy of @a dirent, allocated in @a pool.
558  *
559  * @since New in 1.4.
560  */
561 svn_dirent_t *
563  apr_pool_t *pool);
564 
565 /**
566  * Create a new svn_dirent_t instance with all values initialized to their
567  * not-available values.
568  *
569  * @since New in 1.8.
570  */
571 svn_dirent_t *
572 svn_dirent_create(apr_pool_t *result_pool);
573 
574 
575 /** Keyword substitution.
576  *
577  * All the keywords Subversion recognizes.
578  *
579  * Note that there is a better, more general proposal out there, which
580  * would take care of both internationalization issues and custom
581  * keywords (e.g., $NetBSD$). See
582  *
583  * @verbatim
584  http://subversion.tigris.org/servlets/ReadMsg?list=dev&msgNo=8921
585  =====
586  From: "Jonathan M. Manning" <jmanning@alisa-jon.net>
587  To: dev@subversion.tigris.org
588  Date: Fri, 14 Dec 2001 11:56:54 -0500
589  Message-ID: <87970000.1008349014@bdldevel.bl.bdx.com>
590  Subject: Re: keywords @endverbatim
591  *
592  * and Eric Gillespie's support of same:
593  *
594  * @verbatim
595  http://subversion.tigris.org/servlets/ReadMsg?list=dev&msgNo=8757
596  =====
597  From: "Eric Gillespie, Jr." <epg@pretzelnet.org>
598  To: dev@subversion.tigris.org
599  Date: Wed, 12 Dec 2001 09:48:42 -0500
600  Message-ID: <87k7vsebp1.fsf@vger.pretzelnet.org>
601  Subject: Re: Customizable Keywords @endverbatim
602  *
603  * However, it is considerably more complex than the scheme below.
604  * For now we're going with simplicity, hopefully the more general
605  * solution can be done post-1.0.
606  *
607  * @defgroup svn_types_keywords Keyword definitions
608  * @{
609  */
610 
611 /** The maximum size of an expanded or un-expanded keyword. */
612 #define SVN_KEYWORD_MAX_LEN 255
613 
614 /** The most recent revision in which this file was changed. */
615 #define SVN_KEYWORD_REVISION_LONG "LastChangedRevision"
616 
617 /** Short version of LastChangedRevision */
618 #define SVN_KEYWORD_REVISION_SHORT "Rev"
619 
620 /** Medium version of LastChangedRevision, matching the one CVS uses.
621  * @since New in 1.1. */
622 #define SVN_KEYWORD_REVISION_MEDIUM "Revision"
623 
624 /** The most recent date (repository time) when this file was changed. */
625 #define SVN_KEYWORD_DATE_LONG "LastChangedDate"
626 
627 /** Short version of LastChangedDate */
628 #define SVN_KEYWORD_DATE_SHORT "Date"
629 
630 /** Who most recently committed to this file. */
631 #define SVN_KEYWORD_AUTHOR_LONG "LastChangedBy"
632 
633 /** Short version of LastChangedBy */
634 #define SVN_KEYWORD_AUTHOR_SHORT "Author"
635 
636 /** The URL for the head revision of this file. */
637 #define SVN_KEYWORD_URL_LONG "HeadURL"
638 
639 /** Short version of HeadURL */
640 #define SVN_KEYWORD_URL_SHORT "URL"
641 
642 /** A compressed combination of the other four keywords. */
643 #define SVN_KEYWORD_ID "Id"
644 
645 /** A full combination of the first four keywords.
646  * @since New in 1.6. */
647 #define SVN_KEYWORD_HEADER "Header"
648 
649 /** @} */
650 
651 
652 
653 /** All information about a commit.
654  *
655  * @note Objects of this type should always be created using the
656  * svn_create_commit_info() function.
657  *
658  * @since New in 1.3.
659  */
660 typedef struct svn_commit_info_t
661 {
662  /** just-committed revision. */
664 
665  /** server-side date of the commit. */
666  const char *date;
667 
668  /** author of the commit. */
669  const char *author;
670 
671  /** error message from post-commit hook, or NULL. */
672  const char *post_commit_err;
673 
674  /** repository root, may be @c NULL if unknown.
675  @since New in 1.7. */
676  const char *repos_root;
677 
679 
680 /**
681  * Allocate an object of type #svn_commit_info_t in @a pool and
682  * return it.
683  *
684  * The @c revision field of the new struct is set to #SVN_INVALID_REVNUM.
685  * All other fields are initialized to @c NULL.
686  *
687  * @note Any object of the type #svn_commit_info_t should
688  * be created using this function.
689  * This is to provide for extending the svn_commit_info_t in
690  * the future.
691  *
692  * @since New in 1.3.
693  */
695 svn_create_commit_info(apr_pool_t *pool);
696 
697 /**
698  * Return a deep copy @a src_commit_info allocated in @a pool.
699  *
700  * @since New in 1.4.
701  */
703 svn_commit_info_dup(const svn_commit_info_t *src_commit_info,
704  apr_pool_t *pool);
705 
706 
707 
708 /**
709  * A structure to represent a path that changed for a log entry.
710  *
711  * @note To allow for extending the #svn_log_changed_path2_t structure in
712  * future releases, always use svn_log_changed_path2_create() to allocate
713  * the structure.
714  *
715  * @since New in 1.6.
716  */
718 {
719  /** 'A'dd, 'D'elete, 'R'eplace, 'M'odify */
720  char action;
721 
722  /** Source path of copy (if any). */
723  const char *copyfrom_path;
724 
725  /** Source revision of copy (if any). */
727 
728  /** The type of the node, may be svn_node_unknown. */
730 
731  /** Is the text modified, may be svn_tristate_unknown.
732  * @since New in 1.7. */
734 
735  /** Are properties modified, may be svn_tristate_unknown.
736  * @since New in 1.7. */
738 
739  /* NOTE: Add new fields at the end to preserve binary compatibility.
740  Also, if you add fields here, you have to update
741  svn_log_changed_path2_dup(). */
743 
744 /**
745  * Returns an #svn_log_changed_path2_t, allocated in @a pool with all fields
746  * initialized to NULL, None or empty values.
747  *
748  * @note To allow for extending the #svn_log_changed_path2_t structure in
749  * future releases, this function should always be used to allocate the
750  * structure.
751  *
752  * @since New in 1.6.
753  */
756 
757 /**
758  * Return a deep copy of @a changed_path, allocated in @a pool.
759  *
760  * @since New in 1.6.
761  */
764  apr_pool_t *pool);
765 
766 /**
767  * A structure to represent a path that changed for a log entry. Same as
768  * the first three fields of #svn_log_changed_path2_t.
769  *
770  * @deprecated Provided for backward compatibility with the 1.5 API.
771  */
773 {
774  /** 'A'dd, 'D'elete, 'R'eplace, 'M'odify */
775  char action;
776 
777  /** Source path of copy (if any). */
778  const char *copyfrom_path;
779 
780  /** Source revision of copy (if any). */
782 
784 
785 /**
786  * Return a deep copy of @a changed_path, allocated in @a pool.
787  *
788  * @since New in 1.3.
789  * @deprecated Provided for backward compatibility with the 1.5 API.
790  */
794  apr_pool_t *pool);
795 
796 /**
797  * A structure to represent all the information about a particular log entry.
798  *
799  * @note To allow for extending the #svn_log_entry_t structure in future
800  * releases, always use svn_log_entry_create() to allocate the structure.
801  *
802  * @since New in 1.5.
803  */
804 typedef struct svn_log_entry_t
805 {
806  /** A hash containing as keys every path committed in @a revision; the
807  * values are (#svn_log_changed_path_t *) structures.
808  *
809  * The subversion core libraries will always set this field to the same
810  * value as changed_paths2 for compatibility reasons.
811  *
812  * @deprecated Provided for backward compatibility with the 1.5 API.
813  */
814  apr_hash_t *changed_paths;
815 
816  /** The revision of the commit. */
818 
819  /** The hash of requested revision properties, which may be NULL if it
820  * would contain no revprops. Maps (const char *) property name to
821  * (svn_string_t *) property value. */
822  apr_hash_t *revprops;
823 
824  /**
825  * Whether or not this message has children.
826  *
827  * When a log operation requests additional merge information, extra log
828  * entries may be returned as a result of this entry. The new entries, are
829  * considered children of the original entry, and will follow it. When
830  * the HAS_CHILDREN flag is set, the receiver should increment its stack
831  * depth, and wait until an entry is provided with SVN_INVALID_REVNUM which
832  * indicates the end of the children.
833  *
834  * For log operations which do not request additional merge information, the
835  * HAS_CHILDREN flag is always FALSE.
836  *
837  * For more information see:
838  * https://svn.apache.org/repos/asf/subversion/trunk/notes/merge-tracking/design.html#commutative-reporting
839  */
841 
842  /** A hash containing as keys every path committed in @a revision; the
843  * values are (#svn_log_changed_path2_t *) structures.
844  *
845  * If this value is not @c NULL, it MUST have the same value as
846  * changed_paths or svn_log_entry_dup() will not create an identical copy.
847  *
848  * The subversion core libraries will always set this field to the same
849  * value as changed_paths for compatibility with users assuming an older
850  * version.
851  *
852  * @note See http://svn.haxx.se/dev/archive-2010-08/0362.shtml for
853  * further explanation.
854  *
855  * @since New in 1.6.
856  */
857  apr_hash_t *changed_paths2;
858 
859  /**
860  * Whether @a revision should be interpreted as non-inheritable in the
861  * same sense of #svn_merge_range_t.
862  *
863  * Only set when this #svn_log_entry_t instance is returned by the
864  * libsvn_client mergeinfo apis. Currently always FALSE when the
865  * #svn_log_entry_t instance is reported by the ra layer.
866  *
867  * @since New in 1.7.
868  */
870 
871  /**
872  * Whether @a revision is a merged revision resulting from a reverse merge.
873  *
874  * @since New in 1.7.
875  */
877 
878  /* NOTE: Add new fields at the end to preserve binary compatibility.
879  Also, if you add fields here, you have to update
880  svn_log_entry_dup(). */
882 
883 /**
884  * Returns an #svn_log_entry_t, allocated in @a pool with all fields
885  * initialized to NULL values.
886  *
887  * @note To allow for extending the #svn_log_entry_t structure in future
888  * releases, this function should always be used to allocate the structure.
889  *
890  * @since New in 1.5.
891  */
893 svn_log_entry_create(apr_pool_t *pool);
894 
895 /** Return a deep copy of @a log_entry, allocated in @a pool.
896  *
897  * The resulting svn_log_entry_t has @c changed_paths set to the same
898  * value as @c changed_path2. @c changed_paths will be @c NULL if
899  * @c changed_paths2 was @c NULL.
900  *
901  * @since New in 1.6.
902  */
904 svn_log_entry_dup(const svn_log_entry_t *log_entry, apr_pool_t *pool);
905 
906 /** The callback invoked by log message loopers, such as
907  * #svn_ra_plugin_t.get_log() and svn_repos_get_logs().
908  *
909  * This function is invoked once on each log message, in the order
910  * determined by the caller (see above-mentioned functions).
911  *
912  * @a baton is what you think it is, and @a log_entry contains relevant
913  * information for the log message. Any of @a log_entry->author,
914  * @a log_entry->date, or @a log_entry->message may be @c NULL.
915  *
916  * If @a log_entry->date is neither NULL nor the empty string, it was
917  * generated by svn_time_to_cstring() and can be converted to
918  * @c apr_time_t with svn_time_from_cstring().
919  *
920  * If @a log_entry->changed_paths is non-@c NULL, then it contains as keys
921  * every path committed in @a log_entry->revision; the values are
922  * (#svn_log_changed_path_t *) structures.
923  *
924  * If @a log_entry->has_children is @c TRUE, the message will be followed
925  * immediately by any number of merged revisions (child messages), which are
926  * terminated by an invocation with SVN_INVALID_REVNUM. This usage may
927  * be recursive.
928  *
929  * Use @a pool for temporary allocation. If the caller is iterating
930  * over log messages, invoking this receiver on each, we recommend the
931  * standard pool loop recipe: create a subpool, pass it as @a pool to
932  * each call, clear it after each iteration, destroy it after the loop
933  * is done. (For allocation that must last beyond the lifetime of a
934  * given receiver call, use a pool in @a baton.)
935  *
936  * @since New in 1.5.
937  */
938 typedef svn_error_t *(*svn_log_entry_receiver_t)(
939  void *baton,
940  svn_log_entry_t *log_entry,
941  apr_pool_t *pool);
942 
943 /**
944  * Similar to #svn_log_entry_receiver_t, except this uses separate
945  * parameters for each part of the log entry.
946  *
947  * @deprecated Provided for backward compatibility with the 1.4 API.
948  */
949 typedef svn_error_t *(*svn_log_message_receiver_t)(
950  void *baton,
951  apr_hash_t *changed_paths,
952  svn_revnum_t revision,
953  const char *author,
954  const char *date, /* use svn_time_from_cstring() if need apr_time_t */
955  const char *message,
956  apr_pool_t *pool);
957 
958 
959 /** Callback function type for commits.
960  *
961  * When a commit succeeds, an instance of this is invoked with the
962  * @a commit_info, along with the @a baton closure.
963  * @a pool can be used for temporary allocations.
964  *
965  * @note Implementers of this callback that pass this callback to
966  * svn_ra_get_commit_editor3() should be careful with returning errors
967  * as these might be returned as commit errors. See the documentation
968  * of svn_ra_get_commit_editor3() for more details.
969  *
970  * @since New in 1.4.
971  */
972 typedef svn_error_t *(*svn_commit_callback2_t)(
973  const svn_commit_info_t *commit_info,
974  void *baton,
975  apr_pool_t *pool);
976 
977 /** Same as #svn_commit_callback2_t, but uses individual
978  * data elements instead of the #svn_commit_info_t structure
979  *
980  * @deprecated Provided for backward compatibility with the 1.3 API.
981  */
982 typedef svn_error_t *(*svn_commit_callback_t)(
983  svn_revnum_t new_revision,
984  const char *date,
985  const char *author,
986  void *baton);
987 
988 
989 
990 /** A buffer size that may be used when processing a stream of data.
991  *
992  * @note We don't use this constant any longer, since it is considered to be
993  * unnecessarily large.
994  *
995  * @deprecated Provided for backwards compatibility with the 1.3 API.
996  */
997 #define SVN_STREAM_CHUNK_SIZE 102400
998 
999 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1000 /*
1001  * The maximum amount we (ideally) hold in memory at a time when
1002  * processing a stream of data.
1003  *
1004  * For example, when copying data from one stream to another, do it in
1005  * blocks of this size.
1006  *
1007  * NOTE: This is an internal macro, put here for convenience.
1008  * No public API may depend on the particular value of this macro.
1009  */
1010 #define SVN__STREAM_CHUNK_SIZE 16384
1011 #endif
1012 
1013 /** The maximum amount we can ever hold in memory. */
1014 /* FIXME: Should this be the same as SVN_STREAM_CHUNK_SIZE? */
1015 #define SVN_MAX_OBJECT_SIZE (((apr_size_t) -1) / 2)
1017 
1018 
1019 /* ### Note: despite being about mime-TYPES, these probably don't
1020  * ### belong in svn_types.h. However, no other header is more
1021  * ### appropriate, and didn't feel like creating svn_validate.h for
1022  * ### so little.
1023  */
1024 
1025 /** Validate @a mime_type.
1026  *
1027  * If @a mime_type does not contain a "/", or ends with non-alphanumeric
1028  * data, return #SVN_ERR_BAD_MIME_TYPE, else return success.
1029  *
1030  * Use @a pool only to find error allocation.
1031  *
1032  * Goal: to match both "foo/bar" and "foo/bar; charset=blah", without
1033  * being too strict about it, but to disallow mime types that have
1034  * quotes, newlines, or other garbage on the end, such as might be
1035  * unsafe in an HTTP header.
1036  */
1037 svn_error_t *
1038 svn_mime_type_validate(const char *mime_type,
1039  apr_pool_t *pool);
1040 
1041 /** Return FALSE iff @a mime_type is a textual type.
1042  *
1043  * All mime types that start with "text/" are textual, plus some special
1044  * cases (for example, "image/x-xbitmap").
1045  */
1047 svn_mime_type_is_binary(const char *mime_type);
1048 
1049 
1050 
1051 /** A user defined callback that subversion will call with a user defined
1052  * baton to see if the current operation should be continued. If the operation
1053  * should continue, the function should return #SVN_NO_ERROR, if not, it
1054  * should return #SVN_ERR_CANCELLED.
1055  */
1056 typedef svn_error_t *(*svn_cancel_func_t)(void *cancel_baton);
1057 
1058 
1059 
1060 /**
1061  * A lock object, for client & server to share.
1062  *
1063  * A lock represents the exclusive right to add, delete, or modify a
1064  * path. A lock is created in a repository, wholly controlled by the
1065  * repository. A "lock-token" is the lock's UUID, and can be used to
1066  * learn more about a lock's fields, and or/make use of the lock.
1067  * Because a lock is immutable, a client is free to not only cache the
1068  * lock-token, but the lock's fields too, for convenience.
1069  *
1070  * Note that the 'is_dav_comment' field is wholly ignored by every
1071  * library except for mod_dav_svn. The field isn't even marshalled
1072  * over the network to the client. Assuming lock structures are
1073  * created with apr_pcalloc(), a default value of 0 is universally safe.
1074  *
1075  * @note in the current implementation, only files are lockable.
1076  *
1077  * @since New in 1.2.
1078  */
1079 typedef struct svn_lock_t
1080 {
1081  const char *path; /**< the path this lock applies to */
1082  const char *token; /**< unique URI representing lock */
1083  const char *owner; /**< the username which owns the lock */
1084  const char *comment; /**< (optional) description of lock */
1085  svn_boolean_t is_dav_comment; /**< was comment made by generic DAV client? */
1086  apr_time_t creation_date; /**< when lock was made */
1087  apr_time_t expiration_date; /**< (optional) when lock will expire;
1088  If value is 0, lock will never expire. */
1090 
1091 /**
1092  * Returns an #svn_lock_t, allocated in @a pool with all fields initialized
1093  * to NULL values.
1094  *
1095  * @note To allow for extending the #svn_lock_t structure in the future
1096  * releases, this function should always be used to allocate the structure.
1097  *
1098  * @since New in 1.2.
1099  */
1100 svn_lock_t *
1101 svn_lock_create(apr_pool_t *pool);
1102 
1103 /**
1104  * Return a deep copy of @a lock, allocated in @a pool.
1105  *
1106  * @since New in 1.2.
1107  */
1108 svn_lock_t *
1109 svn_lock_dup(const svn_lock_t *lock, apr_pool_t *pool);
1110 
1111 
1112 
1113 /**
1114  * Return a formatted Universal Unique IDentifier (UUID) string.
1115  *
1116  * @since New in 1.4.
1117  */
1118 const char *
1119 svn_uuid_generate(apr_pool_t *pool);
1120 
1121 
1122 
1123 /**
1124  * Mergeinfo representing a merge of a range of revisions.
1125  *
1126  * @since New in 1.5
1127  */
1128 typedef struct svn_merge_range_t
1129 {
1130  /**
1131  * If the 'start' field is less than the 'end' field then 'start' is
1132  * exclusive and 'end' inclusive of the range described. This is termed
1133  * a forward merge range. If 'start' is greater than 'end' then the
1134  * opposite is true. This is termed a reverse merge range. If 'start'
1135  * equals 'end' the meaning of the range is not defined.
1136  */
1138  svn_revnum_t end;
1139 
1140  /**
1141  * Whether this merge range should be inherited by treewise
1142  * descendants of the path to which the range applies. */
1145 
1146 /**
1147  * Return a copy of @a range, allocated in @a pool.
1148  *
1149  * @since New in 1.5.
1150  */
1152 svn_merge_range_dup(const svn_merge_range_t *range, apr_pool_t *pool);
1153 
1154 /**
1155  * Returns true if the changeset committed in revision @a rev is one
1156  * of the changesets in the range @a range.
1157  *
1158  * @since New in 1.5.
1159  */
1162 
1163 
1164 
1165 /** @defgroup node_location_seg_reporting Node location segment reporting.
1166  * @{ */
1167 
1168 /**
1169  * A representation of a segment of an object's version history with an
1170  * emphasis on the object's location in the repository as of various
1171  * revisions.
1172  *
1173  * @since New in 1.5.
1174  */
1176 {
1177  /** The beginning (oldest) and ending (youngest) revisions for this
1178  segment, both inclusive. */
1180  svn_revnum_t range_end;
1181 
1182  /** The absolute (sans leading slash) path for this segment. May be
1183  NULL to indicate gaps in an object's history. */
1184  const char *path;
1185 
1187 
1188 /**
1189  * A callback invoked by generators of #svn_location_segment_t
1190  * objects, used to report information about a versioned object's
1191  * history in terms of its location in the repository filesystem over
1192  * time.
1193  */
1194 typedef svn_error_t *(*svn_location_segment_receiver_t)(
1195  svn_location_segment_t *segment,
1196  void *baton,
1197  apr_pool_t *pool);
1198 
1199 /**
1200  * Return a deep copy of @a segment, allocated in @a pool.
1201  *
1202  * @since New in 1.5.
1203  */
1206  apr_pool_t *pool);
1207 
1208 /** @} */
1209 
1210 
1211 
1212 /** A line number, such as in a file or a stream.
1213  *
1214  * @since New in 1.7.
1215  */
1216 typedef unsigned long svn_linenum_t;
1217 
1218 /** The maximum value of an svn_linenum_t.
1219  *
1220  * @since New in 1.7.
1221  */
1222 #define SVN_LINENUM_MAX_VALUE ULONG_MAX
1224 
1225 
1226 #ifdef __cplusplus
1227 }
1228 #endif /* __cplusplus */
1229 
1230 
1231 /*
1232  * Everybody and their brother needs to deal with svn_error_t, the error
1233  * codes, and whatever else. While they *should* go and include svn_error.h
1234  * in order to do that... bah. Let's just help everybody out and include
1235  * that header whenever somebody grabs svn_types.h.
1236  *
1237  * Note that we do this at the END of this header so that its contents
1238  * are available to svn_error.h (our guards will prevent the circular
1239  * include). We also need to do the include *outside* of the cplusplus
1240  * guard.
1241  */
1242 #include "svn_error.h"
1243 
1244 
1245 /*
1246  * Subversion developers may want to use some additional debugging facilities
1247  * while working on the code. We'll pull that in here, so individual source
1248  * files don't have to include this header manually.
1249  */
1250 #ifdef SVN_DEBUG
1251 #include "private/svn_debug.h"
1252 #endif
1253 
1254 
1255 #endif /* SVN_TYPES_H */
svn_log_changed_path2_t
struct svn_log_changed_path2_t svn_log_changed_path2_t
A structure to represent a path that changed for a log entry.
svn_lock_t::path
const char * path
the path this lock applies to
Definition: svn_types.h:1081
svn_lock_t::expiration_date
apr_time_t expiration_date
(optional) when lock will expire; If value is 0, lock will never expire.
Definition: svn_types.h:1087
svn_types_impl.h
Subversion's data types (common implementation)
svn_merge_range_t::start
svn_revnum_t start
If the 'start' field is less than the 'end' field then 'start' is exclusive and 'end' inclusive of th...
Definition: svn_types.h:1137
svn_location_segment_t::range_start
svn_revnum_t range_start
The beginning (oldest) and ending (youngest) revisions for this segment, both inclusive.
Definition: svn_types.h:1179
svn_log_changed_path2_t::node_kind
svn_node_kind_t node_kind
The type of the node, may be svn_node_unknown.
Definition: svn_types.h:729
svn_commit_info_dup
svn_commit_info_t * svn_commit_info_dup(const svn_commit_info_t *src_commit_info, apr_pool_t *pool)
Return a deep copy src_commit_info allocated in pool.
svn_error_t
Subversion error object.
Definition: svn_types.h:181
svn_commit_info_t::date
const char * date
server-side date of the commit.
Definition: svn_types.h:666
svn_log_changed_path2_dup
svn_log_changed_path2_t * svn_log_changed_path2_dup(const svn_log_changed_path2_t *changed_path, apr_pool_t *pool)
Return a deep copy of changed_path, allocated in pool.
svn_error_t::child
struct svn_error_t * child
Pointer to the error we "wrap" (may be NULL).
Definition: svn_types.h:204
svn_create_commit_info
svn_commit_info_t * svn_create_commit_info(apr_pool_t *pool)
Allocate an object of type svn_commit_info_t in pool and return it.
svn_log_changed_path2_t
A structure to represent a path that changed for a log entry.
Definition: svn_types.h:718
svn_commit_info_t::post_commit_err
const char * post_commit_err
error message from post-commit hook, or NULL.
Definition: svn_types.h:672
svn_commit_info_t
All information about a commit.
Definition: svn_types.h:661
svn_commit_info_t::repos_root
const char * repos_root
repository root, may be NULL if unknown.
Definition: svn_types.h:676
svn_log_changed_path2_t::text_modified
svn_tristate_t text_modified
Is the text modified, may be svn_tristate_unknown.
Definition: svn_types.h:733
svn_tristate__from_word
svn_tristate_t svn_tristate__from_word(const char *word)
Return the appropriate tristate for word.
svn_mime_type_validate
svn_error_t * svn_mime_type_validate(const char *mime_type, apr_pool_t *pool)
Validate mime_type.
svn_log_entry_t::non_inheritable
svn_boolean_t non_inheritable
Whether revision should be interpreted as non-inheritable in the same sense of svn_merge_range_t.
Definition: svn_types.h:869
svn_log_changed_path2_t::copyfrom_path
const char * copyfrom_path
Source path of copy (if any).
Definition: svn_types.h:723
svn_error_t::file
const char * file
Source file where the error originated (iff SVN_DEBUG; undefined otherwise).
Definition: svn_types.h:215
svn_linenum_t
unsigned long svn_linenum_t
A line number, such as in a file or a stream.
Definition: svn_types.h:1216
svn_lock_dup
svn_lock_t * svn_lock_dup(const svn_lock_t *lock, apr_pool_t *pool)
Return a deep copy of lock, allocated in pool.
svn_dirent_t::time
apr_time_t time
time of created_rev (mod-time)
Definition: svn_types.h:549
svn_log_changed_path_t
A structure to represent a path that changed for a log entry.
Definition: svn_types.h:773
svn_depth_from_word
svn_depth_t svn_depth_from_word(const char *word)
Return the appropriate depth for depth_str.
svn_revnum_parse
svn_error_t * svn_revnum_parse(svn_revnum_t *rev, const char *str, const char **endptr)
Parse NULL-terminated C string str as a revision number and store its value in rev.
svn_log_entry_t::changed_paths
apr_hash_t * changed_paths
A hash containing as keys every path committed in revision; the values are (svn_log_changed_path_t *)...
Definition: svn_types.h:814
svn_log_entry_t::changed_paths2
apr_hash_t * changed_paths2
A hash containing as keys every path committed in revision; the values are (svn_log_changed_path2_t *...
Definition: svn_types.h:857
svn_error_t
struct svn_error_t svn_error_t
Subversion error object.
svn_log_changed_path2_create
svn_log_changed_path2_t * svn_log_changed_path2_create(apr_pool_t *pool)
Returns an svn_log_changed_path2_t, allocated in pool with all fields initialized to NULL,...
svn_depth_to_word
const char * svn_depth_to_word(svn_depth_t depth)
Return a constant string expressing depth as an English word, e.g., "infinity", "immediates",...
svn_log_entry_t
A structure to represent all the information about a particular log entry.
Definition: svn_types.h:805
svn_merge_range_dup
svn_merge_range_t * svn_merge_range_dup(const svn_merge_range_t *range, apr_pool_t *pool)
Return a copy of range, allocated in pool.
svn_merge_range_t
struct svn_merge_range_t svn_merge_range_t
Mergeinfo representing a merge of a range of revisions.
svn_tristate__to_word
const char * svn_tristate__to_word(svn_tristate_t tristate)
Return a constant string "true", "false" or NULL representing the value of tristate.
svn_error_t::pool
apr_pool_t * pool
The pool in which this error object is allocated.
Definition: svn_types.h:210
svn_tristate_t
svn_tristate_t
Generic three-state property to represent an unknown value for values that are just like booleans.
Definition: svn_types_impl.h:83
svn_location_segment_t
A representation of a segment of an object's version history with an emphasis on the object's locatio...
Definition: svn_types.h:1176
svn_log_changed_path2_t::props_modified
svn_tristate_t props_modified
Are properties modified, may be svn_tristate_unknown.
Definition: svn_types.h:737
svn_log_entry_t::subtractive_merge
svn_boolean_t subtractive_merge
Whether revision is a merged revision resulting from a reverse merge.
Definition: svn_types.h:876
svn_error_t::apr_err
apr_status_t apr_err
APR error value; possibly an SVN_ custom error code (see ‘svn_error_codes.h’ for a full listing).
Definition: svn_types.h:185
svn_error.h
Common exception handling for Subversion.
svn_depth_t
svn_depth_t
The concept of depth for directories.
Definition: svn_types_impl.h:111
svn_error_t::message
const char * message
Details from the producer of error.
Definition: svn_types.h:198
svn_dirent_t::kind
svn_node_kind_t kind
node kind
Definition: svn_types.h:537
svn_log_changed_path_t::action
char action
'A'dd, 'D'elete, 'R'eplace, 'M'odify
Definition: svn_types.h:775
svn_commit_info_t::author
const char * author
author of the commit.
Definition: svn_types.h:669
svn_lock_t
A lock object, for client & server to share.
Definition: svn_types.h:1080
svn_dirent_create
svn_dirent_t * svn_dirent_create(apr_pool_t *result_pool)
Create a new svn_dirent_t instance with all values initialized to their not-available values.
svn_merge_range_contains_rev
svn_boolean_t svn_merge_range_contains_rev(const svn_merge_range_t *range, svn_revnum_t rev)
Returns true if the changeset committed in revision rev is one of the changesets in the range range.
svn_location_segment_t
struct svn_location_segment_t svn_location_segment_t
A representation of a segment of an object's version history with an emphasis on the object's locatio...
svn_merge_range_t::inheritable
svn_boolean_t inheritable
Whether this merge range should be inherited by treewise descendants of the path to which the range a...
Definition: svn_types.h:1143
svn_commit_info_t
struct svn_commit_info_t svn_commit_info_t
All information about a commit.
svn_dirent_t::created_rev
svn_revnum_t created_rev
last rev in which this node changed
Definition: svn_types.h:546
svn_recurse_kind
svn_recurse_kind
An enum to indicate whether recursion is needed.
Definition: svn_types.h:424
svn_error_t::line
long line
Source line where the error originated (iff SVN_DEBUG; undefined otherwise).
Definition: svn_types.h:220
svn_mime_type_is_binary
svn_boolean_t svn_mime_type_is_binary(const char *mime_type)
Return FALSE iff mime_type is a textual type.
svn_filesize_t
apr_int64_t svn_filesize_t
The size of a file in the Subversion FS.
Definition: svn_types.h:405
svn_lock_create
svn_lock_t * svn_lock_create(apr_pool_t *pool)
Returns an svn_lock_t, allocated in pool with all fields initialized to NULL values.
svn_commit_info_t::revision
svn_revnum_t revision
just-committed revision.
Definition: svn_types.h:663
svn_merge_range_t
Mergeinfo representing a merge of a range of revisions.
Definition: svn_types.h:1129
svn_lock_t::is_dav_comment
svn_boolean_t is_dav_comment
was comment made by generic DAV client?
Definition: svn_types.h:1085
svn_dirent_t
A general subversion directory entry.
Definition: svn_types.h:535
svn_lock_t
struct svn_lock_t svn_lock_t
A lock object, for client & server to share.
svn_log_entry_t
struct svn_log_entry_t svn_log_entry_t
A structure to represent all the information about a particular log entry.
svn_log_changed_path_t::copyfrom_path
const char * copyfrom_path
Source path of copy (if any).
Definition: svn_types.h:778
svn_log_entry_dup
svn_log_entry_t * svn_log_entry_dup(const svn_log_entry_t *log_entry, apr_pool_t *pool)
Return a deep copy of log_entry, allocated in pool.
svn_boolean_t
int svn_boolean_t
YABT: Yet Another Boolean Type.
Definition: svn_types.h:141
svn_dirent_t
struct svn_dirent_t svn_dirent_t
A general subversion directory entry.
SVN_DEPRECATED
#define SVN_DEPRECATED
Macro used to mark deprecated functions.
Definition: svn_types.h:62
svn_location_segment_t::path
const char * path
The absolute (sans leading slash) path for this segment.
Definition: svn_types.h:1184
svn_revnum_t
long int svn_revnum_t
A revision number.
Definition: svn_types_impl.h:95
svn_node_kind_t
svn_node_kind_t
The various types of nodes in the Subversion filesystem.
Definition: svn_types_impl.h:51
svn_log_entry_create
svn_log_entry_t * svn_log_entry_create(apr_pool_t *pool)
Returns an svn_log_entry_t, allocated in pool with all fields initialized to NULL values.
svn_lock_t::token
const char * token
unique URI representing lock
Definition: svn_types.h:1082
svn_log_entry_t::revision
svn_revnum_t revision
The revision of the commit.
Definition: svn_types.h:817
svn_lock_t::owner
const char * owner
the username which owns the lock
Definition: svn_types.h:1083
svn_location_segment_dup
svn_location_segment_t * svn_location_segment_dup(const svn_location_segment_t *segment, apr_pool_t *pool)
Return a deep copy of segment, allocated in pool.
svn_dirent_t::has_props
svn_boolean_t has_props
does the node have props?
Definition: svn_types.h:543
svn_log_changed_path2_t::copyfrom_rev
svn_revnum_t copyfrom_rev
Source revision of copy (if any).
Definition: svn_types.h:726
svn_dirent_t::last_author
const char * last_author
author of created_rev
Definition: svn_types.h:552
svn_log_changed_path_t
struct svn_log_changed_path_t svn_log_changed_path_t
A structure to represent a path that changed for a log entry.
svn_dirent_t::size
svn_filesize_t size
length of file text, otherwise SVN_INVALID_FILESIZE
Definition: svn_types.h:540
svn_log_changed_path_t::copyfrom_rev
svn_revnum_t copyfrom_rev
Source revision of copy (if any).
Definition: svn_types.h:781
svn_node_kind_to_word
const char * svn_node_kind_to_word(svn_node_kind_t kind)
Return a constant string expressing kind as an English word, e.g., "file", "dir", etc.
svn_lock_t::comment
const char * comment
(optional) description of lock
Definition: svn_types.h:1084
svn_log_entry_t::revprops
apr_hash_t * revprops
The hash of requested revision properties, which may be NULL if it would contain no revprops.
Definition: svn_types.h:822
svn_version_t
Version information.
Definition: svn_version.h:148
svn_node_kind_from_word
svn_node_kind_t svn_node_kind_from_word(const char *word)
Return the appropriate node_kind for word.
svn_dirent_dup
svn_dirent_t * svn_dirent_dup(const svn_dirent_t *dirent, apr_pool_t *pool)
Return a deep copy of dirent, allocated in pool.
svn_log_changed_path2_t::action
char action
'A'dd, 'D'elete, 'R'eplace, 'M'odify
Definition: svn_types.h:720
svn_lock_t::creation_date
apr_time_t creation_date
when lock was made
Definition: svn_types.h:1086
svn_log_entry_t::has_children
svn_boolean_t has_children
Whether or not this message has children.
Definition: svn_types.h:840
svn_uuid_generate
const char * svn_uuid_generate(apr_pool_t *pool)
Return a formatted Universal Unique IDentifier (UUID) string.
svn_log_changed_path_dup
svn_log_changed_path_t * svn_log_changed_path_dup(const svn_log_changed_path_t *changed_path, apr_pool_t *pool)
Return a deep copy of changed_path, allocated in pool.