exceptions.hpp

// Copyright (c) 2014-2022 Thomas Fussell
// Copyright (c) 2010-2015 openpyxl
// Copyright (c) 2024-2026 xlnt-community
//
// 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
//
// @license: http://www.opensource.org/licenses/mit-license.php
// @author: see AUTHORS file

#pragma once

#include <stdexcept>

#include <xlnt/xlnt_config.hpp>
#include <xlnt/cell/index_types.hpp>
#include <xlnt/utils/variant.hpp>

namespace xlnt {

class XLNT_API exception : public std::runtime_error
{
public:
    explicit exception(const std::string &message);

    void message(const std::string &message);

    const std::string & message();

private:
    std::string message_;
};

class XLNT_API invalid_parameter : public exception
{
public:
    explicit invalid_parameter(const std::string &message);
};

class XLNT_API invalid_sheet_title : public exception
{
public:
    explicit invalid_sheet_title(const std::string &title);
};

class XLNT_API invalid_file : public exception
{
public:
    explicit invalid_file(const std::string &reason);
};

class XLNT_API illegal_character : public exception
{
public:
    explicit illegal_character(char c);
};

class XLNT_API invalid_data_type : public exception
{
public:
    invalid_data_type(const std::string &type);
};

class XLNT_API invalid_column_index : public exception
{
public:
    explicit invalid_column_index(column_t::index_t column_index);

    explicit invalid_column_index(column_t column);

    explicit invalid_column_index(const std::string &column_str);
};

class XLNT_API invalid_cell_reference : public exception
{
public:
    invalid_cell_reference(column_t column, row_t row);

    explicit invalid_cell_reference(const std::string &reference_string);
};

class XLNT_API invalid_attribute : public exception
{
public:
    explicit invalid_attribute(const std::string &message);
};

class XLNT_API key_not_found : public exception
{
public:
    explicit key_not_found(const std::string &key_name);
};

class XLNT_API no_visible_worksheets : public exception
{
public:
    no_visible_worksheets();
};

class XLNT_API unhandled_switch_case : public exception
{
public:
    explicit unhandled_switch_case(long long switch_value);

    explicit unhandled_switch_case(const std::string &switch_value_string);

    explicit unhandled_switch_case(const char *switch_value_optional_string = nullptr);
};

class XLNT_API invalid_password : public exception
{
public:
    explicit invalid_password(const std::string &message);
};

class XLNT_API unsupported : public exception
{
public:
    explicit unsupported(const std::string &message);
};

class XLNT_API encoding_error : public exception
{
public:
    explicit encoding_error(const std::string &message);
};

class XLNT_API bad_variant_access : public exception
{
public:
    explicit bad_variant_access(variant::type expected_type, variant::type actual_type);
};

} // namespace xlnt