i3_ipc_invalid_argument.hpp

/*
    Copyright (C) 2019, Ivan Balević

    This file is part of "i3-ipc++" library.

    "i3-ipc++" is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    "i3-ipc++" is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with "i3-ipc++". If not, see <https://www.gnu.org/licenses/>.
*/

/**
 * \file    i3_ipc_invalid_argument.hpp
 *
 * \brief   Defines "i3_ipc_invalid_argument" class used for throwing errors when user provides invalid arguments.
 */

#ifndef I3_IPC_INVALID_ARGUMENT_HPP
#define I3_IPC_INVALID_ARGUMENT_HPP

// Library headers.
#include "i3_ipc_exception.hpp"

// C++ headers.
#include <string_view>

/**
 * \brief   Exception class used only when user provides bad arguments to the "i3-ipc++" library.
 */
class i3_ipc_invalid_argument : public i3_ipc_exception
{

public:

    /**
     * \brief                        Constructs exception class with error message.
     *
     * \param [in] a_error_message   Error message used to explain what went wrong.
     */
    i3_ipc_invalid_argument(std::string_view a_error_message);

    /**
     * \brief    Function explaining what went wrong.
     *
     * \return   Error message.
     */
    virtual const char* what() const noexcept;

    /**
     * \brief                        Sets new error message.
     *
     * \param [in] a_error_message   Error message used to explain what went wrong.
     */
    void set_error_message(std::string_view a_error_message);

};

#endif // I3_IPC_INVALID_ARGUMENT_HPP