font.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 <cstring>
#include <functional>

#include <xlnt/xlnt_config.hpp>
#include <xlnt/styles/color.hpp>
#include <xlnt/utils/optional.hpp>
#include <xlnt/utils/hash_combine.hpp>

namespace xlnt {

class style;

class XLNT_API font
{
public:
    enum class underline_style
    {
        none,
        double_,
        double_accounting,
        single,
        single_accounting
    };

    font();

    font &bold(bool bold);

    bool bold() const;

    font &subscript(bool value);

    bool subscript() const;

    font &superscript(bool value);

    bool superscript() const;

    font &italic(bool italic);

    bool italic() const;

    font &strikethrough(bool strikethrough);

    bool strikethrough() const;

    font &outline(bool outline);

    bool outline() const;

    font &shadow(bool shadow);

    bool shadow() const;

    font &underline(underline_style new_underline);

    bool underlined() const;

    underline_style underline() const;

    bool has_size() const;

    font &size(double size);

    double size() const;

    bool has_name() const;

    font &name(const std::string &name);

    const std::string &name() const;

    bool has_color() const;

    font &color(const color &c);

    xlnt::color color() const;

    bool has_family() const;

    font &family(std::size_t family);

    std::size_t family() const;

    bool has_charset() const;

    // TODO: charset should be an enum, not a number

    font &charset(std::size_t charset);

    std::size_t charset() const;

    bool has_scheme() const;

    font &scheme(const std::string &scheme);

    const std::string &scheme() const;

    bool operator==(const font &other) const;

    bool operator!=(const font &other) const
    {
        return !operator==(other);
    }

private:
    friend class style;

    optional<std::string> name_;

    optional<double> size_;

    bool bold_ = false;

    bool italic_ = false;

    bool superscript_ = false;

    bool subscript_ = false;

    bool strikethrough_ = false;

    bool outline_ = false;

    bool shadow_ = false;

    underline_style underline_ = underline_style::none;

    optional<xlnt::color> color_;

    optional<std::size_t> family_;

    optional<std::size_t> charset_;

    optional<std::string> scheme_;
};

} // namespace xlnt

namespace std {

template<>
struct hash<xlnt::font>
{
    size_t operator()(const xlnt::font& f) const
    {
        size_t seed = 0;

        // Hash name
        if (f.has_name())
        {
            xlnt::detail::hash_combine(seed, f.name());
        }

        // Hash size
        if (f.has_size())
        {
            xlnt::detail::hash_combine(seed, f.size());
        }

        // Hash all boolean properties
        xlnt::detail::hash_combine(seed, f.bold());
        xlnt::detail::hash_combine(seed, f.italic());
        xlnt::detail::hash_combine(seed, f.superscript());
        xlnt::detail::hash_combine(seed, f.subscript());
        xlnt::detail::hash_combine(seed, f.strikethrough());
        xlnt::detail::hash_combine(seed, static_cast<int>(f.underline()));
        xlnt::detail::hash_combine(seed, f.outline());
        xlnt::detail::hash_combine(seed, f.shadow());

        // Hash scheme
        if (f.has_scheme())
        {
            xlnt::detail::hash_combine(seed, f.scheme());
        }

        // Hash color (importantly, this re-uses the std::hash<xlnt::color> we just defined)
        if (f.has_color())
        {
            xlnt::detail::hash_combine(seed, f.color());
        }

        // Hash family
        if (f.has_family())
        {
            xlnt::detail::hash_combine(seed, f.family());
        }

        // Hash charset
        if (f.has_charset())
        {
            xlnt::detail::hash_combine(seed, f.charset());
        }

        return seed;
    }
};

} // namespace std