mDNSShared/GenLinkedList.h

   1 /*
   2  * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24
  25         File:           GenLinkedList.c
  26
  27         Contains:       interface to generic linked lists.
  28
  29         Version:        1.0
  30         Tabs:           4 spaces
  31
  32     Change History (most recent first):
  33
  34 $Log: GenLinkedList.h,v $
  35 Revision 1.2  2004/02/05 07:41:08  cheshire
  36 Add Log header
  37
  38 */
  39
  40 #ifndef __GenLinkedList__
  41 #define __GenLinkedList__
  42
  43
  44 #include <stddef.h>
  45
  46
  47 struct  GenLinkedList
  48 {
  49         void            *Head,
  50                                 *Tail;
  51         size_t          LinkOffset;
  52 };
  53 typedef struct GenLinkedList    GenLinkedList;
  54
  55
  56 void            InitLinkedList( GenLinkedList *pList, size_t linkOffset);
  57
  58 void            AddToHead( GenLinkedList *pList, void *elem);
  59 void            AddToTail( GenLinkedList *pList, void *elem);
  60
  61 int             RemoveFromList( GenLinkedList *pList, void *elem);
  62
  63 int             ReplaceElem( GenLinkedList *pList, void *elemInList, void *newElem);
  64
  65
  66
  67 struct  GenDoubleLinkedList
  68 {
  69         void            *Head,
  70                                 *Tail;
  71         size_t          FwdLinkOffset,
  72                                 BackLinkOffset;
  73 };
  74 typedef struct GenDoubleLinkedList      GenDoubleLinkedList;
  75
  76
  77 void            InitDoubleLinkedList( GenDoubleLinkedList *pList, size_t fwdLinkOffset,
  78                                                                           size_t backLinkOffset);
  79
  80 void            DLLAddToHead( GenDoubleLinkedList *pList, void *elem);
  81
  82 void            DLLRemoveFromList( GenDoubleLinkedList *pList, void *elem);
  83
  84
  85
  86 /* A GenLinkedOffsetList is like a GenLinkedList that stores the *Next field as a signed */
  87 /* offset from the address of the beginning of the element, rather than as a pointer. */
  88
  89 struct  GenLinkedOffsetList
  90 {
  91         size_t          Head,
  92                                 Tail;
  93         size_t          LinkOffset;
  94 };
  95 typedef struct GenLinkedOffsetList      GenLinkedOffsetList;
  96
  97
  98 void            InitLinkedOffsetList( GenLinkedOffsetList *pList, size_t linkOffset);
  99
 100 void            *GetHeadPtr( GenLinkedOffsetList *pList);
 101 void            *GetTailPtr( GenLinkedOffsetList *pList);
 102 void            *GetOffsetLink( GenLinkedOffsetList *pList, void *elem);
 103
 104 void            OffsetAddToHead( GenLinkedOffsetList *pList, void *elem);
 105 void            OffsetAddToTail( GenLinkedOffsetList *pList, void *elem);
 106
 107 int             OffsetRemoveFromList( GenLinkedOffsetList *pList, void *elem);
 108
 109 int             OffsetReplaceElem( GenLinkedOffsetList *pList, void *elemInList, void *newElem);
 110
 111
 112 #endif //       __GenLinkedList__