rippled/Subtrees/beast/modules/beast_basics/beast_basics.h

/*============================================================================*/
/*
  Beast: https://github.com/vinniefalco/Beast

  Copyright (C) 2008 by Vinnie Falco <vinnie.falco@gmail.com>

  This library contains portions of other open source products covered by
  separate licenses. Please see the corresponding source files for specific
  terms.

  Beast is provided under the terms of The MIT License (MIT):

  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  IN THE SOFTWARE.
*/
/*============================================================================*/

/** Include this to get the @ref beast_basics module.

    @file beast_basics.h
    @ingroup beast_basics
*/

#ifndef BEAST_BASICS_BEASTHEADER
#define BEAST_BASICS_BEASTHEADER

//==============================================================================
/**
  @mainpage Beast: A multipurpose library using parts of JUCE.

  ### Version 1.1

  Copyright (C) 2008 by Vinnie Falco \<vinnie.falco@gmail.com\> ([e-mail][0])

  Beast is a source code collection of individual modules containing
  functionality for a variety of applications, with an emphasis on building
  concurrent systems. Beast requires [JUCE][3] (Jules' Utility Class
  Extensions), available from [Raw Material Software][4]. JUCE is available
  under both the [GNU General Public License][5] and a [commercial license][6].
  Other than JUCE, Beast has no external dependencies.

  Beast is hosted on Github at [https://github.com/vinniefalco/Beast][1]

  The online documentation is at [http://vinniefalco.github.com/Beast][2]

  ## Platforms

  All platforms supported by JUCE are also supported by Beast. Currently these
  platforms include:

  - **Windows**: Applications and VST/RTAS/NPAPI/ActiveX plugins can be built
    using MS Visual Studio. The results are all fully compatible with Windows
    XP, Vista or Windows 7.

  - **Mac OS X**: Applications and VST/AudioUnit/RTAS/NPAPI plugins with Xcode.

  - **GNU/Linux**: Applications and plugins can be built for any kernel 2.6 or
    later.

  - **iOS**: Native iPhone and iPad apps.

  - **Android**: Supported.

  ## Prerequisites

  This documentation assumes that the reader has a working knowledge of JUCE.
  Some modules built on external libraries assume that the reader understands
  the operation of those external libraries. Certain modules assume that the
  reader understands additional domain-specific information. Modules with
  additional prerequisites are marked in the documentation.

  ## External Modules

  Some modules bring in functionality provided by external libraries. For
  example, the @ref beast_bzip2 module provides the compression and decompression
  algorithms in [bZip2][7]. Usage of these external library modules is optional.
  They come with complete source code, as well as options for using either
  system or user provided variants of the external libraries: it is not
  necessary to download additional source code packages to use these modules.

  External code incorporated into Beast is covered by separate licenses. See
  the licensing information and notes in the corresponding source files for
  copyright information and terms of use.

  ## Integration

  Beast requires recent versions of JUCE. It won't work with versions 1.53 or
  earlier. To use the library it is necessary to first download JUCE to a
  location where your development environment can find it. Or, you can use your
  existing installation of JUCE.

  This library uses the same modularized organizational structure as JUCE. To
  use a module, first add a path to the list of includes searched by your
  development environment or project, which points to the Beast directory. Then,
  add the single corresponding .c or .cpp file to your existing project which
  already uses JUCE. For example, to use the @ref beast_core module, add the file
  beast_core.cpp to your project. Some modules depend on other modules.

  To use a module, include the appropriate header from within your source code.
  For example, to access classes in the @ref beast_concurrent module, use this:

  @code

  #include "modules/beast_concurrent/beast_concurrent.h"

  @endcode

  Then add the corresponding file beast_concurrent.cpp to your build.

  ## AppConfig

  Some Beast features can be controlled at compilation time through
  preprocessor directives. The available choices of compilation options are
  described in AppConfig.h, located in the AppConfigTemplate directory. Copy
  the provided settings into your existing AppConfig.h (a file used by JUCE
  convention).

  ## License

  This library contains portions of other open source products covered by
  separate licenses. Please see the corresponding source files for specific
  terms.

  Beast is provided under the terms of The MIT License (MIT):

  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  IN THE SOFTWARE.

  Some files contain portions of these external projects, licensed separately:

  - [bZip2][7] is Copyright (C) 1996-2010 Julian R Seward. All rights
    reserved. See the corresponding file LICENSE for licensing terms.

  - Portions of the software are Copyright (C) 1996-2001, 2006 by [The FreeType
    Project][8]. All rights reserved. [FreeType][8] is distributed
    under both the [GNU General Public License][5], or the
    [FreeType License][9].

  - Portions of this software are Copyright (C) 1994-2012 [Lua.org][10], PUC-Rio.
    Lua is distributed under the terms of the [MIT License][11].

  - [Luabridge][12] is Copyright (C) 2012 by Vinnie Falco and Copyrighted (C)
    2007 by Nathan Reed. [Luabridge][12] is distributed under the terms of the
    [MIT License][11].

  - [Soci][13] is Copyright (C) 2004-2008 Maciej Sobczak, Stephen Hutton, and
    various others noted in the corresponding source files. Soci is distributed
    under the [Boost Software License, Version 1.0][14].

  - [SQLite][15], placed in the public domain.

  - [TagLib][16] is distributed under both the [GNU Lesser General Public License,
  Version 2.1][17] and the [Mozilla Public License][18].

  [0]: mailto:vinnie.falco@gmail.com "Vinnie Falco (Email)"
  [1]: https://github.com/vinniefalco/Beast "Beast Project"
  [2]: http://vinniefalco.github.com/Beast/ "Beast Documentation"
  [3]: http://rawmaterialsoftware.com/juce.php "JUCE"
  [4]: http://rawmaterialsoftware.com/ "Raw Material Software"
  [5]: http://www.gnu.org/licenses/gpl-2.0.html "GNU General Public License, version 2"
  [6]: http://rawmaterialsoftware.com/jucelicense.php "JUCE Licenses"
  [7]: http://www.bzip.org/ "bZip2: Home"
  [8]: http://freetype.org/ "The FreeType Project"
  [9]: http://www.freetype.org/FTL.TXT "The FreeType Project License"
  [10]: http://www.lua.org/ "The Programming Language Lua"
  [11]: http://www.opensource.org/licenses/mit-license.html "The MIT License"
  [12]: https://github.com/vinniefalco/LuaBridge
  [13]: http://soci.sourceforge.net/ "SOCI"
  [14]: http://www.boost.org/LICENSE_1_0.txt "Boost Software License, Version 1.0"
  [15]: http://sqlite.org/ "SQLite Home Page"
  [16]: http://developer.kde.org/~wheeler/taglib.html "TagLib"
  [17]: http://www.gnu.org/licenses/lgpl-2.1.html "Gnu Lesser General Public License, version 2.1"
  [18]: http://www.mozilla.org/MPL/1.1/ "Mozilla Public License"

  @copyright Copyright (C) 2008 by Vinnie Falco \<vinnie.falco@gmail.com\> ([e-mail][0])
  @copyright Provided under the [MIT License][11]
*/

