attributes.hh

Go to the documentation of this file.

/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2005, 2006, 2007, 2008 Ciaran McCreesh
 *
 * This file is part of the Paludis package manager. Paludis is free software;
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License version 2, as published by the Free Software Foundation.
 *
 * Paludis 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 General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef PALUDIS_GUARD_PALUDIS_ATTRIBUTES_HH
#define PALUDIS_GUARD_PALUDIS_ATTRIBUTES_HH 1

/** \file
 * Declare the PALUDIS_ATTRIBUTE macros.
 *
 * \ingroup g_utils
 *
 * \section Examples
 *
 * - None at this time.
 */

/** \def PALUDIS_ATTRIBUTE
 * If we're using a GNU compatible compiler, expands to __attribute__, otherwise
 * discards its arguments.
 *
 * \ingroup g_utils
 */

/** \def PALUDIS_VISIBLE
 * Marker used to represent 'make visible', if visibility is enabled.
 *
 * \ingroup g_utils
 */

/** \def PALUDIS_HIDDEN
 * Marker used to represent 'make hidden', if visibility is enabled.
 *
 * \ingroup g_utils
 */

#if defined(DOXYGEN)
#  define PALUDIS_ATTRIBUTE(x)
#else
#  define PALUDIS_ATTRIBUTE(x) __attribute__(x)
#endif

#if defined(DOXYGEN)
#  define PALUDIS_VISIBLE
#  define PALUDIS_HIDDEN
#else
#  define PALUDIS_VISIBLE PALUDIS_ATTRIBUTE((visibility("default")))
#  define PALUDIS_HIDDEN PALUDIS_ATTRIBUTE((visibility("hidden")))
#endif

#endif