1 // Copyright 2005, Google Inc.
2 // All rights reserved.
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above
11 // copyright notice, this list of conditions and the following disclaimer
12 // in the documentation and/or other materials provided with the
14 // * Neither the name of Google Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from
16 // this software without specific prior written permission.
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 // A sample program demonstrating using Google C++ testing framework.
32 #ifndef GTEST_SAMPLES_SAMPLE3_INL_H_
33 #define GTEST_SAMPLES_SAMPLE3_INL_H_
38 // Queue is a simple queue implemented as a singled-linked list.
40 // The element type must support copy constructor.
41 template <typename E> // E is the element type
44 // QueueNode is a node in a Queue, which consists of an element of
45 // type E and a pointer to the next node.
46 template <typename E> // E is the element type
48 friend class Queue<E>;
51 // Gets the element in this node.
52 const E& element() const { return element_; }
54 // Gets the next node in the queue.
55 QueueNode* next() { return next_; }
56 const QueueNode* next() const { return next_; }
59 // Creates a node with a given element value. The next pointer is
61 explicit QueueNode(const E& an_element) : element_(an_element), next_(NULL) {}
63 // We disable the default assignment operator and copy c'tor.
64 const QueueNode& operator = (const QueueNode&);
65 QueueNode(const QueueNode&);
71 template <typename E> // E is the element type.
74 // Creates an empty queue.
75 Queue() : head_(NULL), last_(NULL), size_(0) {}
77 // D'tor. Clears the queue.
83 // 1. Deletes every node.
84 QueueNode<E>* node = head_;
85 QueueNode<E>* next = node->next();
89 if (node == NULL) break;
93 // 2. Resets the member variables.
99 // Gets the number of elements.
100 size_t Size() const { return size_; }
102 // Gets the first element of the queue, or NULL if the queue is empty.
103 QueueNode<E>* Head() { return head_; }
104 const QueueNode<E>* Head() const { return head_; }
106 // Gets the last element of the queue, or NULL if the queue is empty.
107 QueueNode<E>* Last() { return last_; }
108 const QueueNode<E>* Last() const { return last_; }
110 // Adds an element to the end of the queue. A copy of the element is
111 // created using the copy constructor, and then stored in the queue.
112 // Changes made to the element in the queue doesn't affect the source
113 // object, and vice versa.
114 void Enqueue(const E& element) {
115 QueueNode<E>* new_node = new QueueNode<E>(element);
118 head_ = last_ = new_node;
121 last_->next_ = new_node;
127 // Removes the head of the queue and returns it. Returns NULL if
128 // the queue is empty.
134 const QueueNode<E>* const old_head = head_;
135 head_ = head_->next_;
141 E* element = new E(old_head->element());
147 // Applies a function/functor on each element of the queue, and
148 // returns the result in a new queue. The original queue is not
150 template <typename F>
151 Queue* Map(F function) const {
152 Queue* new_queue = new Queue();
153 for (const QueueNode<E>* node = head_; node != NULL; node = node->next_) {
154 new_queue->Enqueue(function(node->element()));
161 QueueNode<E>* head_; // The first node of the queue.
162 QueueNode<E>* last_; // The last node of the queue.
163 size_t size_; // The number of elements in the queue.
165 // We disallow copying a queue.
167 const Queue& operator = (const Queue&);
170 #endif // GTEST_SAMPLES_SAMPLE3_INL_H_