Foreach.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_FOREACH_H_
#define _MIRA_FOREACH_H_


// Since Boost >= 1.48 the very common "define foreach BOOST_FOREACH" causes
// a lot of problems: https://svn.boost.org/trac/boost/ticket/6131
// Therefore, we first use a "undef foreach" to ensure, that we have a 'clean'
// environment to apply a work-around (see below).
// Especially, this is necessary when include files of other libraries, which
// also for the "define foreach BOOST_FOREACH" (like Qt) were included before
// this file.
#undef foreach
#undef foreach_reverse


#ifndef Q_MOC_RUN
#include <boost/foreach.hpp>
#include <boost/version.hpp>
#include <boost/typeof/typeof.hpp>
#endif


// Boost versions >= 1.48 need a work-around for foreach (see below). But on
// some systems, the suggested work-around is already included in the boost
// version provided by the system vendor. Therefore, we need to detect this
// situation to skip the suggested work-around.
// Unfortunately, the only way to detect this situation seems to check the
// gcc and boost versions. At the moment, this combination seems to be unique
// enough.

#ifdef __GNUC__
# if (defined __GNUC_RH_RELEASE__) && (BOOST_VERSION == 105300)
    // RedHat Enterprise / CentOS 7 with Boost 1.53.0
#   define MIRA_SKIP_BOOST_FOREACH_WORKAROUND_6131
# endif
#endif


// Suggested work-around for problems with "define foreach BOOST_FOREACH" with
// Boost version >= 1.48. For more details, please here the following ticket:
//   https://svn.boost.org/trac/boost/ticket/6131
// The work-around is based on the following comment on this issue:
//   https://svn.boost.org/trac/boost/ticket/6131#comment:21
namespace boost {
#if (BOOST_VERSION != 104900) && !defined(MIRA_SKIP_BOOST_FOREACH_WORKAROUND_6131)
    namespace BOOST_FOREACH = foreach;
#endif
}


// Note: we do not need to enter a namespace here, since all macros are in
// the global namespace anyway

#undef foreach // QT might have defined it already (but boost foreach is much better and compatible!!)
// workaround for eclipse with CDT 8.0 (that is able to parse the new C++11 
// range-based 'for' expression, but not the BOOST_FOREACH macro)
#ifdef __CDT_PARSER__ 
# define foreach(i,c) for(i:c)
#else
# define foreach BOOST_FOREACH
#endif


#undef foreach_reverse
#define foreach_reverse BOOST_REVERSE_FOREACH

#define foreachIt(var, container) for(auto var=container.begin();var!=container.end();++var)


#endif