security/nss/lib/libpkix/pkix/util/pkix_list.h

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is the PKIX-C library.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Sun Microsystems, Inc.
  18  * Portions created by the Initial Developer are
  19  * Copyright 2004-2007 Sun Microsystems, Inc.  All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Sun Microsystems, Inc.
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * 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  * pkix_list.h
  39  *
  40  * List Object Type Definition
  41  *
  42  */
  43
  44 #ifndef _PKIX_LIST_H
  45 #define _PKIX_LIST_H
  46
  47 #include "pkix_tools.h"
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 typedef PKIX_Error *
  54 (*PKIX_List_SortComparatorCallback)(
  55         PKIX_PL_Object *obj1,
  56         PKIX_PL_Object *obj2,
  57         PKIX_Int32 *pResult,
  58         void *plContext);
  59
  60 struct PKIX_ListStruct {
  61         PKIX_PL_Object *item;
  62         PKIX_List *next;
  63         PKIX_Boolean immutable;
  64         PKIX_UInt32 length;
  65         PKIX_Boolean isHeader;
  66 };
  67
  68 /* see source file for function documentation */
  69
  70 PKIX_Error *pkix_List_RegisterSelf(void *plContext);
  71
  72 PKIX_Error *
  73 pkix_List_Contains(
  74         PKIX_List *list,
  75         PKIX_PL_Object *object,
  76         PKIX_Boolean *pFound,
  77         void *plContext);
  78
  79 PKIX_Error *
  80 pkix_List_Remove(
  81         PKIX_List *list,
  82         PKIX_PL_Object *target,
  83         void *plContext);
  84
  85 PKIX_Error *
  86 pkix_List_MergeLists(
  87         PKIX_List *firstList,
  88         PKIX_List *secondList,
  89         PKIX_List **pMergedList,
  90         void *plContext);
  91
  92 PKIX_Error *
  93 pkix_List_AppendList(
  94         PKIX_List *toList,
  95         PKIX_List *fromList,
  96         void *plContext);
  97
  98 PKIX_Error *
  99 pkix_List_AppendUnique(
 100         PKIX_List *toList,
 101         PKIX_List *fromList,
 102         void *plContext);
 103
 104 PKIX_Error *
 105 pkix_List_RemoveItems(
 106         PKIX_List *list,
 107         PKIX_List *deleteList,
 108         void *plContext);
 109
 110 PKIX_Error *
 111 pkix_List_QuickSort(
 112         PKIX_List *fromList,
 113         PKIX_List_SortComparatorCallback comparator,
 114         PKIX_List **pSortedList,
 115         void *plContext);
 116
 117 PKIX_Error *
 118 pkix_List_BubbleSort(
 119         PKIX_List *fromList,
 120         PKIX_List_SortComparatorCallback comparator,
 121         PKIX_List **pSortedList,
 122         void *plContext);
 123
 124 #ifdef __cplusplus
 125 }
 126 #endif
 127
 128 #endif /* _PKIX_LIST_H */