tablecontext.h

Go to the documentation of this file.

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

/// \file
/// \brief Class provide input method support for table-based ones, like wubi.

// Workaround a boost missing include bug.
#include <boost/type_traits/add_const.hpp>

#include <cstddef>
#include <cstdint>
#include <memory>
#include <string>
#include <string_view>
#include <tuple>
#include <vector>
#include <boost/iterator/iterator_categories.hpp>
#include <boost/range/any_range.hpp>
#include <fcitx-utils/macros.h>
#include <libime/core/inputbuffer.h>
#include <libime/table/libimetable_export.h>
#include <libime/table/tablebaseddictionary.h>
#include "libime/core/lattice.h"

namespace libime {

class TableContextPrivate;
class TableBasedDictionary;
class UserLanguageModel;

/// \brief Input context for table input method.
class LIBIMETABLE_EXPORT TableContext : public InputBuffer {
public:
    using CandidateRange = boost::any_range<const SentenceResult,
                                            boost::random_access_traversal_tag>;

    TableContext(TableBasedDictionary &dict, UserLanguageModel &model);
    virtual ~TableContext();

    void erase(size_t from, size_t to) override;

    void select(size_t idx);

    bool isValidInput(uint32_t c) const;

    CandidateRange candidates() const;

    std::string candidateHint(size_t idx, bool custom = false) const;

    static std::string code(const SentenceResult &sentence);
    static PhraseFlag flag(const SentenceResult &sentence);
    static bool isPinyin(const SentenceResult &sentence);
    static bool isAuto(const SentenceResult &sentence);

    bool selected() const;
    size_t selectedSize() const;
    std::tuple<std::string, bool> selectedSegment(size_t idx) const;
    std::string selectedCode(size_t idx) const;
    size_t selectedSegmentLength(size_t idx) const;

    /// \brief A simple preedit implementation.
    /// The value is derived from function selectedSegment and currentCode.
    std::string preedit() const;

    /// \brief Current unselected code.
    const std::string &currentCode() const;

    /// \brief The concatenation of all selectedSegment where bool == true.
    std::string selectedSentence() const;
    size_t selectedLength() const;

    /// \brief Save the current selected text.
    void learn();

    /// \brief Save the last selected text.
    void learnLast();

    /// \brief Learn auto word from string.
    ///
    /// Depending on the tableOptions, it will try to learn the word in history.
    void learnAutoPhrase(std::string_view history);

    /// \brief Learn auto word from string
    ///
    /// Similar to its overload, but with hint of given code.
    void learnAutoPhrase(std::string_view history,
                         const std::vector<std::string> &hints);

    const TableBasedDictionary &dict() const;
    TableBasedDictionary &mutableDict();

    const UserLanguageModel &model() const;
    UserLanguageModel &mutableModel();
    void autoSelect();

    /// Set the auto select index, usually, this is the candidate cursor index.
    ///
    /// \since 1.0.12
    void setAutoSelectIndex(size_t index);

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

private:
    void update();
    bool typeOneChar(std::string_view chr);

    std::unique_ptr<TableContextPrivate> d_ptr;
    FCITX_DECLARE_PRIVATE(TableContext);
};
} // namespace libime

#endif // _FCITX_LIBIME_TABLE_TABLECONTEXT_H_