pinyincontext.h

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

#include <cstddef>
#include <memory>
#include <span>
#include <string>
#include <string_view>
#include <unordered_set>
#include <utility>
#include <vector>
#include <fcitx-utils/macros.h>
#include <libime/core/inputbuffer.h>
#include <libime/core/languagemodel.h>
#include <libime/core/lattice.h>
#include <libime/pinyin/libimepinyin_export.h>
#include "libime/core/historybigram.h"

namespace libime {
class PinyinIME;
class PinyinContextPrivate;
enum class PinyinPreeditMode;

class LIBIMEPINYIN_EXPORT PinyinContext : public InputBuffer {
public:
    PinyinContext(PinyinIME *ime);
    virtual ~PinyinContext();

    void setUseShuangpin(bool sp);
    bool useShuangpin() const;

    void erase(size_t from, size_t to) override;
    void setCursor(size_t pos) override;

    int maxSentenceLength() const;
    void setMaxSentenceLength(int length);

    const std::vector<SentenceResult> &candidates() const;

    /**
     * Return the set of candidates, useful for deduplication.
     *
     * @see PinyinContext::candidates
     * @since 1.0.18
     */
    const std::unordered_set<std::string> &candidateSet() const;

    const std::vector<SentenceResult> &candidatesToCursor() const;

    /**
     * Return the set of candidates to current cursor.
     *
     * @see PinyinContext::candidatesToCursor
     * @since 1.0.18
     */
    const std::unordered_set<std::string> &candidatesToCursorSet() const;
    void select(size_t idx);
    void selectCandidatesToCursor(size_t idx);
    void cancel();
    bool cancelTill(size_t pos);

    /**
     * Create a custom selection
     *
     * This allows Engine to do make a custom selection that is not pinyin.
     *
     * @param inputLength the length of characters to match in the input
     * @param segment segment
     * @param encodedPinyin whether this segment has a pinyin
     * @since 1.1.7
     */
    void selectCustom(size_t inputLength, std::string_view segment,
                      std::string_view encodedPinyin = "");

    /// Whether the input is fully selected.
    bool selected() const;

    /// The sentence for this context, can be used as preedit.
    std::string sentence() const {
        const auto &c = candidates();
        if (!c.empty()) {
            return selectedSentence() + c[0].toString();
        }
        return selectedSentence();
    }

    std::string preedit(PinyinPreeditMode mode) const;

    /// Mixed preedit (selected hanzi + pinyin).
    std::pair<std::string, size_t>
    preeditWithCursor(PinyinPreeditMode mode) const;

    std::string preedit() const;

    /// Mixed preedit (selected hanzi + pinyin).
    std::pair<std::string, size_t> preeditWithCursor() const;

    /// Selected hanzi.
    std::string selectedSentence() const;

    /// Selected pinyin length.
    size_t selectedLength() const;

    /// Selected hanzi segments.
    std::vector<std::string> selectedWords() const;

    /// Selected hanzi with encoded pinyin
    std::vector<HistoryBigram::WordWithCode> selectedWordsWithPinyin() const;

    /// Get the full pinyin string of the selected part.
    std::string selectedFullPinyin() const;

    /// Get the full pinyin string of certain candidate.
    std::string candidateFullPinyin(size_t i) const;

    /// Get the full pinyin string of certain candidate.
    std::string candidateFullPinyin(const SentenceResult &candidate) const;

    /// Add the selected part to history if selected() == true.
    void learn();

    /// Return the position of last pinyin. E.g. 你h|ao, return the offset
    /// before h.
    int pinyinBeforeCursor() const;

    /// Return the position of last pinyin. E.g. 你h|ao, return the offset after
    /// h.
    int pinyinAfterCursor() const;

    PinyinIME *ime() const;

    /// Opaque language model state.
    State state() const;

    /**
     * Set context words for better prediction.
     * @param contextWords The context words.
     * @since 1.1.13
     */
    void setContextWords(const std::vector<std::string> &contextWords);

    /**
     * Clear context words.
     * @since 1.1.13
     */
    void clearContextWords();

    /**
     * Append context words for better prediction.
     * @param contextWords The context words.
     * @since 1.1.13
     */
    void appendContextWords(const std::vector<std::string> &contextWords);

    /**
     * Get context words for better prediction.
     * @return current context words
     * @since 1.1.13
     */
    std::vector<std::string> contextWords() const;

    /**
     * Set context words with pinyin for better prediction.
     * @param contextWordsWithPinyin The context words with encoded pinyin.
     * @since 1.1.14
     */
    void setContextWordsWithPinyin(
        const std::vector<HistoryBigram::WordWithCode> &contextWordsWithPinyin);

    /**
     * Append context words with pinyin for better prediction.
     * @param contextWordsWithPinyin The context words with pinyin.
     * @since 1.1.14
     */
    void appendContextWordsWithPinyin(
        const std::vector<HistoryBigram::WordWithCode> &contextWordsWithPinyin);

    /**
     * Get context words with pinyin for better prediction.
     * @return current context words with pinyin
     * @since 1.1.14
     */
    std::vector<HistoryBigram::WordWithCode> contextWordsWithPinyin() const;

protected:
    bool typeImpl(const char *s, size_t length) override;

private:
    void update();
    bool learnWord();
    std::unique_ptr<PinyinContextPrivate> d_ptr;
    FCITX_DECLARE_PRIVATE(PinyinContext);
};
} // namespace libime

#endif // _FCITX_LIBIME_PINYIN_PINYINCONTEXT_H_