
/****************************************************************************
** Copyright (c) 2006 - 2011, the LibQxt project.
** See the Qxt AUTHORS file for a list of authors and copyright holders.
** All rights reserved.
**
** Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are met:
**     * Redistributions of source code must retain the above copyright
**       notice, this list of conditions and the following disclaimer.
**     * Redistributions in binary form must reproduce the above copyright
**       notice, this list of conditions and the following disclaimer in the
**       documentation and/or other materials provided with the distribution.
**     * Neither the name of the LibQxt project nor the
**       names of its contributors may be used to endorse or promote products
**       derived from this software without specific prior written permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
** WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
** DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
** DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
** (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
** LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
**
** <http://libqxt.org>  <foundation@libqxt.org>
*****************************************************************************/

/*!
\class QxtMultiSignalWaiter

\inmodule QxtCore

\brief The QxtMultiSignalWaiter class blocks and processes events until a group of signals is emitted

Code written in a synchronous style will sometimes need to block until any of several conditions are met,
or until all of a set of conditions are met. This class allows a group of signals to be defined and waited
upon in a simple AND or OR fashion. More complex Boolean relationships can be written by connecting
together multiple QxtSignalGroup objects and waiting for all or any of these groups to emit one of
their signals.

\bold {Note:}
QxtMultiSignalWaiter is subject to the same reentrancy problems as QxtSignalWaiter.

\sa QxtSignalWaiter
*/

#include "qxtmultisignalwaiter.h"
#include "qxtsignalwaiter.h"

/*!
 * Constructs a QxtMultiSignalWaiter with the specified \a parent.
 */
QxtMultiSignalWaiter::QxtMultiSignalWaiter(QObject* parent) : QxtSignalGroup(parent)
{
    /* initializers only */
}

/*!
 * Destructs the multi signal waiter.
 */
QxtMultiSignalWaiter::~QxtMultiSignalWaiter()
{
    /* no-op */
}

/*!
 * Blocks the current function by processing events from the event queue according to
 * \a flags until any of the signals in the group are emitted.
 * If \a msec is not \c -1, waitForAny() will return before a signal is emitted if the
 * specified  number of milliseconds have elapsed. Returns \c true if a signal was
 * caught, or \c false if the timeout elapsed.
 * Note that waitForAny() may continue to block after a signal is emitted or the
 * timeout elapses; the function only guarantees that it will not return BEFORE
 * one of these conditions has occurred. This function is not reentrant.
 *
 * \sa QxtSignalGroup::addSignal(), QxtSignalGroup::firstSignalReceived()
 */
bool QxtMultiSignalWaiter::waitForAny(int msec, QEventLoop::ProcessEventsFlags flags)
{
    if (hasReceivedFirstSignal()) return true;
    return QxtSignalWaiter::wait(this, SIGNAL(firstSignalReceived()), msec, flags);
}

/*!
 * Blocks the current function by processing events from the event queue according to
 * \a flags until all of the signals in the group have been emitted. If \a msec is not
 * \c -1, waitForAll() will return before all of the signals are emitted if the specified
 * number of milliseconds have elapsed. Returns \c true if each signal was caught at
 * least once, or \c false if the timeout elapsed. Note that waitForAll() may continue
 * to block after the last signal is emitted or the timeout elapses; the function only
 * guarantees that it will not return BEFORE one of these conditions has occurred.
 * This function is not reentrant.
 *
 * \sa QxtSignalGroup::addSignal(), QxtSignalGroup::allSignalsReceived()
 */
bool QxtMultiSignalWaiter::waitForAll(int msec, QEventLoop::ProcessEventsFlags flags)
{
    if (hasReceivedAllSignals()) return true;
    return QxtSignalWaiter::wait(this, SIGNAL(allSignalsReceived()), msec, flags);
}

