Loading...
Searching...
No Matches
svn_sorts.h
Go to the documentation of this file.
/**
* @copyright
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
* @endcopyright
*
* @file svn_sorts.h
* @brief all sorts of sorts.
*/
#ifndef SVN_SORTS_H
#define SVN_SORTS_H
#include <apr.h> /* for apr_ssize_t */
#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 */
/* Define a MAX macro if we don't already have one */
#ifndef MAX
#define MAX(a, b) ((a) < (b) ? (b) : (a))
#endif
/* Define a MIN macro if we don't already have one */
#ifndef MIN
#define MIN(a, b) ((a) < (b) ? (a) : (b))
#endif
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
␌
/** This structure is used to hold a key/value from a hash table.
* @note Private. For use by Subversion's own code only. See issue #1644.
*/
typedef struct svn_sort__item_t svn_sort__item_t;
/** Compare two @c svn_sort__item_t's, returning an integer greater than,
* equal to, or less than 0, according to whether the key of @a a is
* greater than, equal to, or less than the key of @a b as determined
* by comparing them with svn_path_compare_paths().
*
* The key strings must be NULL-terminated, even though klen does not
* include the terminator.
*
* This is useful for converting a hash into a sorted
* @c apr_array_header_t. For example, to convert hash @a hsh to a sorted
* array, do this:
*
* @code
apr_array_header_t *array;
array = svn_sort__hash(hsh, svn_sort_compare_items_as_paths, pool);
@endcode
*
* This function works like svn_sort_compare_items_lexically() except that it
* orders children in subdirectories directly after their parents. This allows
* using the given ordering for a depth first walk, but at a performance
* penalty. Code that doesn't need this special behavior for children, e.g. when
* sorting files at a single directory level should use
* svn_sort_compare_items_lexically() instead.
*/
int
svn_sort_compare_items_as_paths(const svn_sort__item_t *a,
const svn_sort__item_t *b);
/** Compare two @c svn_sort__item_t's, returning an integer greater than,
* equal to, or less than 0, according as @a a is greater than, equal to,
* or less than @a b according to a lexical key comparison. The keys are
* not required to be zero-terminated.
*/
int
svn_sort_compare_items_lexically(const svn_sort__item_t *a,
const svn_sort__item_t *b);
/** Compare two @c svn_revnum_t's, returning an integer greater than, equal
* to, or less than 0, according as @a b is greater than, equal to, or less
* than @a a. Note that this sorts newest revision to oldest (IOW, descending
* order).
*
* This function is compatible for use with qsort().
*
* This is useful for converting an array of revisions into a sorted
* @c apr_array_header_t. You are responsible for detecting, preventing or
* removing duplicates.
*/
int
svn_sort_compare_revisions(const void *a,
const void *b);
/**
* Compare two @c const char * paths, @a *a and @a *b, returning an
* integer greater than, equal to, or less than 0, using the same
* comparison rules as are used by svn_path_compare_paths().
*
* This function is compatible for use with qsort().
*
* @since New in 1.1.
*/
int
svn_sort_compare_paths(const void *a,
const void *b);
/**
* Compare two @c svn_merge_range_t *'s, @a *a and @a *b, returning an
* integer greater than, equal to, or less than 0 if the first range is
* greater than, equal to, or less than, the second range.
*
* Both @c svn_merge_range_t *'s must describe forward merge ranges.
*
* If @a *a and @a *b intersect then the range with the lower start revision
* is considered the lesser range. If the ranges' start revisions are
* equal then the range with the lower end revision is considered the
* lesser range.
*
* @since New in 1.5
*/
int
svn_sort_compare_ranges(const void *a,
const void *b);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* SVN_SORTS_H */
svn_sort_compare_items_lexically
int svn_sort_compare_items_lexically(const svn_sort__item_t *a, const svn_sort__item_t *b)
Compare two svn_sort__item_t's, returning an integer greater than, equal to, or less than 0,...
svn_sort_compare_ranges
int svn_sort_compare_ranges(const void *a, const void *b)
Compare two svn_merge_range_t *'s, *a and *b, returning an integer greater than, equal to,...
svn_sort_compare_items_as_paths
int svn_sort_compare_items_as_paths(const svn_sort__item_t *a, const svn_sort__item_t *b)
Compare two svn_sort__item_t's, returning an integer greater than, equal to, or less than 0,...
svn_sort_compare_revisions
int svn_sort_compare_revisions(const void *a, const void *b)
Compare two svn_revnum_t's, returning an integer greater than, equal to, or less than 0,...
svn_sort_compare_paths
int svn_sort_compare_paths(const void *a, const void *b)
Compare two const char * paths, *a and *b, returning an integer greater than, equal to,...
svn_sort__item_t
struct svn_sort__item_t svn_sort__item_t
This structure is used to hold a key/value from a hash table.
Definition svn_sorts.h:55