rich_text.hpp

// Copyright (c) 2016-2022 Thomas Fussell
// Copyright (c) 2024 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 <string>
#include <vector>

#include <xlnt/xlnt_config.hpp>
#include <xlnt/cell/phonetic_run.hpp>
#include <xlnt/cell/rich_text_run.hpp>
#include <xlnt/worksheet/phonetic_pr.hpp>

namespace xlnt {

class XLNT_API rich_text
{
public:
    rich_text() = default;

    rich_text(const std::string &plain_text);

    rich_text(const rich_text &other);

    rich_text(const std::string &plain_text, const class font &text_font);

    rich_text(const rich_text_run &single_run);

    void clear();

    void plain_text(const std::string &s, bool preserve_space);

    std::string plain_text() const;

    std::vector<rich_text_run> runs() const;

    void runs(const std::vector<rich_text_run> &new_runs);

    void add_run(const rich_text_run &t);

    std::vector<phonetic_run> phonetic_runs() const;

    void phonetic_runs(const std::vector<phonetic_run> &new_phonetic_runs);

    void add_phonetic_run(const phonetic_run &t);

    bool has_phonetic_properties() const;

    const phonetic_pr &phonetic_properties() const;

    void phonetic_properties(const phonetic_pr &phonetic_props);

    rich_text &operator=(const rich_text &rhs);

    bool operator==(const rich_text &rhs) const;

    bool operator!=(const rich_text &rhs) const;

    bool operator==(const std::string &rhs) const;

    bool operator!=(const std::string &rhs) const;

private:
    std::vector<rich_text_run> runs_;
    std::vector<phonetic_run> phonetic_runs_;
    optional<phonetic_pr> phonetic_properties_;
};

class XLNT_API rich_text_hash
{
public:
    std::size_t operator()(const rich_text &k) const
    {
        std::size_t res = 0;

        for (auto r : k.runs())
        {
            res ^= std::hash<std::string>()(r.first);
        }

        return res;
    }
};

} // namespace xlnt