/****************************************************************************
**
** This file is part of the Ponder library, formerly CAMP.
**
** The MIT License (MIT)
**
** Copyright (C) 2009-2014 TEGESO/TEGESOFT and/or its subsidiary(-ies) and mother company.
** Copyright (C) 2015-2018 Nick Trout.
**
** 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.
**
****************************************************************************/

#pragma once
#ifndef PONDER_ERRORS_HPP
#define PONDER_ERRORS_HPP

#include <ponder/error.hpp>
#include <ponder/type.hpp>

namespace ponder {
    
class Class;

/**
 * \brief Error thrown when providing a metavalue whose type is incompatible with what's expected
 */
class PONDER_API BadType : public Error
{
public:

    /**
     * \brief Constructor
     *
     * \param provided Provided type
     * \param expected Expected type
     */
    BadType(ValueKind provided, ValueKind expected);

protected:

    /**
     * \brief Constructor for derived classes
     *
     * \param message Description of the error
     */
    BadType(const String& message);

    /**
     * \brief Get the string name of a Ponder type
     *
     * \param type Type to convert
     *
     * \return Name of the provided type
     */
    static ponder::String typeName(ValueKind type);
};

/**
 * \brief Error thrown when providing a function argument which is incompatible with 
 *        what the function expects
 */
class PONDER_API BadArgument : public BadType
{
public:

    /**
     * \brief Constructor
     *
     * \param provided Provided type
     * \param expected Expected type
     * \param index Index of the argument in the function prototype
     * \param functionName Name of the function
     */
    BadArgument(ValueKind provided, ValueKind expected,
                std::size_t index, IdRef functionName);
};

/**
 * \brief Error thrown when a declaring a metaclass that already exists
 */
class PONDER_API ClassAlreadyCreated : public Error
{
public:

    /**
     * \brief Constructor
     *
     * \param idType Name of the class
     */
    ClassAlreadyCreated(IdRef idType);
};

/**
 * \brief Error thrown when a metaclass couldn't be found (either by its name or its id)
 */
class PONDER_API ClassNotFound : public Error
{
public:

    /**
     * \brief Constructor
     *
     * \param name Name of the requested class
     */
    ClassNotFound(IdRef name);
};

/**
 * \brief Error thrown when trying to convert an object to a class that is not a 
 *        base nor a derived
 */
class PONDER_API ClassUnrelated : public Error
{
public:

    /**
     * \brief Constructor
     *
     * \param sourceClass Name of the source class
     * \param requestedClass Name of the requested class
     */
    ClassUnrelated(IdRef sourceClass, IdRef requestedClass);
};

/**
 * \brief Error thrown when a declaring a metaenum that already exists
 */
class PONDER_API EnumAlreadyCreated : public Error
{
public:

    /**
     * \brief Constructor
     *
     * \param typeId Name of the enum
     */
    EnumAlreadyCreated(IdRef typeId);
};

/**
 * \brief Error thrown when the value of a metaenum couldn't be found by its name
 */
class PONDER_API EnumNameNotFound : public Error
{
public:

    /**
     * \brief Constructor
     *
     * \param name Name of the requested metaenum member
     * \param enumName Name of the owner metaenum
     */
    EnumNameNotFound(IdRef name, IdRef enumName);
};

/**
 * \brief Error thrown when a metaenum couldn't be found (either by its name or its id)
 */
class PONDER_API EnumNotFound : public Error
{
public:

    /**
     * \brief Constructor
     *
     * \param name Name of the requested enum
     */
    EnumNotFound(IdRef name);
};

/**
 * \brief Error thrown when a value in a metaenum couldn't be found
 */
class PONDER_API EnumValueNotFound : public Error
{
public:

    /**
     * \brief Constructor
     *
     * \param value Value of the requested metaenum member
     * \param enumName Name of the owner metaenum
     */
    EnumValueNotFound(long value, IdRef enumName);
};

/**
 * \brief Error thrown when calling a function that is not callable
 */
class PONDER_API ForbiddenCall : public Error
{
public:

    /**
     * \brief Constructor
     *
     * \param functionName Name of the function
     */
    ForbiddenCall(IdRef functionName);
};

/**
 * \brief Error thrown when trying to read a property that is not readable
 */
class PONDER_API ForbiddenRead : public Error
{
public:

    /**
     * \brief Constructor
     *
     * \param propertyName Name of the property
     */
    ForbiddenRead(IdRef propertyName);
};

/**
 * \brief Error thrown when trying to write a function that is not writable
 */
class PONDER_API ForbiddenWrite : public Error
{
public:

    /**
     * \brief Constructor
     *
     * \param propertyName Name of the property
     */
    ForbiddenWrite(IdRef propertyName);
};

/**
 * \brief Error thrown when a function can't be found in a metaclass (by its name)
 */
class PONDER_API FunctionNotFound : public Error
{
public:

    /**
     * \brief Constructor
     *
     * \param name Name of the requested function
     * \param className Name of the owner metaclass
     */
    FunctionNotFound(IdRef name, IdRef className);
};
    
/**
 * \brief Error thrown when a declaring a metaclass that already exists
 */
class PONDER_API NotEnoughArguments : public Error
{
public:

    /**
     * \brief Constructor
     *
     * \param functionName Name of the function
     * \param provided Number of arguments provided
     * \param expected Number of arguments expected
     */
    NotEnoughArguments(IdRef functionName,
                       std::size_t provided,
                       std::size_t expected);
};

/**
 * \brief Error thrown when trying to use an empty metaobject
 */
class PONDER_API NullObject : public Error
{
public:

    /**
     * \brief Constructor
     *
     * \param objectClass Metaclass of the object (may be null if object has no class)
     */
    NullObject(const Class* objectClass);
};

/**
 * \brief Error thrown when using an index which is out of bounds
 */
class PONDER_API OutOfRange : public Error
{
public:

    /**
     * \brief Constructor
     *
     * \param index Invalid index
     * \param size Allowed size
     */
    OutOfRange(std::size_t index, std::size_t size);
};

/**
 * \brief Error thrown when a property can't be found in a metaclass (by its name)
 */
class PONDER_API PropertyNotFound : public Error
{
public:

    /**
     * \brief Constructor
     *
     * \param name Name of the requested property
     * \param className Name of the owner metaclass
     */
    PropertyNotFound(IdRef name, IdRef className);
};

/**
 * \brief Error thrown when cannot distinguish between multiple type instance
 */
class PONDER_API TypeAmbiguity : public Error
{
public:
    
    /**
     * \brief Constructor
     *
     * \param typeName Name of the type causing problems
     */
    TypeAmbiguity(IdRef typeName);
};

} // namespace ponder

#endif // PONDER_ERRORS_HPP
