//////////////////////////////////////////////////////////////////////////////
/// \file   Exception.h
/// \brief  Generic Exception.
/// \author JD Gascuel.
/// \copyright (c) 2011-2016 JD Gascuel. All rights reserved.
/// $Id$
//////////////////////////////////////////////////////////////////////////////
//
// BSD 2-Clause License:
//
// 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.
//
// 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 HOLDER 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.
//
//////////////////////////////////////////////////////////////////////////////
// HISTORY
//  2013-12-21  jDG: Creation.
//  2016-05-24  jDG: BSD-2 version.

#ifndef EXCEPTION_H
#define EXCEPTION_H

#include <QString>
#include <exception>

//////////////////////////////////////////////////////////////////////////////
#define BUILD_OSTC_COMPANION 1

#if defined(BUILD_OSTC_COMPANION)
#  define EXPORT __declspec(dllexport)
#else
#  define EXPORT __declspec(dllimport)
#endif

class EXPORT Exception
  : public std::exception
{
    const char* const _msg;
public:
    explicit Exception(const char* msg);
    explicit Exception(const QString& msg);

    // Final cleanup.
    ~Exception() throw() override;

    /// Message contains, in UTF8 format.
    const char* what() const throw() override;
};

//////////////////////////////////////////////////////////////////////////////

#define DEFINE_EXCEPTION(name, parent) \
struct EXPORT name                                              \
  : public parent                                               \
{   explicit inline name(const char* msg)   : parent(msg) {}    \
    explicit inline name(const QString& msg): parent(msg) {}    \
}

DEFINE_EXCEPTION(Timeout, Exception);
    DEFINE_EXCEPTION(ReadTimeout,  Timeout);
    DEFINE_EXCEPTION(WriteTimeout, Timeout);

#endif // EXCEPTION_H