/* -*- Mode: c; tab-width: 8; indent-tabs-mode: 1; c-basic-offset: 8; -*- */

/*

 * Copyright (c) 1993, 1994, 1995, 1996, 1997

 *	The Regents of the University of California.  All rights reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions

 * are met:

 * 1. Redistributions of source code must retain the above copyright

 *    notice, this list of conditions and the following disclaimer.

 * 2. 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.

 * 3. All advertising materials mentioning features or use of this software

 *    must display the following acknowledgement:

 *	This product includes software developed by the Computer Systems

 *	Engineering Group at Lawrence Berkeley Laboratory.

 * 4. Neither the name of the University nor of the Laboratory may be used

 *    to endorse or promote products derived from this software without

 *    specific prior written permission.

 *

 * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 THE REGENTS OR CONTRIBUTORS 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.

 */

#ifndef lib_pcap_funcattrs_h

#define lib_pcap_funcattrs_h

#include <pcap/compiler-tests.h>

/*

 * Attributes to apply to functions and their arguments, using various

 * compiler-specific extensions.

 */

/*

 * PCAP_API_DEF must be used when defining *data* exported from

 * libpcap.  It can be used when defining *functions* exported

 * from libpcap, but it doesn't have to be used there.  It

 * should not be used in declarations in headers.

 *

 * PCAP_API must be used when *declaring* data or functions

 * exported from libpcap; PCAP_API_DEF won't work on all platforms.

 */

#if defined(_WIN32)

  /*

   * For Windows:

   *

   *    when building libpcap:

   *

   *       if we're building it as a DLL, we have to declare API

   *       functions with __declspec(dllexport);

   *

   *       if we're building it as a static library, we don't want

   *       to do so.

   *

   *    when using libpcap:

   *

   *       if we're using the DLL, calls to its functions are a

   *       little more efficient if they're declared with

   *       __declspec(dllimport);

   *

   *       if we're not using the dll, we don't want to declare

   *       them that way.

   *

   * So:

   *

   *    if pcap_EXPORTS is defined, we define PCAP_API_DEF as

   *     __declspec(dllexport);

   *

   *    if PCAP_DLL is defined, we define PCAP_API_DEF as

   *    __declspec(dllimport);

   *

   *    otherwise, we define PCAP_API_DEF as nothing.

   */

  #if defined(pcap_EXPORTS)

    /*

     * We're compiling libpcap as a DLL, so we should export functions

     * in our API.

     */

    #define PCAP_API_DEF	__declspec(dllexport)

  #elif defined(PCAP_DLL)

    /*

     * We're using libpcap as a DLL, so the calls will be a little more

     * efficient if we explicitly import the functions.

     */

    #define PCAP_API_DEF	__declspec(dllimport)

  #else

    /*

     * Either we're building libpcap as a static library, or we're using

     * it as a static library, or we don't know for certain that we're

     * using it as a dynamic library, so neither import nor export the

     * functions explicitly.

     */

    #define PCAP_API_DEF

  #endif

#elif defined(MSDOS)

  /* XXX - does this need special treatment? */

  #define PCAP_API_DEF

#else /* UN*X */

  #ifdef pcap_EXPORTS

    /*

     * We're compiling libpcap as a (dynamic) shared library, so we should

     * export functions in our API.  The compiler might be configured not

     * to export functions from a shared library by default, so we might

     * have to explicitly mark functions as exported.

     */

    #if PCAP_IS_AT_LEAST_GNUC_VERSION(3,4) \

        || PCAP_IS_AT_LEAST_XL_C_VERSION(12,0)

      /*

       * GCC 3.4 or later, or some compiler asserting compatibility with

       * GCC 3.4 or later, or XL C 13.0 or later, so we have

       * __attribute__((visibility()).

       */

      #define PCAP_API_DEF	__attribute__((visibility("default")))

    #elif PCAP_IS_AT_LEAST_SUNC_VERSION(5,5)

      /*

       * Sun C 5.5 or later, so we have __global.

       * (Sun C 5.9 and later also have __attribute__((visibility()),

       * but there's no reason to prefer it with Sun C.)

       */

      #define PCAP_API_DEF	__global

    #else

      /*

       * We don't have anything to say.

       */

      #define PCAP_API_DEF

    #endif

  #else

    /*

     * We're not building libpcap.

     */

    #define PCAP_API_DEF

  #endif

#endif /* _WIN32/MSDOS/UN*X */

#define PCAP_API	PCAP_API_DEF extern

