summaryrefslogtreecommitdiff
path: root/salhelper/inc/salhelper/queue.hxx
blob: 273c4b9e7e0e3f95ba0119c387eb9d84da5ce679 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: queue.hxx,v $
 * $Revision: 1.5 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef _SALHELPER_QUEUE_HXX_
#define _SALHELPER_QUEUE_HXX_

#include <sal/types.h>
#include <osl/diagnose.h>
#include <osl/mutex.hxx>
#ifndef _OSL_SEMAPHOR_HXX_
#include <osl/semaphor.hxx>
#endif

#ifndef __LIST__
#include <list>
#endif

namespace salhelper
{

//----------------------------------------------------------------------------

#ifndef SALHELPER_COPYCTOR_API
#define SALHELPER_COPYCTOR_API(C) C (const C&); C& operator= (const C&)
#endif

//----------------------------------------------------------------------------

template<class element_type>
class QueueBase : protected std::list<element_type>
{
    /** Representation.
     */
    osl::Mutex m_aMutex;

    /** Not implemented.
     */
    SALHELPER_COPYCTOR_API(QueueBase<element_type>);

public:
    inline QueueBase()
    {}

    inline ~QueueBase()
    {
        erase (this->begin(), this->end());
    }

    inline void put (const element_type& element)
    {
        osl::MutexGuard aGuard (m_aMutex);
        push_back (element);
    }

    inline element_type get()
    {
        element_type element;

        osl::MutexGuard aGuard (m_aMutex);
        if (!this->empty())
        {
            element = this->front();
            this->pop_front();
        }

        return (element);
    }
};

//----------------------------------------------------------------------------

/** Queue.

    @deprecated
    Must not be used, as it internally uses unnamed semaphores, which are not
    supported on Mac OS X.
*/
template<class element_type>
class Queue : protected QueueBase<element_type>
{
    /** Representation.
     */
    osl::Semaphore m_aNotEmpty;

    /** Not implemented.
     */
    SALHELPER_COPYCTOR_API(Queue<element_type>);

public:
    inline Queue() : m_aNotEmpty (static_cast< sal_uInt32 >(0))
    {}

    inline ~Queue()
    {}

    inline void put (const element_type& element)
    {
        QueueBase<element_type>::put (element);
        m_aNotEmpty.release();
    }

    inline element_type get()
    {
        element_type element;

        m_aNotEmpty.acquire();
        element = QueueBase<element_type>::get();

        return (element);
    }
};

//----------------------------------------------------------------------------

/** Bounded queue.

    @deprecated
    Must not be used, as it internally uses unnamed semaphores, which are not
    supported on Mac OS X.
*/
template<class element_type>
class BoundedQueue : protected Queue<element_type>
{
    /** Representation.
     */
    osl::Semaphore m_aNotFull;

    /** Not implemented.
     */
    SALHELPER_COPYCTOR_API(BoundedQueue<element_type>);

public:
    inline BoundedQueue (sal_uInt32 capacity) : m_aNotFull (capacity)
    {
        OSL_POSTCOND(capacity, "BoundedQueue:BoundedQueue(): no capacity");
    }

    inline ~BoundedQueue()
    {}

    inline void put (const element_type& element)
    {
        m_aNotFull.acquire();
        Queue<element_type>::put (element);
    }

    inline element_type get()
    {
        element_type element;

        element = Queue<element_type>::get();
        m_aNotFull.release();

        return (element);
    }
};

//----------------------------------------------------------------------------

} // namespace salhelper

#endif /* !_SALHELPER_QUEUE_HXX_ */