/*============================================================================*/
/**
  @internal

  Implementation classes.

  Thase classes are used internally.

  @defgroup internal internal
*/

/*============================================================================*/
/**
  External modules.

  These modules bring in functionality from third party or system libraries.

  @defgroup external external
*/

/*============================================================================*/
/**
  Core classes.

  This module provides core required functionality, and classes useful for
  general development. All other modules require this module.

  @todo Discuss the treatment of exceptions versus Error objects in the library.

  @todo Discuss the additions to AppConfig.h

  @defgroup beast_core beast_core
*/

/*  See the Juce notes regarding AppConfig.h

    This file must always be included before any Juce headers.

    There are some Beast specific build options that may be placed
    into this file. See the AppConfig.h provided with Beast.
*/

/* BeastConfig.h must be included before this file */

/* Use sensible default configurations if they forgot
   to append the necessary macros into their AppConfig.h.
*/
#ifndef BEAST_USE_BOOST
#define BEAST_USE_BOOST      0
#endif

#ifndef BEAST_USE_BZIP2
#define BEAST_USE_BZIP2      0
#endif

#ifndef BEAST_USE_FREETYPE
#define BEAST_USE_FREETYPE   0
#endif

#ifndef BEAST_USE_NATIVE_FREETYPE
#define BEAST_USE_NATIVE_FREETYPE 1
#endif

#ifndef BEAST_USE_NATIVE_SQLITE
#define BEAST_USE_NATIVE_SQLITE 1
#endif

#ifndef BEAST_USE_LEAKCHECKED
#define BEAST_USE_LEAKCHECKED BEAST_CHECK_MEMORY_LEAKS
#endif

/* Get this early so we can use it. */
#include "../beast_core/system/beast_TargetPlatform.h"

// Handy macro that lets pragma warnings be clicked in the output window
// Usage: #pragma message(BEAST_LOC_"Advertise here!")
#define BEAST_STR2_(x) #x
#define BEAST_STR1_(x) BEAST_STR2_(x)
#define BEAST_LOC_ __FILE__ "("BEAST_STR1_(__LINE__)") : WARNING: "

#if BEAST_USE_BOOST
#include <boost/thread/tss.hpp>
#endif

#if BEAST_MSVC
# include <crtdbg.h>
# include <functional>

#elif BEAST_IOS
# if BEAST_USE_BOOST
#  include <boost/bind.hpp>
#  include <boost/function.hpp>
# else
#  include <ciso646>  // detect std::lib
#  if _LIBCPP_VERSION // libc++
#   include <functional>
#  else // libstdc++ (GNU)
#   include <tr1/functional>
#  endif
# endif

#elif BEAST_MAC
# include <ciso646>  // detect std::lib
# if _LIBCPP_VERSION // libc++
#  include <functional>
# else // libstdc++ (GNU)
#  include <tr1/functional>
# endif

#elif BEAST_LINUX
# include <tr1/functional>

#else
# error Unnkown platform!

#endif

#include <algorithm>
#include <cfloat>
#include <cmath>
#include <cstdarg>
#include <cstddef>
#include <exception>
#include <istream>
#include <iterator>
#include <limits>
#include <list>
#include <map>
#include <new>
#include <numeric>
#include <ostream>
#include <sstream>
#include <stdexcept>
#include <string>
#include <typeinfo>
#include <vector>

#include <assert.h>
#include <ctype.h>
#include <errno.h>
#include <float.h>
#include <locale.h>
#include <math.h>
#include <memory.h>
#include <stdarg.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#ifdef _CRTDBG_MAP_ALLOC
#error "MSVC C Runtime Debug Macros not supported"
#endif

// If the MSVC debug heap headers were included, disable
// the macros during the juce include since they conflict.
#ifdef _CRTDBG_MAP_ALLOC
#include <crtdbg.h>
#include <stdlib.h>
#include <malloc.h>

#pragma push_macro("calloc")
#pragma push_macro("free")
#pragma push_macro("malloc")
#pragma push_macro("realloc")
#pragma push_macro("_recalloc")
#pragma push_macro("_aligned_free")
#pragma push_macro("_aligned_malloc")
#pragma push_macro("_aligned_offset_malloc")
#pragma push_macro("_aligned_realloc")
#pragma push_macro("_aligned_recalloc")
#pragma push_macro("_aligned_offset_realloc")
#pragma push_macro("_aligned_offset_recalloc")
#pragma push_macro("_aligned_msize")

