Back to index

lightning-sunbird  0.9+nobinonly
jsclist.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 Mozilla Communicator client code, released
00016  * March 31, 1998.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 1998
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef jsclist_h___
00040 #define jsclist_h___
00041 
00042 #include "jstypes.h"
00043 
00044 /*
00045 ** Circular linked list
00046 */
00047 typedef struct JSCListStr {
00048     struct JSCListStr *next;
00049     struct JSCListStr *prev;
00050 } JSCList;
00051 
00052 /*
00053 ** Insert element "_e" into the list, before "_l".
00054 */
00055 #define JS_INSERT_BEFORE(_e,_l)  \
00056     JS_BEGIN_MACRO               \
00057         (_e)->next = (_l);       \
00058         (_e)->prev = (_l)->prev; \
00059         (_l)->prev->next = (_e); \
00060         (_l)->prev = (_e);       \
00061     JS_END_MACRO
00062 
00063 /*
00064 ** Insert element "_e" into the list, after "_l".
00065 */
00066 #define JS_INSERT_AFTER(_e,_l)   \
00067     JS_BEGIN_MACRO               \
00068         (_e)->next = (_l)->next; \
00069         (_e)->prev = (_l);       \
00070         (_l)->next->prev = (_e); \
00071         (_l)->next = (_e);       \
00072     JS_END_MACRO
00073 
00074 /*
00075 ** Return the element following element "_e"
00076 */
00077 #define JS_NEXT_LINK(_e)         \
00078         ((_e)->next)
00079 /*
00080 ** Return the element preceding element "_e"
00081 */
00082 #define JS_PREV_LINK(_e)         \
00083         ((_e)->prev)
00084 
00085 /*
00086 ** Append an element "_e" to the end of the list "_l"
00087 */
00088 #define JS_APPEND_LINK(_e,_l) JS_INSERT_BEFORE(_e,_l)
00089 
00090 /*
00091 ** Insert an element "_e" at the head of the list "_l"
00092 */
00093 #define JS_INSERT_LINK(_e,_l) JS_INSERT_AFTER(_e,_l)
00094 
00095 /* Return the head/tail of the list */
00096 #define JS_LIST_HEAD(_l) (_l)->next
00097 #define JS_LIST_TAIL(_l) (_l)->prev
00098 
00099 /*
00100 ** Remove the element "_e" from it's circular list.
00101 */
00102 #define JS_REMOVE_LINK(_e)             \
00103     JS_BEGIN_MACRO                     \
00104         (_e)->prev->next = (_e)->next; \
00105         (_e)->next->prev = (_e)->prev; \
00106     JS_END_MACRO
00107 
00108 /*
00109 ** Remove the element "_e" from it's circular list. Also initializes the
00110 ** linkage.
00111 */
00112 #define JS_REMOVE_AND_INIT_LINK(_e)    \
00113     JS_BEGIN_MACRO                     \
00114         (_e)->prev->next = (_e)->next; \
00115         (_e)->next->prev = (_e)->prev; \
00116         (_e)->next = (_e);             \
00117         (_e)->prev = (_e);             \
00118     JS_END_MACRO
00119 
00120 /*
00121 ** Return non-zero if the given circular list "_l" is empty, zero if the
00122 ** circular list is not empty
00123 */
00124 #define JS_CLIST_IS_EMPTY(_l) \
00125     ((_l)->next == (_l))
00126 
00127 /*
00128 ** Initialize a circular list
00129 */
00130 #define JS_INIT_CLIST(_l)  \
00131     JS_BEGIN_MACRO         \
00132         (_l)->next = (_l); \
00133         (_l)->prev = (_l); \
00134     JS_END_MACRO
00135 
00136 #define JS_INIT_STATIC_CLIST(_l) \
00137     {(_l), (_l)}
00138 
00139 #endif /* jsclist_h___ */