gecko-dev/include/xp_list.h

82 строки
2.7 KiB
C
Исходник Обычный вид История

1998-03-28 05:44:41 +03:00
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
#ifndef XPLIST_H
#define XPLIST_H
#include "xp_core.h"
/* generic list structure
*/
struct _XP_List {
void * object;
struct _XP_List * next;
struct _XP_List * prev;
};
XP_BEGIN_PROTOS
extern XP_List * XP_ListNew (void);
extern void XP_ListDestroy (XP_List *list);
extern void XP_ListAddObject (XP_List *list, void *newObject);
extern void XP_ListAddObjectToEnd (XP_List *list, void *newObject);
extern void XP_ListInsertObject (XP_List *list, void *insert_before, void *newObject);
extern void XP_ListInsertObjectAfter (XP_List *list, void *insert_after, void *newObject);
/* returns the list node of the specified object if it was
* in the list
*/
extern XP_List * XP_ListFindObject (XP_List *list, void * obj);
extern Bool XP_ListRemoveObject (XP_List *list, void *oldObject);
extern void * XP_ListRemoveTopObject (XP_List *list);
extern void * XP_ListPeekTopObject (XP_List *list);
extern void * XP_ListRemoveEndObject (XP_List *list);
#define XP_ListIsEmpty(list) (list ? list->next == NULL : TRUE)
extern int XP_ListCount (XP_List *list);
#define XP_ListTopObject(list) (list && list->next ? list->next->object : NULL)
extern void * XP_ListGetEndObject (XP_List *list);
extern void * XP_ListGetObjectNum (XP_List *list, int num);
extern int XP_ListGetNumFromObject (XP_List *list, void * object);
/* move the top object to the bottom of the list
* this function is useful for reordering the list
* so that a round robin ordering can occur
*/
extern void XP_ListMoveTopToBottom (XP_List *list);
XP_END_PROTOS
/* traverse the list in order
*
* make a copy of the list pointer and point it at the list object head.
* the first call the XP_ListNextObject will return the first object
* and increment the copy of the list pointer. Subsequent calls
* will continue to increment the copy of the list pointer and return
* objects
*/
#define XP_ListNextObject(list) \
(list && ((list = list->next)!=0) ? list->object : NULL)
#endif /* XPLIST_H */