include/pantheios/pantheios.hpp

Go to the documentation of this file.

/* /////////////////////////////////////////////////////////////////////////
 * File:        pantheios/pantheios.hpp
 *
 * Purpose:     Primary header file for Pantheios
 *
 * Created:     21st June 2005
 * Updated:     2nd September 2006
 *
 * Author:      Matthew Wilson
 *
 * Home:        http://www.pantheios.org/
 *
 * Copyright:   Matthew Wilson and Synesis Software Pty Ltd, 1999-2005.
 *              Matthew Wilson, (c) 2005-2006.
 *
 * 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 names of Matthew Wilson and Synesis Software nor the names of
 *   any 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 THE COPYRIGHT OWNER 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 PANTHEIOS_INCL_PANTHEIOS_HPP_PANTHEIOS
#define PANTHEIOS_INCL_PANTHEIOS_HPP_PANTHEIOS

/* /////////////////////////////////////////////////////////////////////////
 * Version information
 */

#ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
# define PANTHEIOS_VER_PANTHEIOS_HPP_PANTHEIOS_MAJOR      3
# define PANTHEIOS_VER_PANTHEIOS_HPP_PANTHEIOS_MINOR      0
# define PANTHEIOS_VER_PANTHEIOS_HPP_PANTHEIOS_REVISION   1
# define PANTHEIOS_VER_PANTHEIOS_HPP_PANTHEIOS_EDIT       71
#endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION */

/* /////////////////////////////////////////////////////////////////////////
 * Includes
 */

/* Main Panthieos Header */
#include <pantheios/pantheios.h>

/* Now select various headers to bring in string access shims */
#include <stlsoft/shims/access/string/fwd.h>

#if !defined(PANTHEIOS_NO_INCLUDE_STLSOFT_SHIM_ACCESS_SHIMS)
# include <stlsoft/shims/access/string.hpp>
# include <stlsoft/shims/access/string/std/time.hpp>

 /* Include shims for ATL, if
  *
  *  - it's not been proscribed, by PANTHEIOS_NO_INCLUDE_ATLSTL_STRING_ACCESS, and either
  *      - it's been explicitly requested, by PANTHEIOS_FORCE_INCLUDE_ATLSTL_STRING_ACCESS, or
  *      - _ATL and _ATL_VER are defined
  */
#  if !defined(PANTHEIOS_NO_INCLUDE_ATLSTL_STRING_ACCESS) && \
      (   defined(PANTHEIOS_FORCE_INCLUDE_ATLSTL_STRING_ACCESS) || \
          (   defined(_ATL) && \
              defined(_ATL_VER)))
#  include <atlstl/shims/access/string.hpp>
# endif /* ATL */

 /* Include shims for COM, if
  *
  *  - it's not been proscribed, by PANTHEIOS_NO_INCLUDE_COMSTL_STRING_ACCESS, and either
  *      - it's been explicitly requested, by PANTHEIOS_FORCE_INCLUDE_COMSTL_STRING_ACCESS, or
  *      - WIN32 is defined
  */
#  if !defined(PANTHEIOS_NO_INCLUDE_COMSTL_STRING_ACCESS) && \
      (   defined(PANTHEIOS_FORCE_INCLUDE_COMSTL_STRING_ACCESS) || \
          defined(WIN32))
#  include <comstl/shims/access/string.hpp>
# endif /* COM */

 /* Include shims for MFC, if
  *
  *  - it's not been proscribed, by PANTHEIOS_NO_INCLUDE_MFCSTL_STRING_ACCESS, and either
  *      - it's been explicitly requested, by PANTHEIOS_FORCE_INCLUDE_MFCSTL_STRING_ACCESS, or
  *      - _AFX and _MFC_VER are defined
  */
#  if !defined(PANTHEIOS_NO_INCLUDE_MFCSTL_STRING_ACCESS) && \
      (   defined(PANTHEIOS_FORCE_INCLUDE_MFCSTL_STRING_ACCESS) || \
          defined(_AFXDLL) || \
          (   defined(_AFX) && \
              defined(_MFC_VER)))
#  include <mfcstl/shims/access/string.hpp>
# endif /* MFC */

 /* Include shims for UNIX, if
  *
  *  - it's not been proscribed, by PANTHEIOS_NO_INCLUDE_UNIXSTL_STRING_ACCESS, and either
  *      - it's been explicitly requested, by PANTHEIOS_FORCE_INCLUDE_UNIXSTL_STRING_ACCESS, or
  *      - unix, __unix, __unix__ or UNIX is defined
  */
