Back to index

lightning-sunbird  0.9+nobinonly
prclist.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is the Netscape Portable Runtime (NSPR).
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998-2000
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef prclist_h___
00039 #define prclist_h___
00040 
00041 #include "prtypes.h"
00042 
00043 typedef struct PRCListStr PRCList;
00044 
00045 /*
00046 ** Circular linked list
00047 */
00048 struct PRCListStr {
00049     PRCList   *next;
00050     PRCList   *prev;
00051 };
00052 
00053 /*
00054 ** Insert element "_e" into the list, before "_l".
00055 */
00056 #define PR_INSERT_BEFORE(_e,_l)     \
00057     PR_BEGIN_MACRO           \
00058        (_e)->next = (_l);    \
00059        (_e)->prev = (_l)->prev; \
00060        (_l)->prev->next = (_e); \
00061        (_l)->prev = (_e);    \
00062     PR_END_MACRO
00063 
00064 /*
00065 ** Insert element "_e" into the list, after "_l".
00066 */
00067 #define PR_INSERT_AFTER(_e,_l)      \
00068     PR_BEGIN_MACRO           \
00069        (_e)->next = (_l)->next; \
00070        (_e)->prev = (_l);    \
00071        (_l)->next->prev = (_e); \
00072        (_l)->next = (_e);    \
00073     PR_END_MACRO
00074 
00075 /*
00076 ** Return the element following element "_e"
00077 */
00078 #define PR_NEXT_LINK(_e)     \
00079        ((_e)->next)
00080 /*
00081 ** Return the element preceding element "_e"
00082 */
00083 #define PR_PREV_LINK(_e)     \
00084        ((_e)->prev)
00085 
00086 /*
00087 ** Append an element "_e" to the end of the list "_l"
00088 */
00089 #define PR_APPEND_LINK(_e,_l) PR_INSERT_BEFORE(_e,_l)
00090 
00091 /*
00092 ** Insert an element "_e" at the head of the list "_l"
00093 */
00094 #define PR_INSERT_LINK(_e,_l) PR_INSERT_AFTER(_e,_l)
00095 
00096 /* Return the head/tail of the list */
00097 #define PR_LIST_HEAD(_l) (_l)->next
00098 #define PR_LIST_TAIL(_l) (_l)->prev
00099 
00100 /*
00101 ** Remove the element "_e" from it's circular list.
00102 */
00103 #define PR_REMOVE_LINK(_e)         \
00104     PR_BEGIN_MACRO                 \
00105        (_e)->prev->next = (_e)->next; \
00106        (_e)->next->prev = (_e)->prev; \
00107     PR_END_MACRO
00108 
00109 /*
00110 ** Remove the element "_e" from it's circular list. Also initializes the
00111 ** linkage.
00112 */
00113 #define PR_REMOVE_AND_INIT_LINK(_e)    \
00114     PR_BEGIN_MACRO                 \
00115        (_e)->prev->next = (_e)->next; \
00116        (_e)->next->prev = (_e)->prev; \
00117        (_e)->next = (_e);          \
00118        (_e)->prev = (_e);          \
00119     PR_END_MACRO
00120 
00121 /*
00122 ** Return non-zero if the given circular list "_l" is empty, zero if the
00123 ** circular list is not empty
00124 */
00125 #define PR_CLIST_IS_EMPTY(_l) \
00126     ((_l)->next == (_l))
00127 
00128 /*
00129 ** Initialize a circular list
00130 */
00131 #define PR_INIT_CLIST(_l)  \
00132     PR_BEGIN_MACRO      \
00133        (_l)->next = (_l); \
00134        (_l)->prev = (_l); \
00135     PR_END_MACRO
00136 
00137 #define PR_INIT_STATIC_CLIST(_l) \
00138     {(_l), (_l)}
00139 
00140 #endif /* prclist_h___ */