diff options
author | Carlos Garnacho <carlosg@gnome.org> | 2019-12-11 20:09:08 +0100 |
---|---|---|
committer | Carlos Garnacho <carlosg@gnome.org> | 2019-12-12 11:12:47 +0100 |
commit | f8562b0278d187e9be5fc022c5c474e438265e46 (patch) | |
tree | 470431b6715404f6e1db012cdef8f3defb99da0f | |
parent | 8cc5888df39dec16c8cb1316d56ddd357bd221c4 (diff) | |
download | tracker-f8562b0278d187e9be5fc022c5c474e438265e46.tar.gz |
libtracker-control: Drop libtracker-control as a public library
This API gained some users, but it is solely used to deal with
one miner (tracker-miner-fs, obviously). In those circumstances,
it's about just as practical to poke well-known DBus names,
certainly there's little users beyond tracker CLI for generic
management of miners.
22 files changed, 20 insertions, 266 deletions
diff --git a/docs/reference/libtracker-control/libtracker-control-docs.xml b/docs/reference/libtracker-control/libtracker-control-docs.xml deleted file mode 100644 index ca9f4181d..000000000 --- a/docs/reference/libtracker-control/libtracker-control-docs.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.5//EN' - 'http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd' [ - -<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -<!ENTITY version SYSTEM "version.xml"> -]> -<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> - <bookinfo> - <title>Tracker Control Library Reference Manual</title> - <releaseinfo> - for libtracker-control &version;. - The latest version of this documentation can be found on-line at - <ulink role="online-location" url="https://developer.gnome.org/libtracker-miner/stable/"> - https://developer.gnome.org/libtracker-miner/stable - </ulink>. - </releaseinfo> - </bookinfo> - - <part id="libtracker-miner-reference"> - <title>API Reference</title> - <partintro> - <para> - This section provides the detailed API of the Tracker Miner library. - </para> - </partintro> - - <chapter> - <title>Tracker control objects</title> - <xi:include href="xml/tracker-miner-manager.xml"/> - </chapter> - </part> - - <xi:include href="migrating-1to2.xml"/> - - <index id="api-index-full"> - <title>Index</title> - <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> - </index> - <index id="api-index-deprecated" role="deprecated"> - <title>Index of deprecated symbols</title> - <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include> - </index> - <index id="api-index-0-8" role="0.8"> - <title>Index of new symbols in 0.8</title> - <xi:include href="xml/api-index-0.8.xml"><xi:fallback /></xi:include> - </index> - <index id="api-index-0-10" role="0.10"> - <title>Index of new symbols in 0.10</title> - <xi:include href="xml/api-index-0.10.xml"><xi:fallback /></xi:include> - </index> - <index id="api-index-0-10-5" role="0.10.5"> - <title>Index of new symbols in 0.10.5</title> - <xi:include href="xml/api-index-0.10.5.xml"><xi:fallback /></xi:include> - </index> - <index id="api-index-0-10-15" role="0.10.15"> - <title>Index of new symbols in 0.10.15</title> - <xi:include href="xml/api-index-0.10.15.xml"><xi:fallback /></xi:include> - </index> - <index id="api-index-0-12" role="0.12"> - <title>Index of new symbols in 0.12</title> - <xi:include href="xml/api-index-0.12.xml"><xi:fallback /></xi:include> - </index> - <index id="api-index-0-16" role="0.16"> - <title>Index of new symbols in 0.16</title> - <xi:include href="xml/api-index-0.16.xml"><xi:fallback /></xi:include> - </index> - <index id="api-index-1-10" role="1.10"> - <title>Index of new symbols in 1.10</title> - <xi:include href="xml/api-index-1.10.xml"><xi:fallback /></xi:include> - </index> - <index id="api-index-2-0" role="2.0"> - <title>Index of new symbols in 2.0</title> - <xi:include href="xml/api-index-2.0.xml"><xi:fallback /></xi:include> - </index> - - <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> -</book> diff --git a/docs/reference/libtracker-control/meson.build b/docs/reference/libtracker-control/meson.build deleted file mode 100644 index b38beedd4..000000000 --- a/docs/reference/libtracker-control/meson.build +++ /dev/null @@ -1,12 +0,0 @@ -version_xml = configure_file(input: 'version.xml.in', - output: 'version.xml', - configuration: conf) - -gnome.gtkdoc('libtracker-control', - src_dir: controlinc, - main_xml: 'libtracker-control-docs.xml', - content_files: ['migrating-1to2.xml'], - dependencies: tracker_control_dep, - scan_args: ['--rebuild-sections'], - fixxref_args: fixxref_args, - install: true) diff --git a/docs/reference/libtracker-control/migrating-1to2.xml b/docs/reference/libtracker-control/migrating-1to2.xml deleted file mode 100644 index 22ccad4f7..000000000 --- a/docs/reference/libtracker-control/migrating-1to2.xml +++ /dev/null @@ -1,25 +0,0 @@ -<?xml version='1.0'?> - -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ -<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<chapter id="tracker-migrating-1-to-2"> - <title>Migrating from libtracker-control 1.x to 2.0</title> - - <para> - Tracker 2.0 is a new major version, containing some possibly - incompatible changes. Most of the changes are not hard to adapt, - and even unlikely to be a problem if the ported application was - kept up-to-date in its usage of 1.x. - </para> - - <section> - <title>Cancellation support for tracker_miner_manager_index_file</title> - <para> - The <link linkend="tracker-miner-manager-index-file">tracker_miner_manager_index_file</link> - method now requires a <link linkend="GCancellable-struct"><classname>GCancellable</classname></link> - argument. You can pass <structname>NULL</structname> if you don't want to specify one. - </para> - </section> -</chapter> diff --git a/docs/reference/libtracker-control/version.xml.in b/docs/reference/libtracker-control/version.xml.in deleted file mode 100644 index c7e1225e2..000000000 --- a/docs/reference/libtracker-control/version.xml.in +++ /dev/null @@ -1 +0,0 @@ -@TRACKER_VERSION@ diff --git a/docs/reference/libtracker-sparql/migrating-2to3.xml b/docs/reference/libtracker-sparql/migrating-2to3.xml index 9c4201f60..282300f89 100644 --- a/docs/reference/libtracker-sparql/migrating-2to3.xml +++ b/docs/reference/libtracker-sparql/migrating-2to3.xml @@ -68,4 +68,14 @@ SELECT ?s { ?s a nfo:FileDataObject } graph, with ?g being NULL. </para> </section> + <section> + <title>No libtracker-control</title> + <para> + This library offered fully generic control method to Tracker + miners. This genericity is not widely useful, so the feature is + no longer exposed as a library. Users are recommended to perform + direct DBus calls to the well-known name of the miner(s) of + interest. + </para> + </section> </chapter> diff --git a/docs/reference/meson.build b/docs/reference/meson.build index f64931159..314c6c494 100644 --- a/docs/reference/meson.build +++ b/docs/reference/meson.build @@ -11,7 +11,6 @@ fixxref_args = [ '--extra-dir=@0@'.format(join_paths(docpath, 'libtracker-sparql')), ] -subdir('libtracker-control') subdir('libtracker-miner') subdir('libtracker-sparql') diff --git a/src/libtracker-control/.gitignore b/src/libtracker-control/.gitignore deleted file mode 100644 index 4f98f606f..000000000 --- a/src/libtracker-control/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -tracker-control-*.deps -tracker-control-*.vapi -*.pc diff --git a/src/libtracker-control/TrackerControl-1.0.metadata b/src/libtracker-control/TrackerControl-1.0.metadata deleted file mode 100644 index 7374e99b4..000000000 --- a/src/libtracker-control/TrackerControl-1.0.metadata +++ /dev/null @@ -1,6 +0,0 @@ -*.*.cancellable#parameter nullable default=null - -MinerManager - .miner_progress#virtual_method skip - -MinerManagerError errordomain diff --git a/src/libtracker-control/meson.build b/src/libtracker-control/meson.build deleted file mode 100644 index 49f51a084..000000000 --- a/src/libtracker-control/meson.build +++ /dev/null @@ -1,55 +0,0 @@ -sources = ['tracker-miner-manager.c'] - -headers = ['tracker-control.h', 'tracker-miner-manager.h'] - -mapfile = 'tracker-control-2.map' -vflag = '-Wl,--version-script,@0@/@1@'.format(meson.current_source_dir(), mapfile) - -libtracker_control = library('tracker-control-' + tracker_api_version, - sources, - tracker_common_enum_header, - c_args: tracker_c_args, - soversion: soversion, - version: libversion, - install: true, - install_rpath: tracker_internal_libs_dir, - dependencies: [tracker_common_dep, tracker_sparql_dep, tracker_miner_dep], - include_directories: [commoninc, configinc, srcinc], - link_args: vflag, -) - -controlinc = include_directories('.') - -tracker_control_dep = declare_dependency( - link_with: libtracker_control, - dependencies: tracker_miner_dep -) - -tracker_control_gir = gnome.generate_gir(libtracker_control, - sources: sources + headers, - nsversion: tracker_api_version, - namespace: 'TrackerControl', - identifier_prefix: 'Tracker', - symbol_prefix: 'tracker', - includes : ['GLib-2.0', 'GObject-2.0', 'Gio-2.0' ], - install: true, - extra_args: '--c-include=libtracker-control/tracker-control.h') - -gnome.generate_vapi( - 'tracker-control-' + tracker_api_version, - sources : tracker_control_gir[0], - packages : 'gio-2.0', - install : true, - ) - -pkg.generate(libtracker_control, - description: 'A library to monitor/control tracker miners', - requires: [glib, gio], - subdirs: 'tracker-' + tracker_api_version, - variables: [ - 'exec_prefix=${prefix}' - ], -) - -install_headers (headers, - subdir: 'tracker-@0@/libtracker-control'.format(tracker_api_version)) diff --git a/src/libtracker-control/tracker-control-2.map b/src/libtracker-control/tracker-control-2.map deleted file mode 100644 index 953287191..000000000 --- a/src/libtracker-control/tracker-control-2.map +++ /dev/null @@ -1,6 +0,0 @@ -{ -global: - tracker_miner_manager_*; -local: - *; -}; diff --git a/src/libtracker-control/tracker-control.deps b/src/libtracker-control/tracker-control.deps deleted file mode 100644 index cd10dfde4..000000000 --- a/src/libtracker-control/tracker-control.deps +++ /dev/null @@ -1 +0,0 @@ -gio-2.0 diff --git a/src/libtracker-control/tracker-control.h b/src/libtracker-control/tracker-control.h deleted file mode 100644 index 7055e30aa..000000000 --- a/src/libtracker-control/tracker-control.h +++ /dev/null @@ -1,29 +0,0 @@ -/* - * Copyright (C) 2014, Carlos Garnacho <carlosg@gnome.org> - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library 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 - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the - * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, - * Boston, MA 02110-1301, USA. - */ - -#ifndef __LIBTRACKER_CONTROL_H__ -#define __LIBTRACKER_CONTROL_H__ - -#define __LIBTRACKER_CONTROL_H_INSIDE__ - -#include <libtracker-control/tracker-miner-manager.h> - -#undef __LIBTRACKER_CONTROL_H_INSIDE__ - -#endif /* __LIBTRACKER_CONTROL_H__ */ diff --git a/src/libtracker-control/tracker-control.vapi b/src/libtracker-control/tracker-control.vapi deleted file mode 100644 index 4bfece8d4..000000000 --- a/src/libtracker-control/tracker-control.vapi +++ /dev/null @@ -1,38 +0,0 @@ -/* tracker-control.vapi generated by vapigen, do not modify. */ - -[CCode (cprefix = "Tracker", gir_namespace = "TrackerControl", gir_version = "2.0", lower_case_cprefix = "tracker_")] -namespace Tracker { - [CCode (cheader_filename = "libtracker-control/tracker-control.h", type_id = "tracker_miner_manager_get_type ()")] - public class MinerManager : GLib.Object, GLib.Initable { - [CCode (has_construct_function = false)] - public MinerManager (); - public static GLib.Quark error_quark (); - [CCode (has_construct_function = false)] - public MinerManager.full (string? domain_name, bool auto_start) throws GLib.Error; - public GLib.SList<string>? get_available (); - public unowned string get_description (string miner); - public unowned string get_display_name (string miner); - public GLib.SList<string>? get_running (); - public bool get_status (string miner, out string status, out double progress, out int remaining_time); - public bool index_file (GLib.File file) throws GLib.Error; - public async bool index_file_async (GLib.File file, GLib.Cancellable? cancellable = null) throws GLib.Error; - public bool is_active (string miner); - public bool is_paused (string miner, [CCode (array_length = false, array_null_terminated = true)] out string[] applications, [CCode (array_length = false, array_null_terminated = true)] out string[] reasons); - public bool pause (string miner, string reason, out uint32 cookie); - public bool pause_for_process (string miner, string reason, out uint32 cookie); - public bool reindex_by_mimetype ([CCode (array_length = false, array_null_terminated = true)] string[] mimetypes) throws GLib.Error; - public bool resume (string miner, uint32 cookie); - [NoAccessorMethod] - public bool auto_start { get; construct; } - public virtual signal void miner_activated (string miner_name); - public virtual signal void miner_deactivated (string miner_name); - public virtual signal void miner_paused (string miner_name); - public virtual signal void miner_progress (string miner_name, string status, double progress, int remaining_time); - public virtual signal void miner_resumed (string miner_name); - } - [CCode (cheader_filename = "libtracker-control/tracker-control.h", cprefix = "TRACKER_MINER_MANAGER_ERROR_")] - public errordomain MinerManagerError { - NOT_AVAILABLE, - NOENT - } -} diff --git a/src/meson.build b/src/meson.build index 04f7f3983..dfcfe1460 100644 --- a/src/meson.build +++ b/src/meson.build @@ -23,9 +23,6 @@ subdir('libtracker-sparql-backend') # Public libtracker-miner library subdir('libtracker-miner') -# Internal control library -subdir('libtracker-control') - # Public commandline control tool subdir('tracker') diff --git a/src/tracker/meson.build b/src/tracker/meson.build index 1bc682cb2..75a822a1d 100644 --- a/src/tracker/meson.build +++ b/src/tracker/meson.build @@ -1,4 +1,5 @@ sources = [ + 'tracker-miner-manager.c', 'tracker-main.c', 'tracker-config.c', 'tracker-daemon.c', @@ -25,7 +26,7 @@ executable('tracker', sources, install_rpath: tracker_install_rpath, # This doesn't depend on tracker_common_dep because of # https://github.com/mesonbuild/meson/issues/671 - dependencies: [tracker_control_dep, tracker_sparql_dep, tracker_data_dep], + dependencies: [tracker_sparql_dep, tracker_data_dep], include_directories: [commoninc, configinc, srcinc], ) diff --git a/src/tracker/tracker-config.c b/src/tracker/tracker-config.c index 59d756132..13bf58e25 100644 --- a/src/tracker/tracker-config.c +++ b/src/tracker/tracker-config.c @@ -24,9 +24,9 @@ #include <glib/gi18n.h> #include <libtracker-common/tracker-common.h> -#include <libtracker-control/tracker-control.h> #include "tracker-config.h" +#include "tracker-miner-manager.h" GSList * tracker_gsettings_get_all (gint *longest_name_length) diff --git a/src/tracker/tracker-daemon.c b/src/tracker/tracker-daemon.c index c73658477..240152df6 100644 --- a/src/tracker/tracker-daemon.c +++ b/src/tracker/tracker-daemon.c @@ -32,13 +32,13 @@ #include <glib/gprintf.h> #include <libtracker-common/tracker-common.h> -#include <libtracker-miner/tracker-miner.h> -#include <libtracker-control/tracker-control.h> +#include <libtracker-sparql/tracker-sparql.h> #include "tracker-daemon.h" #include "tracker-config.h" #include "tracker-process.h" #include "tracker-dbus.h" +#include "tracker-miner-manager.h" typedef struct { TrackerSparqlConnection *connection; diff --git a/src/tracker/tracker-index.c b/src/tracker/tracker-index.c index a759c40c3..fc52c990d 100644 --- a/src/tracker/tracker-index.c +++ b/src/tracker/tracker-index.c @@ -30,11 +30,11 @@ #include <glib/gi18n.h> #include <gio/gio.h> -#include <libtracker-control/tracker-control.h> #include <libtracker-sparql/tracker-sparql.h> #include "tracker-index.h" #include "tracker-dbus.h" +#include "tracker-miner-manager.h" static gchar **reindex_mime_types; static gboolean index_file; diff --git a/src/libtracker-control/tracker-miner-manager.c b/src/tracker/tracker-miner-manager.c index c68be8d03..e9f5aafd1 100644 --- a/src/libtracker-control/tracker-miner-manager.c +++ b/src/tracker/tracker-miner-manager.c @@ -26,7 +26,6 @@ #include <libtracker-common/tracker-dbus.h> #include <libtracker-common/tracker-type-utils.h> #include <libtracker-common/tracker-domain-ontology.h> -#include <libtracker-miner/tracker-miner.h> #include "tracker-miner-manager.h" @@ -49,6 +48,8 @@ #define METHOD_INDEX_FILE "IndexFile" #define METHOD_INDEX_FILE_FOR_PROCESS "IndexFileForProcess" +#define TRACKER_MINER_DBUS_INTERFACE "org.freedesktop.Tracker1.Miner" + typedef struct TrackerMinerManagerPrivate TrackerMinerManagerPrivate; typedef struct MinerData MinerData; diff --git a/src/libtracker-control/tracker-miner-manager.h b/src/tracker/tracker-miner-manager.h index d0927d21a..d0927d21a 100644 --- a/src/libtracker-control/tracker-miner-manager.h +++ b/src/tracker/tracker-miner-manager.h diff --git a/src/tracker/tracker-reset.c b/src/tracker/tracker-reset.c index 8457f6261..7fb037dd7 100644 --- a/src/tracker/tracker-reset.c +++ b/src/tracker/tracker-reset.c @@ -29,13 +29,13 @@ #include <libtracker-common/tracker-common.h> #include <libtracker-data/tracker-data.h> -#include <libtracker-control/tracker-control.h> #include "tracker-reset.h" #include "tracker-daemon.h" #include "tracker-process.h" #include "tracker-config.h" #include "tracker-color.h" +#include "tracker-miner-manager.h" static gboolean hard_reset; static gboolean soft_reset; diff --git a/src/tracker/tracker-status.c b/src/tracker/tracker-status.c index 3a5e28f7c..4cb16b2cd 100644 --- a/src/tracker/tracker-status.c +++ b/src/tracker/tracker-status.c @@ -31,10 +31,10 @@ #include <libtracker-common/tracker-common.h> #include <libtracker-sparql/tracker-sparql.h> -#include <libtracker-control/tracker-control.h> #include "tracker-status.h" #include "tracker-config.h" +#include "tracker-miner-manager.h" #define STATUS_OPTIONS_ENABLED() \ (show_stat || \ |