Sawyer.h

// WARNING: Changes to this file must be contributed back to Sawyer or else they will
//          be clobbered by the next update from Sawyer.  The Sawyer repository is at
//          https://github.com/matzke1/sawyer.




#ifndef Sawyer_H
#define Sawyer_H

#include <boost/cstdint.hpp>
#include <boost/thread/recursive_mutex.hpp>
#include <cstdio>
#include <string>

// Version numbers (conditional compiliation is only so we can test version mismatch handling)
#ifndef SAWYER_VERSION_MAJOR
#define SAWYER_VERSION_MAJOR    0
#define SAWYER_VERSION_MINOR    1
#define SAWYER_VERSION_PATCH    0
#endif

// Macros for thread-safety portability. This allows Sawyer to be compiled with or without thread support and not have a huge
// proliferation of conditional compilation directives in the main body of source code.
#ifdef _REENTRANT
    #define SAWYER_MULTI_THREADED 1
    #define SAWYER_THREAD_TAG Sawyer::MultiThreadedTag
#else
    #define SAWYER_MULTI_THREADED 0
    #define SAWYER_THREAD_TAG Sawyer::SingleThreadedTag
#endif
#define SAWYER_THREAD_TRAITS Sawyer::SynchronizationTraits<SAWYER_THREAD_TAG>

#ifdef _REENTRANT
    #if __cplusplus >= 201103L
       #define SAWYER_THREAD_LOCAL thread_local
    #elif defined(_MSC_VER)
        // Visual C++, Intel (Windows), C++ Builder, Digital Mars C++
        #define SAWYER_THREAD_LOCAL __declspec(thread)
    #else
       // Solaris Studio, IBM XL, GNU, LLVM, Intel (linux)
       #define SAWYER_THREAD_LOCAL __thread
    #endif
#else
     #define SAWYER_THREAD_LOCAL /*void*/
#endif

#ifdef BOOST_WINDOWS
    //--------------------------
    // Microsoft Windows
    //--------------------------
    // FIXME[Robb Matzke 2014-06-18]: get rid of ROSE_UTIL_EXPORTS; cmake can only have one DEFINE_SYMBOL
    #if defined(SAWYER_DO_EXPORTS) || defined(ROSE_UTIL_EXPORTS) // defined in CMake when compiling libsawyer
        #define SAWYER_EXPORT __declspec(dllexport)
        #if _MSC_VER
            #define SAWYER_EXPORT_NORETURN __declspec(dllexport noreturn)
        #else
            // MinGW complains about __declspec(dllexport noreturn), so use only __declspec(dllexport) instead.
            #define SAWYER_EXPORT_NORETURN __declspec(dllexport)
        #endif
    #else
        #define SAWYER_EXPORT __declspec(dllimport)
        #define SAWYER_EXPORT_NORETURN __declspec(noreturn)
    #endif
#elif defined(__APPLE__) && defined(__MACH__)
    //--------------------------
    // Apple OSX, iOS, Darwin
    //--------------------------
    #define SAWYER_EXPORT /*void*/
    #define SAWYER_EXPORT_NORETURN _Noreturn
#else
    //--------------------------
    // Other OS compilers
    //--------------------------
    #define SAWYER_EXPORT /*void*/
    #define SAWYER_EXPORT_NORETURN /*void*/
#endif

#define SAWYER_LINKAGE_INFO SAWYER_VERSION_MAJOR, SAWYER_VERSION_MINOR, SAWYER_VERSION_PATCH, SAWYER_MULTI_THREADED
#define SAWYER_CHECK_LINKAGE Sawyer::initializeLibrary(SAWYER_LINKAGE_INFO)
    

namespace Sawyer {
    
SAWYER_EXPORT bool initializeLibrary(size_t vmajor=SAWYER_VERSION_MAJOR,
                                     size_t vminor=SAWYER_VERSION_MINOR,
                                     size_t vpatch=SAWYER_VERSION_PATCH,
                                     bool withThreads=SAWYER_MULTI_THREADED);

SAWYER_EXPORT boost::int64_t strtoll(const char*, char**, int);

SAWYER_EXPORT boost::uint64_t strtoull(const char*, char**, int);

SAWYER_EXPORT std::string readOneLine(FILE*);

SAWYER_EXPORT FILE *popen(const std::string&, const char *how);

SAWYER_EXPORT int pclose(FILE*);

SAWYER_EXPORT std::string generateSequentialName(size_t length=3);

SAWYER_EXPORT void checkBoost();

SAWYER_EXPORT std::string thisExecutableName();

} // namespace

// Define only when we have the Boost Chrono library, which was first available in boost-1.47.
//#define SAWYER_HAVE_BOOST_CHRONO


//                                      Compiler portability issues
//
// The following macros are used to distinguish between different compilers:
//     _MSC_VER         Defined only when compiled by Microsoft's MVC C++ compiler. This macro is predefined by Microsoft's
//                      preprocessor.
//
// The following macros are used to distinguish between different target environments, regardless of what compiler is being
// used or the environment which is doing the compiling.  For instance, BOOST_WINDOWS will be defined when using the MinGW
// compiler on Linux to target a Windows environment.
//     BOOST_WINDOWS    The Windows API is present.  This is defined (or not) by including <boost/config.hpp>.
//

// Suppress warnings about unused function formal arguments. Most of the time you can simply omit the argument name, but that's
// not possible if the argument is integral to the documentation. In those cases, mention the argument with this macro.
# define SAWYER_ARGUSED(X) (void)(X)

#ifdef _MSC_VER
//--------------------------
// Microsoft Windows
//--------------------------

# define SAWYER_ATTR_UNUSED /*void*/
# define SAWYER_ATTR_NORETURN /*void*/
# define SAWYER_PRETTY_FUNCTION __FUNCSIG__
# define SAWYER_MAY_ALIAS /*void*/
# define SAWYER_STATIC_INIT /*void*/
# define SAWYER_DEPRECATED(WHY) /*void*/

// Microsoft compiler doesn't support stack arrays whose size is not known at compile time.  We fudge by using an STL vector,
// which will be cleaned up propertly at end of scope or exceptions.
# define SAWYER_VARIABLE_LENGTH_ARRAY(TYPE, NAME, SIZE) \
    std::vector<TYPE> NAME##Vec_(SIZE);                 \
    TYPE *NAME = &(NAME##Vec_[0]);

#elif defined(__sun)
//--------------------------
// Sun Solaris
//--------------------------

# define SAWYER_ATTR_UNUSED /*void*/
# define SAWYER_ATTR_NORETURN /*void*/
# define SAWYER_PRETTY_FUNCTION __PRETTY_FUNCTION__
# define SAWYER_MAY_ALIAS /*void*/
# define SAWYER_STATIC_INIT /*void*/
# define SAWYER_DEPRECATED(WHY) /*void*/

# define SAWYER_VARIABLE_LENGTH_ARRAY(TYPE, NAME, SIZE) \
    TYPE NAME[SIZE]; memset(NAME, 0, (SIZE)*sizeof(TYPE))

#elif defined(__APPLE__) && defined(__MACH__)
//--------------------------
// Apple OSX, iOS, Darwin
//--------------------------

# define SAWYER_ATTR_UNUSED /*void*/
# define SAWYER_ATTR_NORETURN /*void*/
# define SAWYER_PRETTY_FUNCTION __PRETTY_FUNCTION__
# define SAWYER_MAY_ALIAS /*void*/
# define SAWYER_STATIC_INIT /*void*/
# define SAWYER_DEPRECATED(WHY) /*void*/

// Apple compilers don't support stack arrays whose size is not known at compile time.  We fudge by using an STL vector,
// which will be cleaned up propertly at end of scope or exceptions.
# define SAWYER_VARIABLE_LENGTH_ARRAY(TYPE, NAME, SIZE) \
    std::vector<TYPE> NAME##Vec_(SIZE);                 \
    TYPE *NAME = &(NAME##Vec_[0]);


#else
//--------------------------
// Other, GCC-based
//--------------------------

# define SAWYER_ATTR_UNUSED __attribute__((unused))
# define SAWYER_ATTR_NORETURN __attribute__((noreturn))
# define SAWYER_PRETTY_FUNCTION __PRETTY_FUNCTION__
# define SAWYER_MAY_ALIAS __attribute__((may_alias))
# define SAWYER_DEPRECATED(WHY) __attribute__((deprecated))

// Sawyer globals need to be initialized after the C++ standard runtime, but before other user-level stuff. The constant 101
// causes the initialization to happen as early as possible after the C++ runtime.
# define SAWYER_STATIC_INIT __attribute__((init_priority(101)))

# define SAWYER_VARIABLE_LENGTH_ARRAY(TYPE, NAME, SIZE) \
    TYPE NAME[SIZE]; memset(NAME, 0, (SIZE)*sizeof(TYPE))

#endif

#define SAWYER_CONFIGURED /*void*/

#endif

// Clean up namespace pollution (shame on Qt for attempting to unilaterally change the language!)
// These need to be outside the #ifndef Sawyer_H that protects the rest of this file, otherwise the following
// is possible:
//     #include "foo.h" // which includes Saywer.h"
//     #include "bar.h" // which includes #define emit...
//     #include "baz.h" // which has "emit" symbols clobbered by the pollution
//
// I decided it's better to fail early/fail often, therefore these are always deleted.
// Please fix your Qt headers. Qt's "moc" tool has a command-line switch that prevents the pollution.
#undef slot
#undef emit