#undef calloc
#undef free
#undef malloc
#undef realloc
#undef _recalloc
#undef _aligned_free
#undef _aligned_malloc
#undef _aligned_offset_malloc
#undef _aligned_realloc
#undef _aligned_recalloc
#undef _aligned_offset_realloc
#undef _aligned_offset_recalloc
#undef _aligned_msize
#endif

#include "../beast_core/beast_core.h"

#ifdef _CRTDBG_MAP_ALLOC
#pragma pop_macro("_aligned_msize")
#pragma pop_macro("_aligned_offset_recalloc")
#pragma pop_macro("_aligned_offset_realloc")
#pragma pop_macro("_aligned_recalloc")
#pragma pop_macro("_aligned_realloc")
#pragma pop_macro("_aligned_offset_malloc")
#pragma pop_macro("_aligned_malloc")
#pragma pop_macro("_aligned_free")
#pragma pop_macro("_recalloc")
#pragma pop_macro("realloc")
#pragma pop_macro("malloc")
#pragma pop_macro("free")
#pragma pop_macro("calloc")
#endif

/** The Beast namespace.

    This namespace contains all Beast symbols.
*/
namespace beast
{

// This group must come first since other files need it
#include "memory/beast_Uncopyable.h"
#include "diagnostic/beast_CatchAny.h"
#include "diagnostic/beast_Debug.h"
#include "diagnostic/beast_Error.h"
#include "diagnostic/beast_FPUFlags.h"
#include "diagnostic/beast_LeakChecked.h"
#include "diagnostic/beast_SafeBool.h"
#include "diagnostic/beast_Throw.h"

#include "containers/beast_List.h"
#include "containers/beast_LockFreeStack.h"
#include "containers/beast_LockFreeQueue.h"
#include "containers/beast_SharedTable.h"
#include "containers/beast_SortedLookupTable.h"

#include "events/beast_OncePerSecond.h"
#include "events/beast_PerformedAtExit.h"

#include "functor/beast_Bind.h"
#include "functor/beast_Function.h"

#include "math/beast_Interval.h"
#include "math/beast_Math.h"
#include "math/beast_MurmurHash.h"

#include "memory/beast_MemoryAlignment.h"
#include "memory/beast_StaticObject.h"
#include "memory/beast_AtomicCounter.h"
#include "memory/beast_AtomicFlag.h"
#include "memory/beast_AtomicPointer.h"
#include "memory/beast_AtomicState.h"
#include "memory/beast_AllocatedBy.h"
#include "memory/beast_RefCountedSingleton.h"
#include "memory/beast_FifoFreeStore.h"
#if BEAST_USE_BOOST
#include "memory/beast_FifoFreeStoreWithTLS.h"
#else
#include "memory/beast_FifoFreeStoreWithoutTLS.h"
#endif
#include "memory/beast_GlobalFifoFreeStore.h"
#include "memory/beast_GlobalPagedFreeStore.h"
#include "memory/beast_PagedFreeStore.h"

#if BEAST_MSVC
#pragma warning (push)
#pragma warning (disable: 4100) // unreferenced formal parmaeter
#pragma warning (disable: 4355) // 'this' used in base member
#endif
#include "memory/beast_CacheLine.h"
#if BEAST_MSVC
#pragma warning (pop)
#endif

#include "threads/beast_Semaphore.h"
#include "threads/beast_SerialFor.h"
#include "threads/beast_SpinDelay.h"
#include "threads/beast_InterruptibleThread.h"
#include "threads/beast_ReadWriteMutex.h"
#include "threads/beast_ThreadGroup.h"
#include "threads/beast_CallQueue.h"
#include "threads/beast_ConcurrentObject.h"
#include "threads/beast_ConcurrentState.h"
#include "threads/beast_GlobalThreadGroup.h"
#include "threads/beast_Listeners.h"
#include "threads/beast_ManualCallQueue.h"
#include "threads/beast_ParallelFor.h"
#include "threads/beast_ThreadWithCallQueue.h"
#include "threads/beast_SharedObject.h"

}

#endif