/*

 * PCAP_NORETURN, before a function declaration, means "this function

 * never returns".  (It must go before the function declaration, e.g.

 * "extern PCAP_NORETURN func(...)" rather than after the function

 * declaration, as the MSVC version has to go before the declaration.)

 *

 * PCAP_NORETURN_DEF, before a function *definition*, means "this

 * function never returns"; it would be used only for static functions

 * that are defined before any use, and thus have no declaration.

 * (MSVC doesn't support that; I guess the "decl" in "__declspec"

 * means "declaration", and __declspec doesn't work with definitions.)

 */

#if __has_attribute(noreturn) \

    || PCAP_IS_AT_LEAST_GNUC_VERSION(2,5) \

    || PCAP_IS_AT_LEAST_SUNC_VERSION(5,9) \

    || PCAP_IS_AT_LEAST_XL_C_VERSION(10,1) \

    || PCAP_IS_AT_LEAST_HP_C_VERSION(6,10)

  /*

   * Compiler with support for __attribute((noreturn)), or GCC 2.5 or

   * later, or some compiler asserting compatibility with GCC 2.5 or

   * later, or Solaris Studio 12 (Sun C 5.9) or later, or IBM XL C 10.1

   * or later (do any earlier versions of XL C support this?), or HP aCC

   * A.06.10 or later.

   */

  #define PCAP_NORETURN __attribute((noreturn))

  #define PCAP_NORETURN_DEF __attribute((noreturn))

#elif defined(_MSC_VER)

  /*

   * MSVC.

   */

  #define PCAP_NORETURN __declspec(noreturn)

  #define PCAP_NORETURN_DEF

#else

  #define PCAP_NORETURN

  #define PCAP_NORETURN_DEF

#endif

/*

 * PCAP_PRINTFLIKE(x,y), after a function declaration, means "this function

 * does printf-style formatting, with the xth argument being the format

 * string and the yth argument being the first argument for the format

 * string".

 */

#if __has_attribute(__format__) \

    || PCAP_IS_AT_LEAST_GNUC_VERSION(2,3) \

    || PCAP_IS_AT_LEAST_XL_C_VERSION(10,1) \

    || PCAP_IS_AT_LEAST_HP_C_VERSION(6,10)

  /*

   * Compiler with support for it, or GCC 2.3 or later, or some compiler

   * asserting compatibility with GCC 2.3 or later, or IBM XL C 10.1

   * and later (do any earlier versions of XL C support this?),

   * or HP aCC A.06.10 and later.

   */

  #define PCAP_PRINTFLIKE(x,y) __attribute__((__format__(__printf__,x,y)))

#else

  #define PCAP_PRINTFLIKE(x,y)

#endif

/*

 * PCAP_DEPRECATED(func, msg), after a function declaration, marks the

 * function as deprecated.

 *

 * The first argument is the name of the function; the second argument is

 * a string giving the warning message to use if the compiler supports that.

 *

 * (Thank you, Microsoft, for requiring the function name.)

 */

#if __has_attribute(deprecated) \

    || PCAP_IS_AT_LEAST_GNUC_VERSION(4,5) \

    || PCAP_IS_AT_LEAST_SUNC_VERSION(5,13)

  /*

   * Compiler that supports __has_attribute and __attribute__((deprecated)),

   * or GCC 4.5 or later, or Sun/Oracle C 12.4 (Sun C 5.13) or later.

   *

   * Those support __attribute__((deprecated(msg))) (we assume, perhaps

   * incorrectly, that anything that supports __has_attribute() is

   * recent enough to support __attribute__((deprecated(msg)))).

   */

  #define PCAP_DEPRECATED(func, msg)	__attribute__((deprecated(msg)))

#elif PCAP_IS_AT_LEAST_GNUC_VERSION(3,1)

  /*

   * GCC 3.1 through 4.4.

   *

   * Those support __attribute__((deprecated)) but not

   * __attribute__((deprecated(msg))).

   */

  #define PCAP_DEPRECATED(func, msg)	__attribute__((deprecated))

#elif (defined(_MSC_VER) && (_MSC_VER >= 1500)) && !defined(BUILDING_PCAP)

  /*

   * MSVC from Visual Studio 2008 or later, and we're not building

   * libpcap itself.

   *

   * If we *are* building libpcap, we don't want this, as it'll warn

   * us even if we *define* the function.

   */

  #define PCAP_DEPRECATED(func, msg)	__pragma(deprecated(func))

#else

  #define PCAP_DEPRECATED(func, msg)

#endif

/*

 * For flagging arguments as format strings in MSVC.

 */

#ifdef _MSC_VER

 #include <sal.h>

 #if _MSC_VER > 1400

  #define PCAP_FORMAT_STRING(p) _Printf_format_string_ p

 #else

  #define PCAP_FORMAT_STRING(p) __format_string p

 #endif

#else

 #define PCAP_FORMAT_STRING(p) p

#endif

#endif /* lib_pcap_funcattrs_h */