#  if !defined(PANTHEIOS_NO_INCLUDE_WINSTL_STRING_ACCESS) && \
      (   defined(PANTHEIOS_FORCE_INCLUDE_WINSTL_STRING_ACCESS) || \
          (  defined(unix) || \
             defined(__unix) || \
             defined(__unix__) || \
             defined(UNIX)))
#  include <unixstl/shims/access/string.hpp>
# endif /* UNIX */

 /* Include shims for Windows, if
  *
  *  - it's not been proscribed, by PANTHEIOS_NO_INCLUDE_WINSTL_STRING_ACCESS, and either
  *      - it's been explicitly requested, by PANTHEIOS_FORCE_INCLUDE_WINSTL_STRING_ACCESS, or
  *      - WIN32 is defined
  */
#  if !defined(PANTHEIOS_NO_INCLUDE_WINSTL_STRING_ACCESS) && \
      (   defined(PANTHEIOS_FORCE_INCLUDE_WINSTL_STRING_ACCESS) || \
          defined(WIN32))
#  include <winstl/shims/access/string.hpp>
#  include <winstl/shims/access/string/time.hpp>
# endif /* Win */

#endif /* !PANTHEIOS_NO_INCLUDE_STLSOFT_SHIM_ACCESS_SHIMS */

/* /////////////////////////////////////////////////////////////////////////
 * GCC bug
 */

/* NOTE: We must include <pantheios/inserters.hpp> here, as GCC is a bit thick
 * about its two-phase name lookup when resolving shim functions for the
 * Pantheios inserter types integer, pointer and real.
 */

#if defined(STLSOFT_COMPILER_IS_GCC) && \
    __GNUC__ < 4
# include <pantheios/inserters.hpp>
#endif /* compiler */

/* /////////////////////////////////////////////////////////////////////////
 * Namespace
 */

#if !defined(PANTHEIOS_NO_NAMESPACE)
namespace pantheios
{
#endif /* !PANTHEIOS_NO_NAMESPACE */

/* /////////////////////////////////////////////////////////////////////////
 * C++ API components
 */


#include "./c/log_dispatch_functions.h"         // log(s), log(s, s) etc etc

#ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
# include "./cpp/log_dispatch_functions.hpp"    // log(s), log(s, s) etc etc
#endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION */

#include "./cpp/log_functions.hpp"              // log(s), log(s, s) etc etc

#ifndef PANTHEIOS_NO_SEVERITY_SPECIFIC_FUNCTIONS
# include "./cpp/log_sev_functions.hpp"         // log_ALERT() overloads, log_ERROR() overloads, etc.
#endif /* !PANTHEIOS_NO_SEVERITY_SPECIFIC_FUNCTIONS */

/* /////////////////////////////////////////////////////////////////////////
 * Namespace
 */

#if !defined(PANTHEIOS_NO_NAMESPACE)
} /* namespace pantheios */
#endif /* !PANTHEIOS_NO_NAMESPACE */

/* /////////////////////////////////////////////////////////////////////////
 * Auto-initialisation
 *
 * Except when making a DLL, this is automatic, unless PANTHEIOS_NO_AUTO_INIT
 * is defined.
 *
 * To force it for a DLL, define PANTHEIOS_FORCE_AUTO_INIT
 */

#if defined(_USRDLL) || \
    defined(_AFXDLL)
# define PANTHEIOS_NO_AUTO_INIT
#endif /* dynamic library */

#if defined(PANTHEIOS_FORCE_AUTO_INIT) || \
    !defined(PANTHEIOS_NO_AUTO_INIT)
# include "./cpp/initialiser.hpp"    // Schwarz counter initialisation
#endif /* PANTHEIOS_FORCE_AUTO_INIT || !PANTHEIOS_NO_AUTO_INIT */

/* /////////////////////////////////////////////////////////////////////////
 * Inclusion
 */

#ifdef STLSOFT_CF_PRAGMA_ONCE_SUPPORT
# pragma once
#endif /* STLSOFT_CF_PRAGMA_ONCE_SUPPORT */

/* ////////////////////////////////////////////////////////////////////// */

#endif /* !PANTHEIOS_INCL_PANTHEIOS_HPP_PANTHEIOS */

/* ////////////////////////////////////////////////////////////////////// */

pantheios Library documentation © Matthew Wilson, 2006