/* gtd-storage.h
 *
 * Copyright (C) 2015-2020 Georges Basile Stavracas Neto <georges.stavracas@gmail.com>
 *
 * This program 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef GTD_PROVIDER_H
#define GTD_PROVIDER_H

#include "gtd-object.h"
#include "gtd-types.h"

#include <gio/gio.h>
#include <glib.h>

G_BEGIN_DECLS

#define GTD_TYPE_PROVIDER (gtd_provider_get_type ())

G_DECLARE_INTERFACE (GtdProvider, gtd_provider, GTD, PROVIDER, GtdObject)

struct _GtdProviderInterface
{
  GTypeInterface parent;

  /* Information */
  const gchar*       (*get_id)                                   (GtdProvider        *provider);

  const gchar*       (*get_name)                                 (GtdProvider        *provider);

  const gchar*       (*get_provider_type)                        (GtdProvider        *provider);

  const gchar*       (*get_description)                          (GtdProvider        *provider);

  gboolean           (*get_enabled)                              (GtdProvider        *provider);

  void               (*refresh)                                  (GtdProvider        *provider);

  /* Customs */
  GIcon*             (*get_icon)                                 (GtdProvider        *provider);

  /* Tasks */
  void               (*create_task)                              (GtdProvider        *provider,
                                                                  GtdTaskList        *list,
                                                                  const gchar        *title,
                                                                  GDateTime          *due_date,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

  GtdTask*           (*create_task_finish)                       (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

  void               (*update_task)                              (GtdProvider        *provider,
                                                                  GtdTask            *task,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

  gboolean           (*update_task_finish)                       (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

  void               (*remove_task)                              (GtdProvider        *provider,
                                                                  GtdTask            *task,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

  gboolean           (*remove_task_finish)                       (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

  /* Task lists */
  void               (*create_task_list)                         (GtdProvider        *provider,
                                                                  const gchar        *name,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

  gboolean           (*create_task_list_finish)                  (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

  void               (*update_task_list)                         (GtdProvider        *provider,
                                                                  GtdTaskList        *list,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

  gboolean           (*update_task_list_finish)                  (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

  void               (*remove_task_list)                         (GtdProvider        *provider,
                                                                  GtdTaskList        *list,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

  gboolean           (*remove_task_list_finish)                  (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

  GList*             (*get_task_lists)                           (GtdProvider        *provider);

  GtdTaskList*       (*get_inbox)                                (GtdProvider        *provider);
};

const gchar*         gtd_provider_get_id                         (GtdProvider        *provider);

const gchar*         gtd_provider_get_name                       (GtdProvider        *provider);

const gchar*         gtd_provider_get_provider_type              (GtdProvider        *provider);

const gchar*         gtd_provider_get_description                (GtdProvider        *provider);

gboolean             gtd_provider_get_enabled                    (GtdProvider        *provider);

void                 gtd_provider_refresh                        (GtdProvider        *provider);

GIcon*               gtd_provider_get_icon                       (GtdProvider        *provider);

void                 gtd_provider_create_task                    (GtdProvider        *provider,
                                                                  GtdTaskList        *list,
                                                                  const gchar        *title,
                                                                  GDateTime          *due_date,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

GtdTask*             gtd_provider_create_task_finish             (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

void                 gtd_provider_update_task                    (GtdProvider        *provider,
                                                                  GtdTask            *task,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

gboolean             gtd_provider_update_task_finish             (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

void                 gtd_provider_remove_task                    (GtdProvider        *provider,
                                                                  GtdTask            *task,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

gboolean             gtd_provider_remove_task_finish             (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

void                 gtd_provider_create_task_list               (GtdProvider        *provider,
                                                                  const gchar        *name,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

gboolean             gtd_provider_create_task_list_finish        (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

void                 gtd_provider_update_task_list               (GtdProvider        *provider,
                                                                  GtdTaskList        *list,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

gboolean             gtd_provider_update_task_list_finish        (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

void                 gtd_provider_remove_task_list               (GtdProvider        *provider,
                                                                  GtdTaskList        *list,
                                                                  GCancellable       *cancellable,
                                                                  GAsyncReadyCallback callback,
                                                                  gpointer            user_data);

gboolean             gtd_provider_remove_task_list_finish        (GtdProvider        *self,
                                                                  GAsyncResult       *result,
                                                                  GError            **error);

GList*               gtd_provider_get_task_lists                 (GtdProvider        *provider);

GtdTaskList*         gtd_provider_get_inbox                      (GtdProvider        *provider);

gint                 gtd_provider_compare                        (GtdProvider        *a,
                                                                  GtdProvider        *b);

G_END_DECLS

#endif /* GTD_PROVIDER_H */