qsort_r.c File Reference

Context-free sorting function. More...

#include "config.h"
#include <stddef.h>
#include <stdlib.h>
#include "qsort_r.h"
#include "lib.h"

Include dependency graph for qsort_r.c:

Go to the source code of this file.

Functions
static int	relay_compar (const void *a, const void *b)
	Shim to pass context through to real comparator.
void	mutt_qsort_r (void *base, size_t nmemb, size_t size, sort_t compar, void *sdata)
	Sort an array, where the comparator has access to opaque data rather than requiring global variables.

Variables
static sort_t	GlobalCompar = NULL
	Original comparator in fallback implementation.
static void *	GlobalData = NULL
	Original opaque data in fallback implementation.

Detailed Description

Context-free sorting function.

Authors

• Eric Blake
• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file qsort_r.c.

Function Documentation

relay_compar()

static int relay_compar ( const void *  a, const void *  b  )

static

Shim to pass context through to real comparator.

Parameters

a	First item to be compared
b	Second item to be compared

Return values

<0	a sorts before b
0	a and b sort equally (sort stability not guaranteed)
>0	a sorts after b

Definition at line 50 of file qsort_r.c.

{
  return GlobalCompar(a, b, GlobalData);
}

Here is the caller graph for this function:

mutt_qsort_r()

void mutt_qsort_r	(	void *	base,
		size_t	nmemb,
		size_t	size,
		sort_t	compar,
		void *	sdata
	)

Sort an array, where the comparator has access to opaque data rather than requiring global variables.

Parameters

base	Start of the array to be sorted
nmemb	Number of elements in the array
size	Size of each array element
compar	Comparison function, return <0/0/>0 to compare two elements
sdata	Opaque argument to pass to compar

Note

This implementation might not be re-entrant: signal handlers and compar must not call mutt_qsort_r().

Definition at line 67 of file qsort_r.c.

{
#ifdef HAVE_QSORT_S
  /* FreeBSD 13, where qsort_r had incompatible signature but qsort_s works */
  qsort_s(base, nmemb, size, compar, sdata);
#elif defined(HAVE_QSORT_R)
  /* glibc, POSIX (https://www.austingroupbugs.net/view.php?id=900) */
  qsort_r(base, nmemb, size, compar, sdata);
#else
  /* This fallback is not re-entrant. */
  ASSERT(!GlobalCompar && !GlobalData);
  GlobalCompar = compar;
  GlobalData = sdata;
  qsort(base, nmemb, size, relay_compar);
  GlobalCompar = NULL;
  GlobalData = NULL;
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

GlobalCompar

sort_t GlobalCompar = NULL

static

Original comparator in fallback implementation.

Definition at line 38 of file qsort_r.c.

GlobalData

void* GlobalData = NULL

static

Original opaque data in fallback implementation.

Definition at line 40 of file qsort_r.c.