diff options
Diffstat (limited to 'src/libtracker-miner/tracker-data-provider.c')
| -rw-r--r-- | src/libtracker-miner/tracker-data-provider.c | 207 |
1 files changed, 0 insertions, 207 deletions
diff --git a/src/libtracker-miner/tracker-data-provider.c b/src/libtracker-miner/tracker-data-provider.c deleted file mode 100644 index 20a3396b6..000000000 --- a/src/libtracker-miner/tracker-data-provider.c +++ /dev/null @@ -1,207 +0,0 @@ -/* - * Copyright (C) 2014, Softathome <contact@softathome.com> - * - * 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. - * - * Author: Martyn Russell <martyn@lanedo.com> - */ - -#include "config.h" - -#include <glib/gi18n.h> - -#include "tracker-data-provider.h" - -/** - * SECTION:tracker-data-provider - * @short_description: Provide data to be indexed - * @include: libtracker-miner/miner.h - * - * #TrackerDataProvider allows you to operate on a set of #GFiles, - * returning a #GFileInfo structure for each file enumerated (e.g. - * tracker_data_provider_begin() will return a #GFileEnumerator - * which can be used to enumerate resources provided by the - * #TrackerDataProvider. - * - * There is also a #TrackerFileDataProvider which is an implementation - * of this #TrackerDataProvider interface. - * - * The #TrackerMinerFS class which is a subclass to #TrackerMiner - * takes a #TrackerDataProvider property which is passed down to the - * TrackerCrawler created upon instantiation. This property is - * #TrackerMinerFS:data-provider. - * - * Since: 1.2 - **/ - -typedef TrackerDataProviderIface TrackerDataProviderInterface; -G_DEFINE_INTERFACE (TrackerDataProvider, tracker_data_provider, G_TYPE_OBJECT) - -static void -tracker_data_provider_default_init (TrackerDataProviderInterface *iface) -{ -} - -/** - * tracker_data_provider_begin: - * @data_provider: a #TrackerDataProvider - * @url: a #GFile to enumerate - * @attributes: an attribute query string - * @flags: a set of #TrackerDirectoryFlags - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @error: location to store the error occurring, or %NULL to ignore - * - * Creates a #GFileEnumerator to enumerate children at the URI - * provided by @url. - * - * The attributes value is a string that specifies the file attributes - * that should be gathered. It is not an error if it's not possible to - * read a particular requested attribute from a file - it just won't - * be set. attributes should be a comma-separated list of attributes - * or attribute wildcards. The wildcard "*" means all attributes, and - * a wildcard like "standard::*" means all attributes in the standard - * namespace. An example attribute query be "standard::*,owner::user". - * The standard attributes are available as defines, like - * G_FILE_ATTRIBUTE_STANDARD_NAME. See g_file_enumerate_children() for - * more details. - * - * Returns: (transfer full): a #GFileEnumerator or %NULL on failure. - * This must be freed with g_object_unref(). - * - * Since: 1.2 - **/ -GFileEnumerator * -tracker_data_provider_begin (TrackerDataProvider *data_provider, - GFile *url, - const gchar *attributes, - TrackerDirectoryFlags flags, - GCancellable *cancellable, - GError **error) -{ - TrackerDataProviderIface *iface; - - g_return_val_if_fail (TRACKER_IS_DATA_PROVIDER (data_provider), NULL); - - if (g_cancellable_set_error_if_cancelled (cancellable, error)) { - return NULL; - } - - iface = TRACKER_DATA_PROVIDER_GET_IFACE (data_provider); - - if (iface->begin == NULL) { - g_set_error_literal (error, - G_IO_ERROR, - G_IO_ERROR_NOT_SUPPORTED, - _("Operation not supported")); - return NULL; - } - - return (* iface->begin) (data_provider, url, attributes, flags, cancellable, error); -} - -/** - * tracker_data_provider_begin_async: - * @data_provider: a #TrackerDataProvider. - * @url: a #GFile to enumerate - * @attributes: an attribute query string - * @flags: a set of #TrackerDirectoryFlags - * @io_priority: the I/O priority of the request (example: %G_PRIORITY_DEFAULT) - * @cancellable: (allow-none): optional #GCancellable object, %NULL to - * ignore - * @callback: (scope async): a #GAsyncReadyCallback to call when the - * request is satisfied - * @user_data: (closure): the data to pass to callback function - * - * Precisely the same operation as tracker_data_provider_begin() - * is performing, but asynchronously. - * - * When all i/o for the operation is finished the @callback will be - * called with the requested information. - - * See the documentation of #TrackerDataProvider for information about the - * order of returned files. - * - * In case of a partial error the callback will be called with any - * succeeding items and no error, and on the next request the error - * will be reported. If a request is cancelled the callback will be - * called with %G_IO_ERROR_CANCELLED. - * - * During an async request no other sync and async calls are allowed, - * and will result in %G_IO_ERROR_PENDING errors. - * - * Any outstanding i/o request with higher priority (lower numerical - * value) will be executed before an outstanding request with lower - * priority. Default priority is %G_PRIORITY_DEFAULT. - * - * Since: 1.2 - **/ -void -tracker_data_provider_begin_async (TrackerDataProvider *data_provider, - GFile *url, - const gchar *attributes, - TrackerDirectoryFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) -{ - TrackerDataProviderIface *iface; - - g_return_if_fail (TRACKER_IS_DATA_PROVIDER (data_provider)); - - iface = TRACKER_DATA_PROVIDER_GET_IFACE (data_provider); - - if (iface->begin_async == NULL) { - g_critical (_("Operation not supported")); - return; - } - - (* iface->begin_async) (data_provider, url, attributes, flags, io_priority, cancellable, callback, user_data); -} - -/** - * tracker_data_provider_begin_finish: - * @data_provider: a #TrackerDataProvider. - * @result: a #GAsyncResult. - * @error: a #GError location to store the error occurring, or %NULL - * to ignore. - * - * Finishes the asynchronous operation started with - * tracker_data_provider_begin_async(). - * - * Returns: (transfer full): a #GFileEnumerator or %NULL on failure. - * This must be freed with g_object_unref(). - * - * Since: 1.2 - **/ -GFileEnumerator * -tracker_data_provider_begin_finish (TrackerDataProvider *data_provider, - GAsyncResult *result, - GError **error) -{ - TrackerDataProviderIface *iface; - - g_return_val_if_fail (TRACKER_IS_DATA_PROVIDER (data_provider), NULL); - g_return_val_if_fail (G_IS_ASYNC_RESULT (result), NULL); - - iface = TRACKER_DATA_PROVIDER_GET_IFACE (data_provider); - - if (g_async_result_legacy_propagate_error (result, error)) { - return NULL; - } - - return (* iface->begin_finish) (data_provider, result, error); -} |