/gecko_api/include/nsQuickSort.h

 1/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 2/* ***** BEGIN LICENSE BLOCK *****
 3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 4 *
 5 * The contents of this file are subject to the Mozilla Public License Version
 6 * 1.1 (the "License"); you may not use this file except in compliance with
 7 * the License. You may obtain a copy of the License at
 8 * http://www.mozilla.org/MPL/
 9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 1998
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 *
24 * Alternatively, the contents of this file may be used under the terms of
25 * either of the GNU General Public License Version 2 or later (the "GPL"),
26 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38
39/* We need this because Solaris' version of qsort is broken and
40 * causes array bounds reads.
41 */
42
43#ifndef nsQuickSort_h___
44#define nsQuickSort_h___
45
46#include "prtypes.h"
47#include "nscore.h"
48
49PR_BEGIN_EXTERN_C
50
51/**
52 * Parameters:
53 *  1. the array to sort
54 *  2. the number of elements in the array
55 *  3. the size of each array element
56 *  4. comparison function taking two elements and parameter #5 and
57 *     returning an integer:
58 *      + less than zero if the first element should be before the second
59 *      + 0 if the order of the elements does not matter
60 *      + greater than zero if the second element should be before the first
61 *  5. extra data to pass to comparison function
62 */
63NS_COM_GLUE void NS_QuickSort(void *, unsigned int, unsigned int,
64                              int (*)(const void *, const void *, void *), 
65                              void *);
66
67PR_END_EXTERN_C
68
69#endif /* nsQuickSort_h___ */