svn_sorts.h File Reference

all sorts of sorts. More...

`#include <apr.h>`
`#include <apr_pools.h>`
`#include <apr_tables.h>`
`#include <apr_hash.h>`

Go to the source code of this file.

## Macros

#define | MAX(a, b) ((a) < (b) ? (b) : (a))
#define | MIN(a, b) ((a) < (b) ? (a) : (b))

## Typedefs

typedef struct svn_sort__item_t | svn_sort__item_t
| This structure is used to hold a key/value from a hash table. More...

## Functions

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, according to whether the key of a is greater than, equal to, or less than the key of b as determined by comparing them with svn_path_compare_paths(). More...
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, according as a is greater than, equal to, or less than b according to a lexical key comparison. More...
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, according as b is greater than, equal to, or less than a. More...
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, or less than 0, using the same comparison rules as are used by svn_path_compare_paths(). More...
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, or less than 0 if the first range is greater than, equal to, or less than, the second range. More...

## Detailed Description

all sorts of sorts.

# @if copyrights

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.

Definition in file svn_sorts.h.

## Typedef Documentation

## svn_sort__item_t

typedef struct svn_sort__item_t svn_sort__item_t

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.

Definition at line 1 of file svn_sorts.h.

## Function Documentation

## 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, according to whether the key of a is greater than, equal to, or less than the key of 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 `apr_array_header_t`. For example, to convert hash hsh to a sorted array, do this:

apr_array_header_t *array;
array = svn_sort__hash(hsh, svn_sort_compare_items_as_paths, pool);
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,...

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.

## 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, according as a is greater than, equal to, or less than b according to a lexical key comparison.

The keys are not required to be zero-terminated.

## 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, 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.

## 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, or less than 0 if the first range is greater than, equal to, or less than, the second range.

Both `svn_merge_range_t` *'s must describe forward merge ranges.

If *a and *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

## 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, according as b is greater than, equal to, or less than 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 `apr_array_header_t`. You are responsible for detecting, preventing or removing duplicates.