How to implement gtksourceview2.CompletionProvider?

Question

I want to add code completion to my little application. I created my completion provider, added it to completion object in my source view but unfortunately something is not working :P When I run my test application (listed below) I get error:

app = Application()
File "./test.py", line 37, in __init__
self.__completion_window.show()
TypeError: providers must be a list

Why this is happening and how can I fix it?

Here is example application which generates this error:

#!/usr/bin/env python

import keyword
import gtk
import gobject
import gtksourceview2


class MyCompletionProvider(gobject.GObject, gtksourceview2.CompletionProvider):

    def __init__(self):
        gobject.GObject.__init__(self)

    def do_get_name(self):
        return 'PythonKeywords'

    def do_get_activation(self):
        return gtksourceview2.COMPLETION_ACTIVATION_USER_REQUESTED

    def do_match(self, context):
        return True

    def do_get_start_iter(self, context):
        return context.get_iter()

    def do_activate_proposal(self, proposal, iter):
        return True

    def do_populate(self, context):
        self.completions = []
        for compl in keyword.kwlist:
            self.completions.append(
                gtksourceview2.CompletionItem(
                    compl.name, compl.complete, info=compl.type))
        context.add_proposals(self, self.completions, True)


gobject.type_register(MyCompletionProvider)


class Application(gtk.Window):

    def __init__(self):
        gtk.Window.__init__(self, gtk.WINDOW_TOPLEVEL)
        self.connect('destroy', lambda e: gtk.main_quit())
        self.set_size_request(640, 480)
        self.__buffer = gtksourceview2.Buffer()
        self.__buffer.set_text('a' * 20)
        self.__editor = gtksourceview2.View(self.__buffer)
        self.__completion_window = self.__editor.get_completion()
        self.__completion_window.add_provider(MyCompletionProvider())
        self.add(self.__editor)
        self.show_all()
        self.__completion_window.show()

app = Application()
gtk.main()

score 1 · Answer 1 · answered Mar 16 '15 at 16:45

you have to supply a list of CompletionItem instances, using add_proposal method of context

def do_populate(self, context):
    ...
    self.completions = []
    for compl in script.completions():
        self.completions.append(sview.CompletionItem(compl.name, compl.complete, info=compl.type))
    context.add_proposals(self, self.completions, True)

And more, you have to implement all interface's methods, like do_match, do_get_start_iter etc. The only one I have not used is do_get_priority, because didn't found a way to override a GInterface property.

Hi, nice to see that someone dug out my question :) I've incorporated your ideas to my code but unfortunately error did not change. I edited my post with updated example application, if you have time and ideas I will gladly test them :) — BPS, Mar 17 '15 at 17:47

How to implement gtksourceview2.CompletionProvider?

1 Answers1