Parent&child providers help required

[distractor]

Hi,

This isn't really in issue but more of a "how to question".

Let's assume I wanted to type box:statistic("area"). And my wish is to trigger autocomplete on three different places. Starting with an empty line:

• b should I guess show everything that starts with b including box:. Then I press ENTER to confirm.
• my text is box: which should (immediately) trigger&show the second autocomplete, containing for example property(, property_at( and statistic(. So if my text is box:s the autocomplete should show only box:statistic(. I press ENTER again
• My text is now box:statistic( which should trigger a final provider with a list of suggestions "stat1", "stat2".

Is building such hierarchy possible? Is there some example code somewhere or could it be briefly explained how to do it?

[distractor]

I actually got this far:

But as you can see pressing ENTER to confirm selection box:statistic( does not trigger the following provider. If I add changes to the code (add white space and remove it) the correct provider is shown. Maybe there is a signal emission missing, @gamecreature ?

Not that I set this up using multiple edbee::TextAutoCompleteProvider:

1. One for box
2. another one for box:property, box:property_at, box:statistic_at and box:statistic(
3. and then the third one with box:statistic( + a list of "<stat_name>"

Apart from the (I think) missing signal emission it almost works, nevertheless I still think somebody thought of this and there is probably a better way to do it.

[gamecreature]

@distractor To be honest I'm nu sure. I've built the basic autocomplete implementation a long time ago. (It was good enough for the moment)
I don't think the implementation was built with this concept in mind. After selecting an item, directly showing another autocomplete.
Can you share (the basics) of you implementation?

I guess something like this needs to happen:

• event of autocomplete closed is fired
• directly a evaluation should happen to check if another autocomplete is required. (You don't want an endless autocomplete loop)

[distractor]

Hi,

So the "basics" of my implementation I'm sharing below are not really so "basic". Mainly because I think I have found a fairly save solution and did not bother too much with a basic reproducible example. Do not hesitate to ask for better example, if one is required.

Fundamentals

I have defined a wrapper around edbee:

    class MyProvider : public edbee::TextAutoCompleteProvider
    {
    public:
        explicit MyProvider(const QString& triggerWord);
        QList<edbee::TextAutoCompleteItem*> findAutoCompleteItemsForRange(edbee::TextDocument* document, const edbee::TextRange& range, const QString& word) override;
        QString triggerWord() const { return m_TriggerWord; };

    protected:
        QList<edbee::TextAutoCompleteItem*> m_ItemList;

    private:
        QString m_TriggerWord;
    };

And a nested provider:

    class MyNestedProvider : public MyProvider
    {
    public:
        using MyProvider::MyProvider;

        QList<edbee::TextAutoCompleteItem*> findAutoCompleteItemsForRange(edbee::TextDocument* document, const edbee::TextRange& range, const QString& word) override;
    };

Note that I had to play a bit with the findAutoCompleteItemsForRange:

/* MyProvider */

MyProvider::MyProvider(const QString& triggerWord) : m_TriggerWord(triggerWord) {};

QList<edbee::TextAutoCompleteItem*> MyProvider::findAutoCompleteItemsForRange(edbee::TextDocument* document, const edbee::TextRange& range, const QString& word)
{
    QList<edbee::TextAutoCompleteItem*> matches;

    for (edbee::TextAutoCompleteItem* item : m_ItemList)
        if (item->label().startsWith(word, Qt::CaseInsensitive))
        {
            const int score = item->matchLabelScore(document, range, word);
            if (score > 0)
                matches.append(item);
        }

    std::ranges::sort(matches, [](const edbee::TextAutoCompleteItem* a, const edbee::TextAutoCompleteItem* b) {
        return a->label() < b->label();
    });

    return matches;
}

/* MyNestedProvider */

QList<edbee::TextAutoCompleteItem*> MyNestedProvider::findAutoCompleteItemsForRange(edbee::TextDocument* document, const edbee::TextRange& range, const QString& word)
{
    QList<edbee::TextAutoCompleteItem*> matches;

    for (edbee::TextAutoCompleteItem* item : m_ItemList)
        // The first part of the following if check assures the long list of statistic names is shown
        // only after "<input_name>:statistic(" is typed. Note that an EXACT match is required.
        //  It's subjective, but I think this results in better user experience. Alternative is to just show everything along with
        //  "<input_name>:property(" and others.
        if (word.contains(this->triggerWord(), Qt::CaseSensitive) && item->matchLabelScore(document, range, word) > 0)
            matches.append(item);

    std::ranges::sort(matches, [](const edbee::TextAutoCompleteItem* a, const edbee::TextAutoCompleteItem* b) {
        return a->label() < b->label();
    });

    return matches;
}

Usage

        class ObjectAutoCompleteProvider : public MyProvider
        {
        public:
            explicit ObjectAutoCompleteProvider(const QString& triggerWord);
            static std::vector<MyProvider*> createWithSupplements(const QString& triggerWord, const QStringList& statisticNameList, const QStringList& propertyNameList);

        private:
            MyProvider* createParameterNamesProvider(const QString& accessPoint);
        };

        class ParameterNamesProvider : public MyNestedProvider
        {
        public:
            explicit ParameterNamesProvider(const MyProvider* pParent, const QString& accessPoint, const QStringList& parameterList);
        };

with the following implementation:

    /* Object provider. */
    Lua::ObjectAutoCompleteProvider::ObjectAutoCompleteProvider(const QString& triggerWord) : MyProvider(triggerWord + ":")
    {
        m_ItemList.append(new edbee::TextAutoCompleteItem(triggerWord, edbee::TextAutoCompleteKind::Class));  // Add self-id.

        auto add = [&](const QString& label, const QString& detail, const QString outputType = "value") {
            m_ItemList.append(new edbee::TextAutoCompleteItem(this->triggerWord() + label, edbee::TextAutoCompleteKind::Function, outputType + " = " + this->triggerWord() + detail));
        };

        // TODO: These methods are defined in calculation_object.cpp.
        // Would be nice if we could automatically get them here instead.
        add("property", "property(name)");
        add("property_at", "property_at(name, time)");
        add("statistic(", "statistic(name)"); // <----- this is where the nested stuff will work for now!
        add("statistic_at", "statistic_at(name, time)");
    };

    std::vector<MyProvider*>
    Lua::ObjectAutoCompleteProvider::createWithSupplements(const QString& triggerWord, const QStringList& statisticNameList, const QStringList& propertyNameList)
    {
        std::vector<MyProvider*> providers;
        auto pObjectProvider = new ObjectAutoCompleteProvider(triggerWord);
        providers.emplace_back(pObjectProvider);

        // Supplements.
        if (!statisticNameList.empty())
            providers.emplace_back(new ParameterNamesProvider(pObjectProvider, "statistic", statisticNameList));
        if (!propertyNameList.empty())
            providers.emplace_back(new ParameterNamesProvider(pObjectProvider, "property", propertyNameList));

        return providers;
    }

    /* Statistic&Property names provider. */
    Lua::ParameterNamesProvider::ParameterNamesProvider(const MyProvider* pParent, const QString& accessPoint, const QStringList& parameterList) : MyNestedProvider(pParent->triggerWord() + accessPoint + "(")
    {
        auto add = [&](const QString& label, const QString outputType = "value") {
            m_ItemList.append(new edbee::TextAutoCompleteItem(triggerWord() + label + ")", edbee::TextAutoCompleteKind::Value, outputType));
            m_ItemList.append(new edbee::TextAutoCompleteItem(triggerWord() + "_at(" + label + ", ", edbee::TextAutoCompleteKind::Value, outputType));
        };

        for (const auto& param : parameterList)
            add(param);
    }

Notice that the ParameterNamesProvider has a trigger word set to parent_trigger + access_point + "(". The parent is triggered at "box", access point in my case is "statistic".

All that is needed is to call all of this from main:

                auto sceneProviders = Lua::ObjectAutoCompleteProvider::createWithSupplements(QString::fromStdString(entry.name()), statisticNames, propertyNames);  // TODO: needs to get property names list.
                providers.insert(providers.end(), sceneProviders.begin(), sceneProviders.end());

MR

After some testing debugging the only thing I found missing is to re-check if an auto-complete list should be shown after an item is selected.

See #174

I have added it to "ENTER key" and "double-click". Not sure if it is needed elsewhere, but these (I hope safe) changes lead to the following (desired) behavior:

[gamecreature]

@distractor Thanks for your work!. I was a bit busy this week. I will review it coming week and merge it.

[gamecreature]

I've merged your pull-request. I think re-evaluating the autocomplete after closing the previous is a very good addition. Again thanks for your work!