Skip to content
Snippets Groups Projects
visibility.hh 1.38 KiB
Newer Older
  • Learn to ignore specific revisions
  • // -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
    // vi: set et ts=4 sw=2 sts=2:
    #ifndef DUNE_COMMON_VISIBILITY_HH
    #define DUNE_COMMON_VISIBILITY_HH
    
    /** \file
     * \brief Definition of macros controlling symbol visibility at the ABI level.
     */
    
    #ifdef DOXYGEN
    
    //! Export a symbol as part of the public ABI.
    /**
     * Mark a class, function or static variable as visible outside the current DSO.
     * For now, this is mostly important for templated global variables and functions
     * that contain static variables.
     */
    #define DUNE_EXPORT implementation_defined
    
    //! Mark a symbol as being for internal use within the current DSO only.
    /**
     * Mark a class, function or static variable as inaccessible from outside the current DSO.
     * Doing so will decrease the size of the symbol table, but you have to be sure that the
     * symbol will never have to be accessed from another library or the main executable!
     */
    #define DUNE_PRIVATE implementation_defined
    
    #else // DOXYGEN
    
    #if __GNUC__ >= 4
    // GCC and Clang both define __GNUC__ to 4 and they both support the visibility
    // attribute
    #define DUNE_EXPORT __attribute__((visibility("default")))
    #define DUNE_PRIVATE __attribute__((visibility("hidden")))
    #else
    // We don't know about the active compiler, so just turn the visibility macros to no-ops.
    #define DUNE_EXPORT
    #define DUNE_PRIVATE
    #endif
    
    #endif // DOXYGEN
    
    #endif // DUNE_COMMON_VISIBILITY