Commit 59f873ec authored by Giovanni Campagna's avatar Giovanni Campagna

Add a gnome-shell search-provider for settings panel

Replace the gnome-shell builtin settings search, which relied on removed
menu files, with one that uses the remote search infrastructure and
CcSearchModel, and features the ability to continue searching within the
control center application.

https://bugzilla.gnome.org/show_bug.cgi?id=690577
parent 3911ef1c
ACLOCAL_AMFLAGS = -I m4 -I libgd ${ACLOCAL_FLAGS}
SUBDIRS = libgd po egg-list-box panels shell
SUBDIRS = libgd po egg-list-box panels shell search-provider
if BUILD_DOCUMENTATION
SUBDIRS += man
endif
DIST_SUBDIRS = libgd egg-list-box po panels shell man
DIST_SUBDIRS = libgd egg-list-box po panels shell man search-provider
MAINTAINERCLEANFILES = \
$(srcdir)/INSTALL \
......
......@@ -522,6 +522,7 @@ panels/wacom/calibrator/Makefile
panels/wacom/gnome-wacom-panel.desktop.in
po/Makefile.in
libgd/Makefile
search-provider/Makefile
shell/Makefile
shell/gnome-control-center.desktop.in
man/Makefile
......
dbus_shell_search_provider_built_sources = \
cc-shell-search-provider-generated.c \
cc-shell-search-provider-generated.h
# The upstream for the DBus interface definition is
# at http://git.gnome.org/browse/gnome-shell/plain/data/org.gnome.ShellSearchProvider2.xml
$(dbus_shell_search_provider_built_sources) : Makefile.am $(srcdir)/org.gnome.ShellSearchProvider2.xml
gdbus-codegen \
--interface-prefix org.gnome. \
--c-namespace Cc \
--generate-c-code cc-shell-search-provider-generated \
$(srcdir)/org.gnome.ShellSearchProvider2.xml \
$(NULL)
INCLUDES = \
-DCC_PANEL_LOADER_NO_GTYPES \
-I$(top_srcdir) \
$(SHELL_CFLAGS) \
-I$(top_srcdir)/libgd
libexec_PROGRAMS = gnome-control-center-search-provider
BUILT_SOURCES = $(dbus_shell_search_provider_built_sources)
gnome_control_center_search_provider_SOURCES = \
$(BUILT_SOURCES) \
$(top_srcdir)/shell/cc-panel-loader.c \
$(top_srcdir)/shell/cc-panel-loader.h \
control-center-search-provider.c \
control-center-search-provider.h \
cc-search-provider.c \
cc-search-provider.h
gnome_control_center_search_provider_LDADD = \
$(top_builddir)/shell/libshell.la \
$(SHELL_LIBS)
AM_CPPFLAGS = -DGNOMELOCALEDIR="\"$(datadir)/locale\""
CLEANFILES = $(BUILT_SOURCES) $(service_DATA)
servicedir = $(datadir)/dbus-1/services
service_DATA = $(service_in_files:.service.in=.service)
service_in_files = \
org.gnome.ControlCenter.SearchProvider.service.in
org.gnome.ControlCenter.SearchProvider.service: org.gnome.ControlCenter.SearchProvider.service.in Makefile
$(AM_V_GEN) sed -e "s|\@libexecdir\@|$(libexecdir)|" $< > $@
EXTRA_DIST = $(service_in_files) org.gnome.ShellSearchProvider2.xml
searchproviderdir = $(datadir)/gnome-shell/search-providers
dist_searchprovider_DATA = gnome-control-center-search-provider.ini
-include $(top_srcdir)/git.mk
This diff is collapsed.
/*
* Copyright (c) 2012 Giovanni Campagna <scampa.giovanni@gmail.com>
*
* The Control Center is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version.
*
* The Control Center is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
* You should have received a copy of the GNU General Public License along
* with the Control Center; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#ifndef _CC_SEARCH_PROVIDER_H
#define _CC_SEARCH_PROVIDER_H
#include <glib-object.h>
#include <gio/gio.h>
#include "cc-shell-search-provider-generated.h"
#include <shell/cc-shell-model.h>
G_BEGIN_DECLS
#define CC_TYPE_SEARCH_PROVIDER cc_search_provider_get_type()
#define CC_SEARCH_PROVIDER(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), \
CC_TYPE_SEARCH_PROVIDER, CcSearchProvider))
#define CC_SEARCH_PROVIDER_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), \
CC_TYPE_SEARCH_PROVIDER, CcSearchProviderClass))
#define CC_IS_SEARCH_PROVIDER(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
CC_TYPE_SEARCH_PROVIDER))
#define CC_IS_SEARCH_PROVIDER_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), \
CC_TYPE_SEARCH_PROVIDER))
#define CC_SEARCH_PROVIDER_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), \
CC_TYPE_SEARCH_PROVIDER, CcSearchProviderClass))
typedef struct _CcSearchProvider CcSearchProvider;
typedef struct _CcSearchProviderClass CcSearchProviderClass;
GType cc_search_provider_get_type (void) G_GNUC_CONST;
CcSearchProvider *cc_search_provider_new (void);
gboolean cc_search_provider_dbus_register (CcSearchProvider *provider,
GDBusConnection *connection,
const char *object_path,
GError **error);
void cc_search_provider_dbus_unregister (CcSearchProvider *provider,
GDBusConnection *connection,
const char *object_path);
G_END_DECLS
#endif /* _CC_SEARCH_PROVIDER_H */
/*
* Copyright (c) 2012 Giovanni Campagna <scampa.giovanni@gmail.com>
*
* The Control Center is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version.
*
* The Control Center is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
* You should have received a copy of the GNU General Public License along
* with the Control Center; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#include "config.h"
#include <glib/gi18n.h>
#include <stdlib.h>
#include <gio/gio.h>
#include <shell/cc-panel-loader.h>
#include <shell/cc-shell-model.h>
#include "cc-search-provider.h"
#include "control-center-search-provider.h"
G_DEFINE_TYPE (CcSearchProviderApp, cc_search_provider_app, GTK_TYPE_APPLICATION);
#define INACTIVITY_TIMEOUT 60 * 1000 /* One minute, in milliseconds */
static gboolean
cc_search_provider_app_dbus_register (GApplication *application,
GDBusConnection *connection,
const gchar *object_path,
GError **error)
{
CcSearchProviderApp *self;
if (!G_APPLICATION_CLASS (cc_search_provider_app_parent_class)->dbus_register (application,
connection,
object_path,
error))
return FALSE;
self = CC_SEARCH_PROVIDER_APP (application);
return cc_search_provider_dbus_register (self->search_provider, connection,
object_path, error);
}
static void
cc_search_provider_app_dbus_unregister (GApplication *application,
GDBusConnection *connection,
const gchar *object_path)
{
CcSearchProviderApp *self;
self = CC_SEARCH_PROVIDER_APP (application);
if (self->search_provider)
cc_search_provider_dbus_unregister (self->search_provider, connection, object_path);
G_APPLICATION_CLASS (cc_search_provider_app_parent_class)->dbus_unregister (application,
connection,
object_path);
}
static void
cc_search_provider_app_dispose (GObject *object)
{
CcSearchProviderApp *self;
self = CC_SEARCH_PROVIDER_APP (object);
g_clear_object (&self->model);
g_clear_object (&self->search_provider);
G_OBJECT_CLASS (cc_search_provider_app_parent_class)->dispose (object);
}
static void
cc_search_provider_app_init (CcSearchProviderApp *self)
{
self->model = cc_shell_model_new ();
cc_panel_loader_fill_model (self->model);
self->search_provider = cc_search_provider_new ();
g_application_set_inactivity_timeout (G_APPLICATION (self),
INACTIVITY_TIMEOUT);
/* HACK: get the inactivity timeout started */
g_application_hold (G_APPLICATION (self));
g_application_release (G_APPLICATION (self));
}
static void
cc_search_provider_app_class_init (CcSearchProviderAppClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
GApplicationClass *app_class = G_APPLICATION_CLASS (klass);
object_class->dispose = cc_search_provider_app_dispose;
app_class->dbus_register = cc_search_provider_app_dbus_register;
app_class->dbus_unregister = cc_search_provider_app_dbus_unregister;
}
CcShellModel *
cc_search_provider_app_get_model (CcSearchProviderApp *application)
{
return application->model;
}
CcSearchProviderApp *
cc_search_provider_app_get ()
{
static CcSearchProviderApp *singleton;
if (singleton)
return singleton;
singleton = g_object_new (CC_TYPE_SEARCH_PROVIDER_APP,
"application-id", "org.gnome.ControlCenter.SearchProvider",
"flags", G_APPLICATION_IS_SERVICE,
NULL);
return singleton;
}
int main (int argc, char **argv)
{
GApplication *app;
app = G_APPLICATION (cc_search_provider_app_get ());
return g_application_run (app, argc, argv);
}
/*
* Copyright (c) 2012 Giovanni Campagna <scampa.giovanni@gmail.com>
*
* The Control Center is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version.
*
* The Control Center is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
* You should have received a copy of the GNU General Public License along
* with the Control Center; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#ifndef _CONTROL_CENTER_SEARCH_PROVIDER_H
#define _CONTROL_CENTER_SEARCH_PROVIDER_H
#include <gtk/gtk.h>
#include <shell/cc-shell-model.h>
#include "cc-search-provider.h"
typedef struct {
GtkApplication parent;
CcShellModel *model;
CcSearchProvider *search_provider;
} CcSearchProviderApp;
typedef struct {
GtkApplicationClass parent_class;
} CcSearchProviderAppClass;
#define CC_TYPE_SEARCH_PROVIDER_APP cc_search_provider_app_get_type ()
#define CC_SEARCH_PROVIDER_APP(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), \
GNOME_TYPE_CONTROL_CENTER_APP, CcSearchProviderApp))
GType cc_search_provider_app_get_type (void) G_GNUC_CONST;
CcSearchProviderApp *cc_search_provider_app_get (void);
CcShellModel *cc_search_provider_app_get_model (CcSearchProviderApp *application);
#endif
[Shell Search Provider]
DesktopId=gnome-control-center.desktop
BusName=org.gnome.ControlCenter.SearchProvider
ObjectPath=/org/gnome/ControlCenter/SearchProvider
Version=2
[D-BUS Service]
Name=org.gnome.ControlCenter.SearchProvider
Exec=@libexecdir@/gnome-control-center-search-provider
\ No newline at end of file
<!DOCTYPE node PUBLIC
'-//freedesktop//DTD D-BUS Object Introspection 1.0//EN'
'http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd'>
<node>
<!--
org.gnome.Shell.SearchProvider2:
@short_description: Search provider interface
The interface used for integrating into GNOME Shell's search
interface (version 2).
-->
<interface name="org.gnome.Shell.SearchProvider2">
<!--
GetInitialResultSet:
@terms: Array of search terms, which the provider should treat as logical AND.
@results: An array of result identifier strings representing items which match the given search terms. Identifiers must be unique within the provider's domain, but other than that may be chosen freely by the provider.
Called when the user first begins a search.
-->
<method name="GetInitialResultSet">
<arg type="as" name="terms" direction="in" />
<arg type="as" name="results" direction="out" />
</method>
<!--
GetSubsearchResultSet:
@previous_results: Array of results previously returned by GetInitialResultSet().
@terms: Array of updated search terms, which the provider should treat as logical AND.
@results: An array of result identifier strings representing items which match the given search terms. Identifiers must be unique within the provider's domain, but other than that may be chosen freely by the provider.
Called when a search is performed which is a "subsearch" of
the previous search, e.g. the method may return less results, but
not more or different results.
This allows search providers to only search through the previous
result set, rather than possibly performing a full re-query.
-->
<method name="GetSubsearchResultSet">
<arg type="as" name="previous_results" direction="in" />
<arg type="as" name="terms" direction="in" />
<arg type="as" name="results" direction="out" />
</method>
<!--
GetResultMetas:
@identifiers: An array of result identifiers as returned by GetInitialResultSet() or GetSubsearchResultSet()
@metas: A dictionary describing the given search result, containing 'id' and 'name' (both strings). Optionally, either 'gicon' (a serialized GIcon) or 'icon-data' (raw image data as (iiibiiay) - width, height, rowstride, has-alpha, bits per sample, channels, data) can be specified if the result can be better served with a thumbnail of the content (such as with images). A 'description' field (string) may also be specified if more context would help the user find the desired result.
Return an array of meta data used to display each given result
-->
<method name="GetResultMetas">
<arg type="as" name="identifiers" direction="in" />
<arg type="aa{sv}" name="metas" direction="out" />
</method>
<!--
ActivateResult:
@identifier: A result identifier as returned by GetInitialResultSet() or GetSubsearchResultSet()
@terms: Array of search terms, which the provider should treat as logical AND.
@timestamp: A timestamp of the user interaction that triggered this call
Called when the users chooses a given result. The result should
be displayed in the application associated with the corresponding
provider. The provided search terms can be used to allow launching a full search in
the application.
-->
<method name="ActivateResult">
<arg type="s" name="identifier" direction="in" />
<arg type="as" name="terms" direction="in" />
<arg type="u" name="timestamp" direction="in" />
</method>
<!--
LaunchSearch:
@terms: Array of search terms, which the provider should treat as logical AND.
@timestamp: A timestamp of the user interaction that triggered this call
Asks the search provider to launch a full search in the application for the provided terms.
-->
<method name="LaunchSearch">
<arg type="as" name="terms" direction="in" />
<arg type="u" name="timestamp" direction="in" />
</method>
</interface>
</node>
......@@ -6,6 +6,14 @@ INCLUDES = \
all-local: check-local
noinst_LTLIBRARIES = libshell.la
libshell_la_SOURCES = \
cc-shell-model.c \
cc-shell-model.h \
cc-util.c \
cc-util.h
bin_PROGRAMS = gnome-control-center
BUILT_SOURCES = \
......@@ -23,8 +31,6 @@ gnome_control_center_SOURCES = \
cc-shell-category-view.h \
cc-shell-item-view.c \
cc-shell-item-view.h \
cc-shell-model.c \
cc-shell-model.h \
cc-editable-entry.c \
cc-editable-entry.h \
cc-panel-loader.c \
......@@ -33,8 +39,6 @@ gnome_control_center_SOURCES = \
cc-panel.h \
cc-shell.c \
cc-shell.h \
cc-util.c \
cc-util.h \
hostname-helper.c \
hostname-helper.h \
cc-hostname-entry.c \
......@@ -44,6 +48,7 @@ gnome_control_center_SOURCES = \
gnome_control_center_LDFLAGS = -export-dynamic
gnome_control_center_LDADD = \
libshell.la \
$(SHELL_LIBS) \
$(CHEESE_LIBS) \
$(top_builddir)/libgd/libgd.la \
......@@ -126,5 +131,4 @@ EXTRA_DIST += hostnames-test.txt
check-local: test-hostname
$(builddir)/test-hostname $(srcdir)/hostnames-test.txt > /dev/null
-include $(top_srcdir)/git.mk
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment