/* ide-session-addin.h
 *
 * Copyright 2018-2019 Christian Hergert <chergert@redhat.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/>.
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */

#pragma once

#if !defined (IDE_GUI_INSIDE) && !defined (IDE_GUI_COMPILATION)
# error "Only <libide-gui> can be included directly."
#endif

#include <libide-core.h>
#include <libide-gui.h>

G_BEGIN_DECLS

#define IDE_TYPE_SESSION_ADDIN (ide_session_addin_get_type ())

IDE_AVAILABLE_IN_41
G_DECLARE_INTERFACE (IdeSessionAddin, ide_session_addin, IDE, SESSION_ADDIN, IdeObject)

struct _IdeSessionAddinInterface
{
  GTypeInterface parent;

  void      (*save_page_async)     (IdeSessionAddin      *self,
                                    IdePage              *page,
                                    GCancellable         *cancellable,
                                    GAsyncReadyCallback   callback,
                                    gpointer              user_data);
  GVariant *(*save_page_finish)    (IdeSessionAddin      *self,
                                    GAsyncResult         *result,
                                    GError              **error);
  void      (*restore_page_async)  (IdeSessionAddin      *self,
                                    GVariant             *state,
                                    GCancellable         *cancellable,
                                    GAsyncReadyCallback   callback,
                                    gpointer              user_data);
  IdePage  *(*restore_page_finish) (IdeSessionAddin      *self,
                                    GAsyncResult         *result,
                                    GError              **error);
  gboolean  (*can_save_page)       (IdeSessionAddin      *self,
                                    IdePage              *page);
  char    **(*get_autosave_properties) (IdeSessionAddin *self);
};

IDE_AVAILABLE_IN_41
void       ide_session_addin_save_page_async         (IdeSessionAddin      *self,
                                                      IdePage              *page,
                                                      GCancellable         *cancellable,
                                                      GAsyncReadyCallback   callback,
                                                      gpointer              user_data);
IDE_AVAILABLE_IN_41
GVariant  *ide_session_addin_save_page_finish        (IdeSessionAddin      *self,
                                                      GAsyncResult         *result,
                                                      GError              **error);
IDE_AVAILABLE_IN_41
void       ide_session_addin_restore_page_async      (IdeSessionAddin      *self,
                                                      GVariant             *state,
                                                      GCancellable         *cancellable,
                                                      GAsyncReadyCallback   callback,
                                                      gpointer              user_data);
IDE_AVAILABLE_IN_41
IdePage   *ide_session_addin_restore_page_finish     (IdeSessionAddin      *self,
                                                      GAsyncResult         *result,
                                                      GError              **error);
IDE_AVAILABLE_IN_41
gboolean   ide_session_addin_can_save_page           (IdeSessionAddin      *self,
                                                      IdePage              *page);
IDE_AVAILABLE_IN_41
char     **ide_session_addin_get_autosave_properties (IdeSessionAddin      *self);

G_END_DECLS