text.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016-2016 CSSlayer <wengxt@gmail.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 *
 */
#ifndef _FCITX_TEXT_H_
#define _FCITX_TEXT_H_

#include <memory>
#include <ostream>
#include <string>
#include <vector>
#include <fcitx-utils/macros.h>
#include <fcitx-utils/textformatflags.h>
#include <fcitx/fcitxcore_export.h>

/// \addtogroup FcitxCore
/// \{
/// \file
/// \brief Formatted string commonly used in user interface.

namespace fcitx {
class TextPrivate;

/// A class represents a formatted string.
class FCITXCORE_EXPORT Text {
public:
    Text();
    explicit Text(std::string text,
                  TextFormatFlags flag = TextFormatFlag::NoFlag);
    FCITX_DECLARE_VIRTUAL_DTOR_COPY_AND_MOVE(Text);

    /// Get cursor by byte.
    int cursor() const;
    /// Set cursor by byte.
    void setCursor(int pos = -1);
    void clear();
    void append(std::string str, TextFormatFlags flag = TextFormatFlag::NoFlag);
    /**
     * Append another text.
     *
     * @param text text to append
     * @since 5.1.9
     */
    void append(Text text);
    const std::string &stringAt(int idx) const;
    TextFormatFlags formatAt(int idx) const;
    size_t size() const;
    bool empty() const;
    size_t textLength() const;
    std::string toString() const;
    std::string toStringForCommit() const;

    /**
     * Remove empty string piece and merge the string with same format.
     *
     * This function is useful for frontend to send less data over the wire and
     * avoid send data that is problematic for some frontend.
     *
     * @since 5.1.1
     */
    Text normalize() const;

    /**
     * Split Text object into lines.
     *
     * @return lines.
     * @since 5.0.6
     */
    std::vector<Text> splitByLine() const;

private:
    std::unique_ptr<TextPrivate> d_ptr;
    FCITX_DECLARE_PRIVATE(Text);
};

FCITXCORE_EXPORT std::ostream &operator<<(std::ostream &os, const Text &text);

} // namespace fcitx

#endif // _FCITX_TEXT_H_