Bug #: 3831
[WebKit-https.git] / WebCore / kwq / KWQListImpl.h
1 /*
2  * Copyright (C) 2003 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef KWQ_LIST_IMPL_H
27 #define KWQ_LIST_IMPL_H
28
29 #include "KWQDef.h"
30
31 class KWQListNode;
32 class KWQListIteratorImpl;
33
34 class KWQListImpl
35 {
36 public:
37     
38     KWQListImpl(void (*deleteFunc)(void *));
39     KWQListImpl(const KWQListImpl &impl);
40     ~KWQListImpl();
41      
42     bool isEmpty() const { return nodeCount == 0; }
43     uint count() const { return nodeCount; }
44     void clear(bool deleteItems);
45     void sort(int (*compareFunc)(void *a, void *b, void *data), void *data); 
46
47     void *at(uint n);
48
49     bool insert(uint n, const void *item);
50     bool remove(bool deleteItem);
51     bool remove(uint n, bool deleteItem);
52     bool remove(const void *item, bool deleteItem, int (*compareFunc)(void *a, void *b, void *data), void *data);
53     bool removeFirst(bool deleteItem);
54     bool removeLast(bool deleteItem);
55     bool removeRef(const void *item, bool deleteItem);
56
57     void *getFirst() const;
58     void *getLast() const;
59     void *current() const;
60     void *first();
61     void *last();
62     void *next();
63     void *prev();
64     void *take(uint n);
65     void *take();
66
67     void append(const void *item);
68     void prepend(const void *item);
69
70     uint containsRef(const void *item) const;
71     int findRef(const void *item);
72
73     KWQListImpl &assign(const KWQListImpl &impl, bool deleteItems);
74
75  private:
76     KWQListImpl &operator =(const KWQListImpl &impl);
77
78     void swap(KWQListImpl &impl);
79
80     void addIterator(KWQListIteratorImpl *iter) const;
81     void removeIterator(KWQListIteratorImpl *iter) const;
82
83     KWQListNode *head;
84     KWQListNode *tail;
85     KWQListNode *cur;
86     uint nodeCount;
87     void (*deleteItem)(void *);
88     mutable KWQListIteratorImpl *iterators;
89
90     friend class KWQListIteratorImpl;
91 };
92
93
94 class KWQListIteratorImpl {
95 public:
96     KWQListIteratorImpl();
97     KWQListIteratorImpl(const KWQListImpl &impl);
98     ~KWQListIteratorImpl();
99
100     KWQListIteratorImpl(const KWQListIteratorImpl &impl);
101     KWQListIteratorImpl &operator=(const KWQListIteratorImpl &impl);
102
103     uint count() const;
104     void *toFirst();
105     void *toLast();
106     void *current() const;
107
108     void *operator--();
109     void *operator++();
110
111 private:
112     const KWQListImpl *list;
113     KWQListNode *node;
114     KWQListIteratorImpl *next;
115     KWQListIteratorImpl *prev;
116
117     friend class KWQListImpl;
118 };
119
120 #endif